Overview API Endpoint

https://api.nyobank.com/

What is NyoBank?

NyoBank was formed on 2nd Nov 2023 with intention of making the digital payments for the corporate and individuals wants to use the card for making payments to the vendors or to the respective dues towards water, electricity, rent payment etc.

NyoBank is founded by the experienced professionals in payment industry across various departments like merchant acquisition, merchant management along with Corporate acquisition, Account Development, Risk Assessment, Payment Processing, Financial Services, Banking Processes in B2B and retail space over 12 years.

NyoBank opens the avenues for the corporate to use the respective corporate cards for Vendor, Statutory Payments, Salary Payments etc. through NyoBank portal and simple submission of an excel.

Overview

Hi, Welcome to NyoBank! We’ll help you go through this documentation in order to understand who we are, what we offer and how you can scale your business by integrating with us.

The NyoBank API provides programmatic access to read data. Retrieve a character, provide an oauth connexion, retrieve a familly, filter them, etc.

To use this API, you need an MerchantID, ClientID, ClientSecretKey. Please contact us at info@NyoBank.com to get your own API key.

API Endpoint

QUERY PARAMETERS

Field Type Description
payout_refno String Unique Transaction Number
amount String Transaction Amount (Max 100000)
payout_mode String (Capital Letter) IMPS / NEFT
user_mobile_number String 10 Digit Sender Mobile Number
account_name String Account Holder Name min 5 Digit
account_no String Benefisary Account Number
ifsc String IFSC Code

Body raw (json)

merchantId String The Uniqe Merchant ID Given in your portal
clientid String The Uniqe clientid Given in your portal
clientSecretKey String The Uniqe clientSecretKey Given in your portal

PAYOUT / EXPRESS

var options = new RestClientOptions("https://api.nyobank.com")

{

MaxTimeout = -1,

};

var client = new RestClient(options);

