Initaite Transaction

POSThttps://xyz.com/v1/service/payout/orders

Authentication

Basic Authentication

• Username: Client Id
• Password: Secret Key

Example Authorization Header:

Authorization: Basic eGV0dGxlXzgzMjg2NjU5YmRmNzBkZWEzMDUwMzcwNzE1MTYwMzA0MDo3YzE1ZDQyYTZhYjEyOTYzYWI4NzJhMzFkOTk4MDk1ZDMwNTAzNzA3MTUxNjMyMDg5

Request Body

{
 "amount":"10",
 "purpose":"others", 
 "mode":"IMPS", 
 "contactId":"CONT_1025707858831303A0FC",
 "clientRefId":"IN3STAN4344517788", 
 "udf1":"" ,
 "udf2":"" 
}

Request Parameters

Parameter	Type	Required	Description
amount	String	Yes	Transaction amount
purpose	String	Yes	Purpose of the transaction (e.g., "others")
mode	String	Yes	Payment mode (e.g., "IMPS")
contactId	String	Yes	ID of the previously created contact
clientRefId	String	Yes	Your unique reference ID for this transaction
udf1	String	No	User-defined field 1 (optional)
udf2	String	No	User-defined field 2 (optional)

Request Examples

Request Examples

Curl

curl --location 'https://xyz.com/v1/service/payout/orders' --header 'Content-Type: application/json' --header 'Authorization: Basic U0FGRUVfYmNlOTQ4MmUxZmJlZmFiMzEwMjU2MjY2NTg5NTUyMDk6MjRlN2Y3NGMyNjUxZTI3ZGQwOTI0NTA5OTM5YWY5NTgxMDI1NjI2NjU4OTYyNDcx' --data '{
 "amount":"10",
 "purpose":"others", 
 "mode":"IMPS", 
 "contactId":"CONT_1025707858831303A0FC",
 "clientRefId":"IN3STAN4344517788", 
 "udf1":"" ,
 "udf2":"" 
}'

JavaScript

const axios = require('axios');
let data = JSON.stringify({
  "amount": "10",
  "purpose": "others",
  "mode": "IMPS",
  "contactId": "CONT_1025707858831303A0FC",
  "clientRefId": "IN3STAN4344517788",
  "udf1": "",
  "udf2": ""
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://xyz.com/v1/service/payout/orders',
  headers: { 
    'Content-Type': 'application/json', 
    'Authorization': 'Basic U0FGRUVfYmNlOTQ4MmUxZmJlZmFiMzEwMjU2MjY2NTg5NTUyMDk6MjRlN2Y3NGMyNjUxZTI3ZGQwOTI0NTA5OTM5YWY5NTgxMDI1NjI2NjU4OTYyNDcx'
  },
  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.Post, "https://xyz.com/v1/service/payout/orders");
request.Headers.Add("Authorization", "Basic U0FGRUVfYmNlOTQ4MmUxZmJlZmFiMzEwMjU2MjY2NTg5NTUyMDk6MjRlN2Y3NGMyNjUxZTI3ZGQwOTI0NTA5OTM5YWY5NTgxMDI1NjI2NjU4OTYyNDcx");
var content = new StringContent("{
 "amount":"10",
 "purpose":"others", 
 "mode":"IMPS", 
 "contactId":"CONT_1025707858831303A0FC",
 "clientRefId":"IN3STAN4344517788", 
 "udf1":"" ,
 "udf2":"" 
}", null, "application/json");
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("application/json");
RequestBody body = RequestBody.create(mediaType, "{
 "amount":"10",
 "purpose":"others", 
 "mode":"IMPS", 
 "contactId":"CONT_1025707858831303A0FC",
 "clientRefId":"IN3STAN4344517788", 
 "udf1":"" ,
 "udf2":"" 
}");
Request request = new Request.Builder()
  .url("https://xyz.com/v1/service/payout/orders")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Basic U0FGRUVfYmNlOTQ4MmUxZmJlZmFiMzEwMjU2MjY2NTg5NTUyMDk6MjRlN2Y3NGMyNjUxZTI3ZGQwOTI0NTA5OTM5YWY5NTgxMDI1NjI2NjU4OTYyNDcx")
  .build();
Response response = client.newCall(request).execute();

Python

import requests
import json

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

payload = json.dumps({
  "amount": "10",
  "purpose": "others",
  "mode": "IMPS",
  "contactId": "CONT_1025707858831303A0FC",
  "clientRefId": "IN3STAN4344517788",
  "udf1": "",
  "udf2": ""
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Basic U0FGRUVfYmNlOTQ4MmUxZmJlZmFiMzEwMjU2MjY2NTg5NTUyMDk6MjRlN2Y3NGMyNjUxZTI3ZGQwOTI0NTA5OTM5YWY5NTgxMDI1NjI2NjU4OTYyNDcx'
}

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

print(response.text)

Response Examples

Queued

{
    "code": "0x0200",
    "message": "Order accepted successfully",
    "status": "SUCCESS",
    "data": {
        "clientRefId": "IN3STAN4344517788",
        "orderRefId": "REF307464872548520306F08",
        "status": "queued"
    }
}

Failed

{
    "code": "0x0201",
    "message": "Unauthorized IP used.",
    "status": "FAILURE",
    "ip": "152.58.32.60"
}

MISSING_PARAMETER

{
    "code": "0x0203",
    "status": "MISSING_PARAMETER",
    "message": "contactId is not valid"
}

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.