Get Fiat Deposit Status with Signature

GET

https://pay.deficopay.com/api/v1/deposits/fiat/{{deficopay_transaction_id}}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

Responses

🟢200Success

application/json

Body

🟠404Record not found

🟠422Standartized Error Response

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://pay.deficopay.com/api/v1/deposits/fiat/{{deficopay_transaction_id}}' \
--header 'X-API-Signature: {{x_api_signature}}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Response Example

200 - Success

{
  "type": "object",
  "properties": {
    "trace_id": {
      "type": "string",
      "format": "uuid",
      "description": "Trace ID of the request"
    },
    "data": {
      "type": "object",
      "properties": {
        "success": {
          "type": "boolean",
          "example": true
        },
        "data": {
          "type": "object",
          "properties": {
            "merchant_transaction_id": {
              "type": "string",
              "format": "uuid",
              "description": "Merchant-provided transaction ID"
            },
            "deficopay_transaction_id": {
              "type": "string",
              "format": "uuid",
              "description": "Generated transaction ID on Deficopay side"
            },
            "status": {
              "type": "string",
              "enum": [
                "pending",
                "completed",
                "cancelled",
                "failed"
              ],
              "description": "Current status of the transaction"
            },
            "amount": {
              "type": "string",
              "example": "30.00 R$",
              "description": "Formatted amount including currency symbol"
            },
            "currency": {
              "type": "string",
              "example": "BRL"
            },
            "updated_at": {
              "type": "string",
              "format": "date-time",
              "example": "2025-05-14T11:37:05.000000Z"
            },
            "payment_details": {
              "type": "object",
              "description": "Additional payment details (e.g., QR code)",
              "properties": {
                "qrCode": {
                  "type": "string",
                  "description": "QR code for PIX if applicable",
                  "example": "00020126850014br.gov.bcb.pix2563..."
                }
              },
              "required": []
            }
          },
          "required": [
            "merchant_transaction_id",
            "deficopay_transaction_id",
            "status",
            "amount",
            "currency",
            "updated_at"
          ]
        }
      },
      "required": [
        "success",
        "data"
      ]
    }
  },
  "required": [
    "trace_id",
    "data"
  ]
}

Modified at 2025-05-21 12:31:38

Get merchant balances