Process settlement on device

Request via an API to start the settlement process.

Securityapi_key
Request
path Parameters
mid
required
string

Merchant Identifier.

tid
required
string

Terminal Identifier.

Request Body schema: application/json
settlementType
required
string (ESettlementType)

A combination of all settlement types

Enum: "SETTLEMENT" "PRE_SETTLEMENT" "LAST_SETTLEMENT"
postbackUrl
string <uri>

The URL including any relevant path for returning information relating to the request, will be used for sending process settlement requests.

Responses
204

Expected response body.

400

Bad request.

401

Invalid API key/MID.

403

Forbidden from performing this action.

422

Thrown when trying to process an intent on a device that is not AVAILABLE.

Callbacks
postSettlement Callback(postback)
post/merchant/{mid}/terminals/{tid}/settlement
Request samples
application/json
{}
Response samples
application/json

Thrown when trying process settlement without providing a tid in the request body.

{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "code": "NoTerminalIDProvided",
  • "message": "Cannot process settlement without a Terminal ID."
}
Callback payload samples
POST: Settlement Callback(postback)
application/json
{
  • "mid": "string",
  • "tid": "string",
  • "settlementType": "SETTLEMENT"
}