Check account balance

Get started

Checking account balance as a Partner account follows the same approach as getting an account balance as a Merchant account, but uses separate endpoints and additional parameters. Start by familiarising yourself with getting balances.

Once you're familiar with the process, you can recreate the steps with some minor differences.

📘

Helpful to know

You'll need to generate a partner access token. Learn how to do this in the Partner portal here.

Partner get balance

Send an HTTP POST request to the relevant endpoint + /api/v1/partners/merchants/{merchantId}/settlementAccounts/{identifier}/balance including the header Authorization: Bearer <payment_token>.

In addition to the standard parameters, you must include an additional parameter merchantId.

Request

cURL

curl --location --request GET 'https://uat.app.payvyne.com/api/v1/partners/merchants/<merchantId>/settlementAccounts/<identifier>/balance' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <payment_token>'

Parameter	Description
merchantId	16 digit alphanumeric merchant identifier - used to signify the Merchant account you wish to request balance for.