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.

200 Payin successfully cancelled

{
    "externalId": "1623539480",
    "internalId": "764355d7-9935-4716-8e26-0f507ba2e6f8",
    "status": {
        "code": "900",
        "description": "CANCELLED",
        "detail": "The payin was cancelled"
    }
}

400 Not possible to cancel

404 Payin not found

Example: Cancel a bank transfer payment order

Request a cancellation (JSON)

{
    "status": "CANCELLED"
}

Request a cancellation (cURL)

Example Response: Status OK

Example Response: Bad request