Deposit Status Endpoint

You can execute the call to check the status of the deposit at any time you deem appropriate. However, each time a repository changes status, we will send you a notification containing the repository

Deposit Status

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

This endpoint allows you to retrieve the status of a deposit request.

Path Parameters

Name	Type	Description
deposit_id*	integer	TuPay deposit_id. It is obtained when creating the deposit

Headers

Name	Type	Description
X-Date*	string	ISO8601 Datetime with Timezone: yyyy-MM-dd'T'HH:mm:ssZ
X-Login*	string	Merchant X-Login API Key
Authorization*	string	Authentication signature hash

200 Deposit status successfully retrieved.

{
    "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 The deposit_id specified is not valid

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

Response

Name	Format	Descriptions
user_id	String	Identifier of the user generator on the Tupay side.
deposit_id	Number	Identifier of the deposit generated on the Tupay side.
invoice_id	String	Identifier of the repository generated on the Tupay side.
country	String	Country
currency	String	Money PEN/USD
local_amount	Number	Amount in local currency.
usd_amount	Number	Amount in USD.
payment_method	String	Payment Methods
status	String	Tank status
payer[]	Object	Object containing information about the payer. Only the data you have submitted or we have collected will be displayed.
payer.document	String	Identity document of the payer.
payer.document_type	String	Type of identity document of the payer.
payer.email	String	Payer's email address.
payer.first_name	String	Name of payer.
payer.last_name	String	Last Name of payer
payer.address[]	Object	Object containing details of the payer's address. Only data you have submitted or we have collected will be displayed.
payer.address.city	String	Payer city
payer.address.state	String	Payer status in ISO format.
payer.address.street	String	Street of payer
payer.address.zip_code	String	Code Address zip
fee_amount	Number	Deposit fee in the currency of the balance sheet.
fee_currency	String	Fee currency
completed_payment_method_code	String	Payment method used by the customer to complete the transaction. The codes can be found (Method code completed).

Examples for developers

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;

Method Code Completed

completed_payment_method_code	Description
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

State Codes

Estado	Descripción
​​	The repository was created, but the user has not opened the link yet.
​​	The deposit was created and the user has opened the link, but has not completed the payment flow with their personal information or the provider has not been able to process the request.
​​	The deposit was created with all the required information waiting to be completed by the user.
​​	The deposit did not pass our anti-fraud systems and will be held until it is manually reviewed.
​​	The deposit has reached its expiration date and the user has not paid.
​​	The deposit was canceled by the user or 7 days have passed since its expiration.
​​	The deposit has been completed and the money was credited to the merchant's account.