POST
/
api
/
v1
/
payments
/
submit

Authorizations

Authorization
string
headerrequired

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

Body

application/json
invoiceId
string
required

The ID of the payment invoice

webReceipt
string
required

The web receipt for the payment

Response

200 - application/json
id
string

The ID of the payment invoice

userId
string

The ID of the user / merchant who created the payment invoice

cashTag
string

The CashTag of the payment recipient

note
string

The required note associated with the payment

amount
number

The amount invoiced

isWhiteLabel
boolean

Whether the payment is white-labeled

receiptId
string | null

The ID of the web receipt for the payment

paidAmount
number | null

The amount paid

cashpayFee
number | null

The CashPay service fee

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

The URL where the user can make the payment

callbackUrl
string | null

The URL to call back on payment status changes

returnUrl
string | null

The URL where the user will be redirected after the payment

expiresAt
string

The date and time when the payment expires

createdAt
string

The date and time when the payment was created

updatedAt
string

The date and time when the payment was last updated

Fetch Payment InvoiceFetch Web Receipt