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.

{
    "code": "200",
    "description": "The PayOut was cancelled",
    "internalId": "9da696d2-bee2-4973-bf4b-c4f325496342"
}
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}}"}'
PreviousProof of Payment (POP)NextCommit payout

Last updated

Was this helpful?