Axiym

List payouts

Returns the payments created by the partnership. Use the optional filters to narrow the results by funding account, client reference, or payment status.

Authorization

Default
AuthorizationBearer <token>

In: header

Query Parameters

accountId?string
Formatuuid
clientReference?string
status?string

Normalized payout lifecycle status. PENDING_CONFIRMATION means the prepared payout has not yet been committed and cannot move funds or be submitted for execution.

Allowed values

  • "PENDING_CONFIRMATION"
  • "PROCESSING"
  • "APPROVED"
  • "SETTLED"
  • "SUBMITTED"
  • "COMPLETED"
  • "REJECTED"
  • "FAILED"
  • "RETURNED"
  • "CANCELED"
  • "EXPIRED"
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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the X-Request-Id response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json