Pix2DePix API
    • ⚡ Quickstart
    • Guides
      • 🔑 Authentication
      • 🔄 Possible Statuses
      • 🔀 Synchronous requests & safe retries
      • ⚠️ Errors & the response envelope
      • 🧩 Troubleshooting
      • ✅ Best Practices
      • 🚀 Features
        • ⏱️ QR Delay
      • 🛡️ Security & Limits
        • 🚦 API Limits
        • 🧱 Firewall
        • 🪲 Bug Bounty
    • API Endpoints
      • Ping
      • Deposit (PIX ➔ DePix)
      • Deposit Status
      • Deposits
      • User Info
      • Withdraw
      • Withdraw Status
    • Webhooks
      • 🪝 Webhooks
      • Deposit Webhook
      • Withdraw Webhook
      • MED Webhook
    • Reference
      • 📖 Glossary
      • 📝 Changelog
    • Schemas
      • JWTClaims
      • ErrorObj
      • PingObj
      • ErrorResponse
      • DepositObj
      • PingResponse
      • DepositResponse
      • DepositStatusObj
      • DepositStatusResponse
      • DepositWebhookBody
      • DepositsResponse
      • DepositStatus
      • UserInfoResponse
      • WithdrawStatusResponse
      • WithdrawStatusObj
      • WithdrawResponse
      • WithdrawObj
      • WithdrawStatus
      • WithdrawWebhookBody
      • MEDWebhookBody
      • RejectionReasons

    DepositStatusObj

    The state of one deposit. GET /deposit-status returns it inside the response envelope, and the deposit webhook posts the same fields plus the webhookType discriminator.

    {
        "bankTxId": "string",
        "blockchainTxID": "string",
        "customerMessage": "string",
        "payerName": "string",
        "payerTaxNumber": "string",
        "pixKey": "string",
        "qrId": "string",
        "status": "pending",
        "valueInCents": 1,
        "expiration": "2019-08-24T14:15:22.123Z",
        "payerEUID": "string",
        "delayUntil": "string",
        "rejectionReasons": [
            "PAST_DAILY_LIMIT"
        ]
    }
    Built with