Get Merchant Balance

📍 Endpoint

GET https://pay.deficopay.com/api/v1/merchant/balance

🔐 Authorization

This endpoint requires:

A valid JWT Bearer token, obtained via POST /api/v1/auth/token

A valid HMAC-SHA256 signature, passed via the X-Deficopay-Signature header

🧾 Headers

Header	Value	Required	Description
`Authorization`	`Bearer {{auth_token}}`	✅	JWT token
`X-Deficopay-Signature`	`{{x_api_signature}}`	✅	HMAC-SHA256 signature of the canonical string
`Content-Type`	`application/json`	✅	Always required

🧠 Canonical String for Signature

GET
/api/v1/merchant/balance

Then calculate the signature as:

HMAC_SHA256(canonical_string, api_key)

The resulting hex digest is sent in the X-Deficopay-Signature header.

✅ Response Example

{
  "success": true,
  "data": [
    {
      "currency": "ARS",
      "available": "3200.00",
      "pending": "150.00",
      "reserved": "100.00",
      "total": "3450.00"
    },
    {
      "currency": "BRL",
      "available": "800.00",
      "pending": "0.00",
      "reserved": "0.00",
      "total": "800.00"
    }
  ]
}

🧮 Response Field Descriptions

Each item in the data array represents a balance for one currency.

Field	Type	Description
`currency`	string	ISO currency code (e.g., `ARS`, `BRL`)
`available`	string	Funds that are immediately available for payout or new transactions
`pending`	string	Funds awaiting confirmation (e.g., recently received or pending)
`reserved`	string	Funds temporarily locked (e.g., in active withdrawal or fraud check)
`total`	string	Sum of all three balances: `available + pending + reserved`

💡 Use Cases

Display merchant's wallet balances in portal or dashboard

Check if the merchant can initiate a new payout

Track incoming vs confirmed funds across currencies

📍 Endpoint#

🔐 Authorization#

🧾 Headers#

🧠 Canonical String for Signature#

✅ Response Example#

🧮 Response Field Descriptions#