Reverse Payment

Reverses a payment by recording a negative counter-payment (payment_type suffixed "/reversal") and restoring the bill's outstanding amount. Requires the p/reverse-payment permission on the bill location; alternatively a user-scoped authorization token with the reverse-payment scope can be supplied as token (manager override). The register session ("cloud" or a session id) must be open.

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

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

string | null

Optional user-scoped override token with the reverse-payment scope.

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