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".

Request

Version stringrequired

API Version

Available optionsv3

orderId stringrequired

Order ID

application/json

application/json

Body

Bodyrequired

altIdstringrequired

location Id / company Id based on altType

altTypestringrequired
Alt Type
Available optionslocation
modestringrequired
manual payment method
Available optionscashcardchequebank_transferother
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

amountnumber

Amount to be paid against the invoice.

metaobject

Meta data to be recorded with the transaction

isPartialPaymentboolean

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

Example (auto)

{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "mode": "card",
  "card": {
    "type": "mastercard",
    "last4": "1234"
  },
  "cheque": {
    "number": "129-129-129-912"
  },
  "notes": "This was a direct payment",
  "amount": 100,
  "meta": {},
  "isPartialPayment": true
}

application/json

Successful response

application/json

Schema

Schema

successbooleanrequired

Success status of the request

Example (auto)

{
  "success": true
}