Skip to main content
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.collectPayment
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Path Parameters

orderIdstringrequired

Order ID

Example:5e2d4c8e0e8b4e001c1c4f5d

Body

altIdstringrequired

location Id / company Id based on altType

Example:6578278e879ad2646715ba9c
altTypestringrequired

Alt Type

Available optionslocation
Example:location
modestringrequired

manual payment method

Available optionscashcardchequebank_transferother
Example:card
cardobject

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 payment
amountnumber

Amount to be paid against the invoice.

Example:100
metaobject

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