POST
/
intents

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
qrData
string
required

Content of the QR code

initiationMethod
enum<string>
required

how the payment was initiated, if redirected or scanned from inside app

Available options:
handoff,
capture
confirmAuth
boolean
required

Indicates payer has been authenticated

app
string

ID of the app where the request originated

reference
string

A unique internal bank reference

ipAddresss
string

ipAddress of the payer

deviceType
string

Type of device payer is using eg. ios or android

authMethod
enum<string>

Authentication method used by the payer

Available options:
credentials,
biometrics,
other
accountName
string

Payer's account name

accountEmail
string

Payer's email address

accountType
enum<string>

Type of account of the payer, one of 'business' or 'personal'

Available options:
personal,
business

Response

201 - application/json
id
string

ID of the Intent

amount
integer

Amount to be charged (in smallest currency unit eg. kobo)

currency
string

Alphanumeric currency code as defined in ISO 4217

status
enum<string>

Status of the payment intent

Available options:
initiated,
awaiting_charge,
charged,
failed,
cancelled,
reversed,
completed
authConfirmed
boolean

Boolean value that indicates if payer has been authenticated by bank

authConfirmedAt
string

Date value for when authentication of payer was confirmed by the bank

charge
string

Charge identifier

initiationMethod
enum<string>

how the payment was initiated

Available options:
handoff,
capture
paymentInstrument
string

Type of payment

app
string

ID of the app where payment originated

recipient
object