API a la plataforma de Hola Cash
Crea y obtiene un token de pago para una tarjeta de crédito, este token es utilizado para crear un Cargo. Crea un token de pago desde tu aplicación Web o App para que no mandes información del pago a tus servidores. Usa estas tarjetas de pruebas para desencadenar diferentes flujos en su integración y asegúrate de manejarlos correctamente. Nota: Usa una llave pública en el header X-Api-Client-Key
de la petición. Nunca expongas o hagas visible la llave privada.
Usa tu llave pública o privada. Genera un token de pago para tarjetas de crédito o débito que puedes almacenar en tu sistema para completar una o varias transacciones. Lee el Tutorial 3DS 2.0 para más detalle sobre cómo enviar la información requerida y brindarle a tus clientes una experiencia de compra sin fricción.
Información acerca de la credencial de pago que necesita ser tokenizada.
required | object (PaymentCredential) Detalles de la credencial de pago usada para hacer el pago |
required | object (ConsumerDetail) Detalles del cliente |
Operación exitosa
Petición inválida, revisa la respuesta para detalles.
Las credenciales no son válidas
Too many requests per minute. Please retry the request with an exponential backoff.
{- "credential": {
- "payment_method": {
- "method": "credit_or_debit_card"
}, - "credit_or_debit_card": {
- "card_number": "4242424242424242",
- "expiration_month": "12",
- "expiration_year": "2034",
- "card_validation_code": "123"
}
}, - "consumer_details": {
- "contact": {
- "email": "abc@abc.com"
}, - "name": {
- "first_name": "Test",
- "second_first_name": "Hola",
- "first_last_name": "Cash",
- "second_last_name": "User"
}, - "address": {
- "address_line_1": "First line of address",
- "address_line_2": "Unit number",
- "locality": "CDMX",
- "region_name_or_code": "CX",
- "postal_code": "11503",
- "country_code": "MEX"
}
}
}
{- "status_details": {
- "date_created": "1643073307052,",
- "message": "token created",
- "status": "success"
}, - "token_details": {
- "additional_details": [
- {
- "data": "visa",
- "name": "card_brand"
}, - {
- "data": "34",
- "name": "expiration_year"
}, - {
- "data": "12",
- "name": "expiration_month"
}, - {
- "data": "4242",
- "name": "card_last_four_digits"
}
], - "token": "5c86fac0-08a5-4c71-92be-a6f3a770de2d"
}
}
Regresa un token de pago junto con toda la información adicional necesaria. Revisa PaymentCredentialMetadata
para ver mayor información.
Operación exitosa.
Petición inválida, revisa la respuesta para detalles.
Las credenciales no son válidas
curl --location --request GET 'https://sandbox.api.holacash.mx/v2/tokenization/payment_token/5c86fac0-08a5-4c71-92be-a6f3a770de2d' \ --header 'X-Api-Client-Key: <USE SECRET KEY>' \ --data-raw ''
{- "status_details": {
- "date_created": 1643086863215,
- "message": "token obtained",
- "status": "success"
}, - "token_details": {
- "additional_details": [
- {
- "data": "visa",
- "name": "card_brand"
}, - {
- "data": "34",
- "name": "expiration_year"
}, - {
- "data": "12",
- "name": "expiration_month"
}, - {
- "data": "424242",
- "name": "card_bin"
}, - {
- "data": "4242",
- "name": "card_last_four_digits"
}, - {
- "data": "abc@abc.com",
- "name": "holder_email"
}, - {
- "data": "Snoop the Doggy Dog",
- "name": "holder_name"
}
], - "token": "5c86fac0-08a5-4c71-92be-a6f3a770de2d"
}
}
Regresa un token de pago junto con toda la información adicional necesaria. Revisa PaymentCredentialMetadata
para ver mayor información. Requiere una llave secreta para la autenticación
Operación exitosa.
Petición inválida, revisa la respuesta para detalles.
Las credenciales no son válidas
{- "consumer_details": {
- "contact": {
- "email": "abc@abc.com"
}, - "name": {
- "first_name": "Test",
- "second_first_name": "Hola",
- "first_last_name": "Cash",
- "second_last_name": "User"
}, - "address": {
- "address_line_1": "street name",
- "country_code": "MEX",
- "locality": "Leon",
- "postal_code": 37000,
- "region_name_or_code": "GTO"
}
}
}
{- "status_details": {
- "date_created": 1643086863215,
- "message": "token obtained",
- "status": "success"
}, - "token_details": {
- "additional_details": [
- {
- "data": "visa",
- "name": "card_brand"
}, - {
- "data": "34",
- "name": "expiration_year"
}, - {
- "data": "12",
- "name": "expiration_month"
}, - {
- "data": "424242",
- "name": "card_bin"
}, - {
- "data": "4242",
- "name": "card_last_four_digits"
}, - {
- "data": "abc@abc.com",
- "name": "holder_email"
}, - {
- "data": "Snoop the Doggy Dog",
- "name": "holder_name"
}, - {
- "data": {
- "address": {
- "address_line_1": "foo1",
- "address_line_2": "foo2",
- "address_line_3": "foo3",
- "address_line_4": "foo4",
- "country_code": "MEX",
- "locality": "Leon",
- "postal_code": "37000",
- "region_name_or_code": "GTO"
}, - "contact": {
- "email": "test_user@example.com"
}, - "name": {
- "first_name": "Test"
}
}, - "name": "consumer_details"
}
], - "token": "5c86fac0-08a5-4c71-92be-a6f3a770de2d"
}
}
Crea un una order
(orden) en el sistema de Hola Cash. El id
de la orden creada se puede asociar durante la creación de un Charge
(cargo). La llave pública o privada se pueda usar para hacer este API.
Para información adicional que sea importante que nos manden en la petición, por favor revisar el campo additional_details
.
El objeto orden.
Creación de orden exitosa.
Petición inválida, checa la respuesta para detalles.
Las credenciales no son válidas
Too many requests per minute. Please retry the request with an exponential backoff.
{- "order_total_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "description": "This is a test order",
- "purchases": [
- {
- "item_total_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "description": "This is an item in the order",
- "id": "1234",
- "unit_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "quantity": 1
}
], - "additional_details": [ ]
}
{- "order": {
- "description": "This is a test order",
- "order_total_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "purchases": [
- {
- "description": "This is an item in the order",
- "id": "1234",
- "item_total_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "quantity": 1,
- "unit_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}
}
], - "additional_details": [ ]
}
}
{- "event_type": "order_creation.succeeded",
- "payload": {
- "order": {
- "description": "This is a test order",
- "order_total_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "purchases": [
- {
- "description": "This is an item in the order",
- "id": "1234",
- "item_total_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "quantity": 1,
- "unit_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}
}
], - "order_information": {
- "order_id": "f435579e-37c6-49b2-98c5-a22a49a433e9"
}
}
}
}
Regresa una orden dado un ID específico en el sistema de Hola Cash.
Se encontró la orden de forma exitosa.
Petición inválida, checa la respuesta para detalles.
Las credenciales no son válidas
curl --location --request GET 'https://sandbox.api.holacash.mx/v2/order/f435579e-37c6-49b2-98c5-a21a49a433e9' \ --header 'X-Api-Client-Key: <USE PUBLIC OR SECRET KEY>' \ --data-raw ''
{- "order": {
- "description": "This is a test order",
- "order_total_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "purchases": [
- {
- "description": "This is an item in the order",
- "id": "1234",
- "item_total_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "quantity": 1,
- "unit_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}
}
]
}, - "order_information": {
- "order_id": "f435579e-37c6-49b2-98c5-a22a49a433e9"
}
}
Regresa la orden actualizada dado un ID específico en el sistema de HolaCash.
El objeto orden.
Se actualizó la orden de forma exitosa.
Petición inválida, checa la respuesta para detalles.
Las credenciales no son válidas
{- "order_total_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "description": "This is a test order",
- "purchases": [
- {
- "item_total_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "description": "This is an item in the order",
- "id": "1234",
- "unit_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "quantity": 1
}
], - "additional_details": [ ]
}
{- "order": {
- "description": "This is the test order updated",
- "order_total_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "purchases": [
- {
- "description": "This is an item in the updated order",
- "id": "1234",
- "item_total_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "quantity": 2,
- "unit_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}
}
]
}, - "order_information": {
- "order_id": "f435579e-37c6-49b2-98c5-a22a49a433e9"
}
}
Se puede usar la llave secreta o pública. Realiza un cargo por una cantidad específica a una credencial de pago (ej. credit_or_debit_card
o pay_with_bank_account
). Tienes la opción de retener los fondos usando esta API y capturar los fondos cuando la compra sea completada, o puedes completar el cargo en una sola llamada. La funcionalidad de separar la retención de fondos y su captura solo se soporta con una tarjeta de crédito o débito. Revisa processing_instructions
en el objeto Charge
para más información. Puedes usar estas tarjetas de pruebas para probar varios flujos y ver cómo manejarlos correctamente. Lee el Tutorial 3DS 2.0 para más detalles sobre cómo enviar la información requerida para brindarle a tus clientes una experiencia sin fricción.
Para información adicional que sea importante que nos manden en la petición, por favor revisar el campo additional_details
.
Detalle de lo que se necesita autorizar.
Muestra los detalles de lo que se autorizó.
Revisa additional_detail
para más información relacionada al resultado mostrado.
Por ejemplo, additional_detail
puede contener el authorization_code
para transacciones realizadas con tarjeta de débito o crédito si el
banco pertinente lo provee.
Verifica la variable status
en la respuesta para determinar los siguientes
pasos a seguir. El status
puede ser failure
(fallo) o pending
(pendiente).
Si el status
se encuentra pending
, verifica el valor del contenido en detail.code
.
Si el detail.code
contiene el valor action_required
revisa los pasos a seguir en
los detail.additional_details
status
se encuentra pending
, verifica el valor del contenido endetail.code
. Si el detail.code
contiene el valor action_required
revisadetail.additional_details
. payment_method
es credit_or_debit_card
, puedes obtener un3ds_authenticate
dentro del campo action
en detail.additional_details
.redirect_url
payment_method
(método de pago) es pay_with_store
opay_with_bank_account
entonces puedes obtener collect_payment
action
en detail.additional_details
. Para este caso,additional_details
para dirigirpayment_method
es pay_with_bnpl
, entonces puedes obtenercomplete_at_bnpl_provider
dentro del campo action
en detail.additional_details
.redirect_url
/transaction/{id}
o registrar un webhook parastatus
en la respuestastatus
puede ser failure
(fallo)pending
(pendiente)Las credenciales no son válidas
{- "description": "This is a test description",
- "amount_details": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "payment_detail": {
- "credentials": {
- "payment_method": {
- "method": "credit_or_debit_card"
}, - "credit_or_debit_card": {
- "card_number": "4242424242424242",
- "expiration_month": "12",
- "expiration_year": "2024",
- "card_validation_code": "324"
}
}
}, - "consumer_details": {
- "external_consumer_id": "abcd",
- "contact": {
- "id": "1234",
- "email": "test_user@example.com"
}, - "name": {
- "first_name": "Test",
- "second_first_name": "Hola",
- "first_last_name": "Cash",
- "second_last_name": "User"
}
}, - "billing_details": {
- "contact": {
- "email": "test_user@example.com",
- "phone_1": 5512345678
}, - "name": {
- "first_name": "Test",
- "second_first_name": "Hola",
- "first_last_name": "Cash",
- "second_last_name": "User"
}, - "address": {
- "address_line_1": "First line of address",
- "address_line_2": "Unit number",
- "locality": "CDMX",
- "region_name_or_code": "CX",
- "postal_code": "11503",
- "country_code": "MEX"
}
}, - "shipping_details": {
- "contact": {
- "email": "test_user@example.com",
- "phone_1": 5512345678
}, - "name": {
- "first_name": "Test",
- "second_first_name": "Hola",
- "first_last_name": "Cash",
- "second_last_name": "User"
}, - "address": {
- "address_line_1": "First line of address",
- "address_line_2": "Unit number",
- "locality": "CDMX",
- "region_name_or_code": "CX",
- "postal_code": "11503",
- "country_code": "MEX"
}
}, - "processing_instructions": {
- "auto_capture": true
}
}
{- "charge": {
- "amount_details": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "consumer_details": {
- "contact": {
- "email": "test_user@example.com"
}, - "external_consumer_id": "abcd",
- "name": {
- "first_last_name": "Cash",
- "first_name": "Test",
- "second_first_name": "Hola",
- "second_last_name": "User"
}
}, - "description": "This is a test description",
- "payment_detail": {
- "credentials": {
- "credit_or_debit_card": {
- "card_number": "XXXXXXXXXXXXXXXX",
- "card_validation_code": "XXX",
- "expiration_month": "12",
- "expiration_year": "2024"
}, - "payment_method": {
- "method": "credit_or_debit_card"
}
}
}, - "processing_instructions": {
- "auto_capture": true
}
}, - "id": "8fa9a35e-3ece-4085-860c-4deb4c9e28ed",
- "status_details": {
- "date_created": 1643132896227,
- "detail": {
- "additional_details": [
- {
- "data": "visa",
- "name": "card_brand"
}, - {
- "data": "credit",
- "name": "card_type"
}, - {
- "data": "424242",
- "name": "card_bin"
}, - {
- "data": "4242",
- "name": "card_last_four_digits"
}, - {
- "data": "MXN",
- "name": "currency_code"
}, - {
- "data": "24",
- "name": "expiration_year"
}, - {
- "data": "12",
- "name": "expiration_month"
}, - {
- "data": "captured",
- "name": "charge_status"
}, - {
- "data": "801585",
- "name": "authorization_code"
}
]
}, - "message": "charge created",
- "status": "success"
}
}
{- "event_type": "charge.succeeded",
- "payload": {
- "charge": {
- "amount_details": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "consumer_details": {
- "contact": {
- "email": "test_user@example.com"
}, - "external_consumer_id": "abcd",
- "name": {
- "first_last_name": "Cash",
- "first_name": "Test",
- "second_first_name": "Hola",
- "second_last_name": "User"
}
}, - "description": "This is a test description",
- "payment_detail": {
- "credentials": {
- "credit_or_debit_card": {
- "card_number": "424242XXXXXX4242",
- "card_validation_code": "XXX",
- "expiration_month": "12",
- "expiration_year": "2024"
}, - "payment_method": {
- "method": "credit_or_debit_card"
}
}
}, - "processing_instructions": {
- "auto_capture": true
}
}
}, - "id": "8fa9a35e-3ece-4085-860c-4deb4c9e28ed",
- "status_details": {
- "date_created": 1643132896227,
- "detail": {
- "additional_details": [
- {
- "data": "visa",
- "name": "card_brand"
}, - {
- "data": "credit",
- "name": "card_type"
}, - {
- "data": "424242",
- "name": "card_bin"
}, - {
- "data": "4242",
- "name": "card_last_four_digits"
}, - {
- "data": "MXN",
- "name": "currency_code"
}, - {
- "data": "24",
- "name": "expiration_year"
}, - {
- "data": "12",
- "name": "expiration_month"
}, - {
- "data": "captured",
- "name": "charge_status"
}
]
}, - "message": "charge created",
- "status": "success"
}
}
Utiliza la llave secreta. Obtiene una lista paginada de transacciones en tiempo real ordenada por fecha de creación en orden descedente. La paginación funciona con base en cursores donde el objeto de la respuesta contiene información acerca del cursor actual y la lista de transacciones que pertenecen al tamaño de la página (limit
). Estos son algunos parámetros de consulta que se pueden utilizar
limit
- Número máximo de transacciones por regresar.after_id
- Transacción(es) a solicitar después de ese cursor basado en el límite.before_id
- Transacción(es) a solicitar antes de ese cursor basado en el límite.Puedes encontrar todos los parámetros de consulta en la sección Query Parameters
dentro de la sección Request
.
Los atributos del cursor de la respuesta se explican a continuación:
first_cursor
- Indica el cursor más actual del límite de la respuesta actual.has_next
- Indica si hay transacciones más antiguas pendientes por traer.has_previous
- Indica si hay transacciones más nuevas pendientes por traer.last_cursor
- Indica el cursor más antiguo del límite de la respuesta actual.Si se envían ambos parámetros after_id
y before_id
o se envía un cursor inválido causará un error (after_id_and_before_id_both_present
e integrity_or_database_issue
respectivamente). Revisa la sección de Códigos de error
para más detalle. Para moverse hacia adelante entre las páginas de transacciones, envía el valor de first_cursor
en el parámetro de consulta before_id
. Para moverse hacia atrás entre las páginas de transacciones, envía el valor de last_cursor
en el parámetro de consulta after_id
.
search_key | string Parámetro de consulta usado para buscar por:
|
start_time | integer <int64> La fecha de inicio para la búsqueda por rango de fechas, expresada en UTC Unix Epoch Time. Puedes visitar este sitio para convertir fechas en línea. |
end_time | integer <int64> La fecha final para la búsqueda por rango de fechas, expresada en UTC Unix Epoch Time. Puedes visitar este sitio para convertir fechas en línea. |
limit | integer El número de transacciones en un grupo. El valor mínimo es |
before_id | string El ID del sistema usado como un punto de inicio para obetener la transacción anterior |
after_id | string El ID del sistema usado como un punto de inicio para obetener la transacción siguiente |
monthly_installments | string Bandera booleana que indica si la transacción fue a MSI. |
transaction_status | string El estado de los cargos. Esta es una lista de campos separados por comas de |
payment_methods | string El método de pago de los cargos. Esta es una lista de campos separados por comas de |
payment_networks | string Cadena separada por comas con Payment Networks de BNPL |
subscription | string Bandera booleana que indica si la transacción fue pagada por una suscripción |
channel | string Canal por el cual el usuario realizó el pago. Este es una cadena separada por comas de los siguientes posibles valores que representan los canales
|
Información relacionada a los cargos
Verifica la propiedad detail.code
de la respuesta. Estos son los errores que el servicio puede regresar:
Revisa la sección de Códigos de error
para más detalle.
Las credenciales no son válidas
curl --location --request GET 'https://sandbox.api.holacash.mx/v2/transaction/charge' \ --header 'X-Api-Client-Key: <USE SECRET KEY>' \ --header 'Content-Type: application/json'
{- "has_next": true,
- "has_previous": false,
- "last_cursor": "MjAyMi0wNC0yNyAyMzozMzowOS45MTI5NTUrMDA6MDA=",
- "merchant_payment_transactions": [
- {
- "TID": "ba770b24-8cf2-4a7a-83f0-54ac1b3b7328",
- "amount_details": {
- "amount": 10000,
- "currency_code": "MXN"
}, - "charge_status": "failed",
- "creator_email": "test_user@example.com",
- "date_created": 1651102389,
- "description": "Pago en efectivo por medio de tienda",
- "is_refundable": false,
- "original_amount": {
- "amount": 10000,
- "currency_code": "MXN"
}, - "payment_info": {
- "payment_method": "pay_with_store",
- "reference": "1010100846381335",
- "transaction_clabe": "None"
}
}
]
}
Una vez se haya realizado un cargo exitoso obtendrás un id
que puedes utilizar después para obtener detalles de la transacción. Adicional a esto, se te regresa un authorization_code bajo los status_detail.detail.additional_details
El cargo.
Las credenciales no son válidas
Cargo no encontrado.
curl --location --request GET 'https://sandbox.api.holacash.mx/v2/transaction/charge/f2e43795-fce4-424c-880a-f6c1fed8cdf7' \ --header 'X-Api-Client-Key: <USE SECRET KEY>' \ --data-raw ''
{- "charge": {
- "amount_details": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "consumer_details": {
- "contact": {
- "email": "test_user@example.com"
}, - "external_consumer_id": "abcd",
- "name": {
- "first_last_name": "Cash",
- "first_name": "Test",
- "second_first_name": "Hola",
- "second_last_name": "User"
}
}, - "description": "This is a test description",
- "payment_detail": {
- "credentials": {
- "credit_or_debit_card": {
- "card_number": "XXXXXXXXXXXXXXXX",
- "card_validation_code": "XXX",
- "expiration_month": "12",
- "expiration_year": "2024"
}, - "payment_method": {
- "method": "credit_or_debit_card"
}
}
}, - "processing_instructions": {
- "auto_capture": true
}
}, - "id": "8fa9a35e-3ece-4085-860c-4deb4c9e28ed",
- "status_details": {
- "date_created": 1643132896227,
- "detail": {
- "additional_details": [
- {
- "data": "visa",
- "name": "card_brand"
}, - {
- "data": "credit",
- "name": "card_type"
}, - {
- "data": "424242",
- "name": "card_bin"
}, - {
- "data": "4242",
- "name": "card_last_four_digits"
}, - {
- "data": "MXN",
- "name": "currency_code"
}, - {
- "data": "24",
- "name": "expiration_year"
}, - {
- "data": "12",
- "name": "expiration_month"
}, - {
- "data": "captured",
- "name": "charge_status"
}, - {
- "data": "801585",
- "name": "authorization_code"
}
]
}, - "message": "charge created",
- "status": "success"
}
}
Si retuviste fondos durante el cargo desactivando la configuración auto_capture
o no incluyendo la configuarción (desactivado por default), puedes usar este API para capturar algunos o todos los fondos no capturados.
El monto a capturar.
Operación exitosa.
Petición inválida, revisa la respuesta para más detalles.
Las credenciales no son válidas
{- "amount": 5000,
- "currency_code": "MXN"
}
{- "capture_transaction_id": "f2e43795-fce4-424c-880a-f6c1fed8cdf7",
- "captured_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "status_details": {
- "message": "captured",
- "status": "success"
}
}
{- "event_type": "capture.succeeded",
- "payload": {
- "capture_detail": {
- "capture_transaction_id": "f2e43795-fce4-424c-880a-f6c1fed8cdf7",
- "captured_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}
}, - "charge_detail": {
- "charge": {
- "amount_details": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "consumer_details": {
- "contact": {
- "email": "test_user@example.com"
}, - "external_consumer_id": "your_consumer_id",
- "name": {
- "first_last_name": "Cash",
- "first_name": "Test",
- "second_first_name": "Hola",
- "second_last_name": "User"
}
}, - "description": "This is a test description",
- "payment_detail": {
- "credentials": {
- "credit_or_debit_card": {
- "card_number": "424242XXXXXX4242",
- "card_validation_code": "XXX",
- "expiration_month": "12",
- "expiration_year": "2024"
}, - "payment_method": {
- "method": "credit_or_debit_card"
}
}
}, - "processing_instructions": {
- "auto_capture": false
}
}, - "id": "686dc8c1-8660-4642-85fc-a993aea51c20",
- "related_transactions": [
- {
- "data": {
- "amount": 5000,
- "currency": "MXN",
- "date": 1644525036,
- "id": "4fed7c82-8bb2-4d32-a683-2cb408abce26"
}, - "name": "capture"
}
], - "status_details": {
- "date_created": 1644525047789,
- "detail": {
- "additional_details": [
- {
- "data": "captured",
- "name": "charge_status"
}, - {
- "data": "visa",
- "name": "card_brand"
}, - {
- "data": "credit",
- "name": "card_type"
}, - {
- "data": "24",
- "name": "expiration_year"
}, - {
- "data": "12",
- "name": "expiration_month"
}, - {
- "data": "424242",
- "name": "card_bin"
}, - {
- "data": "4242",
- "name": "card_last_four_digits"
}
]
}, - "message": "completed",
- "status": "success"
}
}
}
}
Usa llave secreta. Regresará una lista con las opciones disponibles de meses sin intereses o un arreglo vacío si no es elegible.
El cargo a verificar
Operación exitosa.
Petición inválida, revisa la respuesta para más detalles.
Las credenciales no son válidas
{- "description": "This is a test description",
- "amount_details": {
- "amount": 5070,
- "currency_code": "MXN"
}, - "payment_detail": {
- "credentials": {
- "payment_method": {
- "method": "credit_or_debit_card"
}, - "credit_or_debit_card": {
- "card_number": "4242424242424242",
- "expiration_month": "12",
- "expiration_year": "2024",
- "card_validation_code": "324"
}
}
}, - "consumer_details": {
- "external_consumer_id": "your_consumer_id",
- "contact": {
- "email": "test_user@example.com"
}, - "name": {
- "first_name": "Test",
- "second_first_name": "Hola",
- "first_last_name": "Cash",
- "second_last_name": "User"
}
}, - "billing_details": {
- "contact": {
- "email": "test_user@example.com",
- "phone_1": 5512345678
}, - "name": {
- "first_name": "Test",
- "second_first_name": "Hola",
- "first_last_name": "Cash",
- "second_last_name": "User"
}, - "address": {
- "address_line_1": "First line of address",
- "address_line_2": "Unit number",
- "locality": "CDMX",
- "region_name_or_code": "CX",
- "postal_code": "11503",
- "country_code": "MEX"
}
}, - "shipping_details": {
- "contact": {
- "email": "test_user@example.com",
- "phone_1": 5512345678
}, - "name": {
- "first_name": "Test",
- "second_first_name": "Hola",
- "first_last_name": "Cash",
- "second_last_name": "User"
}, - "address": {
- "address_line_1": "First line of address",
- "address_line_2": "Unit number",
- "locality": "CDMX",
- "region_name_or_code": "CX",
- "postal_code": "11503",
- "country_code": "MEX"
}
}, - "processing_instructions": {
- "auto_capture": true
}
}
{- "options_list_id": "0a3f8ea5-78c4-4680-8952-3c7bee7f022a",
- "options": [
- {
- "id": 1,
- "unit": "months",
- "value": 3
}, - {
- "id": 2,
- "unit": "months",
- "value": 6
}
]
}
Usa una llave secreta. Si realizaste el charge
con la processing_instruction
auto_capture
cómo false
y aún no haz realizado la captura (capture
), solo la cantidad total del charge
es reembolsada sin importar la cantidad que especifiques. Esto en efecto cancela el charge
. Si realizaste el charge
con la processing_instruction
cómo true
entonces puedes hacer el reembolso con una cantidad desde mayor a cero hasta la cantidad total del charge
.
El monto a reembolsar.
Operación exitosa.
Petición inválida, checa la respuesta para detalles.
Las credenciales no son válidas
{- "amount": 5000,
- "currency_code": "MXN"
}
{- "refund_transaction_id": "db068fc2-f07d-4a5d-bd23-59aa5595d7f4",
- "status_details": {
- "message": "refunded",
- "status": "success"
}
}
{- "event_type": "refund.succeeded",
- "payload": {
- "refund_detail": {
- "refund_transaction_id": "db068fc2-f07d-4a5d-bd23-59aa5595d7f4",
- "refunded_amount": {
- "amount": 5000,
- "currency_code": "MXN"
}
}, - "charge_detail": {
- "charge": {
- "amount_details": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "consumer_details": {
- "contact": {
- "email": "test_user@example.com"
}, - "external_consumer_id": "your_consumer_id",
- "name": {
- "first_last_name": "Cash",
- "first_name": "Test",
- "second_first_name": "Hola",
- "second_last_name": "User"
}
}, - "description": "This is a test description",
- "payment_detail": {
- "credentials": {
- "credit_or_debit_card": {
- "card_number": "424242XXXXXX4242",
- "card_validation_code": "XXX",
- "expiration_month": "12",
- "expiration_year": "2024"
}, - "payment_method": {
- "method": "credit_or_debit_card"
}
}
}, - "processing_instructions": {
- "auto_capture": false
}
}, - "id": "686dc8c1-8660-4642-85fc-a993aea51c20",
- "related_transactions": [
- {
- "data": {
- "amount": 5000,
- "currency": "MXN",
- "date": 1644525036,
- "id": "4fed7c82-8bb2-4d32-a683-2cb408abce26"
}, - "name": "capture"
}, - {
- "data": {
- "amount": 5000,
- "currency": "MXN",
- "date": 1644525218,
- "id": "068c9a5a-496d-4eaf-aa5d-feeadf79232e"
}, - "name": "refund"
}
], - "status_details": {
- "date_created": 1644525229484,
- "detail": {
- "additional_details": [
- {
- "data": "refunded",
- "name": "charge_status"
}, - {
- "data": "visa",
- "name": "card_brand"
}, - {
- "data": "credit",
- "name": "card_type"
}, - {
- "data": "24",
- "name": "expiration_year"
}, - {
- "data": "12",
- "name": "expiration_month"
}, - {
- "data": "424242",
- "name": "card_bin"
}, - {
- "data": "4242",
- "name": "card_last_four_digits"
}
]
}, - "message": "completed",
- "status": "success"
}
}
}
}
Regresa el botón de checkout para un merchant, Nota: Por el momento manejamos el mismo botón para todos los clientes, cualquier presentación personalizada estará disponible en una próxima versión.
La imagen del botón del checkout.
Petición inválida, revisa la respuesta para detalles.
Las credenciales no son válidas
curl --location --request GET 'https://sandbox.api.holacash.mx/v2/checkout/button?public_key=<USE PUBLIC KEY>'
{- "date_created": 1643093191130,
- "detail": {
- "additional_details": [ ],
- "code": "invalid_security_credentials",
- "message": "The security credentials are not valid"
}, - "message": "Could not authenticate",
- "status": "failure"
}
Servicio utilizado para obtener todos los cobros relacionados a una suscripción.
Información acerca de los cobros solicitados
Detalles del error retornados cuando la petición falló.
Las credenciales no son válidas
{- "page_count": 0,
- "item_count": 0,
- "next": "string",
- "previous": "string",
- "invoice_list": [
- {
- "price": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "date_created": 0,
- "description": "string",
- "due_date": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "number_of_payment_intents": 0,
- "status": "cancelled",
- "subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627"
}
]
}
Servicio utilizado para obtener todos los payment intents relacionados a una suscripción.
Información acerca de los payment intents solicitados
Detalles del error retornados cuando la petición falló.
Las credenciales no son válidas
{- "page_count": 0,
- "item_count": 0,
- "next": "string",
- "previous": "string",
- "payment_intent_list": [
- {
- "price": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "attempt_count": 0,
- "date_created": 0,
- "date_updated": 0,
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "invoice_id": "f4c4edb8-11e0-4b33-bcc1-482dc59ebb32",
- "max_attempt_count": 0,
- "next_billing_date": 0,
- "next_payment_method": "card",
- "status": "active",
- "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
- "was_automatic": "ed45171f-1dc1-4897-90d4-b4507cb25990"
}
]
}
Servicio utilizado para crear un plan de suscripción y poder ser ofrecido a los clientes. El plan necesita un producto asociado, visita la sección de product
para más información.
Información acerca del plan que se va a crear
Información acerca del plan que fue creado
Detalles del error retornados cuando la petición falló.
Las credenciales no son válidas
{- "name": "My plan",
- "description": "My plan description",
- "additional_details": { },
- "product_id": "09f53b82-295a-452b-b7e5-09a1b0e5b834",
- "price": {
- "amount": 1000,
- "currency_code": "MXN"
}
}
{- "additional_details": { },
- "billing_frequency": "monthly",
- "date_created": 1658956845,
- "description": "My description",
- "id": "02e036d8-f71c-47b4-8f22-3510bffc4e25",
- "name": "hello new product",
- "price": {
- "amount": 50121,
- "currency_code": "MXN"
}, - "product_id": "aa87e96e-62b2-493a-bcd3-8536f7c71a02",
- "status": "active"
}
{- "event_type": "plan_creation.succeeded",
- "payload": {
- "additional_details": { },
- "billing_frequency": "monthly",
- "date_created": 1658956845,
- "description": "My description",
- "id": "02e036d8-f71c-47b4-8f22-3510bffc4e25",
- "name": "hello new product",
- "price": {
- "amount": 50121,
- "currency_code": "MXN"
}, - "product_id": "aa87e96e-62b2-493a-bcd3-8536f7c71a02",
- "status": "active"
}
}
Servicio utilizado para obtener todos los planes de suscripción creados por el comerciante.
Información acerca del plan que fue creado
Detalles del error retornados cuando la petición falló.
Las credenciales no son válidas
{- "page_count": 0,
- "item_count": 0,
- "next": "string",
- "previous": "string",
- "plan_list": [
- {
- "billing_frequency": "daily",
- "description": "string",
- "additional_details": {
- "widget_configuration": { }
}, - "name": "string",
- "price": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "product_id": "string",
- "status": "active",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "date_created": 0,
}
]
}
Servicio utilizado para obtener los detalles de un plan dado un id de plan
Información acerca del plan
Detalles del error retornados cuando la petición falló.
Las credenciales no son válidas
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "additional_details": {
- "widget_configuration": { }
}, - "billing_frequency": "daily",
- "date_created": 0,
- "description": "string",
- "name": "string",
- "price": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "product": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "additional_details": {
- "widget_configuration": { }
}, - "date_created": 0,
- "description": "string",
- "external_product_id": "string",
- "name": "string",
- "subaccount_id": "string",
- "status": "enabled"
}, - "status": "active",
}
Servicio utilizado para obtener el detalle de la suscripción creada por el comerciante.
Información acerca de la suscripción creada
Detalles del error retornados cuando la petición falló.
Las credenciales no son válidas
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "auto_billing": true,
- "billing_frequency": "daily",
- "billing_day": 0,
- "billing_method": "string",
- "customer": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "date_created": 0,
- "full_name": "string",
- "primary_email": "user@example.com",
- "primary_phone_number": "string"
}, - "date_created": 0,
- "end_date": 0,
- "payment_method": {
- "card_brand": "string",
- "card_last_four_digits": "string",
- "bank_name": "string",
- "card_type": "string",
- "holder_name": "string"
}, - "plan": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "additional_details": {
- "widget_configuration": { }
}, - "billing_frequency": "daily",
- "date_created": 0,
- "description": "string",
- "name": "string",
- "price": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "product": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "additional_details": {
- "widget_configuration": { }
}, - "date_created": 0,
- "description": "string",
- "external_product_id": "string",
- "name": "string",
- "subaccount_id": "string",
- "status": "enabled"
}, - "status": "active",
}, - "start_date": 0,
- "status": "active"
}
Servicio utilizado para obtener todas las transacciones creadas por el comerciante. este servicio tiene una paginación que funciona por número de páginas.
Información acerca de las suscripciones creadas por el comerciante
Detalles del error retornados cuando la petición falló.
Las credenciales no son válidas
{- "page_count": 0,
- "item_count": 0,
- "next": "string",
- "previous": "string",
- "subscription_list": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "auto_billing": true,
- "billing_frequency": "daily",
- "billing_day": 0,
- "billing_method": "string",
- "customer": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "date_created": 0,
- "full_name": "string",
- "primary_email": "user@example.com",
- "primary_phone_number": "string"
}, - "date_created": 0,
- "end_date": 0,
- "payment_method": {
- "card_brand": "string",
- "card_last_four_digits": "string",
- "bank_name": "string",
- "card_type": "string",
- "holder_name": "string"
}, - "plan": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "additional_details": {
- "widget_configuration": { }
}, - "billing_frequency": "daily",
- "date_created": 0,
- "description": "string",
- "name": "string",
- "price": {
- "amount": 5000,
- "currency_code": "MXN"
}, - "product": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "additional_details": {
- "widget_configuration": { }
}, - "date_created": 0,
- "description": "string",
- "external_product_id": "string",
- "name": "string",
- "subaccount_id": "string",
- "status": "enabled"
}, - "status": "active",
}, - "start_date": 0,
- "status": "active"
}
]
}
Servicio utilizado para crear una suscripción relacionado a un plan para que el cliente pueda pagar y ser cobrado de acuerdo a la frecuencia de cobros especificada.
Información acerca de la suscripción que se va a crear
Información acerca de las suscripciones creadas por el comerciante
Detalles del error retornados cuando la petición falló.
Las credenciales no son válidas
{- "auto_billing": true,
- "billing_frequency": "monthly",
- "billing_day": 0,
- "billing_method": "card",
- "customer_email": "user@example.com",
- "payment_token_id": "80bcd4f6-0f4b-4ffe-94da-19dee5dcfe20",
- "payment_token_alias": "string",
- "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
- "start_date": 0
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "auto_billing": true,
- "billing_date": 0,
- "billing_frequency": "daily",
- "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
- "date_created": 0,
- "end_date": 0,
- "payment_method": {
- "card_brand": "string",
- "card_last_four_digits": "string",
- "bank_name": "string",
- "card_type": "string",
- "holder_name": "string"
}, - "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
- "start_date": 0,
- "status": "active"
}
{- "event_type": "subscription_creation.succeeded",
- "payload": {
- "auto_billing": true,
- "billing_frequency": "monthly",
- "customer_id": "e1317f33-5115-41da-9bfd-5091243e8ad4",
- "date_created": 1658958437,
- "id": "93e91fdb-fd17-455a-90f0-7125b6e0fc1a",
- "payment_token_id": "2f1da9a6-648d-4e60-b184-7031f53a269f",
- "plan_id": "4095b885-a0cf-4910-8478-f117447ae0ef",
- "start_date": 1658958437,
- "status": "incomplete"
}
}
Servicio utilizado para cancelar una suscripción relacionada a un plan para que el cliente no reciba un cargo en el siguiente periodo.
Información acerca de las suscripción que acaba de ser cancelada
Detalles del error retornados cuando la petición falló.
Las credenciales no son válidas
{- "cancellation_reason": "string"
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "auto_billing": true,
- "billing_date": 0,
- "billing_frequency": "daily",
- "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
- "date_created": 0,
- "end_date": 0,
- "payment_method": {
- "card_brand": "string",
- "card_last_four_digits": "string",
- "bank_name": "string",
- "card_type": "string",
- "holder_name": "string"
}, - "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
- "start_date": 0,
- "status": "active"
}
{- "event_type": "subscription_update.succeeded",
- "payload": {
- "auto_billing": true,
- "billing_frequency": "monthly",
- "customer_id": "e1317f33-5115-41da-9bfd-5091243e8ad4",
- "date_created": 1658958437,
- "id": "93e91fdb-fd17-455a-90f0-7125b6e0fc1a",
- "payment_token_id": "2f1da9a6-648d-4e60-b184-7031f53a269f",
- "plan_id": "4095b885-a0cf-4910-8478-f117447ae0ef",
- "start_date": 1658958437,
- "status": "cancelled"
}
}
Servicio utilizado para crear un producto y poder ser ofrecido a los clientes.
Información acerca del producto que se quiere crear
Información acerca del producto que fue creado
Detalles del error retornados cuando la petición falló.
Las credenciales no son válidas
{- "description": "My description",
- "name": "My new product",
- "additional_details": { },
- "external_product_id": "My_external_order_id"
}
{- "id": "6a9f1b7a-9b8b-4f7c-8e6e-5739a9f9751d",
- "description": "My description",
- "name": "My new product",
- "external_product_id": "My_external_order_id",
- "additional_details": { },
- "date_created": 1655485973,
- "status": "enabled",
- "subaccount_id": "6a9f1b7a-9b8b-4f7c-8e6e-5739a9f9751d"
}
{- "event_type": "product_creation.succeeded",
- "payload": {
- "id": "6a9f1b7a-9b8b-4f7c-8e6e-5739a9f9751d",
- "description": "My description",
- "name": "My new product",
- "external_product_id": "My_external_order_id",
- "additional_details": { },
- "date_created": 1655485973,
- "status": "enabled",
- "subaccount_id": "6a9f1b7a-9b8b-4f7c-8e6e-5739a9f9751d"
}
}
Los Payment links son una herramienta de ventas que permite realizar cobros aceptando todos los métodos de pago de una manera segura y acorde a los lineamientos del PCI , sin la necesidad de poseer una tienda en línea o e-commerce dónde integrar una pasarela de pagos.
Regresa una la lista de los links de pago
Lista de links de pagos con su información
Petición inválida, revisa la respuesta para detalles.
Las credenciales no son válidas
{- "has_next": false,
- "last_cursor": null,
- "has_previous": false,
- "first_cursor": null,
- "payment_links": [ ]
}
Crea un link de pago
Información del link de pago
description required | string Breve descripción del link de pago |
object (Amount) Detalle del monto | |
required | object (AmountConstraints) Los requisitos aplicados al monto |
expiration_date required | integer <int64> (Timestamp) Fecha expresada en UTC Unix Epoch Time. Puedes visitar este sitio para convertir fechas en línea. |
max_num_times_can_be_paid required | integer >= 1 Número máximo de veces que se pueden realizar pagos utilizando este link de pagos. Pon este campo como |
collect_customer_notes | boolean Default: false Dictamina si va a permitir que el usuario agregue notas asociadas al pago. Esto puedo ser útil en casos que quiera recolectar información del client como número de factura, etc. Si esta variable no es asignada, se le asigna el valor |
Array of objects Detalles adicionales para guardar información relacionadas a las notas | |
collect_customer_shipping_address | boolean Default: false Dictamina si va a permitir que el usuario agregue información de envío. |
object or null (PaymentMethodsConfiguration) Configuración de los métodos de pago para pagar el link de pago | |
collect_billing_information | boolean Default: false Habilita esta opción para permitir ingresar información de facturación |
object (ThemeStyle) Objeto que contiene información del estilo de la interfaz de usuario |
Información del link de pago creado
Petición inválida, revisa la respuesta para detalles.
Las credenciales no son válidas
{- "expiration_date": 1755921639,
- "amount": {
- "amount": 20000,
- "currency_code": "MXN"
}, - "description": "Unefon",
- "max_num_times_can_be_paid": 1,
- "collect_customer_notes": false,
- "amount_constraints": {
- "conformance": "fixed",
- "maximum_amount": {
- "amount": 20000,
- "currency_code": "MXN"
}, - "minimum_amount": {
- "amount": 20000,
- "currency_code": "MXN"
}
}
}
{- "date_created": 1656136054,
- "id": "ZrBX9nMbSl9Kis69L8",
- "num_of_completed_transactions": 0,
- "status": "active",
- "status_details": {
- "date_created": 1644525047789,
- "detail": null,
- "message": null,
- "status": "success"
}, - "payment_link": {
- "amount": {
- "amount": 20000,
- "currency_code": "MXN"
}, - "collect_customer_notes": false,
- "description": "Unefon",
- "expiration_date": 1755921639,
- "max_num_times_can_be_paid": 1,
- "amount_constraints": {
- "conformance": "fixed",
- "maximum_amount": {
- "amount": 20000,
- "currency_code": "MXN"
}, - "minimum_amount": {
- "amount": 20000,
- "currency_code": "MXN"
}
}
}
}
Obtén los detalles de un link de pago dado el payment_link_id
Detalles del link de pago
Petición inválida, revisa la respuesta para detalles.
Las credenciales no son válidas
{- "date_created": 1656136054,
- "id": "ZrBX9nMbSl9Kis69L8",
- "num_of_completed_transactions": 0,
- "status": "active",
- "status_details": {
- "date_created": 1644525047789,
- "detail": null,
- "message": null,
- "status": "success"
}, - "payment_link": {
- "amount": {
- "amount": 20000,
- "currency_code": "MXN"
}, - "collect_customer_notes": false,
- "description": "Unefon",
- "expiration_date": 1755921639,
- "max_num_times_can_be_paid": 1,
- "amount_constraints": {
- "conformance": "fixed",
- "maximum_amount": {
- "amount": 20000,
- "currency_code": "MXN"
}, - "minimum_amount": {
- "amount": 20000,
- "currency_code": "MXN"
}
}
}
}
Actualiza un link de pago dado el payment_link_id
Información a actualizar para el link de pago
status | string (PaymentLinkStatus) Estado del link de pago (i.e. Expirado, Activo, etc.) |
description | string Breve descripción del link de pago |
expiration_date | integer <int64> (Timestamp) Fecha expresada en UTC Unix Epoch Time. Puedes visitar este sitio para convertir fechas en línea. |
collect_customer_notes | boolean Dictamina si va a permitir que el usuario agregue notas asociadas al pago. Esto puedo ser útil en casos que quiera recolectar información del client como número de factura, etc. |
Array of objects Detalles adicionales para guardar información relacionadas a las notas | |
collect_customer_shipping_address | boolean Dictamina si va a permitir que el usuario agregue información de envío. |
collect_billing_information | boolean Habilita esta opción para permitir ingresar información de facturación |
object or null (PaymentMethodsConfiguration) Configuración de los métodos de pago para pagar el link de pago |
Link de pago actualizado
Petición inválida, revisa la respuesta para detalles.
Las credenciales no son válidas
{- "status": "active"
}
{- "date_created": 1656136054,
- "id": "ZrBX9nMbSl9Kis69L8",
- "num_of_completed_transactions": 0,
- "status": "active",
- "status_details": {
- "date_created": 1644525047789,
- "detail": null,
- "message": null,
- "status": "success"
}, - "payment_link": {
- "amount": {
- "amount": 20000,
- "currency_code": "MXN"
}, - "collect_customer_notes": false,
- "description": "Unefon",
- "expiration_date": 1755921639,
- "max_num_times_can_be_paid": 1,
- "amount_constraints": {
- "conformance": "fixed",
- "maximum_amount": {
- "amount": 20000,
- "currency_code": "MXN"
}, - "minimum_amount": {
- "amount": 20000,
- "currency_code": "MXN"
}
}
}
}
Una vez que crea un cargo de tipo pay_with_bank_account
o pay_with_store
, obtiene un id
. Puede usar ese 'id' de cargo para completar la transacción de cargo. Esta funcionalidad solo funciona en ambientes SANDBOX.
El cargo.
Cargo no encontrado.
Las credenciales no son válidas
El cargo no está pendiente.
curl --location --request GET 'https://sandbox.api.holacash.mx/v2/testing/transaction/complete/f2e43795-fce4-424c-880a-f6c1fed8cdf7' \ --header 'X-Api-Client-Key: <USE SECRET KEY>' \ --data-raw ''
{- "success_message": "string"
}
Una vez que crea un cargo de tipo pay_with_bank_account
o pay_with_store
, obtiene un id
. Puede usar ese 'id' de cargo para cancelar la transacción de cargo. Esta funcionalidad solo funciona en ambientes SANDBOX.
El cargo.
Cargo no encontrado.
Las credenciales no son válidas
El cargo no está pendiente.
curl --location --request GET 'https://sandbox.api.holacash.mx/v2/testing/transaction/cancel/f2e43795-fce4-424c-880a-f6c1fed8cdf7' \ --header 'X-Api-Client-Key: <USE SECRET KEY>' \ --data-raw ''
{- "success_message": "string"
}
El continuation id es el valor UUID al final de la URL de continuación retornado al crear un cargo cuando el usuario tiene que completar 3DS, por ejemplo. Se puede usar el secret o public key. Retorna la información acerca del cargo asociado a esta external reference ID.