Get Cash In Document by Reference

Get Cash-in Document by Reference

get

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

/banking/v1/cashin/documents/reference/{reference}

Base URL: https://api.pix.aurixpay.ws

This endpoint returns the details of a specific cash-in (deposit) document, identified by its reference.

scope: documents.read

Path parameters

referencestringRequiredExample: 52bba563-1951-4387-b5b5-081faaf3f9f9

Header parameters

AcceptstringOptionalExample: application/json

Content-TypestringOptionalExample: application/json

X-API-KeystringRequiredExample: {{API_KEY}}

Responses

200

Success

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/banking/v1/cashin/documents/reference/{reference}

HTTPcURLJavaScriptPython

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

{
  "id": "0198bce8-b7df-7201-b551-bd281e025fdb",
  "reference": "52bba563-1951-4387-b5b5-081faaf3f9f9",
  "amount": 10,
  "currency": "BRL",
  "status": "approved",
  "type": "deposit",
  "endToEndId": "E60701190202508162121DY5GW6QEWNO",
  "processed_at": "2025-08-19 14:26:04",
  "virtual_account": "0198b2b9-eab1-73d2-9dad-0fee7c453ea9",
  "bank_account": "50381ceb-4e09-4dad-9d28-db293a10defe",
  "pix_deposit": {
    "id": "0198bce8-b7d7-705b-a243-2775da0aeadc",
    "qr_code": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAAFAAQMAAAD3XjfpAAAABlBMVEUEAgT8/vxJvsdeAAAACXBIWXMAAA7EAAAOxAGVKw4bAAADPElEQVRoge1ZQW7kMAyTT36Gfxo7P80zfIrWIuVkWuyhZ7bBYJBJOAOUlSiKMf/hYX/AXwScto7i12Ht9Mus3fXqsw2zw4wn66IcsK0//pztxDf6tLJuVj/jqwE51+0pCBz4xJf71d0XQ2VanFj8QFEFzqiIEqj1Ht9YkKiLxZMwMFkJyLpfUCNHjYuqQLbC4iNOkp7gqc8sFhcEQvYm6uJ/r2/6KALcRyg9qyBVMAnLQwwY9AQHHd3gMeUWW+yDOF8nSwb0gJ304GTwfg0Z6DOGPOZeUwNS18HBHmi29R5zHjWiBlz/f5T8/RKzPob43WHo4GuyKJSAzcO1XTCtgVqsWOVgb6iUK6tHCch/fs60BWF1RDkcYeXa+GwFHSB1Lkx6EMNxF4XAZaWdT89IAWletllDN0R1VDaHw825GjBmeEw5xyQfWFDK0wGbJzVgupjcydgBwQc644AeKAKxmgAS5mUvaqn682sryAAzdched6QvcREMcSV93Z4QMImpsYizHKgE2F2iJ0rSowRsj1m7Nxm8Aob8GXFaQEOQlmHDwMqyJCFQex89BYGNr1G5ozBpo3UFMbGsuBqQ4TFqv0P/SsoeNlRs5D6bGnBuDjDVrZIehhBGCex6QLQ4dxSuJoNPDzDi6HROPSBk70hHgxR5dwa1obwrqRCQmbHToTvug6qMk6MtPopCB0gajporaRr27Wg6syg5II3qTd+KvSRfMes8zZ0ekEMst08+CosRR8HjwqoGxCIy8OzrrryPzAn09C38csAs/CNlIJTPGD9A8/o7C5WAmY4b3g8+3t/NgYsx99SAO36wvZIW7Gr2FsUecUpAaPm5Z3jf2eqBtgh3U5+Hn0LAMOxUu/YO88noJXfTrgikdzM8KqH+sVIM3Iy3FaSABsvm278UPDMpaIv+vIsBEbcMKP2N6kD3M1PMZEIQyGNnaRQ/WBjmi58rqRAQ0l4yV3taP1dSn3lFDth8hw1UgoLzMjOC8idC1gI+6g6xv8hWh5EfRvKaKPBdSTtjJ0tzVxg4iQKLZ9QExxory4ERF5xNQaB/XUaN484YQe1RrwbMYuflO8PyAPI3HLZODfjD4w/4e4D/AJPM+Qn/ttzkAAAAAElFTkSuQmCC",
    "br_code": "00020126820014br.gov.bcb.pix2560pix.treeal.com/qr/v3/at/65b48956-119c-459d-8c14-8fdabef50fc15204000053039865802BR5921DF_PARTICIPACOES_LTDA6009SAO_PAULO62070503***63040E97",
    "pix_key": null,
    "end2end_id": "E60701190202508162121DY5GW6QEWNO",
    "description": "testes",
    "expires_at": "2025-08-18 08:50:24",
    "type": "static",
    "external_id": "7d089ce1-57b2-492a-a515-d7b6d7c257bc"
  },
  "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": "1",
      "account_number": "123456789",
      "account_digit": null,
      "account_type": "checking",
      "pix_key": null,
      "pix_key_type": null
    }
  },
  "created_at": "2025-08-18 08:20:24",
  "updated_at": "2025-08-19 14:26:04"
}