Cancel a Recurring Payment
Only when payment status is ACTIVE , can a PayCash recurring payment be cancelled.
HTTP Request
POST
/v1/payments/charges/references/cancel/{{idempotencyKey}}
Request Response
Request Headers {
"Authorization" : "Bearer {{access_token}}" ,
"x-api-key" : "{{api_key}}"
}
Content-Type: application/json {
"transferStatusCode" : 200 ,
"idempotencyKey" : "{{idempotencyKey}}" ,
"country" : "MX" ,
"currency" : "MXN" ,
"createTime" : "2023-10-20 02:40:07 UTC" ,
"status" : "CANCELLED" ,
"description" : "" ,
"transferDetails" : {
"payCash" : {
"amount" : 0 ,
"expirationDate" : "2024-09-30" ,
"reference" : "1264248200066"
}
}
}
Key
Value
Authorization
"bearer"+ "" + {{access_token}}
PATH and Query Parameters
Parameter
Type
Description
idempotencyKey
String
The idempotency key of the payment which need to cancel
Response Body Details
Parameter
Type
Description
transferStatusCode
Integer
Transfer status code, 200 if CANCELLED.
idempotencyKey
String
Unique key of payment record.
country
String
Country code
currency
String
The currency of the transferred fund
createTime
String
Payment ticket created time.
status
String
Transfer status, should be CANCELLED if success.
description
String
Description of payment
transferDetails
JSON
Transaction details info
Object Parameters
TransferDetails
Parameter
Type
Description
payCash
JSON
The payCash details
PayCash
Parameter
Type
Description
amount
Long
The transaction amount.
expirationDate
String
Expire date in local time,format "yyyy-MM-dd"
reference
String
This is a reference that can be used for more than one time. The payer is required to provide two numbers to the cashier to finish payment. One is this reference number and the other is an agreement number .
Agreement Codes
Offline Collection Points
Agreement Code
7-ELEVEN
Don't need an agreement code.
Kiosko
Don't need an agreement code.
Farmacias YZA
Don't need an agreement code.
BBVA (PRACTICAJA - BANCA DIGITAL)
1420712
Caja Cerano
Don't need an agreement code.
Caja Morelia Valladolid
Don't need an agreement code.
Caja Oblatos
Don't need an agreement code.
SMB Rural
Don't need an agreement code.
CALIMAX
Don't need an agreement code.
Circulo K
Don't need an agreement code.
Tiendas Extra
Don't need an agreement code.
CITY CLUB
Don't need an agreement code.
FARMACIA LA MAS BARATA
Don't need an agreement code.
FARMACIAS ROMA
Don't need an agreement code.
HSBC
7755
Santander (VENTANILLA - SUPERNET)
7292
SORIANA
Don't need an agreement code.
SUPER CITY
Don't need an agreement code.
SUPER DEL NORTE
Don't need an agreement code.
Telecomm
3724
Bodega Aurrera
198
Walmart
198
Sam's Club
198
Walmart express
198
Via servicios
Don't need an agreement code.
BANORTE (VENTANILLA -BANCA DIGITAL)
3724
AFIRME (BANCA DIGITAL)
Don't need an agreement code.