List Cash In Documents

List Cash-in Documents

get

This endpoint returns a paginated list of cash-in (deposit) 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/cashin/documents HTTP/1.1
Host: api.aurixpay.ws
X-API-Key: text
Accept: */*

{
  "data": [
    {
      "id": "01981d2e-9ed5-72df-83af-6b377c64e9f5",
      "type": "deposit",
      "status": "approved",
      "amount": 110,
      "currency": "BRL",
      "createdAt": "2025-07-18 07:57:31",
      "counterparty": {
        "id": "820f6d50-53a9-4d71-bd93-eb3e349345e7",
        "merchant_id": "0197eb96-33fa-701f-98bd-7c65c1496d78",
        "name": "John Doe",
        "tax_number": "10060958456",
        "maximum_amount": null,
        "document_type": "CPF",
        "metadata": {
          "source": "payin_webhook",
          "created_from": "lambda_processor",
          "webhook_data": {
            "original_payer_name": "John Doe",
            "original_payer_document": 10060958456
          }
        },
        "created_at": "2025-07-18T12:09:51.000000Z",
        "updated_at": "2025-07-18T12:09:51.000000Z"
      },
      "endToEndId": "E00416968202507181058Qnl789fWVPG"
    },
    {
      "id": "01981d2e-858c-7328-87ac-fd6976c37349",
      "type": "deposit",
      "status": "pending",
      "amount": 150,
      "currency": "BRL",
      "createdAt": "2025-07-18 07:57:24",
      "counterparty": null,
      "endToEndId": null
    }
  ],
  "total": 2,
  "currentPage": 1,
  "perPage": 15
}