Deposit Status - Pix2DePix API

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.

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Examples

SuccessException

{
    "response": {
        "bankTxId": "fitbank_E1320335420250228200542878498597",
        "blockchainTxID": "4c7dff78eddb910b912f633d83472981fa5b8447859a7c66e49957f2a88167af",
        "customerMessage": "Message from payer here",
        "payerName": "John Doe",
        "payerTaxNumber": "12345678901",
        "expiration": "2025-03-05T14:33:56-03:00",
        "pixKey": "68fa2517-5c6d-412d-b991-f0762eeec2e3",
        "qrId": "01954e29d3337e388d5d1cb846b0d053",
        "status": "depix_sent",
        "valueInCents": 12345,
        "delayUntil": "2025-03-06T14:33:56-03:00"
    },
    "async": false
}

🟠404Record Not Found

🟠400Bad request

🟠403Forbidden

🔴500Server Error

🔴503Service Unavailable