Query Balance

Developing

Develop Env

https://merchant-api.stg.paypaga.com

GET

/get_merchant_balance/{merchant_id}

Real-time access to the financial balances of a merchant's account. This can be used for reporting and as a precursor to Pay Out - Payment Processing to determine if there is sufficient balance.

Error codes for Query Balance

Error code	Description
107	The merchant balance does not exist
500	Unexpected error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://merchant-api.stg.paypaga.com/get_merchant_balance/?country_code&payment_method_code' \
--header 'Authorization;'

Response Example

200 - Success

{
  "country_collection": [
    {
      "country_code": "MX",
      "payment_method_collection": [
        {
          "payment_method_code": "BNKTR",
          "balance_collection": [
            {
              "transaction_type": "Payin",
              "currency": "MXN",
              "amount": 167761.96
            },
            {
              "transaction_type": "Payout",
              "currency": "MXN",
              "amount": 150985.764
            }
          ]
        }
      ]
    }
  ]
}

Request

Path Params

Query Params

Header Params

Responses

🟢200Success

application/json

Body

🟠400Bad Request

🔴500Server Error

Transactions Status Notification

Transaction Status Definitions and Lifecycle