Skip to main content
POST
/
api
/
Invoices
/
payment
Error
A valid request URL is required to generate request examples
{
  "customerId": 1,
  "invoiceId": 1,
  "merchantInvoiceRefId": "123456789",
  "invoiceStatus": "Paid",
  "invoiceAttemptStatus": "Success",
  "message": "Approve",
  "subtotal": 11.97,
  "taxAmount": 1.2,
  "total": 13.17,
  "paymentMethodId": 1
}

Authorizations

Authorization
string
header
required

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

Body

invoice
object
required
paymentMethod
object
paymentMethodAuthorizationId
integer<int64> | null
Required range: 1 <= x <= 1000000000
paymentMethodId
integer<int64> | null
Required range: 1 <= x <= 1000000000
customerId
integer<int64> | null
Required range: 1 <= x <= 1000000000
firstName
string | null
Maximum string length: 150
lastName
string | null
Maximum string length: 150
merchantCustomerRefId
string | null
email
string<email> | null
Maximum string length: 100
dynamicDescriptor
object

Response

OK

customerId
integer<int64>
Required range: 1 <= x <= 1000000000
invoiceId
integer<int64>
Required range: 1 <= x <= 1000000000
merchantInvoiceRefId
string | null
Maximum string length: 100
invoiceStatus
string | null
Maximum string length: 100
invoiceAttemptStatus
string | null
Maximum string length: 100
message
string | null
Maximum string length: 500
subtotal
number<double>
Required range: 0 <= x <= 10000000
taxAmount
number<double>
Required range: 0 <= x <= 10000000
total
number<double>
Required range: 0 <= x <= 10000000
paymentMethodId
integer<int64>
Required range: 1 <= x <= 1000000000
paymentMethodTypeId
integer<int64>
Required range: 1 <= x <= 1000000000
transactionId
string | null
Maximum string length: 100