Cancel Pre Auth Checkout Payment
POST https://api-sandbox.letpay.io/checkout/MY_PAYMENT_TOKEN/cancel
Cancels a pre-authorized payment that were already sent using the Process Checkout Payment method.
Authorization
| Header | Value |
|---|---|
| X-Auth-Token | MY_ACCESS_TOKEN |
Request Body
None
Response Body
payment_token(string): Token to identify this payment.refresh_token(string): Updated access token for next calls.transaction_status(string): Status of this payment.
Example Request
- 200 - Success
- 401 - Unauthorized
- 422 - Unprocessable Entity
- 502 - Bad Gateway
Example Request
200 - Success
curl --location --request POST 'https://api-sandbox.letpay.io/checkout/MY_PAYMENT_TOKEN/cancel' \
--header 'X-Auth-Token: MY_ACCESS_TOKEN'
Example Response
Header
Content-Type: application/json
Body
{
"transaction_status": "PROCESSING",
"payment_token": "8f048623-16c6-47da-aca1-546a16e8fb99",
"refresh_token": "MY_ACCESS_TOKEN"
}
Example Request
401 - Unauthorized
curl --location --request POST 'https://api-sandbox.letpay.io/checkout/MY_PAYMENT_TOKEN/cancel' \
--header 'X-Auth-Token: INVALID_ACCESS_TOKEN'
Example Response
Header
Content-Type: application/json
Body
{
"timestamp": "2024-01-16T19:52:18.186+0000",
"status": 401,
"error": "Unauthorized",
"message": "Access Denied",
"path": "/checkout/633de157-9a42-4d30-bbad-bd9fb883e058/cancel"
}
Example Request
422 - Unprocessable Entity
curl --location --request POST 'https://api-sandbox.letpay.io/checkout/MY_PAYMENT_TOKEN/cancel' \
--header 'X-Auth-Token: MY_ACCESS_TOKEN'
Example Response
Header
Content-Type: application/json
Body
{
"timestamp": "2024-01-16T19:54:11.447+0000",
"status": 422,
"error": "Unprocessable Entity",
"path": "/checkout/633de157-9a42-4d30-bbad-bd9fb883e058/cancel",
"errors": [
{
"code": "00.04.0010",
"description": "The payment token was not pre-authorized, so it can't be captured."
}
],
"refresh_token": "MY_ACCESS_TOKEN"
}
Example Request
502 - Bad Gateway
curl --location --request POST 'https://api-sandbox.letpay.io/checkout/MY_PAYMENT_TOKEN/cancel' \
--header 'X-Auth-Token: MY_ACCESS_TOKEN'
Example Response
Header
Content-Type: application/json
Body
{
"timestamp": "2024-01-16T20:12:28.156+0000",
"status": 502,
"error": "Bad Gateway",
"path": "/checkout/2f1c0103-b6fe-4e99-864c-d20c68b97a85/cancel",
"errors": [
{
"code": "00.03.0001",
"description": "There was an issue when contacting an external API, please contact support"
}
],
"refresh_token": "MY_ACCESS_TOKEN"
}