Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.nomba.com/llms.txt

Use this file to discover all available pages before exploring further.

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

action_type
string
required
The type of terminal action to perform (e.g., pre-balance-check-auth).
action_id
string
required
A unique identifier for this terminal action request.
version
string
required
API version to use (e.g., v1.1.0).
data
object
required
Contains details about the terminal making the request.

Expected response

data
object
required
Contains user balance information.