# Endpoint Estado

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

<mark style="color:blue;">`GET`</mark> `https://api-stg.tupayonline.com/v3/deposits/{deposit_id}`

#### Path Parameters

| Name                                          | Type    | Description                                            |
| --------------------------------------------- | ------- | ------------------------------------------------------ |
| deposit\_id<mark style="color:red;">\*</mark> | integer | Identificador del depósito generado del lado de Tupay. |

#### Headers

| Name                                            | Type   | Description                                                                                                                                          |
| ----------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| X-Date<mark style="color:red;">\*</mark>        | string | <p>Fecha según el estándar ISO 8601 en el siguiente formato: <code>yyyy-MM-dd'T'HH:mm:ssZ</code>. </p><p>E.g.: <code>2020-06-21T12:33:20Z</code></p> |
| X-Login<mark style="color:red;">\*</mark>       | string | X-Login API Key del comercio                                                                                                                         |
| Authorization<mark style="color:red;">\*</mark> | string | Authentication signature hash                                                                                                                        |

{% tabs %}
{% tab title="200 Consulta existosa." %}

```json
{
    "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": "prueba@gmail.com",
        "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"
}
```

{% endtab %}

{% tab title="400: Bad Request El código del deposito no es correcto" %}

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

{% endtab %}
{% endtabs %}

## <mark style="color:green;">Response</mark>

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

## <mark style="color:green;">Ejemplos para desarrolladores</mark>

{% tabs %}
{% tab title="JAVA" %}

```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());
  }
}
```

{% endtab %}

{% tab title="C#" %}

```csharp
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);
        }
    }
}


```

{% endtab %}

{% tab title="PHP" %}

<pre class="language-php"><code class="lang-php"><strong>&#x3C;?php
</strong>
$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;


</code></pre>

{% endtab %}
{% endtabs %}

## <mark style="color:green;">**Códigos de Método Completado**</mark>

<table><thead><tr><th width="140">completed_payment_method_code</th><th>Descripcion</th></tr></thead><tbody><tr><td><code>VI</code></td><td>Visa</td></tr><tr><td><code>MC</code></td><td>Mastercard</td></tr><tr><td><code>YP</code></td><td>Yape</td></tr><tr><td><code>IL</code></td><td>Plin</td></tr><tr><td><code>IB</code></td><td>Interbank</td></tr><tr><td><code>BC</code></td><td>BCP</td></tr><tr><td><code>ST</code></td><td>Scotia</td></tr><tr><td><code>BAB</code></td><td>Banbif</td></tr><tr><td><code>RY</code></td><td>Banco Ripley</td></tr><tr><td><code>RDP</code></td><td>Red Digital</td></tr><tr><td><code>WU</code></td><td>Western Union</td></tr><tr><td><code>BP</code></td><td>BBVA</td></tr><tr><td><code>KE</code></td><td>Kasnet</td></tr><tr><td><code>TM</code></td><td>Tambo</td></tr><tr><td><code>HC</code></td><td>Caja Huancayo</td></tr><tr><td><code>US</code></td><td>Caja Cusco</td></tr><tr><td><code>JA</code></td><td>Caja Arequipa</td></tr><tr><td><code>JI</code></td><td>Caja ICA</td></tr><tr><td><code>JP</code></td><td>Caja Piura</td></tr><tr><td><code>JT</code></td><td>Caja Tacna</td></tr><tr><td><code>DG</code></td><td>Digital Wallet</td></tr></tbody></table>

## <mark style="color:green;">**Códigos de Estados  "**</mark><mark style="color:green;">status</mark><mark style="color:green;">**"**</mark>

|                                                                                                                   Estado                                                                                                                  | Descripción                                                                                                                                                                    |
| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|       ​![](https://2476386583-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M792I7hN0PzC-Sx95CP%2F-MDBDtVvWt-UNvKHZsDY%2F-MDBHnzNY05ffYAzGwV_%2FCREATED.svg?alt=media\&token=0fb1ead7-6fc0-45e4-bcbf-e0f865150a72)​      | El depósito fue creado, pero el usuario no ha abierto el link aún.                                                                                                             |
|      ​![](https://2476386583-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M792I7hN0PzC-Sx95CP%2F-MDBDtVvWt-UNvKHZsDY%2F-MDBHD__gsa_CT3H-8Z2%2FINITIATED.svg?alt=media\&token=3627f922-3209-4bc7-b575-96023baa0278)​     | 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. |
| ​![](https://2476386583-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M792I7hN0PzC-Sx95CP%2F-M9UZX6c7bK760aeWd8v%2F-M9Uq6hh3MZ301JtlBh4%2FUntitled%20Diagram.svg?alt=media\&token=41bf91d1-9560-4eca-ae31-31076fa4318a)​ | El depósito fue creado con toda la información requerida aguardo a ser completado por el usuario.                                                                              |
|     ​![](https://2476386583-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M792I7hN0PzC-Sx95CP%2F-M9UZX6c7bK760aeWd8v%2F-M9Usf-KMOsFfbQJ_ZoQ%2FFOR_REVIEW.svg?alt=media\&token=5e16e936-8504-4809-b0ef-696ead0cda3a)​     | El depósito no pasó nuestros sistemas de antifraude y va a ser retenido hasta que sea revisado manualmente.                                                                    |
|       ​![](https://2476386583-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M792I7hN0PzC-Sx95CP%2F-MDBDtVvWt-UNvKHZsDY%2F-MDBH_7RIHxUC25-qIS1%2FEXPIRED.svg?alt=media\&token=23f5a18e-0b54-4c5e-9421-0070b2fb212d)​      | El depósito ha llegado a su fecha de expiración y el usuario no ha pagado.                                                                                                     |
|      ​![](https://2476386583-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M792I7hN0PzC-Sx95CP%2F-M9UZX6c7bK760aeWd8v%2F-M9UsJ4Co_cg-RzJZT6c%2FCANCELLED.svg?alt=media\&token=740308bc-8d16-47b4-b463-5dcb696664f5)​     | El depósito fue cancelado por el usuario o han pasado 7 días desde su expiración.                                                                                              |
|      ​![](https://2476386583-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M792I7hN0PzC-Sx95CP%2F-M9UZX6c7bK760aeWd8v%2F-M9UsDlL5PDQXBDL5CUD%2FCOMPLETED.svg?alt=media\&token=92d1f295-7b3c-4ad5-b0ce-eb123df5b7ed)​     | El depósito ha sido completado y el dinero fue acreditado en la cuenta del comercio.                                                                                           |

<figure><img src="https://2298703647-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGjMKy3VezYlJlCCcjySW%2Fuploads%2Fx8DLOoKiQsT2JoHZjeTk%2Fimage.png?alt=media&#x26;token=b497523d-f040-4d69-9a34-f66b613dccc0" alt=""><figcaption></figcaption></figure>