Balance Check

Payout Transactions

Customize or approve payout transactions before they are processed.

{
	"action_type" : "pre-balance-check-auth",
	"action_id" : "q6cf8t96-7fg8-432e-98c8-d4cb8f5b",
	"version": "v1.1.0",
	"data" : {
		"terminal" : {
			"terminalId" : "2KUD1234",
			"serialNo" : "91201008993212",
			"pin": "0000",
			"signature":
            "plainKeyPassedByUserAndHashedWithMerchantSecretKey"
		}
	}
}

{
	"data": {
		"user": {
			"balance": 154567.78,
			"currency": "NGN"
		}
	}
}

Passed Data Object

string

required

The type of terminal action to perform (e.g., pre-balance-check-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 details about the terminal making the request.

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 hash of the plain key signed with the merchant’s secret key.

Expected response

object

required

Contains user balance information.

Hide data.user

number

required

Current balance of the user’s account.

string

required

Currency of the returned balance (e.g., NGN).

Introduction

Getting Started

Products

API Basics

Guides

Payout Transactions

Passed Data Object

Expected response

Payout Transactions

​Passed Data Object

​Expected response

Passed Data Object

Expected response