.svg?alt=media&token=6ec3fa6d-d66b-4c3c-bd63-fd5de44d8ef7)
Endpoint Creación de Depósito
Última actualización
Última actualización
POST https://api-stg.tupayonline.com/v3/deposits
| Name | Type | Description |
|---|
| Name | Type | Description |
|---|
Los parámetros del body que se encuentren con marcas * son campos obligatorios.
Dentro de la API de Tupay, será posible encontrar distintos métodos de pago, representados por distintos códigos de payment_method, estos son utilizados para filtrar exactamente que métodos de pago quieren mostrarle al cliente final . "payment_method":"XAQR" / "payment_method":"XA"
Agrupamos los códigos de error en diferentes categorías para un mejor entendimiento.
1xx - Errores de encabezado
2xx - Error en la llamada o de configuración del comercio
3xx - Errores del usuario
4xx - Errores en la creación del depósito
5xx - Otros errores
7xx - Errores internos
| ONE_SHOT | HOSTED |
|---|
| Logo | Valor | Descripción |
|---|
Dentro de la API de Tupay, será posible encontrar distintos tipo de documento de identidad, para ello se tiene una validación por la cantidad de dígitos. ,"document":"86970864"
| document_type (valores) | document (Longitud de caracteres) |
|---|
| Código | Código HTTP | Tipo | Mensaje | Descripción |
|---|
PASS | Min 9 Max 12 dígitos Alfanumerico |
RUC | Numérico 11 dígitos |
CE | Min 9 Max 12 dígitos Alfanumerico |
DNI | Numérico 8 dígitos |
Content-Type | string |
|
X-Date* | string | Fecha según el estándar ISO8601 formato:
|
X-Login* | string | X-Login API Key del Comercio |
Authorization | string | Hash de control de autorización |
X-Idempotency-Key | string | Idempotency key única |
country* | string | (PE) País del depósito |
currency* | string | (PEN / USD) Tipo de Moneda |
amount* | number | Monto de depósito |
request_payer_data_on_validation_failure | boolean | (default:false) Marca utilizada para especificar si desea ignorar error por |
client_ip | string | Dirección IPv4/v6 válida del cliente |
device_id | string | (max length: 100) Identificador único del cliente |
back_url | string | HTTPS URL válida usada para redireccionar al usuario. |
success_url* | string | HTTPS URL usada para redireccionar al cliente en caso de completarse el depósito |
error_url | string | HTTPS URL válida usada para redireccionar al cliente en caso de que ocurra un error a la hora de generar el pago |
payment_method* | string |
notification_url* | string | HTTPS URL válida usada para enviar notificaciones sobre los cambios de estado del depósito |
test | boolean | Etiqueta para indicar que es un depósito de prueba. Si es enviado como |
mobile | boolean | (default: false) La marca mobile es un booleano y tiene que ser enviado con el valor |
payer{}* | object | Objeto que contiene los detalles del pagador. |
prayer.first_name* | string | (max length: 128) Nombre del cliente. |
prayer.last_name* | string | (max length: 128) Apellido del cliente. |
prayer.phone | string | string (max length: 32) Número de teléfono válido del cliente. |
prayer.document* | string | (max length: 30) Asegúrese de que sea correcto y que el usuario no pueda cambiarlo cada vez que desea generar un nuevo depósito. |
prayer.email* | string | (max length: 255) Dirección de email válida del cliente. |
prayer.document_type | string | (max length: 10) |
prayer.address{} | object | Objeto conteniendo detalles de la dirección. |
prayer.address.zip_code | string | (max length: 16) Código postal del cliente. |
prayer.address.city | string | (max length: 128) Ciudad del cliente. |
prayer.address.street | string | (max length: 255) Calle del cliente. |
fee_on_payer | boolean | (default: false) Elija si la tarifa del depósito será pagada por el cliente o debitada de su saldo |
invoice_id* | string | (max length: 128) (random: ^[A-Za-z0-9-_]*$ ) ID de depósito único por parte del merchant. |
expiration | number | (max: 2880) Tiempo de expiracion del voucher minutos minimo 1440 y maximo 2880 |
La creación del depósito fue completada con éxito a partir de su petición, y el usuario verá directamente la información para completar el pago. | La información enviada no es suficiente para crear el depósito, y los datos faltantes deben ser pedidos al usuario. Redirija al usuario a nuestro Hosted Checkout para que solicitemos la información en cuestión. |
XA | El método de pago "XA" representa todos los metodos de pago de Tupay,al utilizar este codigo, el cliente sera ofrecido con todas las opciones que ofrecemos para realizar el pago final |
XAQR | Al utilizar este codigo, el cliente final sera presentado con todas las opciones que ofrecen un QR para escanear y realizar el pago final, esto es representado en el request como |
XABT | El método de pago "XABT" ofrece al usuario final el codigo de pago para utilizar en todas las entidades bancarias y agentes. |
XACC | Al utilizar este codigo, el usuario final podrá realizar su pago con tarjeta visa y mastercard. |
100 | 401 |
| Invalid Credentials | El |
101 | 400 |
| Missing or invalid format for required header {headerName} |
102 | 400 |
| Invalid signature |
103 | 400 |
| X-Date header value out of valid range |
104 | 400 |
| Idempotency key {key} has been already used | La |
105 | 400 |
| Optional header {headerName} must not be blank | Si un encabezado opcional es enviado, puede venir vacío. |
201 | 400 |
| Field validation error. Check details | Uno o más campos son incorrectos. |
202 | 401 |
| Unregistered IP address |
203 | 429 |
| Too many consecutive attempts for user (Velocity Check) | El usuario ha creado muchos depósitos en un corto periodo de tiempo. |
204 | 400 |
| Invalid media type | El formato de la llamada no es soportado. Asegúrse de que el encabezado |
205 | 400 |
| Missing request parameter | La llamada carece de un parámetro importante. |
206 | 400 |
| Missing path variable | La llamada carece de una variable importante en la ruta. |
207 | 400 |
| Invalid request parameter type | Se ha enviado un tipo de parametro incorrecto. |
208 | 404 |
| Resource not found | El |
209 | 400 |
| Invalid request body: {details} | Hay un error de sintaxis en el JSON. |
217 | 403 |
| Merchant has no authorization to use this API | Su comercio no está habilitado a utilizar esa API. Póngase en contacto con su Account Manager. |
300 | 400 |
| User blacklisted | El usuario ha cometido fraude previamente y el depósito fue declinado. |
301 | 400 |
| User greylisted | Se ha detectado actividad inusual y hemos bloqueado al usuario. |
302 | 400 |
| User unauthorized | El usuario está bloqueado. Para más información acceda a la sección Clients del Tupay Panel. |
303 | 400 |
| User unauthorized due to cadastral situation | Revise la situación cadastral del usuario. |
304 | 400 |
| The user limit has been exceeded: {TRANSACTION|DAILY|WEEKLY|MONTHLY} | Revise los limites del usuario en el Tupay Panel bajo la sección Clients. |
305 | 400 |
| Restricted payment method type | El tipo de pago se ha deshabilitado al usuario. |
400 | 400 |
| Invalid amount. The minimum is USD 2 or equivalent in local currency | El monto no ha a alcanzado el mínimo. |
401 | 400 |
| Payment method not found | El |
402 | 400 |
| Invoice already used | El |
404 | 400 |
| Payment method provider unavailable | Nuestro proveedor no está disponible temporalmente, por favor intente nuevamente. |
406 | 400 |
| Invalid address | El valor |
407 | 400 |
| Invalid city | El valor |
408 | 400 |
| Payment method limit exceeded | El |
410 | 400 |
| Payment method minimum required | El |
411 | 400 |
| Invalid user document ID | El |
412 | 400 |
| Payment Method Unavailable | El método de pago no está disponible temporalmente |
418 | 400 |
| Missing required fields in order to generate Deposit | La llamada carece de un campo requerido. |
419 | 400 |
| payer.id or payer.document field is missing | La llamada carece de |
500 | 500 |
| Oh no! Something has gone wrong. Please contact a system administrator | Error interno, por favor contacte a soporte. |
720 | 400 |
| Missing configuration for merchant account | Hay una configuración faltante, póngase en contacto con su Account Manager. |
Debe ser enviado con el valor XA/XAQR
Tipo de documento del cliente. Opcional, en caso de enviar debe ser un valor válido.
Debajo encontrarás los campos requeridos con un Checkbox
Si faltan datos para crear el pago, el flujo HOSTED se hará presente
Asegúrese de que todos los sean correctos.
Invalid Authorization signature.
Firma de Authorization inválida. Revise .
The X-Date value you sent in the header is outside the allowed time-frame.
El valor X-Date enviado en el encabezado está por fuera del marco temporal permitido. Revise .
Debes whitelistear la dirección IP. Revise .
