Skip to content

Commit

Permalink
completed docs and json response samples for new apis
Browse files Browse the repository at this point in the history
  • Loading branch information
devops-blockchyp committed Oct 27, 2023
1 parent a259ba2 commit 85b6f0b
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 28 deletions.
40 changes: 21 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4171,19 +4171,18 @@ print("Response: %r" % response)

```

#### Merchant Invoices
#### Partner Statement Detail



* **API Credential Types:** Partner or Merchant
* **Required Role:** Partner API Access or Merchant API
* **API Credential Types:** Partner
* **Required Role:** Partner API Access

The API returns a list of merchant statements and invoices. By default, all invoices are returned with the most recent
statements listed first. Optional date parameters (`startDate` and `endDate`) can be used to filter statements by date
range.
The API returns detailed information about a specific partner statement. Aggregate data is returned along with
line item level data for each underlying merchant statement.

The `invoiceType` parameter can also be used to filter invoices by type. Invoices could be conventional invoices, such
as those generated when ordering terminals or gift cards, or invoices could be merchant statements.
Use the merchant statement id with the *Merchant Statement Detail* API and the *Partner Commission Breakdown* API
to get the merchant statement and the card brand fee and misc cost breakdown respectively.



Expand All @@ -4205,21 +4204,26 @@ request = {
}

# run the transaction.
response = client.merchant_invoices(request)
response = client.partner_statement_detail(request)

print("Response: %r" % response)


```

#### Merchant Invoice Detail
#### Merchant Invoices



* **API Credential Types:** Partner
* **Required Role:** Partner API Access
* **API Credential Types:** Partner or Merchant
* **Required Role:** Partner API Access or Merchant API

The API returns detailed information about a specific merchant statement.
The API returns a list of merchant statements and invoices. By default, all invoices are returned with the most recent
statements listed first. Optional date parameters (`startDate` and `endDate`) can be used to filter statements by date
range.

The `invoiceType` parameter can also be used to filter invoices by type. Invoices could be conventional invoices, such
as those generated when ordering terminals or gift cards, or invoices could be merchant statements.



Expand All @@ -4241,23 +4245,21 @@ request = {
}

# run the transaction.
response = client.merchant_invoice_detail(request)
response = client.merchant_invoices(request)

print("Response: %r" % response)


```

#### Partner Statement Detail
#### Merchant Invoice Detail



* **API Credential Types:** Partner
* **Required Role:** Partner API Access

The API returns detailed information about a specific partner statement. The optional `includeMerchantStatement` and
`includeInterchange` parameters can be used to return low level detail about how the
residuals or commissions were computed.
The API returns detailed information about a specific merchant statement.



Expand All @@ -4279,7 +4281,7 @@ request = {
}

# run the transaction.
response = client.partner_statement_detail(request)
response = client.merchant_invoice_detail(request)

print("Response: %r" % response)

Expand Down
18 changes: 9 additions & 9 deletions blockchyp/blockchyp.py
Original file line number Diff line number Diff line change
Expand Up @@ -788,35 +788,35 @@ def partner_statements(self, request):
test=request.get("test", False),
)

def merchant_invoices(self, request):
def partner_statement_detail(self, request):
# type: (dict) -> dict
"""Returns a list of merchant invoices."""
"""Returns detail for a single partner statement."""

return self._gateway_request(
method="POST",
path="/api/merchant-invoice-list",
path="/api/partner-statement-detail",
body=request,
test=request.get("test", False),
)

def merchant_invoice_detail(self, request):
def merchant_invoices(self, request):
# type: (dict) -> dict
"""Returns detail for a single merchant-invoice statement."""
"""Returns a list of merchant invoices."""

return self._gateway_request(
method="POST",
path="/api/merchant-invoice-detail",
path="/api/merchant-invoice-list",
body=request,
test=request.get("test", False),
)

def partner_statement_detail(self, request):
def merchant_invoice_detail(self, request):
# type: (dict) -> dict
"""Returns detail for a single partner statement."""
"""Returns detail for a single merchant-invoice statement."""

return self._gateway_request(
method="POST",
path="/api/partner-statement-detail",
path="/api/merchant-invoice-detail",
body=request,
test=request.get("test", False),
)
Expand Down

0 comments on commit 85b6f0b

Please sign in to comment.