Payments

List Payments

get/brands/{brand}/payments

Request

  • Base URL: https://app.amber.ai/api/public/v1
  • URL: https://app.amber.ai/api/public/v1/brands/{brand}/payments
  • Auth: HTTP bearer

Path parameters

brandstring required
Example:acme

Brand slug authorized by this API key.

Query parameters

cursorstring

Opaque nextCursor from the same collection and filters. Omit on the first request.

limitinteger
codestring

Exact, case-sensitive match. Spaces and punctuation are literal.

sourceKindstring

Exact, case-sensitive match. Spaces and punctuation are literal.

sourceKeystring

Exact, case-sensitive match. Spaces and punctuation are literal.

scopeKeystring

Exact, case-sensitive match. Spaces and punctuation are literal.

groupRefstring

Exact, case-sensitive match. Spaces and punctuation are literal.

currencystring

Exact, case-sensitive match. Spaces and punctuation are literal.

onHold'true' | 'false'

Exact Boolean match. Use true or false.

orderIdstring
payeeSupplierIdstring

Response

A page of matching records. totalItems counts all matches across pages. When nextCursor is null, you have reached the last page.

nextCursorstring nullable required
totalItemsinteger required

Total number of matching records across all pages.

Changes

No recorded changes to this operation across all 1 revision of this API.