List Cash Out Documents

List Cash-out Documents

get

This endpoint returns a paginated list of cash-out (withdraw) documents, including status, amount, currency, counterparty data, and identifiers.

scope: documents.read

Header parameters

AcceptstringOptionalExample: application/json

Content-TypestringOptionalExample: application/json

X-API-KeystringRequiredExample: {{API_KEY}}

Responses

200

Success

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /banking/v1/cashout/documents HTTP/1.1
Host: api.aurixpay.ws
X-API-Key: text
Accept: */*

{
  "data": [
    {
      "id": "01981ec2-1a57-720d-be30-386ed6d36d85",
      "type": "withdraw",
      "status": "pending",
      "amount": 500,
      "currency": "BRL",
      "createdAt": "2025-07-18 15:18:13",
      "counterparty": null,
      "endToEndId": null
    },
    {
      "id": "01981ec1-76d6-70a7-bf39-1001e3f3c756",
      "type": "withdraw",
      "status": "pending",
      "amount": 500,
      "currency": "BRL",
      "createdAt": "2025-07-18 15:17:32",
      "counterparty": null,
      "endToEndId": null
    },
    {
      "id": "01981ec0-e9e8-708c-91c7-3e09f7513d12",
      "type": "withdraw",
      "status": "pending",
      "amount": 500,
      "currency": "BRL",
      "createdAt": "2025-07-18 15:16:56",
      "counterparty": null,
      "endToEndId": null
    },
    {
      "id": "0197ecb5-93d3-7146-8ec1-97150172008f",
      "type": "withdraw",
      "status": "pending",
      "amount": 100,
      "currency": "BRL",
      "createdAt": "2025-07-09 01:03:32",
      "counterparty": null,
      "endToEndId": null
    },
    {
      "id": "0197ecad-4c00-707f-9d62-449ce28034c7",
      "type": "withdraw",
      "status": "pending",
      "amount": 600,
      "currency": "BRL",
      "createdAt": "2025-07-09 00:54:29",
      "counterparty": null,
      "endToEndId": null
    }
  ],
  "total": 5,
  "currentPage": 1,
  "perPage": 15
}