Cancel a payment
Cancel a payment in a workflow execution with an optional reason, passing a payment ID for a payment link, or Payrails cancels its latest payment.
Authorizations
You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>.
These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.
Headers
Path Parameters
Body
Reason for invoking the operation or action. Omit it if there is no reason. CustomerDontNeed is deprecated, use CustomerDoesNotNeed instead. With Other, reasonDescription is required for refunds: at least 3 characters after trimming. On refunds, reasonDescription is at most 255 characters for any reason.
BetterPrice, CustomerDoesNotNeed, CustomerDontNeed, DamagedProduct, Duplicate, FraudulentProduct, LateDelivery, Other, ProductMismatchDescription, WrongProduct, WrongProductSpecification Response
The payment cancelation was requested.
Reason for invoking the operation or action. Omit it if there is no reason. CustomerDontNeed is deprecated, use CustomerDoesNotNeed instead. With Other, reasonDescription is required for refunds: at least 3 characters after trimming. On refunds, reasonDescription is at most 255 characters for any reason.
BetterPrice, CustomerDoesNotNeed, CustomerDontNeed, DamagedProduct, Duplicate, FraudulentProduct, LateDelivery, Other, ProductMismatchDescription, WrongProduct, WrongProductSpecification