MAmasspay
Payout

Request payout transaction cancellation

Changed on

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

delete/payout/{user_token}/{payout_token}

Request

Path parameters

user_tokenstring required

Token representing the user to pay out

payout_tokenstring required

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

Query parameters

cancellation_reasonstring
Example:Sent by mistake

Optional. Provide a reason for the cancellation

Headers

Idempotency-Keystring

Unique key to prevent duplicate processing

Response

successful operation

payout_tokenstring required

Payout token that was attempted to be cancelled

cancellation_status'CANCELLED' | 'CANCELLATION_REQUESTED' | 'CANCELLATION_FAILED' required

The status of the cancellation attempt:<br> CANCELLED - The payout was successfully cancelled. Funds have not been released or were successfully reversed.<br> CANCELLATION_REQUESTED - The request to cancel has been accepted and is being processed, but the final outcome is not yet confirmed.<br> CANCELLATION_FAILED - The payout cannot be cancelled because it has already been processed, fully paid, or settled. (see Payout Reversals)

cancellation_status_reasonstring

When available, provide additional information about the status

confirmation_codestring

If a cancellation request was successfully submitted, the request confirmation code would be returned

Changes