Skip to main content
POST
/
payments
/
orders
/
{orderId}
/
record-payment
Record Order Payment
curl --request POST \
  --url https://services.leadconnectorhq.com/payments/orders/{orderId}/record-payment \
  --header 'Content-Type: application/json' \
  --header 'Version: <version>' \
  --data '
{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "mode": "card",
  "notes": "This was a direct payment",
  "amount": 100,
  "meta": {},
  "isPartialPayment": true
}
'
{
  "success": true
}

Documentation Index

Fetch the complete documentation index at: https://help.hoopai.com/llms.txt

Use this file to discover all available pages before exploring further.

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