POST
/
api
/
v1
/
payments
/
create

Authorizations

Authorization
string
header
required

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

Body

application/json
amount
number
required

The amount of the payment

cashTag
string
required

The cash tag for the payment

callbackUrl
string

The URL to call back after payment processing

isWhiteLabel
boolean
default:
false

Whether the payment is white-labeled

returnUrl
string

The URL to return to after payment

Response

200 - application/json
amount
number

The amount invoiced

cashTag
string

The CashTag of the payment recipient

createdAt
string

The date and time when the payment was created

expiresAt
string

The date and time when the payment expires

id
string

The ID of the payment invoice

isWhiteLabel
boolean

Whether the payment is white-labeled

note
string

The required note associated with the payment

paidAmount
number | null

The amount paid

paymentUrl
string

The URL where the user can make the payment

receiptId
string | null

The ID of the web receipt for the payment

returnUrl
string | null

The URL where the user will be redirected after the payment

status
enum<string>
Available options:
PENDING,
UNDER_PAID,
PAID,
FAILED,
EXPIRED