Get Cash Out Document

Get Cash-out Document

get

https://api.aurixpay.wshttps://sandbox.api.aurixpay.ws

/banking/v1/cashout/documents/{id}

This endpoint returns the details of a specific cash-out (withdraw) document, identified by its UUID.

scope: documents.read

Path parameters

idstring · uuidRequiredExample: 0198cdd3-e244-7282-b997-8f5eda52b284

Header parameters

AcceptstringOptionalExample: application/json

Content-TypestringOptionalExample: application/json

X-API-KeystringRequiredExample: {{API_KEY}}

Responses

200

Success

application/json

idstringOptional

merchant_idstringOptional

typestringOptional

amountintegerOptional

currencystringOptional

endToEndIdstring · nullableOptional

statusstringOptional

referencestringOptional

related_transaction_idstring · nullableOptional

processed_atstring · nullableOptional

pix_depositobject · nullableOptional

counterpartyobject · nullableOptional

webhook_event_logsobject[]Optional

created_atstringOptional

updated_atstringOptional

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/banking/v1/cashout/documents/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "0198cdd3-e244-7282-b997-8f5eda52b284",
  "merchant_id": "0197ea6e-d3dc-718c-8b43-5d49bb7f38fc",
  "type": "withdraw",
  "amount": 10,
  "currency": "BRL",
  "endToEndId": "E3305358020250821181114110150e28",
  "status": "approved",
  "reference": "bb11292e-9cf1-4fda-83b0-3f4973941841",
  "related_transaction_id": null,
  "virtual_account_id": "0198c2d0-96ac-70e1-9829-edbe2a177dfa",
  "bank_account_id": "0198c2d0-96a8-7079-a4cc-6b0f62ecb207",
  "counterparty": {
    "id": "820f6d50-53a9-4d71-bd93-eb3e349345e7",
    "name": "John Doe",
    "tax_number": "12345678900",
    "bank_account": {
      "id": "50381ceb-4e09-4dad-9d28-db293a10defe",
      "bank_code": "416968",
      "bank_name": "BANCO INTER",
      "branch": "0000",
      "account_number": "0000",
      "account_digit": "",
      "account_type": "checking",
      "pix_key": "1006095357",
      "pix_key_type": "cpf"
    }
  },
  "created_at": "2025-08-21 15:11:12",
  "updated_at": "2025-08-21 15:11:20"
}