Skip to main content
POST
Create payment request

Authorizations

x-client-id
string
header
required
x-api-key
string
header
required
x-location
string
header
required

Body

application/json
amount
number
required
Required range: x <= 999999999
reference
string
Maximum string length: 100
comment
string
Maximum string length: 250
currency
enum<string>
Available options:
NGN,
FP
metadata
object
duration
integer
Required range: x >= 2
pin
string
payer
string

Paytag identifier used by PayTagPipe

Response

200 - application/json

Created payment request

ID
integer
required
Amount
number
required
Status
enum<string>
required
Available options:
Pending,
Accepted,
Declined,
Cancelled,
Expired
Type
enum<string>
required
Available options:
C2C,
C2P,
C2M,
Top Up,
Adjustment,
Reversal,
Withdrawal,
Bank Transfer,
FirestoreTransaction,
Wallet Settlement,
Reward Redemption,
Reward,
Bulk Transfer,
Exchange,
Partner Terminal,
Partner Gateway,
Card Top Up,
Vas,
Airtime Purchase,
Mobile Data Purchase,
Terminal Settlement,
Virtual Account Transfer,
QR Virtual Account Transfer,
Idaas Outward Transfer,
Idaas Inward Transfer
CreatedAt
string<date-time>
required
UpdatedAt
string<date-time>
required
PayTag
object
Payer
object
Reference
string
Description
string
ExpiresAt
string<date-time>