Axiym

List deposits

Returns incoming payments detected for the selected client's Axiym accounts. Deposits are accepted only from ACTIVE external accounts registered for that client.

Use the optional filters to narrow the results by account or deposit status.

Authorization

Default
AuthorizationBearer <token>

In: header

Path Parameters

clientId*string

Client identifier (UUID) assigned when an onboarding case is created. It identifies the onboarding case and, once active, the client's Trade API resources. The client must belong to your partnership; anyone else's id returns 404.

Formatuuid

Query Parameters

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.

accountId?string

Filter by account.

Formatuuid
status?string

Filter by status.

Allowed values

  • "PENDING"
  • "HELD"
  • "COMPLETED"
  • "CANCELED"
  • "REJECTED"

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