Transfer notification funding notification payout notification

{ "reference": "<string>", "type": "<string>", "service": "<string>", "status": "<string>", "requestState": "<string>", "requestStateDetails": "<string>", "channel": "<string>", "sourcePlatform": "<string>", "merchant": "<string>", "businessCode": "<string>", "currency": "NGN", "trxAmount": 123, "trxFee": 123, "stampDutyApplied": true, "stampDutyAmount": 123, "balanceBefore": 123, "balanceAfter": 123, "beneficiaryName": "<string>", "beneficiaryNumber": "<string>", "beneficiaryBank": "<string>", "toAccountName": "<string>", "toAccountNumber": "<string>", "toAccountBank": "<string>", "description": "<string>", "token": "<string>", "isReversed": true, "dateCreated": "2023-11-07T05:31:56Z", "dateModified": "2023-11-07T05:31:56Z" }

Authorizations

X-Numero-Api-Key

string

header

required

Your business API key (live_key_...). Issued on approval; managed in Dashboard → Settings → Developer.

Body

application/json

The data of a FUNDING_NOTIFICATION (money in) or TRANSFER_NOTIFICATION (money out). Field names are camelCase; amounts are in naira (major units).

reference

string

Numero transaction reference — your idempotent handle.

type

string

Transaction type, e.g. FundWallet, FundTransfer, InternalTransfer.

service

string

Service, e.g. FUNDING, FUNDTRANSFER.

direction

enum<string>

CREDIT = money in

Available options:

CREDIT,

DEBIT

status

string

e.g. Successful, Failed, Pending.

requestState

string | null

requestStateDetails

string | null

channel

string | null

sourcePlatform

string | null

merchant

string | null

Your business name.

businessCode

string

currency

string

Example:

"NGN"

trxAmount

number

Amount in naira.

trxFee

number

The fee charged on this transaction (naira).

stampDutyApplied

boolean

stampDutyAmount

number

balanceBefore

number | null

Wallet balance before this txn (naira).

balanceAfter

number | null

Wallet balance after this txn (naira).

beneficiaryName

string | null

For deposits — the payer's account name.

beneficiaryNumber

string | null

beneficiaryBank

string | null

toAccountName

string | null

For payouts — the recipient's account name.

toAccountNumber

string | null

toAccountBank

string | null

description

string | null

token

string | null

Utility token (e.g. electricity meter token) when applicable.

isReversed

boolean

dateCreated

string<date-time>

dateModified

string<date-time>

Response

200

Acknowledge receipt with 2xx.