Status Check

GEThttps://xyz.com/v1/service/payout/orders/{{transactionId}}

Authentication

Basic Authentication

• Username: Client Id
• Password: Secret Key

Example Authorization Header:

Authorization: Basic eGV0dGxlXzgzMjg2NjU5YmRmNzBkZWEzMDUwMzcwNzE1MTYwMzA0MDo3YzE1ZDQyYTZhYjEyOTYzYWI4NzJhMzFkOTk4MDk1ZDMwNTAzNzA3MTUxNjMyMDg5

Request Body

{}

Request Examples

Request Examples

Curl

curl --location 'https://xyz.com/v1/service/payout/orders/REF1120774118553774015A' --header 'Authorization: Basic eGV0dGxlX2ZjOGE1YTZiODNhMjRmMDkzMDc0NTgzNTI0MTA0Nzk4MzpkNjIxZGFmZGFhMjM1ZGIwNjdlYTJlNWU1ZDhhMjMxODMwNzQ1ODM1MjQxMDcyNzk5' --data ''

JavaScript

const axios = require('axios');
let data = '';

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://xyz.com/v1/service/payout/orders/REF1120774118553774015A',
  headers: { 
    'Authorization': 'Basic eGV0dGxlX2ZjOGE1YTZiODNhMjRmMDkzMDc0NTgzNTI0MTA0Nzk4MzpkNjIxZGFmZGFhMjM1ZGIwNjdlYTJlNWU1ZDhhMjMxODMwNzQ1ODM1MjQxMDcyNzk5'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

C#

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://xyz.com/v1/service/payout/orders/REF1120774118553774015A");
request.Headers.Add("Authorization", "Basic eGV0dGxlX2ZjOGE1YTZiODNhMjRmMDkzMDc0NTgzNTI0MTA0Nzk4MzpkNjIxZGFmZGFhMjM1ZGIwNjdlYTJlNWU1ZDhhMjMxODMwNzQ1ODM1MjQxMDcyNzk5");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://xyz.com/v1/service/payout/orders/REF1120774118553774015A")
  .method("GET", body)
  .addHeader("Authorization", "Basic eGV0dGxlX2ZjOGE1YTZiODNhMjRmMDkzMDc0NTgzNTI0MTA0Nzk4MzpkNjIxZGFmZGFhMjM1ZGIwNjdlYTJlNWU1ZDhhMjMxODMwNzQ1ODM1MjQxMDcyNzk5")
  .build();
Response response = client.newCall(request).execute();

Python

import requests

url = "https://xyz.com/v1/service/payout/orders/REF1120774118553774015A"

payload = ""
headers = {
  'Authorization': 'Basic eGV0dGxlX2ZjOGE1YTZiODNhMjRmMDkzMDc0NTgzNTI0MTA0Nzk4MzpkNjIxZGFmZGFhMjM1ZGIwNjdlYTJlNWU1ZDhhMjMxODMwNzQ1ODM1MjQxMDcyNzk5'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Response Examples

Success

{
    "code": "0x0200",
    "message": "Record fetched successfully.",
    "status": "SUCCESS",
    "data": {
        "clientRefId": "JAT00002072131",
        "accountNo": "CONT_1494845188474050F521",
        "productId": "pr_1626077095",
        "serviceId": "srv_1626077095",
        "orderRefId": "REF687737119324984A",
        "currency": "INR",
        "amount": 51,
        "utr": "412110177543",
        "fee": 0.5100000000000000088817841970012523233890533447265625,
        "tax": 0.0899999999999999966693309261245303787291049957275390625,
        "mode": "IMPS",
        "status": "processed"
    }
}

Failed

{
    "code": "0x0202",
    "status": "FAILURE",
    "message": "Record is failed.",
    "data": {
        "clientRefId": "JAT00002",
        "accountNo": "CONT_3797400211910624908C",
        "productId": "pr_1626077095",
        "serviceId": "srv_1626077095",
        "orderRefId": "REF3875120896551199BAC1",
        "currency": "INR",
        "amount": 102,
        "utr": null,
        "fee": 4.0800000000000000710542735760100185871124267578125,
        "tax": 0.729999999999999982236431605997495353221893310546875,
        "mode": "IMPS",
        "status": "failed"
    }
}

Record_Not_Found

{
    "code": "0x0202",
    "status": "FAILURE",
    "message": "No orders found."
}

Response Codes

The API uses the following response codes to indicate the status of requests:

Code	Description	Meaning
0x0200	SUCCESS	The request was processed successfully.
0x0201	UNAUTHORIZED	Authentication failed or insufficient permissions.
0x0202	FAILED	The request processing failed for a reason other than those specifically identified.
0x0203	MISSING_PARAMETER	The request is missing one or more required parameters.
0x0206	PENDING	The request has been received and is being processed, but processing has not yet completed.
0x0205	SOMETHING_WENT_WRONG	A server error occurred during processing of the request.