Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt

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

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”. 
POST https://services.leadconnectorhq.com/payments/orders/{orderId}/record-payment

​
Autorizacion

​
Authorization
string
required
Bearer token generado desde el portal Leadway. Ver Autenticacion.
​
Version
string
default:"2021-07-28"
required
Version de la API.

​
Path parameters

​
orderId
string
default:"5e2d4c8e0e8b4e001c1c4f5d"
required
Order ID

​
Body

​
altId
string
default:"6578278e879ad2646715ba9c"
required
account Id / company Id based on altType
​
altType
string
default:"account"
required
Alt Type Posibles valores: ‘account’
​
mode
string
default:"card"
required
manual payment method Posibles valores: ‘cash’, ‘card’, ‘cheque’, ‘bank_transfer’, ‘other’
​
card
object
Details of Card if used for payment
​
cheque
object
Details of the Cheque if used for payment
​
notes
string
default:"This was a direct payment"
Any note to be recorded with the transaction
​
amount
number
default:"100"
Amount to be paid against the invoice.
​
meta
object
Meta data to be recorded with the transaction
​
isPartialPayment
boolean
Indicates if the order is intended to be a partial payment.

​
Respuestas

​
success
boolean
default:"True"
required
Success status of the request
{
  "success": true
}

{}

{}

{}

​
Ejemplo

curl -X POST 'https://services.leadconnectorhq.com/payments/orders/YOUR_orderId/record-payment' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "account",
  "mode": "card",
  "notes": "This was a direct payment",
  "amount": 100,
  "meta": {},
  "isPartialPayment": true
}'