Endpoint Estado de Depósito

Se puede ejecutar la llamada para consultar el estado del depósito en cualquier momento que considere pertinente. De todas formas, cada vez que un depósito cambie de estado, le enviaremos una notificación conteniendo el identificador del depósito para que pueda consultar el estado nuevamente.

Estado de Depósito

GET https://api-stg.tupayonline.com/v3/deposits/{deposit_id}

Path Parameters

Name	Type	Description
deposit_id*	integer	Identificador del depósito generado del lado de Tupay.

Headers

Name	Type	Description
X-Date*	string	Fecha según el estándar ISO 8601 en el siguiente formato: yyyy-MM-dd'T'HH:mm:ssZ. E.g.: 2020-06-21T12:33:20Z
X-Login*	string	X-Login API Key del comercio
Authorization*	string	Authentication signature hash

200 Consulta existosa.

{
    "deposit_id": 301178393,
    "invoice_id": "19574-2023284901097729168",
    "country": "PE",
    "currency": "PEN",
    "usd_amount": 2.54,
    "local_amount": 10.00,
    "payment_method": "XA",
    "payment_type": "VOUCHER",
    "status": "PENDING",
    "payer": {
        "document": "78596049",
        "document_type": "DNI",
        "email": "[e-mail]",
        "first_name": "Nombre",
        "last_name": "Apellido"
    },
    "fee_amount": 0.13,
    "fee_currency": "USD",
    "refunded": false,
    "current_payer_verification": "NO_CURRENT_PAYER_DATA",
    "completed_payment_method_code": "YP"
}

400: Bad Request El código del deposito no es correcto

{
    "code": 207,
    "description": "Invalid request parameter type",
    "type": "INVALID_REQUEST_PARAMETER_TYPE"
}

Response

Nombre del campo	Formato	Descripción
user_id	String	Identificador del usuario generador del lado de Tupay.
deposit_id	Number	Identificador del depósito generado del lado de Tupay.
invoice_id	String	Identificador del depósito generado en el extremo del comercio.
country	String	Pais
currency	String	Moneda PEN/USD
local_amount	Number	Monto en divida local.
usd_amount	Number	Monto en USD.
payment_method	String	Métodos de Pagos
status	String	Estado del depósito.
payer[]	Object	Objeto conteniendo de información del pagador. Sólo los datos que haya enviado o nosotros hayamos recolectados serán mostrados.
payer.document	String	Documento de identidad del pagador.
payer.document_type	String	Tipo de documento de identidad del pagador.
payer.email	String	Dirección de email del pagador.
payer.first_name	String	Nombre del pagador.
payer.last_name	String	Apellido del pagador.
payer.address[]	Object	Objeto conteniendo detalles sobre la dirección del pagador. Sólo datos que haya enviado o nosotros hayamos recolectados serán mostrados.
payer.address.city	String	Ciudad del pagador.
payer.address.state	String	Estado del pagador en formato ISO.
payer.address.street	String	Calle del pagador.
payer.address.zip_code	String	Código postal del pagador.
fee_amount	Number	Comisión del depósito en la divisa del balance.
fee_currency	String	Divisa del balance.
completed_payment_method_code	String	Método de pago utilizado por el cliente para completar la transacción. Los códigos se pueden encontrar (Código de método completado).

Ejemplos para desarrolladores

JAVA

import java.io.*;
import okhttp3.*;

public class main {
  public static void main(String []args) throws IOException{
    OkHttpClient client = new OkHttpClient().newBuilder()
      .build();
    Request request = new Request.Builder()
      .url("https://api-stg.tupayonline.com/v3/deposits/300004285")
      .method("GET", null)
      .addHeader("X-Login", "xxxxxxx")
      .addHeader("X-Date", "2020-06-24T17:13:21Z")
      .addHeader("Authorization", "D24 e339247fb57b10c053159cf87d3a88415f9be567beb46a93f6839d9fc45d2c8a")
      .build();
    Response response = client.newCall(request).execute();
    System.out.println(response.body().string());
  }
}

C#

using System;
using RestSharp;

namespace HelloWorldApplication {
    class HelloWorld {
        static void Main(string[] args) {
            var client = new RestClient("https://api-stg.tupayonline.com/v3/deposits/300004285");
            client.Timeout = -1;
            var request = new RestRequest(Method.GET);
            request.AddHeader("X-Login", "xxxxxxx");
            request.AddHeader("X-Date", "2020-06-24T17:13:21Z");
            request.AddHeader("Authorization", "D24 e339247fb57b10c053159cf87d3a88415f9be567beb46a93f6839d9fc45d2c8a");
            request.AddParameter("application/json", "",  ParameterType.RequestBody);
            IRestResponse response = client.Execute(request);
            Console.WriteLine(response.Content);
        }
    }
}

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api-stg.tupayonline.com/v3/deposits/300004285",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "X-Login: xxxxxxxx",
    "X-Date: 2020-06-24T17:13:21Z",
    "Authorization: D24 e339247fb57b10c053159cf87d3a88415f9be567beb46a93f6839d9fc45d2c8a"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Códigos de Método Completado

completed_payment_method_code	Descripcion
VI	Visa
MC	Mastercard
YP	Yape
IL	Plin
IB	Interbank
BC	BCP
ST	Scotia
BAB	Banbif
RY	Banco Ripley
RDP	Red Digital
WU	Western Union
BP	BBVA
KE	Kasnet
TM	Tambo
HC	Caja Huancayo
US	Caja Cusco
JA	Caja Arequipa
JI	Caja ICA
JP	Caja Piura
JT	Caja Tacna
DG	Digital Wallet

Códigos de Estados "status"

Estado	Descripción
​​	El depósito fue creado, pero el usuario no ha abierto el link aún.
​​	El depósito fue creado y el usuario ha abierto el link, pero no ha completado el flujo de pago con su información personal o el proveedor no ha logrado procesar la solicitud.
​​	El depósito fue creado con toda la información requerida aguardo a ser completado por el usuario.
​​	El depósito no pasó nuestros sistemas de antifraude y va a ser retenido hasta que sea revisado manualmente.
​​	El depósito ha llegado a su fecha de expiración y el usuario no ha pagado.
​​	El depósito fue cancelado por el usuario o han pasado 7 días desde su expiración.
​​	El depósito ha sido completado y el dinero fue acreditado en la cuenta del comercio.

Descargar Postman Collection