Get Deposit Status

GET

/deposits/{id}

Consult the current status of a specific deposit.

Request

Authorization

Path Params

Header Params

Responses

🟢200

application/json

Deposit details retrieved.

Body

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/deposits/' \
--header 'X-FlamPix-Key;' \
--header 'X-FlamPix-Key: {{FLAMPIX_API_KEY}}' \
--header 'X-FlamPix-Timestamp;' \
--header 'X-FlamPix-Timestamp: {{X-FlamPix-Timestamp}}' \
--header 'X-FlamPix-Signature;' \
--header 'X-FlamPix-Signature: {{X-FlamPix-Signature}}'

Response Example

{
    "depositId": "33504022-daeb-4ddf-96f2-fc15aa4e6a52",
    "status": "awaiting_payment",
    "amount": {
        "grossInCents": 0,
        "feeInCents": 0,
        "netInCents": 0
    },
    "pix": {
        "qrCopyPaste": "string",
        "qrImageUrl": "http://example.com"
    },
    "feeBreakdown": {
        "percentInCents": 0,
        "fixedInCents": 0,
        "gatewayInCents": 0,
        "totalInCents": 0
    },
    "createdAt": "2019-08-24T14:15:22.123Z"
}

Modified at 2025-12-22 21:14:25

Create Deposit

Get User Info