Payout Transaction

Pre-Balance Check

Intercept balance check requests to apply validation or custom logic.

{
	"action_type" : "pre-payout-auth",
	"action_id" : "d4cb8f5b-8ae5-432e-82c8-c17d6607bf2c",
	"version": "v1.1.0",
	"data" : {
		"terminal" : {
			"terminalId" : "2KUD1234",
			"serialNo" : "91201008993212",
			"pin": "0000",
			"signature": "plainKeyPassedByUserAndHashedWithMerchantSecretKey"
		},
		"transaction" : {
			"amount": 5000,
			"currency": "NGN",
			"source": "pos",
			"type": "transfer",
			"customerBillerId": "",
			"productId": "",
			"billerAccountName": ""
			"rrn": "***"
		},
		"account" : {
			"balance": 5000,
			"currency": "NGN",
			"id": "9ee1586d-3b14-4fcc-b9cf-4226d50f26de"
		}
	}
}

{
	"data": {
		"transaction": {
			"shouldActionProceed": true,
			"reasonCode": "00"
		}
	}
}

Passed Data Object

string

required

The type of terminal action to perform (e.g., pre-payout-auth).

string

required

A unique identifier for this terminal action request.

string

required

API version to use (e.g., v1.1.0).

object

required

Contains the terminal, transaction, and account data for evaluation.

Hide data.terminal

string

required

Unique identifier for the terminal.

string

required

Serial number of the terminal.

string

required

PIN entered by the user.

string

required

HMAC signature generated using the merchant’s secret key.

Hide data.transaction

number

required

The payout amount.

string

required

Currency code (e.g., NGN).

string

required

Origin of the transaction (e.g., pos).

string

required

Type of transaction (e.g., transfer).

string

Customer’s biller identifier (if applicable).

string

Identifier for the product involved in the transaction.

string

Name on the biller account.

string

required

Retrieval Reference Number used to trace the transaction.

Hide data.account

number

required

Current account balance.

string

required

Currency of the account balance.

string

required

Account ID.

Expected response

object

required

Contains the decision outcome for the transaction.

Hide data.transaction

boolean

required

Indicates whether the terminal should proceed with the payout.

string

required

Response code explaining the decision (e.g., 00 for success).

reasonCode is a standard response identifier used in the Terminal Action API to communicate the outcome of a custom logic check. To see all of the supported reason code check here.

Introduction

Getting Started

Products

API Basics

Guides

Pre-Balance Check

Passed Data Object

Expected response

Pre-Balance Check

​Passed Data Object

​Expected response

Passed Data Object

Expected response