Loading...
Loading...
API Reference
Explore 104+ endpoints across 18 categories. Complete documentation with code examples.
PAYMENTS
3
SECURITY
2
AUTENTICACIÓN
1
CORE FLOW
39
/v1/payments/{id}/cancel
Cancelar
Este endpoint permite cancelar un pago, siempre y cuando el ...
/v1/payments/{id}/captures
Capturar
Este endpoint permite solicitar la captura de un pago cuyo m...
/v1/payments/{id}/refund
Reembolsar
Este endpoint permite hacer una devolución total o parcial d...
/v1/payments/{id}/adjust
Ajustes
Este endpoint permite hacer un ajuste decremantal o incremen...
/v1/payments/{id}/reversals
SUMMARY /v1/payments/{id}/reversals
/v1/payments/{id}/reversals
POST /v1/payments/{id}/reversals
Utilice la reversa si desea cancelar o reembolsar un pago y ...
/v2/payments/{id}/reversals
Reversa V2
Endpoint V2 para cancelar un pago. Utilice este endpoint par...
/v1/payments/{id}/cancel-or-refund
Cancelar o Reembolsar
Este endpoint combina funcionalidad de cancelación y reembol...
/v1/authorizations
Autorizar
Este endpoint permite generar una autorización incluyendo lo...
/v1/transactions/authorizations
Autorización Transaccional
Este endpoint permite generar una autorización transaccional...
/v1/transactions/{id}/adjust
Ajuste Transaccional
Este endpoint permite hacer un ajuste transaccional usando e...
/v1/transactions/{id}/captures
Captura Transaccional
Este endpoint permite capturar una transacción usando el ID ...
/v1/transactions/{id}/cancel
Cancelación Transaccional
Este endpoint permite cancelar una transacción usando el ID ...
/v1/transactions/{id}/refund
Reembolso Transaccional
Este endpoint permite reembolsar una transacción usando el I...
/v1/transactions/{id}/cancel-or-refund
Cancelar o Reembolsar Transaccional
Este endpoint permite cancelar o reembolsar una transacción ...
/v1/transactions/{id}/reversals
Reversa Transaccional
Este endpoint permite realizar una reversa transaccional usa...
/v1/payments/authorizations
POST /v1/payments/authorizations
Create a payment authorization. Supports optional tip amount...
/v1/pos/terminals/init
Inicializar terminal
Este endpoint permite verificar que la terminal está lista p...
/v1/pos/authorizations
Autorizar con tarjeta (genérico)
Este endpoint permite generar una autorización con tarjeta p...
/v1/pos/payments/{id}
Obtener pago por ID
Este endpoint permite obtener la información completa de un ...
/v1/pos/cancellations/{id}
Cancelar por identificador de Akua
Este endpoint permite cancelar un pago mediante el id provis...
/v1/pos/cancellations
Cancelar por identificador externo
Este endpoint permite cancelar un pago mediante un identific...
/v1/pos/reversals/{id}
Reversar por identificador de Akua
Este endpoint permite reversar un pago mediante el id provis...
/v1/pos/refunds/{id}
Reembolsar pago por ID
Este endpoint permite realizar un reembolso de un pago espec...
/v1/pos/cancel-or-refund/{id}
Cancelar o Reembolsar
Este endpoint combina funcionalidad de cancelación y reembol...
/v1/pos/terminals/{id}/init
Copy of Inicializar terminal
Este endpoint permite verificar que la terminal está lista p...
/v1/pos/payments/{id}/reversals
Reversa
Endpoint para cancelar un pago. Utilice este endpoint para c...
/v1/pos/payments/{id}/cancel-or-refund
Cancelar o Reembolsar
Este endpoint combina funcionalidad de cancelación y reembol...
/v1/pos/transactions/{id}/cancel-or-refund
Cancelar o Reembolsar Transaccional
Este endpoint permite cancelar o reembolsar una transacción ...
/v1/pos/transactions/{id}/reversals
Reversa Transaccional
Este endpoint permite realizar una reversa transaccional usa...
/v1/pos/transactions/{id}/cancel
Cancelación Transaccional
Este endpoint permite cancelar una transacción usando el ID ...
/v1/pos/transactions/{id}/refund
Reembolso Transaccional
Este endpoint permite reembolsar una transacción usando el I...
/v1/pos/payments/{id}/cancel
Cancelar
Este endpoint permite cancelar un pago, siempre y cuando el ...
/v1/pos/payments/{id}/refund
Reembolsar
Este endpoint permite hacer una devolución total o parcial d...
/v1/batches/terminals/{id}
Copy of Cancelar
Este endpoint permite cancelar un pago, siempre y cuando el ...
/v1/batches/{batch_number}/terminals/{terminal_id}/cutover
Copy of Copy of Cancelar
Este endpoint permite cancelar un pago, siempre y cuando el ...
/v1/batches/{batch_number}/terminals/{terminal_id}/payments
Copy of Copy of Copy of Cancelar
Este endpoint permite cancelar un pago, siempre y cuando el ...
/v1/batches/{batch_number}/terminals/{terminal_id}
Copy of Copy of Copy of Copy of Copy of Cancelar
Este endpoint permite cancelar un pago, siempre y cuando el ...
/v1/batches/terminals/{terminal_id}
Copy of Copy of Copy of Copy of Cancelar
Este endpoint permite cancelar un pago, siempre y cuando el ...
INSTRUMENTS
7
/v1/bins/{bin_number}
Obtener BIN por número
Este endpoint devuelve información sobre un BIN Emisor de ta...
/v1/instruments
Obtener tarjetas
Recupera una lista de todas las tarjetas registradas en el s...
/v1/instruments
Crear tarjeta
Este endpoint permite registrar una nueva tarjeta en el sist...
/v1/instruments/{id}
Obtener tarjeta por id
Este endpoint permite obtener los detalles de una tarjeta es...
/v1/instruments/{id}
Borrar tarjeta
Este endpoint permite eliminar una tarjeta específica utiliz...
/v1/instruments/{id}
Modificar tarjeta
Este endpoint permite modificar los detalles de una tarjeta ...
/v1/instruments/{id}/sensitive-data
Obtener datos sensibles de tarjeta
Este endpoint permite obtener los datos sensibles de una tar...
CASHOUTS
7
/cashouts-api/api/v1/cashouts
Obtener Cashouts
/cashouts-api/api/v1/cashouts/{id}
Obtener un Cashout por su ID
/cashouts-api/api/v1/cashout-methods/{id}
Eliminar un método de pago de cashout
/cashouts-api/api/v1/cashout-methods/{id}
Actualizar un método de pago de un cashout
/cashouts-api/api/v1/cashout-methods/{id}
Obtener un método de pago de cashout por su ID
/cashouts-api/api/v1/cashout-methods
Crear un método de pago de Cashout
/cashouts-api/api/v1/transfers/{transfer_id}/attachments/{attachment_id}
Descargar un comprobante de transferencia
CONTRACARGOS
7
/v1/chargebacks/{id}
Obtener un Contracargo por su Id
/v1/chargebacks
Buscar Contracargos
/v1/chargebacks/{id}/comments
Agregar comentario a un Contracargo
Agrega un comentario a un contracargo específico
/v1/chargebacks/{id}/analysis
Obtener análisis de un Contracargo
Obtiene el análisis de un contracargo específico
/v1/chargebacks/{id}/attachments/upload
Subir archivo adjunto a un Contracargo
Sube un archivo adjunto a un contracargo específico
/v1/chargebacks/{id}/attachments/{attachment-key}
Descargar archivo adjunto de un Contracargo
Descarga un archivo adjunto específico por su attachment-key
/v1/chargebacks/{id}/attachments/{attachment-key}
Eliminar archivo adjunto de un Contracargo
Marca un archivo adjunto como eliminado
ORGANIZACIÓN
1
COMERCIOS
7
/v1/merchants
Crear Comercio
El endpoint permite dar de alta un nuevo comercio en el sist...
/v1/merchants
Obtener los Comercios de una Organización
El endpoint permite recuperar la lista de todos los comercio...
/v1/merchants/{id}
Obtener Comercio por su ID
El endpoint permite recuperar la información detallada de un...
/v1/merchants/{id}
Eliminar Comercio
Este endpoint permite eliminar un comercio previamente regis...
/v1/merchants/{id}
Actualizar Comercio
Permite modificar la información de un comercio ya registrad...
/v1/merchants/{id}/rails
Actualizar Rieles de un Comercio
/v1/merchants/{id}/submerchants
Obtener Subcomercios de un Comercio
El endpoint permite recuperar la lista de todos los subcomer...
3DS AUTHENTICATION API
3
PAGOS
3
PUNTOS DE VENTA
11
/v1/points
Crear un nuevo Punto de Venta
Crea un nuevo punto de venta con la información proporcionad...
/v1/points/{id}
Obtener un Punto de Venta por ID
Recupera la información completa de un Punto de Venta especí...
/v1/points/{id}
Actualizar un Punto de Venta
Actualiza la información completa de un Punto de Venta exist...
/v1/points/{id}
Eliminar un Punto de Venta
Realiza una eliminación lógica del Punto de Venta, marcándol...
/v1/points/{point_id}/terminals
Obtener Terminales de un Punto de Venta
Recupera la lista de todos los terminales asociados a un Pun...
/v1/points/{point_id}/terminals/{terminal_id}
Actualizar asociación de una Terminal a un Punto de Venta
Actualiza la asociación entre una terminal y un punto de ven...
/v1/terminals
Crear una nueva Terminal
Registra una nueva Terminal en el sistema.
/v1/terminals/{id}
Obtener una Terminal por ID
Recupera la información completa de una Terminal específica,...
/v1/terminals/{id}
Actualizar una Terminal
Actualiza la configuración completa de una terminal existent...
/v1/terminals/{id}
Eliminar una Terminal
Realiza una eliminación lógica del terminal, desactivándolo ...
/v1/terminals/models
Obtener los Modelos de las Terminales Disponibles
Recupera la lista completa de modelos de terminales disponib...
USERS
5
/v1/users
Crear un nuevo usuario
Crea un nuevo usuario en el sistema.
/v1/users/{userId}
Obtener usuario por ID
Recupera información del usuario por ID de usuario.
/v1/users/{userId}/instruments
Obtener instrumentos de pago del usuario
Recupera todos los instrumentos de pago asociados con un usu...
/v1/users/{userId}/instruments
Agregar instrumento de pago al usuario
Agrega un nuevo instrumento de pago a la cuenta de un usuari...
/v1/users/{userId}/instruments/{instrumentId}
Remover instrumento de pago del usuario
Remueve un instrumento de pago de la cuenta de un usuario.
EVENTOS
3
/v1/webhooks
Crear un Webhook
El endpoint permite dar de alta un nuevo webhook. El mismo r...
/v1/webhooks
Obtener los Webhooks creados
El endpoint permite recuperar los enpoints creados por el co...
/v1/webhooks/{id}/secrets
Obtener el Webhook Secret
El endpoint permite recuperar el secreto utlizado para corro...