Merchant Balance Inquiry Service

Merchant Balance Inquiry Service Request Model;

With this service, you can make sub-store balance inquiries for merchants and marketplaces.

Method
API URL
Parameters

POST

https://posservice.esnekpos.com/api/services/GetDealerBalance

JSON File

The parameters to be sent to the service are as follows;

Parameters
Type
Compulsory
Description

MERCHANT

string

Yes

It is a unique credential created specifically for the member business.

MERCHANT_KEY

string

Yes

It is the key information created specifically for the member business.

CURRENCY

string

Yes

Currency of the balance to be queried.('TRY','USD','EUR')

DEALER_SUB_EXTERNAL_ID

string

Yes

It is the identity information of the sub-store to be queried in the member workplace. For Marketplace balance inquiry, the ID information of the store's marketplace (merchant) side must be entered in the "DEALER_SUB_EXTERNAL_ID" parameter.

Here is a sample JSON file to send to the service;

                                            
                                        
                                                
{
    "MERCHANT" : "TEST1234",
    "MERCHANT_KEY" : "4oK26hK8MOXrIV1bzTRVPA==",
    "CURRENCY" : "TRY",
    "DEALER_SUB_EXTERNAL_ID" : null
}
                                                
                                            
                                        

Merchant Balance Inquiry Service Reply Message;

The parameters of the reply message sent from the service after the transaction are as follows;

Transaction Listing Service Reply Message Parameters

Parameters
Type
Compulsory
Description

STATUS

string

Yes

Status information

RETURN_CODE

string

Yes

The status of the balance query is the code information.

RETURN_MESSAGE

string

Yes

It is the status message information as a result of the balance inquiry process.

DEALER_BALANCE

array

Yes

It is a JSON string containing the details requested as a result of the balance query.

DEALER BALANCE

Parameters
Type
Compulsory
Description

DEALER_SUB_ID

int

Yes

The unique credential of the sub-merchant.

DEALER_ID

int

Evet

It is the unique identity information of the merchant.

DEALER_TYPE

string

Evet

It is the type information of the member workplace.

MERCHANT

string

Evet

It is a unique credential created specifically for the member business.

DEALER_NAME

string

Evet

It is the name information of the member workplace.

BALANCE

decimal

Evet

It is the balance amount information.

CURRENCY

string

Evet

Currency information.

DEPOSIT_BALANCE

decimal

Evet

Collateral balance information.

CHARGEBACK_BALANCE

decimal

Evet

The payment objection is the balance information.

TOTAL_BALANCE

decimal

Evet

Total balance information.

                                            
                                        

 {
    "STATUS": "SUCCESS",
    "RETURN_CODE": "0",
    "RETURN_MESSAGE": "SUCCESS",
    "DEALER_BALANCE": {
            "DEALER_SUB_ID": 0,
            "DEALER_ID": 1,
            "DEALER_TYPE": "UyeIsyeri",
            "MERCHANT": "TEST1234",
            "DEALER_NAME": "TEST A.Ş.",
            "BALANCE": 24187.2569,
            "CURRENCY": "TRY",
            "DEPOSIT_BALANCE": 0.00,
            "CHARGEBACK_BALANCE": 120.00,
            "TOTAL_BALANCE": 24187.2569
            }
 }
                                            
         

Last updated