.svg?alt=media&token=6ec3fa6d-d66b-4c3c-bd63-fd5de44d8ef7)
EndPoints
Aprenda cómo automatizar sus tareas de conciliación integrando los puntos finales de nuestra API de reconciliación
Última actualización
Aprenda cómo automatizar sus tareas de conciliación integrando los puntos finales de nuestra API de reconciliación
Última actualización
Una vez que su cuenta esté lista para usar la API de comerciantes, el primer paso será autenticarse. Este proceso de autenticación requiere el envío de una solicitud POST al punto final de inicio de sesión. Mencionado abajo. Esta solicitud debe incluir la clave de acceso (correo electrónico) y la clave secreta (contraseña) en formato JSON para validar y establecer las credenciales del usuario.
POST https://merchants-api-stg.tupayonline.com/v1/auth/login
Staging https://merchants-api-stg.tupayonline.com/v1/auth/login
Producción tps://merchants-api.tupayonline.com/v1/auth/login
| Name | Type | Description |
|---|---|---|
Asegúrese de agregar en el encabezado de la solicitud el siguiente valor: Content-Type: application/json
La respuesta incluirá un campo de encabezado llamado Set-Cookie. Este campo en particular llevará una cookie etiquetada como BEARER_TOKEN que debe enviarse de regreso al servidor en todas las siguientes solicitudes para permanecer conectado.
Ejemplo de cookie en el encabezado con el valor BEARER_TOKEN:
Consulte esta página para obtener más información sobre las cookies.
A continuación se describen los puntos finales para cada tipo de transacciones.
Para enviar solicitudes, asegúrese de incluir el BEARER_TOKEN obtenido del punto final de inicio de sesión en el campo del encabezado de autenticación de las solicitudes. Puedes usarlo de las siguientes maneras:
Como parte del encabezado:
O como cookie:
Hay ciertos parámetros que puede enviar en la solicitud GET request. Éstos parámetros vienen en pares de nombres y valores conocidos como name-value. Se agregan a la URL después de un signo de “?”, y se pueden utilizar múltiples parámetros, separados por un signo “&”. El nombre y el valor siempre se separan mediante un signo “=”.
La sintaxis es la siguiente (ejemplos):
Staging
Producción
Los valores "from" y "to" siguen el formato unixTimeStamp, permitiendo una diferencia máxima de hasta 60 días entre ellos. El valor "from" no puede exceder el valor "to".
Una respuesta básica tiene el siguiente formato:
El campo de datos es una matriz que contendrá múltiples objetos JSON, uno para cada transacción. Cada uno con sus propios detalles.
La respuesta de estos puntos finales puede mostrar un máximo de 50 registros por página. En caso de que haya más de 50 registros, deberá solicitar la página siguiente utilizando el parámetro de página en la solicitud GET. Comience siempre con la página = 0.
El campo de filas indica cuántas transacciones devolvió la solicitud.
El campo maxRows muestra el número máximo de transacciones que una solicitud puede recuperar. En caso de que las "filas" sean iguales a "maxRows", debe realizar otra solicitud especificando la página más una. Repita esto hasta que el valor de las filas sea menor que el de maxRows.
GET https://merchants-api-stg.tupayonline.com/v1/deposits
Staging https://merchants-api-stg.tupayonline.com/v1/deposits
Producción https://merchants-api-stg.tupayonline.com/v1/deposits
El parámetro "Status" puede tener cualquiera de los siguientes estados PENDING, APPROVED, COMPLETED, CANCELLED, DECLINED
GET https://merchants-api-stg.tupayonline.com/v1/cashouts
Staging https://merchants-api-stg.tupayonline.com/v1/cashout
Producción https://merchants-api-stg.tupayonline.com/v1/cashout
El parámetro "Status" puede tener cualquiera de los siguientes estados ON_HOLD, PENDING, DELIVERED, COMPLETED, REJECTED, CANCELLED, DECLINED
DELETE https://merchants-api-stg.tupayonline.com/v1/auth/session/destroy
Staging https://merchants-api-stg.tupayonline.com/v1/auth/login
Producción tps://merchants-api.tupayonline.com/v1/auth/login
Una vez que se invalida el token, deberá autenticarse nuevamente antes de enviar una nueva solicitud.
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
accessKey*
string
Dirección de correo electrónico del usuario de API configurada
secretKey*
string
Contraseña del usuario API configurado
from
integer
Intervalo de fecha de creación de transacción en formato UnixTimeStamp
paymentMethod
string
(max legth: 4)
Código de método de pago. (XA/XAQR)
country
string
(PE)
Codigo de Pais
page
integer
El número de página. Cada página contiene tantas transacciones como se indica en el valor de maxRows.
to
integer
Intervalo de fecha de creación de transacción en formato UnixTimeStamp diferencia máxima con valor "desde" 60 días.
clienteDocument
String
El documento del cliente.
status
Status de transaccion valores: PENDING APPROVED COMPLETED CANCELLED DECLINED
Content-Type
String
application/json
Cookie
String
BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk
Authorization
String
BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk
from
integer
Intervalo de fecha de creación de transacción en formato UnixTimeStamp
paymentMethod
string
(max legth: 2)
Código de método de pago. (XA/XAQR)
country
string
(PE)
Codigo de Pais
page
integer
El número de página. Cada página contiene tantas transacciones como se indica en el valor de maxRows.
to
integer
Intervalo de fecha de creación de transacción en formato UnixTimeStamp diferencia máxima con valor "desde" 60 días.
clienteDocument
String
El documento del cliente.
status
Boolean
Status de transaccion valores: ON_HOLD PENDING DELIVERED COMPLETED REJECTED CANCELLED DECLINED
Content-Type
String
application/json
Cookie
String
BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk
Authorization
String
BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk