Skip to main content
POST
create payments

Authorizations

Authorization
string
header
required

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

Body

application/json

Payload to create a payment

payload to create payment

accountId
string
required
Maximum string length: 512
Example:

"ACC001"

externalPaymentReference
object
required

external payment reference object

lineItemRecords
object[]
required
currency
string
required
Maximum string length: 512
Example:

"USD"

totalAmount
number
required
description
string

A brief description of the payment

Maximum string length: 512
Example:

"Payment for Invoice inv.234.23afv"

notes
string

A detailed note about the payment

Maximum string length: 512
Example:

"Payment for purchase of credits"

Response

Response for POST payments requests

Payment object

id
string
required
Example:

"pay.w123rwe.1231"

accountId
string
required
Example:

"ACC001"

externalPaymentReferences
object
required

external payment reference object

lineItemRecords
object[]
required
totalAmount
number
required
currency
string
required
version
number
required
createdBy
string
required
createdAt
string<date-time>
required
description
string
notes
string