Cancel a payment

Request a payment cancelation during a workflow execution.

Path Params
string
required
^[a-z][-A-Za-z0-9]*$

Path parameter to specify the workflow code.

uuid
required

Identifier of the resource in Payrails.

Body Params
uuid

Optionally the ID of the payment to cancel. Used for payment links where an execution can have multiple successful payments. If not specified, the most recent payment done using the payment link will be cancelled.

string
enum

Reason for invoking the operation or action.

string

An optional field to include any necessary information for the capture action.

Headers
uuid
required

Idempotency key to be used.
Sending again the same key would return the same result without re-executing the update.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Choose an example:
application/json