EndPoints

Aprenda cómo automatizar sus tareas de conciliación integrando los puntos finales de nuestra API de reconciliació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

Request Body

Name	Type	Description
accessKey*	string	Dirección de correo electrónico del usuario de API configurada
secretKey*	string	Contraseña del usuario API configurado

Name

Type

Description

accessKey*

string

Dirección de correo electrónico del usuario de API configurada

secretKey*

string

Contraseña del usuario API configurado

{
    "idUser": 123,
    "username": "your@email.com",
    "idMerchant": 456
}

{
    "idUser": 123,
    "username": "your@email.com",
    "idMerchant": 456
}

{
    "code": 83,
    "description": "You are not permitted to log in from this location, please contact your account administrator."
}

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:

cookie: BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk

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:

Authorization: Bearer U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk

O como cookie:

cookie: BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk

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

https://merchants-api-stg.tupayonline.com/v1/cashouts?page=0&from=1577836800&to=1580515200

Producción

https://merchants-api.tupayonline.com/v1/cashouts?page=0&from=1577836800&to=1580515200

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:

{
 "data": [],
 "page": 0,
 "rows": 0,
 "maxRows": 50
 }

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.

CONSULTA DE DEPOSITOS

Recuperar detalles del depósito

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

Query Parameters

Name	Type	Description
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

Name

Type

Description

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.

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

Headers

Name	Type	Description
Content-Type	String	application/json
Cookie	String	BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk
Authorization	String	BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk

Name

Type

Description

Content-Type

String

application/json

String

BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk

Authorization

String

BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk

{
    "data": [
        {
            "idDeposit": 301164223,
            "externalId": "MP_689da0bb343f4bd9ac1da111db351e9b",
            "creationDate": "2024-01-10T13:41:57Z",
            "countryName": "Peru",
            "country": "PE",
            "paymentMethodCode": "XA",
            "clientDocument": "123456789",
            "amount": 10.0,
            "currency": "PEN",
            "requestedAmount": 10.0,
            "requestedCurrency": "PEN",
            "localAmount": 51.45,
            "fee": 0.0,
            "feeCurrency": "PEN",
            "lastChangeDate": "2024-01-10T13:41:58Z",
            "status": "PENDING",
            "idUser": "50097755",
            "flags": [],
            "idMerchant": 12345,
            "merchantName": "Merchant Name",
            "refundAttempted": false,
        }
    ],
    "page": 0,
    "rows": 1,
    "maxRows": 50
}

El parámetro "Status" puede tener cualquiera de los siguientes estados PENDING, APPROVED, COMPLETED, CANCELLED, DECLINED

CONSULTA DE RETIROS

Recuperar detalles del retiros

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

Query Parameters

Name	Type	Description
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		Status de transaccion valores: ON_HOLD PENDING DELIVERED COMPLETED REJECTED CANCELLED DECLINED

Name

Type

Description

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.

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: ON_HOLD PENDING DELIVERED COMPLETED REJECTED CANCELLED DECLINED

Headers

Name	Type	Description
Content-Type	String	application/json
Cookie	String	BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk
Authorization	String	BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk

Name

Type

Description

Content-Type

String

application/json

String

BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk

Authorization

String

BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk

El parámetro "Status" puede tener cualquiera de los siguientes estados ON_HOLD, PENDING, DELIVERED, COMPLETED, REJECTED, CANCELLED, DECLINED

CONSULTA DE REEMBOLSO

Este endpoint final le permite recuperar los detalles de todos sus reembolsos en un momento determinado.

Consulta detalles del reembolso

GET https://merchants-api-stg.tupayonline.com/v1/refund

Staging https://merchants-api-stg.tupayonline.com/v1/refund

Producción https://merchants-api-stg.tupayonline.com/v1/refund

Query Parameters

Name	Type	Description
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 Paí
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.
status		Status de transaccion

Name

Type

Description

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 Paí

page

integer

El número de página. Cada página contiene tantas transacciones como se indica en el valor de maxRows.

integer

Intervalo de fecha de creación de transacción en formato UnixTimeStamp diferencia máxima con valor "desde" 60 días.

status

Status de transaccion

Headers

Name	Type	Description
Content-Type	String	application/json
Cookie	String	BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk
Authorization	String	BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk

Name

Type

Description

Content-Type

String

application/json

String

BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk

Authorization

String

BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk

{
    "code": 18,
    "description": "Date period must be smaller than 60 days",
    "type": "EXCEEDED_DATE_PERIOD"
}

Status de las transacciones PENDING, COMPLETED, CANCELLED, WAITING_DETAILS

LOGOUT

Endpoint Logout

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

Headers

Name Type Description

Name	Type	Description
Cookie*	string	`BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk`

Cookie*

string

BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk

Una vez que se invalida el token, deberá autenticarse nuevamente antes de enviar una nueva solicitud.

AnteriorAspectos técnicos y de seguridad SiguientePlugin

Última actualización hace 1 mes

LOGIN ENDPOINT

Endpoint Login

Request Body

BEARER_TOKEN cookie

CONSULTA DE DEPOSITOS

Recuperar detalles del depósito

Query Parameters

Headers

CONSULTA DE RETIROS

Recuperar detalles del retiros

Query Parameters

Headers

CONSULTA DE REEMBOLSO

Consulta detalles del reembolso

Query Parameters

Headers

LOGOUT

Endpoint Logout

Headers