Cancel

Only PayOut in Locked or On Hold status can be Cancelled. For more information, please have a look at PayOut transaction flow.

Cancel PayOut

PATCH https://api.stage.localpayment.com/api/payout/cancel

This request allows to cancel a PayOut.

Headers

Name	Type	Description
Authorization*	string	JWT token in format Bearer eyJ0... . For more information about authentication, please refer to Authentication token

Request Body

Name	Type	Description
externalId*	string	The same externalId you specified when the order was posted. An id that is meaningful to you.

200 PayOut successfully cancelled.

{
    "code": "200",
    "description": "The PayOut was cancelled",
    "internalId": "9da696d2-bee2-4973-bf4b-c4f325496342"
}

Request

curl --location --request PATCH 'https://api.stage.localpayment.com/api/payout/cancel'
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjg2MjMwNzMxLCJqdGkiOiJhMzJhNjczMzViNTQ0MWZiOGUyYTU1ZjdhNzNkYmYzOCIsInVzZXJfaWQiOjM3NSwic3VwZXJ1c2VyIjp0cnVlLCJpc19zdGFmZiI6ZmFsc2UsInJvbGVzIjpbIkFMTCJdLCJjb3VudHJpZXMiOlsiQUxMIl0sImNvbXBhbnkiOiIwMDEzIiwiY2xpZW50X2NvZGUiOiIwMDEzIn0.U3Z8AG60SduY6-FhxiCwRiNfqpQoRBIhsGYOpfszojY'
--header 'Content-Type: application/json'
--data 

'{ "externalId": "{{YOURINTERNALID}}"}'

Status OK

{
    "externalId": "{{YOUREXTERNALID}}",
    "internalId": "a11c11a1-1c9c-11df-93a9-11111b127379",
    "status": {
        "code": "900",
        "description": "Cancelled",
        "detail": "The payout was cancelled"
    }
}

Bad request

{
    "Status": 400,
    "Message": "This transaction is REJECTED. Unable to update to CANCELED status",
    "TraceId": "f5e9acd3-3730-4b77-bfa8-ea70860a4e4f"
}