3.3. Get balance

3.3.1. Get balance flow

For integration purposes use staging environment sandbox.payneteasy.com instead of production gate.payneteasy.com. Get balance transactions are initiated through HTTPS POST request by using URL in the following format:

Setting up balances

Balances can be configured for managers and merchants via Accounts tab.

../_images/accountstab.png

1. Set up the transaction type and rates(application direction for rates is set manually), which will add or deduct funds from your account. Rates based on transaction amount and statuses may also deduct money from your balance. Optionally, gate and endpoint can be selected - if they are left empty, balance configuration will work for all gates and endpoints of selected manager.

../_images/adding_config.png
  1. Choose which balances you would like to use - Account balances, Processor balance (balances for acquirer can be set), Card mapping balances and Gate group balances (setting balances for specific list of gates)
../_images/adding_account_balance.png

Default balance must be selected. If balance-name parameter is left empty, get balance will respond with default balance.

  1. Adjustments for balance can be made via Add adjustment button. Adjustment amount and external source of the adjustment are mandatory.
../_images/adding_adjustments.png

Alternatively, adjustments requests via API are available. Please refer to the file example and debugger. Added adjustments as seen in the UI:

../_images/added_adjustments.png

Example of configured balance. First balance is funded by sale transaction and defunded by payout and dispute transactions and is set up for USD currency, also merchant rates apply. The other balance is set up for AUD and is only funded by sale transactions, without any rates.

../_images/balance_example.png

Get balance transaction

The End point ID is an entry point for incoming Merchant’s transactions for single currency integration.

https://gate.payneteasy.com/paynet/api/v2/get-balance/ENDPOINTID – for Get balance transaction by End point ID

Get balance also supports checking balance by manager and by merchant login.

https://gate.payneteasy.com/paynet/api/v2/get-balance/merchant/MERCHANTLOGIN – for Get balance transaction by Merchant login.

https://gate.payneteasy.com/paynet/api/v2/get-balance/manager/MANAGERLOGIN – for Get balance transaction by Manager login.

Get balance Parameters

In order to initiate a Get balance transaction Merchant sends an HTTPS POST request with the parameters specified in Get balance Request Parameters Table below

Get balance Parameters Mandatory Description
balance-provider Optional Input your balance provider. Only parameter mandatory for get balance by endpoint
balance-name Optional Your balance name. Only parameter mandatory for get balance by login

Adjustments parameters and file example

Adjustments must be sent in archived tsv file format.

Balance Adjustment Parameter Description
Credit amount Credit amount.
Debit amount Debit amount.
External ID Adjustment external ID.
External Merchant ID External merchant ID. Set in properties of merchant/manager.
Balance name Balance name. If parameter is not set, default balance is automatically selected.

tsv file example:

10.45               eid1    THIS_IS_EXT_MERCH_ID    Global merchant balance
90.05               eid2    THIS_IS_EXT_MERCH_ID    Global merchant balance

Get balance Response Parameters

Get balance Response Parameter Description
amount Current balance.
name Balance name.
currency Currency used for selected balance.
merchantLogin Merchant login for the balance.
managerLogin Manager login for the balance.
externalMerchantIdentifier External merchant identifier.

Get balance Response Example

"name":"Global merchant balance","amount":21.400,"currency":"USD","merchantLogin":"obtmerc","externalMerchantIdentifier":"THIS_IS_EXT_MERCH_ID"

Get Balance Debug

File example Adjustments parameters and file example

To reproduce your API call, input all of the data from your original request, including the authentication tokens. Don’t forget to set the nonce and timestamp to the values you used. An OAuth signed URL should match regardless of the generating library. If the signatures differ, you know there is a bug in your OAuth signature code.

HTTP method
endpoint
url
parameters
version
consumer key
consumer secret
timestamp
nonce
signature method

normalized parameters
signature base string
signature
authorization header
              
            
              
            
              
            

Balance Adjustment Debug

In order to make an adjustment, tsv file must be archived and sent. 7-Zip or similar archiving software is needed in order to use this debugger.

url
Source
Manager login
filename
control key