6 . Merchant's Balance

This API endpoint allows to retrieve the total account’s balance.

6.1 Merchant Ballance API Request

Retrieve Merchant's balance

get

Header parameters

merchantIdstringOptional

hashstringOptional

Responses

200

Success

text/plainapplication/jsontext/jsonapplication/xmltext/xml

balancenumber · doubleOptional

currencystring · nullableOptional

400

Bad Request

text/plainapplication/jsontext/jsonapplication/xmltext/xml

get

/1.0/GoOut/Balance

HTTPcURLJavaScriptPython

GET /1.0/GoOut/Balance HTTP/1.1
Accept: */*

{
  "balance": 1,
  "currency": "text"
}

6.1.1 A Header Sample

{
    merchantId: 123456,
    hash: "xxxxxxxxx"
    Content-Type: "application/json"
}

The request header should contain two parameters: merchantId and hash for security and authorization matters.

6.2 Balance Request Hash Seed Strings:

Concatenate the following information, in that order, to obtain the seed string for hash generation for Balance requests:

• Merchant’s ID

• GMT Date (format “yyyy-MM-dd HH”)

• Merchant’s secret

Assuming merchant’s Id is 34567, the actual date is 2023-07-10 14:22:09 (GMT) and merchant’s secret is “abcdef”, the seed string for hash generation would be:

Seed string = 345672023-07-10 14abcdef

IMPORTANT

The Merchant’s secret should be kept safe because is the secret factor that prevents others from generate valid hash.

6.3 A Response Sample:

The response for the Balance request will be like below:

{
    "balance": 60100.31,
    "currency": "BRL"
}