Cancel Payment

You should always cancel a payment if it will not be completed. Whether the customer opts out, the cashier finds an error, or a set period of time passes without payment confirmation. This ensures your system stays accurate and clear of pending transactions that will never be paid.

Environments

Development

https://api.aplazo.net

Production

https://api.aplazo.mx

Cancel Payment

post

Cancels an existing payment using the cartId. The payment will be cancelled regardless of the totalAmount value provided.

Body

cartIdstringRequired

Identifier in the merchant POS for the order/transaction.

Example: Right-sized-Generic

totalAmountnumber · floatRequired

Amount to be cancelled (informational only).

Example: 10

reasonstring · min: 1Required

Reason for the cancellation.

Example: Requiero devolucion de mi pago

Responses

200

Payment cancelled successfully.

application/json

post

HTTPcURLJavaScriptPython

POST /api/pos/loan/cancel HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "cartId": "Right-sized-Generic",
  "totalAmount": 10,
  "reason": "Requiero devolucion de mi pago"
}

200

Payment cancelled successfully.

{
  "cartId": "Right-sized-Generic",
  "status": "CANCELLED",
  "requestDate": "2025-01-23T17:01:27.77429",
  "updateDate": "2025-01-23T17:01:27.774291"
}