Deposit Status

GET

/deposit-status

The /deposit-status API is used to retrieve the status of a financial deposit in the system. It provides information about the deposit, such as its current state, amount, and other metadata.

Request

Authorization

Query Params

Body Params multipart/form-data

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Headers

Bodyapplication/json

Example

{
    "response": {
        "bankTxId": "processor_E12345678202601010000a1b2c3d4e5f",
        "blockchainTxID": "ce45cbc2f7bdbf9ddda5e7a9fac1e2135c3be2b342b4a93c9a06032672fbf8cc",
        "customerMessage": "Pedido 4821",
        "payerName": "Maria Silva Souza",
        "payerTaxNumber": "12345678909",
        "expiration": "2026-01-01T00:20:00-03:00",
        "pixKey": "550e8400-e29b-41d4-a716-446655440000",
        "qrId": "019b76daa8007000000000000000000d",
        "status": "depix_sent",
        "valueInCents": 15000,
        "delayUntil": "2026-01-02T00:00:00-03:00"
    },
    "async": false
}

🟠400BadRequest

🟠401Unauthorized

🟠403Forbidden

🟠429TooManyRequests

🔴500ServerError

🔴502BadUpstream

🔴503ServiceUnavailable

🔴520Rejected

Modified at 2026-08-24 14:10:04

Deposit (PIX ➔ DePix)

Deposits