Request for Settlement

A Request for Settlement is used to initiate the terminal’s batch settlement with the payment processor. At the end of the business hours, when a merchant is ready to close, all transactions processed during their operating hours must be submitted to the processor to ensure the funds are transferred to their bank account.

Request Body

application/json

RegisterId*string

Alphanumeric reference field.

TPN?string

Alphanumeric TPN field.

AuthKey*string

Authorizes the Host system to use the SPIn Web Service.

RefId*string

Alphanumeric reference field.

TransType*string

Identifies the type of transaction to run – Settle.

Value in"Settle"

MerchantId?string

Merchant number (1-N). If omitted in multi-merchant mode, all merchants are settled.

Param*string

Close = normal closing, Force = force batch totals.

Value in"Close" | "Force"

Response Body

`application/json`

curl -X GET "https://example.com/cgi.html-settle" \  -H "Content-Type: application/json" \  -d '{    "RegisterId": "3",    "TPN": "",    "AuthKey": "",    "RefId": "2",    "TransType": "Settle",    "Param": "Close",    "MerchantId": ""  }'

{
  "RefId": "string",
  "RegisterId": "string",
  "TPN": "string",
  "ResultCode": "string",
  "Message": "string",
  "AuthCode": "string",
  "ExtData": "string"
}

Request for Settlement

Request Body

Response Body

200application/json

`application/json`