Settle Transaction

The "Settle Transaction" endpoint allows customers to settle a terminal transaction.

POST /api/terminal/v1/settle

Provide the terminalID, transaction details (narration, reference, amount), and the transaction's STAN, RRN, and masked PAN.

Headers

Name	Value
Content-Type*	application/json
Authorization*	bearer {token}
Request-Reference	{unique_reference}

Params

Required

Name	Data Type	Required	Description
terminalID	string		The ID of the terminal the transaction was made on.
narration	string		Details describing the transaction.
reference	string		A unique reference for the transaction.
amount	number		The transaction amount, in Kobo.
trx_STAN	string		The transaction's System Trace Audit Number (STAN).
trx_RRN	string		The transaction's Retrieval Reference Number (RRN).
trx_MaskedPAN	string		The masked Primary Account Number (PAN) used in the transaction.

Here is an example request and response with a sample payload sent to the endpoint in Curl format.

Sample Request

curl --location -g '{{baseurl}}/api/terminal/v1/settle' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data '{
  "terminalID": "TID12345",
  "narration": "Test settlement",
  "reference": "unique_Transaction_reference",
  "amount": 10000,//In Kobo
  "trx_STAN": "STN12345",
  "trx_RRN": "STN12345",
  "trx_MaskedPAN": "506125****7999"
}'

Response: 200

{
  "status": true,
  "message": "string"
}