Request payout transaction cancellation

This DELETE endpoint allows you to request the cancellation of a previously created payout transaction.
Once a payout has been committed, you can use this endpoint to submit a cancellation request.
Note: Submitting a cancellation request does not guarantee that the payout will be successfully cancelled.
To use this endpoint, provide the user_token and payout_token of the payout transaction you wish to cancel in the URL path.
The response returns a JSON object containing details about the cancellation request, including the payout_token, cancelation_status, confirmation_code, and any potential errors.

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

Token representing the user to pay out

string
required

Token representing the trsanaction. Retrieved from /payout/{user_token}

Query Params
string

Optional. Provide a reason for the cancellation

Headers
string

Unique key to prevent duplicate processing

Responses

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