var request = new RestRequest("/28Noyhkjh73/api/v1/endpoint/NyoBankPayout?payout_refno=12345125&amount=1&payout_mode=IMPS&
user_mobile_number=1111XXXX22&account_name=XXXX&
account_no=XXXXXXXXXXX&ifsc=XXXXXXXXXXX", Method.Post);

request.AddHeader("Content-Type", "application/json");

var body = @"{

" + "\n" +

@" ""merchantId"": ""XXXXXXX"",

" + "\n" +

@" ""clientid"": ""XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"",

" + "\n" +

@" ""clientSecretKey"": ""XXXXXXXXXXXXXXXXXXXXX""

" + "\n" +

@"}";

request.AddStringBody(body, DataFormat.Json);

RestResponse response = await client.ExecuteAsync(request);

Console.WriteLine(response.Content);

Dynamic Qr Endpoint

QUERY PARAMETERS

Field Type Description
fullName String Name
LastName String LastName
email String Proper email id
mobileNumber String 10 Digit Sender Mobile Number
amount Number Prefer Number Only
payin_ref String Unique Order Id

Body raw (json)

merchantId String The Uniqe Merchant ID Given in your portal
clientid String The Uniqe clientid Given in your portal
clientSecretKey String The Uniqe clientSecretKey Given in your portal

Dynamic QR Endpoint

var options = new RestClientOptions("https://api.nyobank.com")

{

MaxTimeout = -1,

};

var client = new RestClient(options);

var request = new RestRequest("/28Noyhkjh73/api/v1/endpoint/NyoBankDynamicQR?payin_ref=0000000&amount=xxxxxxx&fName=xxxxx&lName=xxxxxx&
mNo=xxxxxx&email=xxxxxx&add1=xxxxxx& city=xxxxxx&state=xxxxxx&pCode=xxxxxx", Method.Post);

request.AddHeader("Content-Type", "application/json");

var body = @"{

" + "\n" +

@" ""merchantId"": ""XXXXXXX"",

" + "\n" +

@" ""clientid"": ""XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"",

" + "\n" +

@" ""clientSecretKey"": ""XXXXXXXXXXXXXXXXXXXXX""

" + "\n" +

@"}";

request.AddStringBody(body, DataFormat.Json);

RestResponse response = await client.ExecuteAsync(request);

Console.WriteLine(response.Content);

STATUS CHECK

QUERY PARAMETERS
Field Type Description
payout_refno String Unique Transaction Number

Body raw (json)

merchantId String The Uniqe Merchant ID Given in your portal
clientid String The Uniqe clientid Given in your portal
clientSecretKey String The Uniqe clientSecretKey Given in your portal

Response Example :

Success

{"response_code":"1","message":"Transaction Found","Status":"Success","rrn":"xxxxx","StatusDescription":"","accountnumber":"xxxx",
"ifsc":"xxx"}

Failed

{"response_code":"1","message":"Transaction Found","Status":"Refunded","rrn":"","StatusDescription":"INVALID ACCOUNT","accountnumber":"x3333",
"ifsc":"x3333"}

STATUS CHECK

var options = new RestClientOptions("https://api.nyobank.com")

{

MaxTimeout = -1,

};

var client = new RestClient(options);

var request = new RestRequest("/28Noyhkjh73/api/v1/endpoint/NyoBankStatusCheck?payout_refno=xxxxxxxxx", Method.Post);

request.AddHeader("Content-Type", "application/json");

var body = @"{

" + "\n" +

@" ""merchantId"": ""xxxxxxx"",

" + "\n" +

@" ""clientid"": ""xxxxxxxx-XXXX-XXXX-XXXX-XXXXXXXXXXXX"",

" + "\n" +

@" ""clientSecretKey"": ""XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX""

" + "\n" +

@"}";

request.AddStringBody(body, DataFormat.Json);

RestResponse response = await client.ExecuteAsync(request);

Console.WriteLine(response.Content);

GET BALANCE

QUERY PARAMETERS

Body raw (json)

merchantId String The Uniqe Merchant ID Given in your portal
clientid String The Uniqe clientid Given in your portal
clientSecretKey String The Uniqe clientSecretKey Given in your portal

Response Example :

{"status":"true","response_code":"1","message":"Record Fetched Successfully","balance":"xxxxxx"}

Check Balance

var options = new RestClientOptions("https://api.nyobank.com")

{

MaxTimeout = -1,

};

var client = new RestClient(options);

var request = new RestRequest("28Noyhkjh73/api/v1/endpoint/NyoBankGetbalance", Method.Post);

request.AddHeader("Content-Type", "application/json");

var body = @"{

" + "\n" +

@" ""merchantId"": ""xxxxxxx"",

" + "\n" +

@" ""clientid"": ""xxxxxxxx-XXXX-XXXX-XXXX-XXXXXXXXXXXX"",

" + "\n" +

@" ""clientSecretKey"": ""XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX""

" + "\n" +

@"}";

request.AddStringBody(body, DataFormat.Json);

RestResponse response = await client.ExecuteAsync(request);

Console.WriteLine(response.Content);

Dynamic Qr Endpoint Status Check

QUERY PARAMETERS
Field Type Description
payin_refno String Unique Transaction Number

Body raw (json)

merchantId String The Uniqe Merchant ID Given in your portal
clientid String The Uniqe clientid Given in your portal
clientSecretKey String The Uniqe clientSecretKey Given in your portal

Response Example :

Success

{"response_code":"1","message":"Transaction Found","Status":"Success","rrn":"xxxxx","StatusDescription":"",
"accountnumber":"xxxx","ifsc":"xxx"}

Failed

{"response_code":"1","message":"Transaction Found","Status":"Refunded","rrn":"","StatusDescription":"INVALID ACCOUNT","accountnumber":"x3333","ifsc":"x3333"}

STATUS CHECK

var options = new RestClientOptions("https://api.nyobank.com")

{

MaxTimeout = -1,

};

var client = new RestClient(options);

var request = new RestRequest("/28Noyhkjh73/api/v1/endpoint/NyoBankDynamicQRStatusCheck?payin_ref=xxxxxxxxx", Method.Post);

request.AddHeader("Content-Type", "application/json");

var body = @"{

" + "\n" +

@" ""merchantId"": ""xxxxxxx"",

" + "\n" +

@" ""clientid"": ""xxxxxxxx-XXXX-XXXX-XXXX-XXXXXXXXXXXX"",

" + "\n" +

@" ""clientSecretKey"": ""XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX""

" + "\n" +

@"}";

request.AddStringBody(body, DataFormat.Json);

RestResponse response = await client.ExecuteAsync(request);

Console.WriteLine(response.Content);

WEBHOOK RESPONSE

The Westeros API uses the following error codes:

Body raw (json)

Error Code Meaning
1 Transaction Success
2 Transaction Failed . If Transaction Failed Fail Immediate.

Response Example :

Success

{"status":"true","response_code":"1","message":"Transaction Successfull","payout_ref":"xxxxx","Amount":"xxxxx","rrn":"xxxx"}

Failed

{"status":"false","response_code":"2","message":"Transaction Failed","payout_ref":"xxxx"}

STATUS CHECK RESPONSE

The Westeros API uses the following error codes:

Body raw (json)

Error Code Meaning
1 Transaction Success
2 Transaction Failed Or Transaction Not Found. If Transaction Failed Fail Immediate else if Transaction Not Found Please Wait and hit api again in 30 minutes till u get the proper response of transaction.
Note : Consider only Failed / Success Response.