Merchant Balance

Use this endpoint to obtain information about the balance currently on the SMARTy Pay account of your merchant.

The Balance object

The MerchantBalance object includes all relevant details about specific merchant balance. The balance is represented by an array of money objects for all currency types with a non-zero amount on balance. The balance can update with a little lag after the payment.

This object might contain parameters and values not documented in the API Reference, which should be disregarded.

Properties

  • Name
    balances
    Type
    object
    Description

    An array of money objects for all currency types with a non-zero amount on balance.


GET/v1/merchants/{merchantId}/balance

Retrieve a balance

This endpoint allows you to retrieve a payment by providing their unique id. Refer to the list at the top of this page to see which properties are included with payment objects.

Request

GET
/v1/merchants/{merchantId}/balance
curl https://partner-api.smartypay.io/v1/merchants/FdDQBuaqXoReYAxf9VtEBq/balance \
  --user API_KEY:SECRET

Response

{
    "balances": [
        {
            "value": "998",
            "currency": "bUSDT"
        },
        {
            "value": "3015",
            "currency": "pUSDC"
        }
    ]
}