v1

latestOpenAPI 3.1.02026-07-24136043.5 KB

Get balance for a client that possess an OBV Token

get/obv/{obvToken}/balance

Path parameters

obvTokenstring required

A Paramount OBV token that must be provided on requests that seek to perform a verification of an existing bank account.

Query parameters

merchantIdstring required

Merchant's assigned Paramount Commerce ID

merchantSubIdinteger required

Merchant Sub ID. This parameter is used to separate reporting and notifications by Merchants who process transactions for multiple websites or need to separate their traffic for other reasons.

merchantUserIdstring required

Merchant User ID

Response

Get Balance Response

obvTokenstring

A Paramount OBV token that must be provided on requests that seek to perform a verification of an existing bank account.

balanceinteger

Balance in minor unit (e.g. pennies)

currencystring

Currency