BizKitHub
DocsAPI ReferenceOrder Payment/bff/order-payment/record
postOrder PaymentAdmin BFF

/bff/order-payment/record

Records one or more payment-receipt rows against the order. Supports combined payments (e.g. 1500 cash + 500 manual_mark in one call). If the cumulative receipt log now covers the order price, the order is flipped to paid via the standard workflow hooks. The acting admin's contact id is captured as recorded_by_contact_id on every inserted row.

Order PaymentpostBffOrder-paymentRecord

Parameters

2 body

2 total
Body · 2
hashstringRequired

Unique order hash.

entriesobject[]Required7 fields

One or more receipt rows. Multiple = combined payment in one call.

Request

POST /bff/order-payment/record

post
curl -X POST "https://api.bizkithub.com/bff/order-payment/record" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "hash": "a1b2c3d4",
  "entries": [
    {
      "price": 0,
      "status": "example_status",
      "note": "example_note",
      "branchId": 0,
      "currencyId": 0
    }
  ]
}'

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key