Docs API Reference Order Payment/bff/order-payment/record

/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

JSON body

Request body

application/json

hashstringRequired

Unique order hash.

Examplea1b2c3d4

entriesobject[]Required

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

Each array item:

Payment kind code (FK to shop__order_payment_kind.code).

pricenumberRequired

Positive amount in the order currency.

Range: 0.0001–∞

statusstringOptional

Override status; otherwise per-kind default.

direction"in" | "out"Optional

notestringOptional

branchIdnumberOptional

Branch (cash register) where the receipt was taken.

currencyIdnumberOptional

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json

{
  "success": true
}

Request example

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
    }
  ]
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key