Create Payment

Records a payment against an outstanding bill. Requires the p/c-bill permission on the bill location. Pass register_session_id: "cloud" to book the payment on the location's cloud register, or a specific open register session id. Partial amounts are allowed; the bill's outstanding total and payment status update accordingly.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
string | null

"cloud" for the location cloud register, or an open register session id.

number
required
string
required

cash, card, bank-transfer, credit, gift-card, loyalty, or a custom company payment type.

payment_extra
object | null

Free-form metadata stored on the payment (e.g. {"ref": "..."}).

Headers
string
required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json