FlamPix Gateway API
  1. Raiz
FlamPix Gateway API
  • 📜 API Overview
  • Docs
    • 🔑 Authentication & HMAC Signing
    • 🪝 Webhook
    • 🧵 Deposit Status Strings
    • 🚦 API Limits
  • Raiz
    • Create Deposit
      POST
    • Get Deposit Status
      GET
    • Get User Info
      GET
    • Health Check
      GET
    • Transaction Status Update
  • Esquemas
    • Customer
    • DepositRequest
    • DepositResponse
    • UserInfoResponse
    • WebhookPayload
  1. Raiz

Get Deposit Status

GET
/deposits/{id}
Consult the current status of a specific deposit.

Requisição

Authorization
or
Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200
application/json
Deposit details retrieved.
Body

🟠404
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/deposits/' \
--header 'X-FlamPix-Key;' \
--header 'X-FlamPix-Key;' \
--header 'X-FlamPix-Timestamp;' \
--header 'X-FlamPix-Timestamp;' \
--header 'X-FlamPix-Signature;' \
--header 'X-FlamPix-Signature;'
Response 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:22Z"
}
Modificado em 2025-12-22 21:14:25
Página anterior
Create Deposit
Próxima página
Get User Info
Built with