Withdraw Status

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

See also: Possible Statuses

Responses

🟢200Success

application/json

Headers

Bodyapplication/json

Example

{
    "response": {
        "blockchainTxID": "79ad78f779839d2cbbe59612c7f9eff0919892ae601888b40ab877607ea54217",
        "depositAddress": "lq1qqtkuz7nwp3cymteg0px5pcltrm26uvsak32t04fawfsacafutjg22fhvc8xhj0ue96cevuatnmt757rf4z2r5cwntsemgngcr",
        "depositAmountInCents": 124647,
        "expiration": "2026-01-01T00:20:00-03:00",
        "id": "019b76daa800700000000000000000a1",
        "payoutAmountInCents": 123400,
        "pixKey": "12345678909",
        "status": "sent",
        "transferDate": "2026-01-01T00:01:12-03:00",
        "receiverName": "Maria Silva Souza",
        "receiverTaxNumber": "***.456.789-**",
        "centralBankId": "E12345678202601010000a1b2c3d4e5f"
    },
    "async": false
}

🟠400Malformed request

🟠401Not authenticated

🟠403Not allowed

🟠429Rate limited

🔴500Internal error

🔴502Bad upstream reply

🔴503Unavailable

🔴520Rejection

Request

Request Code Samples

Responses