Register a payment on an order
POST/v1/orders/:id/payments
Registers a payment against an order and returns the order with its payment totals recalculated.
An order can carry several payments: register one per method the customer used, and the order is marked as paid once they add up to its total. Amounts above the total are accepted and reported as an overpayment.
Works on orders created through the API, placed by the customer on the storefront (INBOUND) or taken by the merchant on the POS (OUTBOUND). An order from a food app belongs to that channel and answers 422 order_not_modifiable.
Required scope: orders:write
Request
Responses
- 201
- 401
- 403
- 404
- 422
The order with the payment applied.
Unauthenticated — the request is missing a credential, or the Bearer token / API key is invalid, expired, or revoked.
Insufficient scope — the credential is authenticated but lacks a scope the endpoint requires.
Not found — no resource matches the id in the path (or it belongs to a different company).
Validation failed — the request body failed schema validation. errors[] lists every offending field.