List partner invoices

get https://api-sandbox.ezypay.com/v2/partnerinvoices

Retrieve a list of partner invoices that occurred between two merchants.

Query Params

issuerMerchantId

string

required

Auto-generated identifier of the merchant who issued the partner invoice.

recipientMerchantId

string

required

Auto-generated identifier of the merchant who received the partner invoice.

status

string

Filter by the status of the partner invoice. Supported values are: paid - Payment transaction for invoice completed successfully. past_due - Payment transaction for invoice failed or was unsuccessful.

from

date

Start date for range of partner invoices to view. Filter by date defined in the invoice date. Supported format is YYYY-MM-DD.

until

date

End date for range of partner invoices to view. Filter by date defined in the invoice date. Supported format is YYYY-MM-DD.

countryCode

string

Filter by two letter ISO 3166-1 alpha-2 country code of the issuing merchant.

partnerSubscriptionId

string

Auto-generated identifier of the partner subscription associated to the invoice.

limit

string

To paginate a large result set, use the 'limit' argument to limit the number of results returned per page up to a maximum of 100 records. For example, limit = 10 shows results 1-10. The default returned result would be 100.

cursor

string

An cursor for use in pagination. Specify the number of objects to skip to fetch the next page of objects. For example, limit=10 and cursor=10 will show results for record 11 - 20.

Responses

200200

400400