Cancel
Cancel a bank transfer payment order through the LP's api
Cancel a bank transfer payin order
PATCH https://api.stage.localpayment.com/api/transactions/:externalId/status
Cancel a bank transfer payin order
Path Parameters
Name
Type
Description
externalId*
string
Mandatory. The same externalId you specified when the order was posted. The ID has to be unique and meaningful to you.
Headers
Name
Type
Description
Authorization*
string
Mandatory. JWT token in format Bearer eyJ0... . For more information about authentication, please refer to Authentication
Request Body
Name
Type
Description
status*
string
Mandatory. Type "CANCELLED" to cancel a bank transfer payin.
{
"externalId": "1623539480",
"internalId": "764355d7-9935-4716-8e26-0f507ba2e6f8",
"status": {
"code": "900",
"description": "CANCELLED",
"detail": "The payin was cancelled"
}
}{
"status": {
"code": "400",
"description": "ERROR",
"detail": "Invalid operation"
}
}{
"status": {
"code": "404",
"description": "ERROR",
"detail": "Payin not found"
}
}Example: Cancel a bank transfer payment order
{
"status": "CANCELLED"
}curl --location --request PATCH 'https://api.stage.localpayment.com/api/transactions/1642002587/1648421605' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjQ4NDIxODYxLCJqdGkiOiI5NjY2OTJmN2UyNWM0NWI0ODU4NjVlZTViOWExZDY3NCIsInVzZXJfaWQiOjMwLCJzdXBlcnVzZXIiOnRydWUsImlzX3N0YWZmIjpmYWxzZSwicm9sZXMiOlsiQUxMIl0sImNvdW50cmllcyI6WyJBTEwiXSwiY29tcGFueSI6IjAwMDEiLCJjbGllbnRfY29kZSI6IjAwMDEifQ.voDnTR8-mihl7OIdSkYAwkS_H_j7xRdk6tF2HU5U30o' \
--header 'Content-Type: application/json' \
--data-raw '{
"status": "CANCELLED"
}'{
"externalId": "1623539480",
"internalId": "764355d7-9935-4716-8e26-0f507ba2e6f8",
"status": {
"code": "900",
"description": "CANCELLED",
"detail": "The payin was cancelled"
}
}{
"status": {
"code": "404",
"description": "ERROR",
"detail": "Payin not found"
}
}Last updated
Was this helpful?