API Reference
System Status

Cancel a payment

post
https://gateway.stage.bill.com/connect/v3/payments//cancel

Cancel an existing payment.

You can cancel a payment only when the payment singleStatus is SCHEDULED. When BILL starts processing the payment, the payment singleStatus changes. At that point, you cannot cancel the payment. You can attempt to void the payment with POST /v3/payments/{paymentId}/void.

Path Params
string
required
length ≥ 1

BILL-generated ID of the payment. The value begins with stp.

Headers
string | null

API session ID generated with /v3/login

string | null

Developer key generated with your BILL developer account

Responses

Updated 29 days ago

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

Updated 29 days ago