OrdersVersion: v3
Record Order Payment
POST/payments/orders/{orderId}/record-payment
The "Record Order Payment" API allows to record a payment for an order. Use this endpoint to record payment for an order and update the order status to "Paid".
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
Scope:
payments/ orders. collectPaymentAuth methods:
OAuthPrivate IntegrationToken type:
Sub-Account TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Path Parameters
orderIdstringrequired
Order ID
Example:
5e2d4c8e0e8b4e001c1c4f5dBody
altIdstringrequired
location Id / company Id based on altType
Example:
6578278e879ad2646715ba9caltTypestringrequired
Alt Type
Available options
locationExample:
locationmodestringrequired
manual payment method
Available options
cashcardchequebank_transferotherExample:
cardcardobject
Details of Card if used for payment
chequeobject
Details of the Cheque if used for payment
notesstring
Any note to be recorded with the transaction
Example:
This was a direct paymentamountnumber
Amount to be paid against the invoice.
Example:
100metaobject
Meta data to be recorded with the transaction
isPartialPaymentboolean
Indicates if the order is intended to be a partial payment.
Response
Successful response
successbooleanrequired
Success status of the request
Example:
true