Axiym

List payouts

Returns payouts using the common payment response document, including payouts awaiting confirmation. Filter by funding account, externalReference, or status.

View MarkdownView complete reference

Authorization

Default
AuthorizationBearer <token>

In: header

Query Parameters

accountId?string

Filter by funding account identifier.

Formatuuid
externalReference?string

Filter by the reference supplied when the payout was created.

status?string

Filter by payout status.

Allowed values

  • "PENDING_CONFIRMATION"
  • "PENDING"
  • "HELD"
  • "COMPLETED"
  • "CANCELED"
  • "REJECTED"
first?integer

Maximum number of items to return (page size).

Range1 <= value <= 100
Default20
after?string

Cursor for the next page, from the previous response's pageInfo.endCursor.

Header Parameters

X-Request-Id?string

Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in X-Request-Id, or generates one when omitted.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json