Payment Links
Cancel payment
POST
Requires scope payment_links:write and a business with a payment-links project in the key's environment; it acts on the record in whichever of those projects it belongs to.
ApiKeyheader
AuthorizationBearer <sk_test_ or sk_live_ key>Your sk_live_ / sk_test_ API key
Response Body
200application/json
Payment cancelled
TypeScript Definitions
Use the response body type in TypeScript.
data*
status*number
success*boolean
401application/json
The Authorization header is missing, malformed, or the API key is unknown or revoked
TypeScript Definitions
Use the response body type in TypeScript.
data*
status*number
success*boolean
429application/json
The API key exceeded its request budget for the window
TypeScript Definitions
Use the response body type in TypeScript.
data*
status*number
success*boolean
Language
curl -X POST 'https://api.pilot.shiga.io/v1/payments/{id}/cancel' \ -H 'Authorization: Bearer sk_test_...'Example Response
{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "status": "CANCELLED", "reference": "string" }, "status": 200, "success": true}