Skip to main content
POST
Record an inbound credit

Authorizations

Authorization
string
header
required

An API key, pk_live_… or pk_test_….

Path Parameters

partner
string
required

The partner.

Example:

"safehaven"

Body

application/json
externalId
string
required

the partner's own transaction id

accountNumber
string
required
Example:

"0123456789"

amount
string
required

Minor units, as a string.

Pattern: ^[0-9]+$
Example:

"500000"

currency
string
required
Example:

"NGN"

fromName
string

as the partner reported it; kept with the partner's record, never on an account

source
string

WEBHOOK | POLL | API

occurredAt
string<date-time>

Response

OK

externalId
string

the partner's transaction id

entryId
string
fromName
string

as the partner reported it

source
string

WEBHOOK | POLL

result
enum<string>

DUPLICATE: replayed notification, credited once

QUARANTINED: number not bound or binding closed

Available options:
CREDITED,
DUPLICATE,
QUARANTINED
amount
string

Minor units, as a string.

currency
string
receivedAt
string<date-time>
accountNumber
string
namedAccountId
string

empty when the number resolved to nothing

reason
string

why it was quarantined