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.

Possible statuses:

canceled - If the payment was canceled by the end user, by our partner or by us. Please contact our team for more details about what happened.

under_review - The payment was received from the end user but is under review by us. If this status takes too long, please let us know.

depix_sent - It means that we received the end user's PIX payment, approved it, and sent the DePix to the partner or specified address. This is probably the status that interests you the most and that you should monitor.

error - If any error occurred during the process, please contact us to find out if the error is reversible or not.

refunded - It means that the amount was refunded to the user who initially made the deposit, probably through a special refund mechanism (MED).

expired - It means that the QR Code expired before the end user could make the payment.

pending - It means that the QR Code has been generated and is awaiting payment.

Request

Authorization

Add the parameter

Authorization

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

Example:

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

Query Params

string

optional

The ID of deposit to be queried.

Example:

83b54acc914f48768b5884bd0ff342d8

Header Params

X-Nonce

string <uuid>

optional

A random uuid string to identify an CLIENT INTENTION as unique. In case of retrying the same request, always use the same nonce. For new operations, use a new one. By default, if this param is empty, a new nonce would be generated.

X-Async

string

write-onlyoptional

Can be true, false or auto. If not auto forces API async or sync behavior.

Default:

auto

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

DepositStatusObjOrError

optional

DepositStatusObjOrError

One of

DepositStatusObj

ErrorObj

expiration

string <date-time>

read-onlyrequired

Deposit QR Code expiration

payerName

string

read-onlyrequired

Payer name (end user)

payerTaxNumber

string

read-onlyrequired

Tax number (CPF / CNPJ) of end user

pixKey

string

read-onlyrequired

PIX Key related with the QR Code

status

enum<string>

read-onlyrequired

Status of the deposit

Allowed values:

pendingdepix_sentunder_reviewcancelederrorrefundedexpired

valueInCents

integer

required

Amount in cents of BRL

>= 1

blockchainTxID

string

optional

Optional txid of the payment

bankTxId

string

required

customerMessage

string

required

qrId

string

required

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
    },
    "async": false
}

🟠404Record Not Found

🟠400Bad request

🟠403Forbidden

🔴500Server Error

🔴503Service Unavailable