Skip to main content
POST
Record Order Payment

Headers

Version
enum<string>
required

API Version

Available options:
2021-07-28

Path Parameters

orderId
string
required

Order ID

Example:

"5e2d4c8e0e8b4e001c1c4f5d"

Body

application/json
altId
string
required

location Id / company Id based on altType

Example:

"6578278e879ad2646715ba9c"

altType
enum<string>
required

Alt Type

Available options:
location
Example:

"location"

mode
enum<string>
required

manual payment method

Available options:
cash,
card,
cheque,
bank_transfer,
other
Example:

"card"

card
object
cheque
object
notes
string

Any note to be recorded with the transaction

Example:

"This was a direct payment"

amount
number

Amount to be paid against the invoice.

Example:

100

meta
object

Meta data to be recorded with the transaction

isPartialPayment
boolean

Indicates if the order is intended to be a partial payment.

Response

Successful response

success
boolean
required

Success status of the request

Example:

true

Last modified on March 8, 2026