Deposit Status Endpoint

Retrieve the status of a previously created deposit

Deposit Status

GET https://api-stg.lime-pay.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	LimePay 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": 301423824,
    "invoice_id": "postmanTest388433169",
    "country": "TH",
    "currency": "THB",
    "usd_amount": 56.10,
    "local_amount": 2000.00,
    "bonus_amount": 1.50,
    "bonus_relative": true,
    "payment_method": "QRT",
    "payment_type": "VOUCHER",
    "status": "COMPLETED",
    "payer": {
        "document": "1234567890123",
        "document_type": "PASS",
        "email": "[e-mail]",
        "first_name": "Test",
        "last_name": "Testing",
        "phone": "[phone]"
    },
    "fee_amount": 2.78,
    "fee_currency": "USD",
    "refunded": false,
    "current_payer_verification": "NO_CURRENT_PAYER_DATA",
    "completed_payment_method_code": "QRT"
}

208 The deposit_id specified is not valid

{
    "code": 208,
    "description": "Resource not found",
    "type": "RESOURCE_NOT_FOUND"
}

Request

You can trigger the check of the status of a deposit at any moment you consider pertinent. However, every time a deposit changes its status, we will send you a notification containing the ID of the deposit so that you can check its status back to retrieve the new deposit's status.

Example request

In the status endpoint, all the request have to be sent as GET, containing the usual headers.

Regarding the Authorization value, since the body of the requests will be empty, you should use an empty ("") string or nothing as the jsonPayload field.

cURL

curl --location --request GET 'https://api-stg.lime-pay.com/v3/deposits/301423824' \
--header 'X-Login: xxxxxxx' \
--header 'X-Date: 2020-06-24T17:13:21Z' \
--header 'Authorization: LIMEPAY e339247fb57b10c053159cf87d3a88415f9be567beb46a93f6839d9fc45d2c8a' \
--data-raw ''

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.lime-pay.com/v3/deposits/301423824")
      .method("GET", null)
      .addHeader("X-Login", "xxxxxxx")
      .addHeader("X-Date", "2020-06-24T17:13:21Z")
      .addHeader("Authorization", "LIMEPAY 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.lime-pay.com/v3/deposits/301423824");
            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", "LIMEPAY 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.lime-pay.com/v3/deposits/301423824",
  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: LIMEPAY e339247fb57b10c053159cf87d3a88415f9be567beb46a93f6839d9fc45d2c8a"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Example response

COMPLETED

{
    "deposit_id": 301423824,
    "invoice_id": "postmanTest388433169",
    "country": "TH",
    "currency": "THB",
    "usd_amount": 56.10,
    "local_amount": 2000.00,
    "bonus_amount": 1.50,
    "bonus_relative": true,
    "payment_method": "QRT",
    "payment_type": "VOUCHER",
    "status": "COMPLETED",
    "payer": {
        "document": "1234567890123",
        "document_type": "PASS",
        "email": "[e-mail]",
        "first_name": "Test",
        "last_name": "Testing",
        "phone": "[phone]"
    },
    "fee_amount": 2.78,
    "fee_currency": "USD",
    "refunded": false,
    "current_payer_verification": "NO_CURRENT_PAYER_DATA",
    "completed_payment_method_code": "QRT"
}
```

PENDING

{
    "deposit_id": 301423817,
    "invoice_id": "postmanTest315819867",
    "country": "TH",
    "currency": "THB",
    "usd_amount": 56.10,
    "local_amount": 2000.00,
    "bonus_amount": 1.50,
    "bonus_relative": true,
    "payment_method": "QRT",
    "payment_type": "VOUCHER",
    "status": "PENDING",
    "payer": {
        "document": "1234567890123",
        "document_type": "PASS",
        "email": "[e-mail]",
        "first_name": "Test",
        "last_name": "Testing",
        "phone": "[phone]"
    },
    "fee_amount": 2.78,
    "fee_currency": "USD",
    "refunded": false,
    "current_payer_verification": "NO_CURRENT_PAYER_DATA"
}

CREATED

{
    "deposit_id": 301423924,
    "invoice_id": "postmanTest323497269",
    "country": "TH",
    "currency": "THB",
    "usd_amount": 56.11,
    "local_amount": 2000.00,
    "bonus_amount": 1.50,
    "bonus_relative": true,
    "status": "CREATED",
    "payer": {
        "document": "1234567890123",
        "document_type": "PASS",
        "email": "[e-mail]",
        "first_name": "Test",
        "last_name": "Testing",
        "phone": "[phone]"
    },
    "fee_amount": 2.78,
    "fee_currency": "USD",
    "refunded": false,
    "current_payer_verification": "NO_CURRENT_PAYER_DATA"
}

Response fields

Parameter current_payer_verification

Through the parameter current_payer_verification you can check if the current payer is the same person who created the deposit. Below you can see the possible results for this parameter: Match --> The document of the person who paid is the same as the one of the person who created the payment. Unmatch --> The documents are different. No client document -> It is when there is no document of the person who proceed with the payment (Current payer). No current payer data -> It is when there is no document of the person who proceed with the payment (Current payer)

In order to make the experience more personalized, we may add more fields to this response's object in the future. Please develop your integration to be able to ignore new fields to avoid any issues.

If you are not sending all the payer details in the deposit request, make sure you store the details we collect and share with this endpoint so that in future attempts you can re-use them instead of having the payers to fill in the same details every time they deposit.

Status Flow

Click here to see each Deposit Status meaning.

Hosted Checkout Status Flow

OneShot Checkout Status Flow

1. The DECLINED status is not a status by itself. It means the transaction couldn't be created because of an error with the data, the customer or the merchant configuration. No transaction will change its status from DECLINED.

2. COMPLETED and CANCELLED* are final status.

3. *There are cases in which the users pays after the deposit expired, or paid an incorrect amount and the deposit gets expired. When that happens manual intervention is required to approve the deposit hence a deposit could change its status from EXPIRED or CANCELLED to COMPLETED.

4. EARLY RELEASED will only be used if you specified it in the deposit request.

5. FOR REVIEW is a transient status we use to specify that the deposit is under revision.

6. If the user doesn't pays, the transaction will be marked as EXPIRED. After 7 days it will change to CANCELLED.

Status codes

Check all the possible status in the following page: