JAVA Library - Business SDK
Business SDK on JAVA
Description
Welcome to the user documentation for Card91BusinessSDK This package provides a set of awesome utility functions that can simplify and enhance your Java projects.
Prerequisites
Before you can run this project, you need to have the following prerequisites installed on your system:
- JAVA (version 1.8 or above)
- AWS configuration using Shared Access and Secret key, with region as ap-south-1 and default output as text (will be shared by card91)
- Export a CodeArtifact authorization token for authorization to your repository from your preferred shell.
The token expires in 12 hours.export CODEARTIFACT_AUTH_TOKEN=`aws codeartifact get-authorization-token --domain card91 --domain-owner 086908697371 --region ap-south-1 --query authorizationToken --output text` - For installing the AWS CLI please follow along the official documentation based type of OS used.
https://docs.aws.amazon.com/cli/latest/userguide/cli-authentication-user.html#cli-authentication-user-configure-wizard
Installation Steps for Gradle
1. build.gradle for gradle or pom.xml and setting.xml on .m2 location file for maven
Add below lines in your build.gradle file or pom and setting.xml for maven implementation
plugins {
id 'java'
}
// Replace Group Id and Version Id as per your project setup
group = '<Group Id>'
version = '<Version Id>'
def codeartifactToken = "aws codeartifact get-authorization-token --domain card91 --domain-owner 086908697371 --query authorizationToken --output text --profile default".execute().text
repositories {
maven {
url 'https://card91-086908697371.d.codeartifact.ap-south-1.amazonaws.com/maven/Card91-library-repo/'
credentials {
username "aws"
password codeartifactToken
}
}
}
dependencies {
implementation 'com.card91:Card91BusinessSDK:1.0.3' // Version will be confirmed by Card91
}
Step 1: Change directory to .m2 location using command
cd ~/.m2
Step 2: Check if settings.xml file is present or not
If absent, then create settings.xml file.
Add below code to settings.xml file.
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
https://maven.apache.org/xsd/settings-1.0.0.xsd">
<servers>
<server>
<id>codeartifact</id>
<username>aws</username>
<password>${env.CODEARTIFACT_AUTH_TOKEN}</password>
</server>
<!-- Add other servers as needed -->
</servers>
</settings>
Step 3: Save the settings.xml file and make sure the changes are reflecting in settings.xml file
Step 4: Execute below command to set token variable
export CODEARTIFACT_AUTH_TOKEN=$(aws codeartifact get-authorization-token --domain card91 --domain-owner 086908697371 --region ap-south-1 --query authorizationToken --output text)
Step 5: Check if token variable is set properly
echo $CODEARTIFACT_AUTH_TOKEN
Step 6: Add below lines to your pom.xml file
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>GROUP-ID</groupId>
<artifactId>ARTIFACT-ID</artifactId>
<version>VERSION-ID</version>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<repositories>
<repository>
<id>codeartifact</id>
<name>codeartifact</name>
<url>https://card91-086908697371.d.codeartifact.ap-south-1.amazonaws.com/maven/Card91-library-repo/</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>com.card91</groupId>
<artifactId>Card91BusinessSDK</artifactId>
<version>1.0.4</version>
</dependency>
</dependencies>
</project>
Step 7: Build the Project using below command
mvn clean install
settings.gradle or settings.xml for Maven
Add below lines at the top of your settings.gradle/settings.xml file
pluginManagement {
def codeartifactToken = "aws codeartifact get-authorization-token --domain card91 --domain-owner 086908697371 --query authorizationToken --output text --profile default".execute().text
repositories {
maven {
name 'Card91-library-repo'
url 'https://card91-086908697371.d.codeartifact.ap-south-1.amazonaws.com/maven/Card91-library-repo/'
credentials {
username 'aws'
password codeartifactToken
}
}
}
}
//Add your server to the list of servers to your settings.xml.
//settings.xml is typically found at ~/.m2/settings.xml. Adding the below snippet section allows Maven to pass the CODEARTIFACT_AUTH_TOKEN environment variable as a token in HTTP requests.
<servers>
<server>
<id>card91-Card91-library-repo</id>
<username>aws</username>
<password>${env.CODEARTIFACT_AUTH_TOKEN}</password>
</server>
</servers>
//Add a profile containing your repository to your settings.xml.
//You can use any value in the <id> element, but it must be the same in both the <server> element from Step 4 and the <repository> elements. This enables the specified credentials to be included in requests to CodeArtifact.
<profiles>
<profile>
<id>card91-Card91-library-repo</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<repositories>
<repository>
<id>card91-Card91-library-repo</id>
<url>https://card91-086908697371.d.codeartifact.ap-south-1.amazonaws.com/maven/Card91-library-repo/</url>
</repository>
</repositories>
</profile>
</profiles>
//(Optional) Set a mirror in your settings.xml that captures all connections and routes them to your repository instead of a public repository.
<mirrors>
<mirror>
<id>card91-Card91-library-repo</id>
<name>card91-Card91-library-repo</name>
<url>https://card91-086908697371.d.codeartifact.ap-south-1.amazonaws.com/maven/Card91-library-repo/</url>
<mirrorOf>*</mirrorOf>
</mirror>
</mirrors>
- Refresh gradle project using gradle clean build
API Documentation
This section provides details on the use of APIs, including sample requests and responses.
Usage :
The main function of this SDK allows you to retrieve card details by passing the card number and other details. This function returns the status code, header details, and the response data.
Use the method to integrate at places you want to use:
| Sr. No. | Method Name | Description |
|---|---|---|
| 1 | GetCardDetails | Use to fetch Card details |
| 2 | GetHolderDetails | Use to fetch Customer status |
| 3 | LoadMoneyToCard | Use to Load money to individual card |
| 4 | PrintCardDetails | Use to update card Details by its ID |
| 5 | MapCustomers | Use to Map insta kit to customer |
| 6 | ListAddresses | Use to Fetch customer addresses |
| 7 | GetOrgDetails | Use to fetch organisation details by org ID |
| 8 | WalletToWalletTransfer | Use to transfer amount within wallets |
| 9 | BulkCardLoad | Use to to bulk card load |
| 10 | GPRBulkUpload | Use to do GPR Bulk Upload |
| 11 | GetInstaKitInventory | Use to fetch Insta Kit Inventory |
| 12 | CreateInstaKitInventory | Use to create Insta Kit Inventory |
| 13 | GetGPRRecords | Use to fetch GPR records |
| 14 | GetBulkUploadTemplate | Use to fetch bulk upload template |
| 15 | GetOrgAccountLedgerReport | Use to fetch Org / Sub org Ledger Account report |
| 16 | GetExtendedOrgDetails | Use to fetch extended organisation details |
| 17 | GetGPRRecordsByBulkUploadID | Use to fetch fetch GPR records by Bulk upload ID |
| 18 | LinkWallet | Use to link wallet ids |
| 19 | UpdateCardHolderDetails | Use to Update CardHolder details |
Method 1: GetCardDetails
Description
- This method allows you to retrieve card details by its ID.
JsonObjects need to be passed in function as parameters to call the method.
- Required fields to call the function
- token (String, required): token needed for authorization.
- environment (String, required): name of environment. Eg. PROD in case of production environment and PROD_SANDBOX for production sandbox
- cardId (String, required): The ID of the card.
Sample Request
// Config creation
JsonObject config = new JsonObject();
config.put("environment", "PROD");//"PROD_SANDBOX" for production sandbox and "PROD" for production
config.put("token", "1J2kjOF65ZXXXXXXXXXXXy0PVngkhnQCbePsdEVc="); ///Business , // refer section 'Authentication with JWT'
// Payload creation
JsonObject payload = new JsonObject();
payload.put("cardId", "230530100608159ID1CARD5790474");
// Call function - getCardDetails
Card91BusinessSDK card91BusinessSDK = new Card91BusinessSDK();
card91BusinessSDK.getCardDetails(config, payload);
Sample Response
{
"status": 200,
"header": [
{
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"Content-Type": [
"application/json"
],
"Date": [
"Tue, 05 Sep 2023 11:49:17 GMT"
],
"Expires": [
"0"
],
"Pragma": [
"no-cache"
],
"Strict-Transport-Security": [
"max-age=31536000 ; includeSubDomains"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"X-Content-Type-Options": [
"nosniff"
],
"X-Frame-Options": [
"DENY"
],
"X-Xss-Protection": [
"1; mode=block"
]
}
],
"data": "{"id":"230530100608159ID1CARD5790474","customerId":"220629141431170ID1CUSTID9321576","nameOnCard":"surya","cardProgramId":"230528190350397ID1CP9723194","cardProgramName":"test","orgId":"230526135544169ID1OID4070270","orgDisplayName":"SDK Business","orgName":"SDK Business","cardMode":"PHYSICAL_NAMED_CARD","instakit":false,"last4Digit":"7915","createdBy":"","modifiedBy":"","expiredBy":"","modifiedTime":"","createdTime":"","status":"ACTIVE","cardImage":"","wallets":null,"cardFlags":null,"issuerCode":"NSDL","network":"RUPAY","addresses":null}"
}
Method 2: GetHolderDetails
Description
- This method allows you to retrieve holder details by its Mobile no.
JsonObjects need to be passed in function as parameters to call the method.
- Required fields to call the function
- token (string, required): Token needed for authorization.
- environment (string, required): The Name of the Environment.
- mobileNo (String, required): Mobile no of the user.
Sample Request
// Config creation
JsonObject config = new JsonObject();
config.put("environment", "PROD");//"PROD_SANDBOX" for production sandbox and "PROD" for production
config.put("token", "1J2kjOF65ZXXXXXXXXXXXy0PVngkhnQCbePsdEVc="); ///Business token , // refer section 'Authentication with JWT'
// Payload creation
JsonObject payload = new JsonObject();
payload.put("mobileNo", "917812381818");
// Call function - getCardHolderStatus
Card91BusinessSDK card91BusinessSDK = new Card91BusinessSDK();
card91BusinessSDK.getCardHolderStatus(config, payload);
Sample Response
{
"status": 200,
"header": [
{
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"Content-Type": [
"application/json"
],
"Date": [
"Tue, 05 Sep 2023 12:04:36 GMT"
],
"Expires": [
"0"
],
"Pragma": [
"no-cache"
],
"Strict-Transport-Security": [
"max-age=31536000 ; includeSubDomains"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"X-Content-Type-Options": [
"nosniff"
],
"X-Frame-Options": [
"DENY"
],
"X-Xss-Protection": [
"1; mode=block"
]
}
],
"data":{
"cardHolderId":"230719090829814ID1CUSTID8908902",
"name":"SDK Business",
"nameOnCard":"",
"email":"",
"mobile":"917812381818",
"status":"ACTIVE",
"createdAt":"",
"kycStatus":[],
"cards":[
{
"cardId":"230719090829847ID1CARD4118406",
"status":"INACTIVE",
"last4CardDigits":"0563",
"cardMode":"PHYSICAL_NAMED_CARD",
"cardImageUrl":"",
"orgId":"230526135544169ID1OID4070270",
"createdAt":"2023-07-19T09:08:31.000+00:00"
}
],
"addresses":null
}
}
Method 3: LoadMoneyToCard
Description
- This method allows you to Add funds to card by card id.
JsonObjects need to be passed in function as parameters to call the method.
- Required fields to call the function
- token (string, required): Token needed for authorization.
- environment (string, required): The Name of the Environment.
- refId (String, required): The reference Id of the card.
- cardId (String, required): The ID of the card.
- walletId (String, required): The wallet Id of the card.
- amount (String, required): Amount to be added.
Sample Request
// config creation
JsonObject config = new JsonObject();
config.put("environment", "PROD");//"PROD_SANDBOX" for production sandbox and "PROD" for production
config.put("token", "1J2kjOF65ZXXXXXXXXXXXy0PVngkhnQCbePsdEVc="); ///Business , // refer section 'Authentication with JWT'
// Wallet creation, similarily we can create multiple wallets
JSONObject jsonObjectWallet = new JSONObject();
jsonObjectWallet.put("walletId", "9188b4f-03594c1f-9e65-f53617317383");
jsonObjectWallet.put("amount", "10");
// Wallet Array creation to store multiple wallets
JSONArray walletsArray = new JSONArray();
walletsArray.put(jsonObjectWallet);
// Payload creation
JsonObject payload = new JsonObject();
payload.put("refId", "reftest02");
payload.put("cardId", "240515121252090ID1CARD6366593");
payload.put("wallets", walletsArray);
// Call function - loadFundToCard
Card91BusinessSDK card91BusinessSDK = new Card91BusinessSDK();
JSONObject response = card91BusinessSDK.loadFundToCard(config, payload);
Sample Response
{
"status": 200,
"header": [
{
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"Content-Type": [
"application/json"
],
"Date": [
"Thu, 07 Sep 2023 10:31:15 GMT"
],
"Expires": [
"0"
],
"Pragma": [
"no-cache"
],
"Strict-Transport-Security": [
"max-age=31536000 ; includeSubDomains"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"X-Content-Type-Options": [
"nosniff"
],
"X-Frame-Options": [
"DENY"
],
"X-Xss-Protection": [
"1; mode=block"
]
}
],
"data": {
"cardId": "230907065654635ID1CARD4992328",
"failedWallets": 0,
"refId": "Ref2875",
"successfulWallets": 1,
"wallets": [
{
"amount": "200",
"balance": "",
"walletId": "3eb460e3-d570-4803-b547-bb51d6724679"
}
]
}
}
Method 4: PrintCardDetails
Description
- This method allows you to update card Details by its ID.
JsonObjects need to be passed in function as parameters to call the method.
- Required fields to call the function
- token (string, required): Token needed for authorization.
- environment (string, required): The Name of the Environment.
- cardId (String, required): The ID of the card.
- nameOnCard (string, required): Card name.
- addressId (int, required): Address Id.
Sample Request
// config creation
JsonObject config = new JsonObject();
config.put("environment", "PROD");//"PROD_SANDBOX" for production sandbox and "PROD" for production
config.put("token", "1J2kjOF65ZXXXXXXXXXXXy0PVngkhnQCbePsdEVc="); ///Business , // refer section 'Authentication with JWT'
// Payload creation
JsonObject payload = new JsonObject();
payload.put("cardId", "2405151433415761CARD4399336");
payload.put("nameOnCard", "Surya Mishra");
payload.put("addressId", 9740);
// Call function - printCard
Card91BusinessSDK card91BusinessSDK = new Card91BusinessSDK();
JSONObject response = card91BusinessSDK.printCard(config, payload);
Sample Response
{
"status": 200,
"header": [
{
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"Content-Type": [
"application/json"
],
"Date": [
"Wed, 06 Sep 2023 08:29:21 GMT"
],
"Expires": [
"0"
],
"Pragma": [
"no-cache"
],
"Strict-Transport-Security": [
"max-age=31536000 ; includeSubDomains"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"X-Content-Type-Options": [
"nosniff"
],
"X-Frame-Options": [
"DENY"
],
"X-Xss-Protection": [
"1; mode=block"
]
}
],
"data": "{}"
}
Method 5: MapCustomers
Description
- This method allows you to map customers to a card .
JsonObjects need to be passed in function as parameters to call the method.
- Required fields to call the function
- token (string, required): Token needed for authorization.
- environment (string, required): The Name of the Environment.
- kitNumber (string, required): Kit Number.
- mobile (string, required): Mobile number.
- orgId (string, required): Organisation id.
- cardProgramId (string, required): Card Program Id.
Sample Request
// Config creation
JsonObject config = new JsonObject();
config.put("environment", "PROD");//"PROD_SANDBOX" for production sandbox and "PROD" for production
config.put("token", "1J2kjOF65ZXXXXXXXXXXXy0PVngkhnQCbePsdEVc="); ///Business , // refer section 'Authentication with JWT'
// Payload creation
JSONObject payload = new JSONObject();
payload.put("kitNumber", "240001788568");
payload.put("mobile", "919216467543");
payload.put("orgId", "240513101377725ID1OID9371856");
payload.put("cardProgramId", "240444121135336ID1CP0068109");
// Call function - mapCustomersToInstaKit
Card91BusinessSDK card91BusinessSDK = new Card91BusinessSDK();
JSONObject response = card91BusinessSDK.mapCustomersToInstaKit(config, payload);
Sample Response
{
"status": 200,
"header": [
{
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"Content-Type": [
"application/json"
],
"Date": [
"Tue, 05 Sep 2023 11:49:17 GMT"
],
"Expires": [
"0"
],
"Pragma": [
"no-cache"
],
"Strict-Transport-Security": [
"max-age=31536000 ; includeSubDomains"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"X-Content-Type-Options": [
"nosniff"
],
"X-Frame-Options": [
"DENY"
],
"X-Xss-Protection": [
"1; mode=block"
]
}
],
"data": "{"id":"230530100608159ID1CARD5790474","customerId":"220629141431170ID1CUSTID9321576","nameOnCard":"surya","cardProgramId":"230528190350397ID1CP9723194","cardProgramName":"test","orgId":"230526135544169ID1OID4070270","orgDisplayName":"SDK Business","orgName":"SDK Business","cardMode":"PHYSICAL_NAMED_CARD","instakit":false,"last4Digit":"7915","createdBy":"","modifiedBy":"","expiredBy":"","modifiedTime":"","createdTime":"","status":"ACTIVE","cardImage":"","wallets":null,"cardFlags":null,"issuerCode":"NSDL","network":"RUPAY","addresses":null}"
}
Method 6: ListAddresses
Description
- This method allows you to list addresses by customer id.
JsonObjects need to be passed in function as parameters to call the method.
- Required fields to call the function
- token (string, required): Token needed for authorization.
- environment (string, required): The Name of the Environment.
- customerId (String, required): Customer ID.
Sample Request
// config creation
JsonObject config = new JsonObject();
config.put("environment", "PROD");//"PROD_SANDBOX" for production sandbox and "PROD" for production
config.put("token", "1J2kjOF65ZXXXXXXXXXXXy0PVngkhnQCbePsdEVc="); ///Business , // refer section 'Authentication with JWT'
// Payload creation
JsonObject payload = new JsonObject();
payload.put("customerId", "240515121252090ID1CARD646593");
// Call function - listAddress
Card91BusinessSDK card91BusinessSDK = new Card91BusinessSDK();
JSONObject response = card91BusinessSDK.listAddress(config, payload);
Sample Response
{
"status": 200,
"header": [
{
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"Content-Type": [
"application/json"
],
"Date": [
"Wed, 06 Sep 2023 08:35:40 GMT"
],
"Expires": [
"0"
],
"Pragma": [
"no-cache"
],
"Strict-Transport-Security": [
"max-age=31536000 ; includeSubDomains"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"X-Content-Type-Options": [
"nosniff"
],
"X-Frame-Options": [
"DENY"
],
"X-Xss-Protection": [
"1; mode=block"
]
}
],
"data": "{"addresses":[{"createdTime":"2022-06-29T14:14:31.000+0000","createdBy":"20220119MPADMIN001","modifiedTime":null,"modifiedBy":null,"id":8313,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"PENDING","address1":"wrwer","address2":"wer","landmark":"wer","city":"bangalore","countryISOCode":"IND","pinCode":"560103","state":"karnataka","latitude":0.0,"longitude":0.0},{"createdTime":"2022-07-01T05:50:06.000+0000","createdBy":"20220119MPADMIN001","modifiedTime":null,"modifiedBy":null,"id":8416,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"PENDING","address1":"addressLine1 is mandatory","address2":"Street / Area","landmark":"Flat","city":"bangalore","countryISOCode":"IND","pinCode":"614804","state":"KA","latitude":0.0,"longitude":0.0},{"createdTime":"2023-05-09T11:07:30.000+0000","createdBy":"221129084538831ID1UID7577402","modifiedTime":null,"modifiedBy":null,"id":19461,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"PENDING","address1":"4444","address2":"","landmark":"","city":"banglore","countryISOCode":"IND","pinCode":"897876","state":"karnataka","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-01T10:46:05.000+0000","createdBy":"230714102428729ID1UID0083499","modifiedTime":"2023-08-01T10:46:05.000+0000","modifiedBy":"230714102428729ID1UID0083499","id":21130,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Bangalore","countryISOCode":"IND","pinCode":"560102","state":"KARNATAKA","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-01T13:36:10.000+0000","createdBy":"230714102428729ID1UID0083499","modifiedTime":"2023-08-01T13:36:10.000+0000","modifiedBy":"230714102428729ID1UID0083499","id":21131,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Bangalore","countryISOCode":"IND","pinCode":"560102","state":"KARNATAKA","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-03T14:38:54.000+0000","createdBy":"230714102428729ID1UID0083499","modifiedTime":"2023-08-03T14:38:54.000+0000","modifiedBy":"230714102428729ID1UID0083499","id":21146,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Chennai","countryISOCode":"IND","pinCode":"560102","state":"TamilNadu","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-03T14:44:59.000+0000","createdBy":"230714102428729ID1UID0083499","modifiedTime":"2023-08-03T14:44:59.000+0000","modifiedBy":"230714102428729ID1UID0083499","id":21147,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Chennai","countryISOCode":"IND","pinCode":"560102","state":"TamilNadu","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-04T07:34:55.000+0000","createdBy":"230714102428729ID1UID0083499","modifiedTime":"2023-08-04T07:34:55.000+0000","modifiedBy":"230714102428729ID1UID0083499","id":21148,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Chennai","countryISOCode":"IND","pinCode":"560102","state":"TamilNadu","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-04T08:34:11.000+0000","createdBy":"230714102428729ID1UID0083499","modifiedTime":"2023-08-04T08:34:11.000+0000","modifiedBy":"230714102428729ID1UID0083499","id":21149,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Chennai","countryISOCode":"IND","pinCode":"560102","state":"TamilNadu","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-06T13:32:16.000+0000","createdBy":"230714102428729ID1UID0083499","modifiedTime":"2023-08-06T13:32:16.000+0000","modifiedBy":"230714102428729ID1UID0083499","id":21151,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Chennai","countryISOCode":"IND","pinCode":"560102","state":"TamilNadu","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-06T13:48:47.000+0000","createdBy":"230714102428729ID1UID0083499","modifiedTime":"2023-08-06T13:48:47.000+0000","modifiedBy":"230714102428729ID1UID0083499","id":21152,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Chennai","countryISOCode":"IND","pinCode":"560102","state":"TamilNadu","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-06T14:04:18.000+0000","createdBy":"230714102428729ID1UID0083499","modifiedTime":"2023-08-06T14:04:18.000+0000","modifiedBy":"230714102428729ID1UID0083499","id":21153,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Chennai","countryISOCode":"IND","pinCode":"560102","state":"TamilNadu","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-07T07:03:28.000+0000","createdBy":"230714102428729ID1UID0083499","modifiedTime":"2023-08-07T07:03:28.000+0000","modifiedBy":"230714102428729ID1UID0083499","id":21157,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Chennai","countryISOCode":"IND","pinCode":"560102","state":"TamilNadu","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-07T07:24:44.000+0000","createdBy":"220527121332484ID1UID2364006","modifiedTime":"2023-08-07T07:24:44.000+0000","modifiedBy":"220527121332484ID1UID2364006","id":21158,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Chennai","countryISOCode":"IND","pinCode":"560102","state":"TamilNadu","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-09T10:22:33.000+0000","createdBy":"220527121332484ID1UID2364006","modifiedTime":"2023-08-09T10:22:33.000+0000","modifiedBy":"220527121332484ID1UID2364006","id":21190,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Chennai","countryISOCode":"IND","pinCode":"560102","state":"TamilNadu","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-10T07:01:26.000+0000","createdBy":"220527121332484ID1UID2364006","modifiedTime":"2023-08-10T07:01:26.000+0000","modifiedBy":"220527121332484ID1UID2364006","id":21203,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Chennai","countryISOCode":"IND","pinCode":"560102","state":"TamilNadu","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-16T05:51:25.000+0000","createdBy":"220527121332484ID1UID2364006","modifiedTime":"2023-08-16T05:51:25.000+0000","modifiedBy":"220527121332484ID1UID2364006","id":21273,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Chennai","countryISOCode":"IND","pinCode":"560102","state":"TamilNadu","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-16T18:33:07.000+0000","createdBy":"230714102428729ID1UID0083499","modifiedTime":"2023-08-16T18:33:07.000+0000","modifiedBy":"230714102428729ID1UID0083499","id":21296,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Chennai","countryISOCode":"IND","pinCode":"560102","state":"TamilNadu","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-17T02:41:55.000+0000","createdBy":"230714102428729ID1UID0083499","modifiedTime":"2023-08-17T02:41:55.000+0000","modifiedBy":"230714102428729ID1UID0083499","id":21297,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Chennai","countryISOCode":"IND","pinCode":"560102","state":"TamilNadu","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-17T02:43:20.000+0000","createdBy":"230714102428729ID1UID0083499","modifiedTime":"2023-08-17T02:43:20.000+0000","modifiedBy":"230714102428729ID1UID0083499","id":21298,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Chennai","countryISOCode":"IND","pinCode":"560102","state":"TamilNadu","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-18T10:18:06.000+0000","createdBy":"221129084538831ID1UID7577402","modifiedTime":null,"modifiedBy":null,"id":21319,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"PENDING","address1":"444","address2":"","landmark":"","city":"Banglore","countryISOCode":"IND","pinCode":"456738","state":"Karnataka","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-18T13:36:58.000+0000","createdBy":"230714102428729ID1UID0083499","modifiedTime":"2023-08-18T13:36:58.000+0000","modifiedBy":"230714102428729ID1UID0083499","id":21326,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Chennai","countryISOCode":"IND","pinCode":"560102","state":"TamilNadu","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-24T06:29:45.000+0000","createdBy":"20220119MPADMIN001","modifiedTime":"2023-08-24T06:29:45.000+0000","modifiedBy":"20220119MPADMIN001","id":21420,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Bangalore","countryISOCode":"IND","pinCode":"560102","state":"KARNATAKA","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-28T06:59:06.000+0000","createdBy":"20220119MPADMIN001","modifiedTime":"2023-08-28T06:59:06.000+0000","modifiedBy":"20220119MPADMIN001","id":21490,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Bangalore","countryISOCode":"IND","pinCode":"560102","state":"KARNATAKA","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-28T07:01:05.000+0000","createdBy":"20220119MPADMIN001","modifiedTime":"2023-08-28T07:01:05.000+0000","modifiedBy":"20220119MPADMIN001","id":21491,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Bangalore","countryISOCode":"IND","pinCode":"560102","state":"KARNATAKA","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-28T07:04:19.000+0000","createdBy":"20220119MPADMIN001","modifiedTime":"2023-08-28T07:04:19.000+0000","modifiedBy":"20220119MPADMIN001","id":21492,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Bangalore","countryISOCode":"IND","pinCode":"560102","state":"KARNATAKA","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-28T07:18:32.000+0000","createdBy":"20220119MPADMIN001","modifiedTime":"2023-08-28T07:18:32.000+0000","modifiedBy":"20220119MPADMIN001","id":21497,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Bangalore","countryISOCode":"IND","pinCode":"560102","state":"KARNATAKA","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-28T07:23:27.000+0000","createdBy":"20220119MPADMIN001","modifiedTime":"2023-08-28T07:23:27.000+0000","modifiedBy":"20220119MPADMIN001","id":21499,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Bangalore","countryISOCode":"IND","pinCode":"560102","state":"KARNATAKA","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-28T07:23:56.000+0000","createdBy":"20220119MPADMIN001","modifiedTime":"2023-08-28T07:23:56.000+0000","modifiedBy":"20220119MPADMIN001","id":21500,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Bangalore","countryISOCode":"IND","pinCode":"560102","state":"KARNATAKA","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-28T07:24:41.000+0000","createdBy":"20220119MPADMIN001","modifiedTime":"2023-08-28T07:24:41.000+0000","modifiedBy":"20220119MPADMIN001","id":21501,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Bangalore","countryISOCode":"IND","pinCode":"560102","state":"KARNATAKA","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-28T07:25:19.000+0000","createdBy":"20220119MPADMIN001","modifiedTime":"2023-08-28T07:25:19.000+0000","modifiedBy":"20220119MPADMIN001","id":21502,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Bangalore","countryISOCode":"IND","pinCode":"560102","state":"KARNATAKA","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-28T07:25:55.000+0000","createdBy":"20220119MPADMIN001","modifiedTime":"2023-08-28T07:25:55.000+0000","modifiedBy":"20220119MPADMIN001","id":21503,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Bangalore","countryISOCode":"IND","pinCode":"560102","state":"KARNATAKA","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-28T07:26:27.000+0000","createdBy":"20220119MPADMIN001","modifiedTime":"2023-08-28T07:26:27.000+0000","modifiedBy":"20220119MPADMIN001","id":21504,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Bangalore","countryISOCode":"IND","pinCode":"560102","state":"KARNATAKA","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-28T07:27:34.000+0000","createdBy":"20220119MPADMIN001","modifiedTime":"2023-08-28T07:27:34.000+0000","modifiedBy":"20220119MPADMIN001","id":21505,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Bangalore","countryISOCode":"IND","pinCode":"560102","state":"KARNATAKA","latitude":0.0,"longitude":0.0},{"createdTime":"2023-08-28T10:31:23.000+0000","createdBy":"20220119MPADMIN001","modifiedTime":"2023-08-28T10:31:23.000+0000","modifiedBy":"20220119MPADMIN001","id":21515,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Bangalore","countryISOCode":"IND","pinCode":"560102","state":"KARNATAKA","latitude":0.0,"longitude":0.0},{"createdTime":"2023-09-04T10:52:59.000+0000","createdBy":"230714102428729ID1UID0083499","modifiedTime":"2023-09-04T10:52:59.000+0000","modifiedBy":"230714102428729ID1UID0083499","id":21689,"entityId":"220629141431170ID1CUSTID9321576","entityType":"CUST","addressType":"DELIVERY_ADDRESS","status":"ACTIVE","address1":"1142,card91 6th main road, sector 7","address2":"Hsr layout","landmark":null,"city":"Bangalore","countryISOCode":"IND","pinCode":"560102","state":"KARNATAKA","latitude":0.0,"longitude":0.0}]}"
}
Method 7: Get Org Details
Description
- This method allows you to Get organisation details by org ID.
JsonObjects need to be passed in function as parameters to call the method.
- Required fields to call the function
- token (string, required): Token needed for authorization.
- environment (string, required): The Name of the Environment.
- orgId (String, required): Organisation ID.
Sample Request
// config creation
JsonObject config = new JsonObject();
config.put("environment", "PROD");//"PROD_SANDBOX" for production sandbox and "PROD" for production
config.put("token", "1J2kjOF65ZXXXXXXXXXXXy0PVngkhnQCbePsdEVc"); ///Business token , // refer section 'Authentication with JWT'
// Payload creation
JsonObject payload = new JsonObject();
payload.put("orgId", "240515121252646593");
// Call function - getOrgDetails
Card91BusinessSDK card91BusinessSDK = new Card91BusinessSDK();
JSONObject response = card91BusinessSDK.getOrgDetails(config, payload);
Sample Response
{
"Status": 200,
"Headers": {
"Transfer-Encoding": [
"chunked"
],
"X-Frame-Options": [
"DENY"
],
"Strict-Transport-Security": [
"max-age=31536000 ; includeSubDomains"
],
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"X-Content-Type-Options": [
"nosniff"
],
"X-Xss-Protection": [
"1; mode=block"
],
"Connection": [
"keep-alive"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"Expires": [
"0"
],
"Pragma": [
"no-cache"
],
"Date": [
"Mon, 03 Jun 2024 07:11:53 GMT"
],
"Content-Type": [
"application/json"
]
},
"Data": {
"org": {
"orgCategory": "BUSINESS",
"addresses": [
{
"pincode": "312312",
"address2": "asdasdadsa",
"city": "Bangalore",
"addressType": "REGISTERED_ADDRESS",
"address1": "asdasdad",
"countryISOCode": "IND",
"id": 9678,
"state": "Karnataka",
"issuerCode": "NSDL",
"landmark": "dasdsadasdas",
"status": "ACTIVE"
}
],
"van": [
{
"van": "MONEPKB240513101496",
"accountName": null,
"accountType": "Current",
"ifsccode": "NSDLB0CMSNOC",
"issuer": "NSDL",
"status": null
}
],
"documents": [],
"totalBalance": "1000.0000",
"displayName": "NSDL Please",
"cardCount": 15,
"issuerDetailsList": [
{
"orgCategory": "BUSINESS",
"issuerAccountIfsc": "NSDLB0212122",
"issuerName": "NSDL",
"displayName": "NSDL Please",
"name": "NSDL Please",
"description": "NSDL Please",
"orgIssuerMapStatus": "ACTIVE",
"issuerCode": "NSDL",
"issuerAccountNumber": "9873187648912",
"businessType": "PRIVATE",
"currencyCode": "INR"
}
],
"authoritySignatory": {
"mobile": "919391284910",
"name": "Raj Mohan",
"id": "240513101332537ID1UID5336944",
"type": "ORG_ADMIN",
"email": "[email protected]"
},
"orgStatus": "ACTIVE",
"adminCount": 3,
"name": "NSDL Please",
"id": "240513101332525ID1OID9371856",
"balanceList": [
{
"balance": "1000.0000",
"issuer": "NSDL"
}
],
"parentOrg": null,
"businessType": "PRIVATE"
}
}
}
Method 8: Wallet To Wallet Transfer
Description
- This method allows you to transfer amount to different wallets.
JsonObjects need to be passed in function as parameters to call the method.
- Required fields to call the function
- token (string, required): Token needed for authorization.
- environment (string, required): The Name of the Environment.
- cardId (String, required): The ID of the card.
- debitWalletId (String, required): Debit ID of the Wallet.
- creditWalletId (String, required): Credit ID of the Wallet.
- amount (String, required): Amount which needs to be transferred.
- narration (String, optional) : Narration of the transfer.
Sample Request
// config creation
JsonObject config = new JsonObject();
config.put("environment", "PROD");//"PROD_SANDBOX" for production sandbox and "PROD" for production
config.put("token", "1J2kjOF65ZXXXXXXXXXXXy0PVngkhnQCbePsdEVc");///Business token , // refer section 'Authentication with JWT'
// Payload creation
JsonObject payload = new JsonObject();
payload.put("cardId", "240522318079ID1CARD7347772"); // Card Id
payload.put("debitWalletId", "e23df686-e3-4281-ab9d-5f8127239a10");
payload.put("creditWalletId", "844d4665-f9-432a-b50a-05048d3dd131");
payload.put("amount", "10");
payload.put("narration", "PB_year_end_closure");
// Call function - walletToWalletTransfer
Card91BusinessSDK card91BusinessSDK = new Card91BusinessSDK();
JSONObject response = card91BusinessSDK.walletToWalletTransfer(config, payload);
Sample Response
{
"Status": 200,
"Headers": {
"Transfer-Encoding": [
"chunked"
],
"X-Frame-Options": [
"DENY"
],
"Strict-Transport-Security": [
"max-age=31536000 ; includeSubDomains"
],
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"X-Content-Type-Options": [
"nosniff"
],
"X-Xss-Protection": [
"1; mode=block"
],
"Connection": [
"keep-alive"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"Expires": [
"0"
],
"Pragma": [
"no-cache"
],
"Date": [
"Mon, 03 Jun 2024 07:17:45 GMT"
],
"Content-Type": [
"application/json"
]
},
"Data": {}
}
Method 9: Bulk Card Load
Description
- This method allows you to bulk card load.
JsonObjects need to be passed in function as parameters to call the method.
- Required fields to call the function
- token (string, required): Token needed for authorization.
- environment (string, required): The Name of the Environment.
- cardProgramId (String, required): Card Program ID.
- orgId (String, required): Organisation ID.
- file (File, required): File for bulk card load. (file used here should be less than 1MB and in .csv format)
Sample Request
// config creation
JsonObject config = new JsonObject();
config.put("environment", "PROD");//"PROD_SANDBOX" for production sandbox and "PROD" for production
config.put("token", "1J2kjOF65ZXXXXXXXXXXXy0PVngkhnQCbePsdEVc");///Business token , // refer section 'Authentication with JWT'
// Payload creation
JSONObject payload = new JSONObject();
payload.put("cardProgramId", "24051135336ID1CP0068109");
payload.put("orgId", "24051332525ID1OID9371856");
// Call function - bulkCardLoad
Card91BusinessSDK card91BusinessSDK = new Card91BusinessSDK();
JSONObject response = card91BusinessSDK.bulkCardLoad(config, payload, new File(<File_Path>));
Sample Response
{
"Status": 200,
"Headers": {
"Transfer-Encoding": [
"chunked"
],
"X-Frame-Options": [
"DENY"
],
"Strict-Transport-Security": [
"max-age=31536000 ; includeSubDomains"
],
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"X-Content-Type-Options": [
"nosniff"
],
"X-Xss-Protection": [
"1; mode=block"
],
"Connection": [
"keep-alive"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"Expires": [
"0"
],
"Pragma": [
"no-cache"
],
"Date": [
"Mon, 03 Jun 2024 07:27:12 GMT"
],
"Content-Type": [
"application/json"
]
},
"Data": {
"failedCount": 0,
"failedRecords": "https://card91-stag-docs.s3.ap-south-1.amazonaws.com/?response-content-disposition=attachment%3B%20filename%3D%22bulk_card_loadnull.csv%22&response-content-type=application%2Fcsv&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240603T072712Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIARIPBJPMN5T4K3APU%2F20240603%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Signature=ce374f6731e5ed449e6d0e975f3ad0a5c157d3558c88c6dfc6ac4adff4073554",
"successCount": 1,
"totalRows": 1,
"bulkUploadId": "240603072711068ID1BULK8644080"
}
}
Method 10: GPR Bulk Upload
Description
- This method allows you to do GPR Bulk Upload.
JsonObjects need to be passed in function as parameters to call the method.
- Required fields to call the function
- token (string, required): Token needed for authorization.
- environment (string, required): The Name of the Environment.
- file (File, required): File for GPR bulk upload.
Sample Request
// config creation
JsonObject config = new JsonObject();
config.put("environment", "PROD");//"PROD_SANDBOX" for production sandbox and "PROD" for production
config.put("token", "1J2kjOF65ZXXXXXXXXXXXy0PVngkhnQCbePsdEVc");///Business token , // refer section 'Authentication with JWT'
// Call function - gprBulkUpload
Card91BusinessSDK card91BusinessSDK = new Card91BusinessSDK();
JSONObject response = card91BusinessSDK.gprBulkUpload(config, new File(<File_Path>));
Sample Response
{
"Status": 200,
"Headers": {
"Transfer-Encoding": [
"chunked"
],
"X-Frame-Options": [
"DENY"
],
"Strict-Transport-Security": [
"max-age=31536000 ; includeSubDomains"
],
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"X-Content-Type-Options": [
"nosniff"
],
"X-Xss-Protection": [
"1; mode=block"
],
"Connection": [
"keep-alive"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"Expires": [
"0"
],
"Pragma": [
"no-cache"
],
"Date": [
"Mon, 03 Jun 2024 07:31:45 GMT"
],
"Content-Type": [
"application/json"
]
},
"Data": {
"message": "Cards creation in progress",
"bulkUploadId": "240603073145321ID1BULK4563222",
"status": "IN_PROGRESS"
}
}
Method 11: Get Insta Kit Inventory
Description
- This method allows you to get Insta Kit Inventory.
JsonObjects need to be passed in function as parameters to call the method.
- Required fields to call the function
- token (string, required): Token needed for authorization.
- environment (string, required): The Name of the Environment.
- orgId (String, optional): The organisation Id.
Sample Request
// config creation
JsonObject config = new JsonObject();
config.put("environment", "PROD");//"PROD_SANDBOX" for production sandbox and "PROD" for production
config.put("token", "1J2kjOF65ZXXXXXXXXXXXy0PVngkhnQCbePsdEVc");///Business token , // refer section 'Authentication with JWT'
// payload creation if orgId params reuiqred
JsonObject payload = new JsonObject();
payload.put("orgId", "ghdj673g373g373gghf83g");
OR
// Pass new JsonObject() as payload when orgId is not required.
// Call function - getInstaKitInventory
Card91BusinessSDK card91BusinessSDK = new Card91BusinessSDK();
JSONObject response = card91BusinessSDK.getInstaKitInventory(config, payload);
Sample Response
{
"recordsCurrentPage": 10,
"currentPage": 1,
"totalPages": 1,
"totalRecords": 10,
"instakitRequestList": [
{
"id": "240530122959140ID1INSTA-REQ1702088",
"orgName": "Kaci Kerluke",
"orgDisplayName": "Raina Kiehn",
"groupName": "YE RUPAY",
"kitQuantity": 20,
"deliverToUserName": "CARD ADMIN",
"address": {
"addressLine1": "Veniam sed",
"addressLine2": "Laudantium",
"city": "Lake Elsinored",
"state": "Florida",
"pinCode": "988371"
},
"status": "PENDING",
"courier": null,
"trackingNumber": null,
"createdAt": "2024-05-30T12:29:59.000+00:00",
"updatedAt": "2024-05-30T12:29:59.000+00:00"
},
{
"id": "240530122912641ID1INSTA-REQ2300540",
"orgName": "Kaci Kerluke",
"orgDisplayName": "Raina Kiehn",
"groupName": "YE RUPAY",
"kitQuantity": 25,
"deliverToUserName": "Audrey Cruickshank",
"address": {
"addressLine1": "Veniam sed",
"addressLine2": "Laudantium",
"city": "Lake Elsinored",
"state": "Florida",
"pinCode": "988371"
},
"status": "PENDING",
"courier": null,
"trackingNumber": null,
"createdAt": "2024-05-30T12:29:13.000+00:00",
"updatedAt": "2024-05-30T12:29:13.000+00:00"
},
{
"id": "240530052417703ID1INSTA-REQ8349230",
"orgName": "Kaci Kerluke",
"orgDisplayName": "Raina Kiehn",
"groupName": "YE RUPAY",
"kitQuantity": 25,
"deliverToUserName": "CARD ADMIN",
"address": {
"addressLine1": "111",
"addressLine2": "111",
"city": "Bengaluru",
"state": "Karnataka",
"pinCode": "345678"
},
"status": "APPROVED",
"courier": null,
"trackingNumber": null,
"createdAt": "2024-05-30T05:24:18.000+00:00",
"updatedAt": "2024-05-30T09:45:43.000+00:00"
},
{
"id": "240530052154238ID1INSTA-REQ6677100",
"orgName": "Kaci Kerluke",
"orgDisplayName": "Raina Kiehn",
"groupName": "YE RUPAY",
"kitQuantity": 25,
"deliverToUserName": "CARD ADMIN",
"address": {
"addressLine1": "111",
"addressLine2": "111",
"city": "Bengaluru",
"state": "Karnataka",
"pinCode": "345678"
},
"status": "APPROVED",
"courier": null,
"trackingNumber": null,
"createdAt": "2024-05-30T05:21:54.000+00:00",
"updatedAt": "2024-06-03T06:03:35.000+00:00"
},
{
"id": "240530050620319ID1INSTA-REQ3854654",
"orgName": "Kaci Kerluke",
"orgDisplayName": "Raina Kiehn",
"groupName": "YE RUPAY",
"kitQuantity": 25,
"deliverToUserName": "CARD ADMIN",
"address": {
"addressLine1": "111",
"addressLine2": "111",
"city": "Bengaluru",
"state": "Karnataka",
"pinCode": "345678"
},
"status": "PENDING",
"courier": null,
"trackingNumber": null,
"createdAt": "2024-05-30T05:06:20.000+00:00",
"updatedAt": "2024-05-30T05:06:20.000+00:00"
},
{
"id": "240529053841259ID1INSTA-REQ6212765",
"orgName": "Kaci Kerluke",
"orgDisplayName": "Raina Kiehn",
"groupName": "YE RUPAY",
"kitQuantity": 25,
"deliverToUserName": "CARD ADMIN",
"address": {
"addressLine1": "111",
"addressLine2": "111",
"city": "Bengaluru",
"state": "Karnataka",
"pinCode": "345678"
},
"status": "APPROVED",
"courier": null,
"trackingNumber": null,
"createdAt": "2024-05-29T05:38:41.000+00:00",
"updatedAt": "2024-05-30T05:02:58.000+00:00"
},
{
"id": "240528123055912ID1INSTA-REQ7990320",
"orgName": "Kaci Kerluke",
"orgDisplayName": "Raina Kiehn",
"groupName": "YE RUPAY",
"kitQuantity": 25,
"deliverToUserName": "CARD ADMIN",
"address": {
"addressLine1": "111",
"addressLine2": "111",
"city": "Bengaluru",
"state": "Karnataka",
"pinCode": "345678"
},
"status": "APPROVED",
"courier": null,
"trackingNumber": null,
"createdAt": "2024-05-28T12:30:56.000+00:00",
"updatedAt": "2024-05-28T13:13:08.000+00:00"
},
{
"id": "240528113243264ID1INSTA-REQ2562673",
"orgName": "Kaci Kerluke",
"orgDisplayName": "Raina Kiehn",
"groupName": "YE RUPAY",
"kitQuantity": 25,
"deliverToUserName": "CARD ADMIN",
"address": {
"addressLine1": "111",
"addressLine2": "111",
"city": "Bengaluru",
"state": "Karnataka",
"pinCode": "345678"
},
"status": "PENDING",
"courier": null,
"trackingNumber": null,
"createdAt": "2024-05-28T11:32:43.000+00:00",
"updatedAt": "2024-05-28T11:32:43.000+00:00"
},
{
"id": "240528113050913ID1INSTA-REQ8412412",
"orgName": "Kaci Kerluke",
"orgDisplayName": "Raina Kiehn",
"groupName": "YE RUPAY",
"kitQuantity": 20,
"deliverToUserName": "Audrey Cruickshank",
"address": {
"addressLine1": "14th North Carolina Street",
"addressLine2": "14th North Carolina Street",
"city": "JAIPUR",
"state": "Kashmir",
"pinCode": "560071"
},
"status": "PENDING",
"courier": null,
"trackingNumber": null,
"createdAt": "2024-05-28T11:30:51.000+00:00",
"updatedAt": "2024-05-28T11:30:51.000+00:00"
},
{
"id": "240528105403476ID1INSTA-REQ1732452",
"orgName": "Kaci Kerluke",
"orgDisplayName": "Raina Kiehn",
"groupName": "YE RUPAY",
"kitQuantity": 100,
"deliverToUserName": "Audrey Cruickshank",
"address": {
"addressLine1": "111",
"addressLine2": "111",
"city": "Bengaluru",
"state": "Karnataka",
"pinCode": "345678"
},
"status": "PENDING",
"courier": null,
"trackingNumber": null,
"createdAt": "2024-05-28T10:54:03.000+00:00",
"updatedAt": "2024-05-28T10:54:03.000+00:00"
}
]
}
Method 12: Create Insta Kit Inventory
Description
- This method allows you to create insta kit inventory.
JsonObjects need to be passed in function as parameters to call the method.
- Required fields to call the function
- token (string, required): Token needed for authorization.
- environment (string, required): The Name of the Environment.
- adminAddressId (String, required): Admin Address ID.
- adminId (String, required): Admin ID.
- orgId (String, required): Organisation ID.
- cardProgramId (String, required): Card program ID.
- kitsQuantity (Integer, required): Kits Quantity.
Sample Request
// config creation
JsonObject config = new JsonObject();
config.put("environment", "PROD");//"PROD_SANDBOX" for production sandbox and "PROD" for production
config.put("token", "1J2kjOF65ZXXXXXXXXXXXy0PVngkhnQCbePsdEVc");///Business token , // refer section 'Authentication with JWT'
// Payload creation
JSONObject payload = new JSONObject();
payload.put("adminAddressId", "26353");
payload.put("adminId", "240520091740960D5415440");
payload.put("orgId", "2405200917409OID6532640");
payload.put("cardProgramId", "240520121869ID1CP7582965");
payload.put("kitsQuantity", 35);
// Call function - createInstaKitInventory
Card91BusinessSDK card91BusinessSDK = new Card91BusinessSDK();
JSONObject response = card91BusinessSDK.createInstaKitInventory(config, payload);
Sample Response
{
"Status": 200,
"Headers": {
"Transfer-Encoding": [
"chunked"
],
"X-Frame-Options": [
"DENY"
],
"Strict-Transport-Security": [
"max-age=31536000 ; includeSubDomains"
],
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"X-Content-Type-Options": [
"nosniff"
],
"X-Xss-Protection": [
"1; mode=block"
],
"Connection": [
"keep-alive"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"Expires": [
"0"
],
"Pragma": [
"no-cache"
],
"Date": [
"Mon, 03 Jun 2024 06:22:54 GMT"
],
"Content-Type": [
"application/json"
]
},
"Data": {
"message": "Instakit request in progress"
}
}
Method 13: Get GPR records
Description
- This method allows you to fetch GPR records.
JsonObjects need to be passed in function as parameters to call the method.
- Required fields to call the function
- token (string, required): Token needed for authorization.
- environment (string, required): The Name of the Environment.
- cardType (String, required): The Card Type.
- page (String, optional): Page Number.
- perPage (String, optional): Per Page records.
- from (String, optional): From date.
- to (String, optional): To date.
Sample Request
JsonObject config = new JSONObject();
config.put("environment", "PROD");
config.put("token", "XvJ1AFlJDltAth/Ljp3rLrqKjaedBC+/JK4ezaU=");
// Payload creation
JSONObject payload = new JSONObject();
payload.put("cardType", "GPR");
// Optional Payload fields
payload.put("page", "1");
payload.put("perPage", "20");
payload.put("from", "2024-06-05");
payload.put("to", "2024-08-05");
// Call function - getGPRRecords
Card91BusinessSDK card91BusinessSDK = new Card91BusinessSDK();
JSONObject response = card91BusinessSDK.getGPRRecords(config, payload);
Sample Response
{
"Status": 200,
"Headers": {
"Transfer-Encoding": [
"chunked"
],
"X-Frame-Options": [
"DENY"
],
"Strict-Transport-Security": [
"max-age=31536000 ; includeSubDomains"
],
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"X-Content-Type-Options": [
"nosniff"
],
"X-Xss-Protection": [
"1; mode=block"
],
"Connection": [
"keep-alive"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"Expires": [
"0"
],
"Pragma": [
"no-cache"
],
"Date": [
"Mon, 03 Jun 2024 06:59:34 GMT"
],
"Content-Type": [
"application/json"
]
},
"Data": {
"recordsCurrentPage": 25,
"totalRecords": 259,
"totalPages": 11,
"bulkUploadCardsDisplayPojos": [
{
"uploadedCSV": "https://card91-stag-docs.s3.ap-south-1.amazonaws.com/SANDBOX/bulkCards/240530130802952ID1FILE7945960/upload?response-content-disposition=attachment%3B%20filename%3D%22bulk_upload_cards_SANDBOX%2FbulkCards%2F240530130802952ID1FILE7945960%2Fupload.csv%22&response-content-type=application%2Fcsv&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240603T065934Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIARIPBJPMN5T4K3APU%2F20240603%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Signature=487bd3bb46afd82c2375853c242fabed807a6ff648bdcd279b945dee3dd8e910",
"cardsNotCreated": 0,
"uploadedFileName": "PPI_Card_Bulk_Upload_Business_SDK.csv",
"cardsCreatedSuccessfully": 10,
"failedCardsCSVFileName": null,
"uploadedByMobile": "917739737997",
"uploadTime": "2024-05-30T13:08:03.000+00:00",
"uploadedByName": "CARD ADMIN",
"version": 2,
"uploadDate": "2024-05-30T13:08:03.000+00:00",
"cardsNotLoaded": 0,
"uploadType": "CARD_CREATION",
"failedCardsCSV": null,
"totalCardsRequested": 10,
"bulkUploadId": "240530130803054ID1BULK5812351",
"status": "COMPLETED"
},
{
"uploadedCSV": "https://card91-stag-docs.s3.ap-south-1.amazonaws.com/SANDBOX/bulkCards/240530050618886ID1FILE1155110/upload?response-content-disposition=attachment%3B%20filename%3D%22bulk_upload_cards_SANDBOX%2FbulkCards%2F240530050618886ID1FILE1155110%2Fupload.csv%22&response-content-type=application%2Fcsv&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240603T065934Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIARIPBJPMN5T4K3APU%2F20240603%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Signature=887bd3619b48b4d5fa35eecb410ab1e44284e1e3fa61347116de5df7589d9949",
"cardsNotCreated": 0,
"uploadedFileName": "Bulk_Card_Load_BUSINESS_SDK.csv",
"cardsCreatedSuccessfully": null,
"failedCardsCSVFileName": null,
"uploadedByMobile": "916208901648",
"uploadTime": "2024-05-30T05:06:20.000+00:00",
"uploadedByName": "Audrey Cruickshank",
"version": 0,
"uploadDate": "2024-05-30T05:06:20.000+00:00",
"cardsNotLoaded": 0,
"uploadType": "CARD_LOAD",
"failedCardsCSV": null,
"totalCardsRequested": 3,
"bulkUploadId": "240530050618886ID1BULK2144585",
"status": null
},
{
"uploadedCSV": "https://card91-stag-docs.s3.ap-south-1.amazonaws.com/SANDBOX/bulkCards/240530050618697ID1FILE0358296/upload?response-content-disposition=attachment%3B%20filename%3D%22bulk_upload_cards_SANDBOX%2FbulkCards%2F240530050618697ID1FILE0358296%2Fupload.csv%22&response-content-type=application%2Fcsv&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240603T065934Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIARIPBJPMN5T4K3APU%2F20240603%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Signature=d03821b686dea4dd6a4e9308e31e468ccb06c7d7ab6e1cf932db68f6535ad85c",
"cardsNotCreated": 0,
"uploadedFileName": "PPI_Card_Bulk_Upload_Business_SDK.csv",
"cardsCreatedSuccessfully": 30,
"failedCardsCSVFileName": null,
"uploadedByMobile": "916208901648",
"uploadTime": "2024-05-30T05:06:19.000+00:00",
"uploadedByName": "Audrey Cruickshank",
"version": 2,
"uploadDate": "2024-05-30T05:06:19.000+00:00",
"cardsNotLoaded": 0,
"uploadType": "CARD_CREATION",
"failedCardsCSV": null,
"totalCardsRequested": 30,
"bulkUploadId": "240530050618766ID1BULK3848112",
"status": "COMPLETED"
}
],
"currentPage": 1
}
}
Method 14: Get Bulk Upload template
Description
- This method allows you to fetch bulk upload template for bulk card create and bulk card load. Method used to get the json response of the template which is then convert to .csv file for Bulk card create and bulk card load
JsonObjects need to be passed in function as parameters to call the method.
For Bulk Card Create
- Required fields to call the function
- token (string, required): Token needed for authorization.
- environment (string, required): The Name of the Environment.
- empty new JSONObject
Sample Request
// config creation
JsonObject config = new JSONObject();
config.put("environment", "PROD");//"PROD_SANDBOX" for production sandbox and "PROD" for production
config.put("token", "1J2kjOF65ZXXXXXXXXXXXy0PVngkhnQCbePsdEVc");///Business token , // refer section 'Authentication with JWT'
// Call function - getBulkUploadTemplate
Card91BusinessSDK card91BusinessSDK = new Card91BusinessSDK();
// call to get bulk upload template without wallet name
JSONObject response = card91BusinessSDK.getBulkUploadTemplate(config, new JSONObject());
Sample Response
{
"Status": 200,
"Headers": {
"Transfer-Encoding": [
"chunked"
],
"X-Frame-Options": [
"DENY"
],
"Strict-Transport-Security": [
"max-age=31536000 ; includeSubDomains"
],
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"X-Content-Type-Options": [
"nosniff"
],
"X-Xss-Protection": [
"1; mode=block"
],
"Connection": [
"keep-alive"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"Expires": [
"0"
],
"Pragma": [
"no-cache"
],
"Date": [
"Wed, 12 Jun 2024 09:16:11 GMT"
],
"Content-Type": [
"application/json"
]
},
"Data": {
"ORG_ID": "",///(mandatory) Business ID eg, 240610200748712ID1OID8463224
"DELIVERY_ADDRESS_LANDMARK": "", /// (optional) eg, Near Stone Corner Circle
"EMBOSS_LINE_4": "", // (optional) for adding 4th line on card
"KYC_DOC_GENDER": "", ///// (optional) M/F/T
"EMAIL": "", // (optional) customer email
"DELIVERY_ADDRESS_CITY": "", // (mandatory) city name eg, bangalore
"SEND_PERSONALISED_CARD_WITHOUT_KYC": "",// (optional) YES/NO
"CARD_MODE": "",// (mandatory) “PHYSICAL_NAMED_CARD”/ “PHYSICAL_NO_NAMED_CARD”/“DIGITAL_ONLY_CARD (for DIGITAL_ONLY_CARD and PHYSICAL_NO_NAMED_CARD all address field is optional)
"KYC_DOC_DOB": "", // (optional) NA
"WALLET_1_LIMIT": "",//(mandatory) eg.2300
"KYC_DOC_TYPE": "",// (optional) NA
"DOB": "",// (mandatory) format 1990-06-22
"FULL_NAME": "",// (mandatory) eg, RAJAT RAWAT
"DELIVERY_ADDRESS_STATE": "",// (mandatory) KA (karnataka), TN (tamil nadu)
"GENDER": "",// (mandatory) M/F/T
"WALLET_ID_1": "",// (mandatory) eg, 08d9d1db-29ce-4901-ac33-f55e6d0c511b if limit is set
"WALLET_ID_2": "",// (optional) eg, 232fefd-1db-29ce-4901-ac33-f55eqewrr
"DELIVERY_ADDRESS_2": "",//(mandatory) eg .017 Ludington Point
"KYC_DOC_VALUE": "",// (optional) NA
"DELIVERY_ADDRESS_1": "",//(mandatory) eg. Flat No: 90 for physical card
"DELIVERY_ADDRESS_PINCODE": "",// (mandatory) eg. 517408
"NARRATION": "",//(optional)
"WALLET_2_LIMIT": "",// (optional)
"KIT_NUMBER": "",// (optional) for PHYSICAL_NO_NAMED_CARD its mandatory
"NAME_ON_CARD": "", //(mandatory) customer full name
"DELIVERY_ADDRESS_COUNTRY": "",// (mandatory) eg. IND for india
"CARD_PROGRAM_ID": "", // (mandatory) card program id
"MOBILE": ""// (mandatory) user mobile number
}
}
For Bulk Card Load
- Required fields to call the function
- token (string, required): Token needed for authorization.
- environment (string, required): The Name of the Environment.
- wallet (String, required): The name of the Wallet ( Wallet name can be fetched from the card program wallet detail api). Calling app has to make sure to sent the correct wallet name which they want to load for the customer.
Sample Request
/ config creation
JsonObject config = new JSONObject();
config.put("environment", "PROD");//"PROD_SANDBOX" for production sandbox and "PROD" for production
config.put("token", "1J2kjOF65ZXXXXXXXXXXXy0PVngkhnQCbePsdEVc");///Business token , // refer section 'Authentication with JWT'
// Payload creation for wallet field addition
JSONObject payload = new JSONObject();
payload.put("wallet", "<Wallet Name Field name>");
// Call function - getBulkUploadTemplate
Card91BusinessSDK card91BusinessSDK = new Card91BusinessSDK();
// call to get bulk upload template with wallet type field name
JSONObject response = card91BusinessSDK.getBulkUploadTemplate(config, payload);
Sample Response
"Status": 200,
"Headers": {
"Transfer-Encoding": [
"chunked"
],
"X-Frame-Options": [
"DENY"
],
"Strict-Transport-Security": [
"max-age=31536000 ; includeSubDomains"
],
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"X-Content-Type-Options": [
"nosniff"
],
"X-Xss-Protection": [
"1; mode=block"
],
"Connection": [
"keep-alive"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"Expires": [
"0"
],
"Pragma": [
"no-cache"
],
"Date": [
"Wed, 12 Jun 2024 09:17:39 GMT"
],
"Content-Type": [
"application/json"
]
},
"Data": {
"Prepaid": "", /// Wallet name which is passed while requesting the function service, in value we have to add the amount value which need to be loaded
"MOBILE_NUMBER": "", // Customer mobile number
"LAST_4_DIGITS": "", // last four digit of the card
"NARRATION": "" // comment needs to be added here
}
}
Method 15: Get Org/ Sub org Ledger Account report
Description
- This method allows you to fetch Org / Sub org Ledger Account report.
JsonObjects need to be passed in function as parameters to call the method.
- Required fields to call the function
- token (string, required): Token needed for authorization.
- environment (string, required): The Name of the Environment.
- issuer (String, required): The Issuer name.
- from (String, required): The start date of the report.
- to (String, required): The end date of the report.
- orgId (String, required): The Organisation ID.
Sample Request
JSONObject config = new JSONObject();
config.put("environment", "PROD"); //"PROD_SANDBOX" for production sandbox and "PROD" for production
config.put("token", "1J2kjOF65ZXXXXXXXXXXXy0PVngkhnQCbePsdEVc");///Business token , // refer section 'Authentication with JWT'
// Payload creation Org account ledger
JSONObject payload = new JSONObject();
payload.put("issuer", "NSDL");
payload.put("from", "2024-04-28");
payload.put("to", "2024-05-28");
payload.put("orgId", "24424311ID1OID6324695");
// Call function - getOrgAccountLedgerReport
Card91BusinessSDK card91BusinessSDK = new Card91BusinessSDK();
JSONObject response = card91BusinessSDK.getOrgAccountLedgerReport(config, payload);
Sample Response
{
"Status": 200,
"Headers": {
"Transfer-Encoding": [
"chunked"
],
"X-Frame-Options": [
"DENY"
],
"Strict-Transport-Security": [
"max-age=31536000 ; includeSubDomains"
],
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"X-Content-Type-Options": [
"nosniff"
],
"X-Xss-Protection": [
"1; mode=block"
],
"Connection": [
"keep-alive"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"Expires": [
"0"
],
"Pragma": [
"no-cache"
],
"Date": [
"Fri, 07 Jun 2024 07:06:22 GMT"
],
"Content-Type": [
"application/json"
]
},
"Data": {
"moneyOutflow": "-5101.0000",
"records": [
{
"date": "2024-05-28",
"delta": "95900.0000",
"closingBalance": "95900.0000",
"recordDetails": [
{
"transactionType": "Cr",
"delta": "100000.0000",
"closingBalance": "100000.0000",
"description": " UTR No: Test Txn Reference No :240528092453077ID1TXNID4958076",
"eventType": "Add Money",
"openingBalance": "0.0000",
"timeOfDay": "14:54:53"
},
{
"transactionType": "Dr",
"delta": "-2000.0000",
"closingBalance": "98000.0000",
"description": "1 Cumulative transaction",
"eventType": "Card Load",
"openingBalance": "100000.0000",
"timeOfDay": "15:01:58"
},
{
"transactionType": "Dr",
"delta": "-1000.0000",
"closingBalance": "97000.0000",
"description": "1 Cumulative transaction",
"eventType": "Card Load",
"openingBalance": "98000.0000",
"timeOfDay": "15:04:51"
},
{
"transactionType": "Dr",
"delta": "-1.0000",
"closingBalance": "96999.0000",
"description": "1 Cumulative transaction",
"eventType": "Card Load",
"openingBalance": "97000.0000",
"timeOfDay": "15:23:20"
},
{
"transactionType": "Cr",
"delta": "1.0000",
"closingBalance": "97000.0000",
"description": "unload money from card wallet",
"eventType": "Card Unload",
"openingBalance": "96999.0000",
"timeOfDay": "15:23:28"
},
{
"transactionType": "Dr",
"delta": "-2000.0000",
"closingBalance": "95000.0000",
"description": "1 Cumulative transaction",
"eventType": "Card Load",
"openingBalance": "97000.0000",
"timeOfDay": "16:36:09"
},
{
"transactionType": "Cr",
"delta": "1000.0000",
"closingBalance": "96000.0000",
"description": "unload money from card wallet",
"eventType": "Card Unload",
"openingBalance": "95000.0000",
"timeOfDay": "16:36:38"
},
{
"transactionType": "Dr",
"delta": "-100.0000",
"closingBalance": "95900.0000",
"description": "1 Cumulative transaction",
"eventType": "Card Load",
"openingBalance": "96000.0000",
"timeOfDay": "16:38:47"
}
],
"openingBalance": "0.0000"
}
],
"closingBalance": "95900.0000",
"moneyInflow": "101001.0000",
"openingBalance": "0.0000"
}
}
Method 16: Get Extended Org details
Description
- This method allows you to fetch extended organisation details.
JsonObjects need to be passed in function as parameters to call the method.
- Required fields to call the function
- token (string, required): Token needed for authorization.
- environment (string, required): The Name of the Environment.
- orgId (String, required): The Organisation ID.
Sample Request
JSONObject config = new JSONObject();
config.put(TOKEN, "1J2kjOF65ZXXXXXXXXXXXy0PVngkhnQCbePsdEVc=");///Business token , // refer section 'Authentication with JWT'
config.put(ENVIRONMENT, "PROD");//"PROD_SANDBOX" for production sandbox and "PROD" for production
JSONObject payload = new JSONObject();
payload.put("orgId", "240601143425063ID9625535");
// Call function - getExtendedOrgDetails
Card91BusinessSDK card91BusinessSDK = new Card91BusinessSDK();
JSONObject response = card91BusinessSDK.getExtendedOrgDetails(config, payload);
Sample Response
{
"Status": 200,
"Headers": {
"Transfer-Encoding": [
"chunked"
],
"X-Frame-Options": [
"DENY"
],
"Strict-Transport-Security": [
"max-age=31536000 ; includeSubDomains"
],
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"X-Content-Type-Options": [
"nosniff"
],
"X-Xss-Protection": [
"1; mode=block"
],
"Connection": [
"keep-alive"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"Expires": [
"0"
],
"Pragma": [
"no-cache"
],
"Date": [
"Fri, 07 Jun 2024 11:59:48 GMT"
],
"Content-Type": [
"application/json"
]
},
"Data": {
"orgName": "NSDL",
"subOrgDetails": [
{
"orgName": "Card",
"subOrgDetails": [],
"orgBalanceResponse": {
"balance": "20001.0000",
"issuerBalances": [
{
"balance": "20001.0000",
"issuer": "NSDL"
}
]
},
"orgId": "240603072817774ID1OID1661547",
"orgVanDetails": [
{
"van": "PPC924155094443",
"accountName": "JA0000049112",
"accountType": "Current",
"ifsccode": "NSDL H0417802",
"issuer": "NSDL"
}
],
"status": "ACTIVE"
},
{
"orgName": "pending",
"subOrgDetails": [
{
"orgName": "asdfgh",
"subOrgDetails": [
{
"orgName": "check",
"subOrgDetails": [],
"orgBalanceResponse": {
"balance": "1000.0000",
"issuerBalances": [
{
"balance": "1000.0000",
"issuer": "NSDL"
}
]
},
"orgId": "240603092134408ID1OID5510336",
"orgVanDetails": [
{
"van": "PPC924155092947",
"accountName": "JA0000049110",
"accountType": "Current",
"ifsccode": "YESH0417802",
"issuer": "NSDL"
}
],
"status": "ACTIVE"
}
],
"orgBalanceResponse": {
"balance": "0.0000",
"issuerBalances": [
{
"balance": "0.0000",
"issuer": "NSDL"
}
]
},
"orgId": "240603075921016ID1OID2625180",
"orgVanDetails": [
{
"van": "PPC924155092022",
"accountName": "JA0000049109",
"accountType": "Current",
"ifsccode": "YESH0417802",
"issuer": "NSDL"
}
],
"status": "ACTIVE"
}
],
"orgBalanceResponse": {
"balance": "43000.0000",
"issuerBalances": [
{
"balance": "43000.0000",
"issuer": "NSDL"
}
]
},
"orgId": "240603073022169ID1OID7280390",
"orgVanDetails": [
{
"van": "PPC924155073705",
"accountName": "JA0000049108",
"accountType": "Current",
"ifsccode": "YESH0417802",
"issuer": "NSDL"
}
],
"status": "ACTIVE"
},
{
"orgName": "last",
"subOrgDetails": [],
"orgBalanceResponse": {
"balance": "0",
"issuerBalances": []
},
"orgId": "240603094616920ID1OID3385918",
"orgVanDetails": [],
"status": "REJECTED"
},
{
"orgName": "Sub Org",
"subOrgDetails": [],
"orgBalanceResponse": {
"balance": "0.0000",
"issuerBalances": [
{
"balance": "0.0000",
"issuer": "NSDL"
}
]
},
"orgId": "240603102816830ID1OID9018272",
"orgVanDetails": [
{
"van": "MONEPKB240603102935",
"accountType": "Current",
"ifsccode": "NSDLB0CMSNOC",
"issuer": "NSDL"
}
],
"status": "ACTIVE"
},
{
"orgName": "sdafgh",
"subOrgDetails": [],
"orgBalanceResponse": {
"balance": "0.0000",
"issuerBalances": [
{
"balance": "0.0000",
"issuer": "NSDL"
},
{
"balance": "0.0000",
"issuer": "NSDL"
}
]
},
"orgId": "240603103136084ID1OID5659766",
"orgVanDetails": [
{
"van": "MONEPKB240603103287",
"accountType": "Current",
"ifsccode": "NSDLB0CMSNOC",
"issuer": "NSDL"
},
{
"van": "PPC924155103230",
"accountName": "JA0000049114",
"accountType": "Current",
"ifsccode": "NSDLH0417802",
"issuer": "NSDL"
}
],
"status": "ACTIVE"
},
{
"orgName": "venky",
"subOrgDetails": [],
"orgBalanceResponse": {
"balance": "0.0000",
"issuerBalances": [
{
"balance": "0.0000",
"issuer": "NSDL"
},
{
"balance": "0.0000",
"issuer": "NSDLGIFTCARD"
},
{
"balance": "0.0000",
"issuer": "NSDL"
}
]
},
"orgId": "240603105845865ID1OID1661450",
"orgVanDetails": [
{
"van": "MONEPKB240603110035",
"accountType": "Current",
"ifsccode": "NSDLB0CMSNOC",
"issuer": "NSDL"
},
{
"van": "PPC924155110141",
"accountName": "JA0000049115",
"accountType": "Current",
"ifsccode": "NSDLH0417802",
"issuer": "NSDL"
}
],
"status": "ACTIVE"
}
],
"orgBalanceResponse": {
"balance": "145999.0000",
"issuerBalances": [
{
"balance": "75999.0000",
"issuer": "NSDL"
},
{
"balance": "0.0000",
"issuer": "NSDL"
},
{
"balance": "50000.0000",
"issuer": "FINO"
},
{
"balance": "20000.0000",
"issuer": "NSDLGIFTCARD"
}
]
},
"orgId": "240601143425063ID1OID9625535",
"orgVanDetails": [
{
"van": "MONEPKB240603102673",
"accountType": "Current",
"ifsccode": "NSDLB0CMSNOC",
"issuer": "NSDL"
},
{
"van": "PPC924153144949",
"accountName": "JA0000049103",
"accountType": "Current",
"ifsccode": "NSDLH0417802",
"issuer": "NSDL"
},
{
"van": "YESVAN385991362",
"accountName": "",
"accountType": "Current",
"ifsccode": "SBIN0054532",
"issuer": "NSDLGIFTCARD"
}
],
"status": "ACTIVE"
}
}
Method 17: Get GPR records by Bulk upload ID
Description
- This method allows you to fetch GC and GPR records by Bulk upload ID.
JsonObjects need to be passed in function as parameters to call the method.
- Required fields to call the function
- token (string, required): Token needed for authorization.
- environment (string, required): The Name of the Environment.
- bulkUploadId (String, required): Bulk card create upload ID.
- page (String, optional): Page number.
- perPage (String, optional): Per page records.
Sample Request
JSONObject config = new JSONObject();
config.put(TOKEN, "lije5KPGC50omMeA9MspcPLqvJNpVWneII4JlBc=");
config.put(ENVIRONMENT, "PROD");
JSONObject payload = new JSONObject();
payload.put("bulkUploadId", "24061911392895ID1BULK8641875"); // Mandatory field
payload.put("page", "1"); // Optional field
payload.put("perPage", "10"); // Optional field
// Call function - getGPRRecordsByBulkUploadId
Card91BusinessSDK card91BusinessSDK = new Card91BusinessSDK();
JSONObject response = card91BusinessSDK.getGPRRecordsByBulkUploadId(config, payload);
Sample Response: In Case of GPR bulk upload id
{
{
"Status": 200,
"Headers": {
"Transfer-Encoding": [
"chunked"
],
"X-Frame-Options": [
"DENY"
],
"Strict-Transport-Security": [
"max-age=31536000 ; includeSubDomains"
],
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"X-Content-Type-Options": [
"nosniff"
],
"X-Xss-Protection": [
"1; mode=block"
],
"Connection": [
"keep-alive"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"Expires": [
"0"
],
"Pragma": [
"no-cache"
],
"Date": [
"Fri, 21 Jun 2024 06:35:59 GMT"
],
"Content-Type": [
"application/json"
]
},
"Data": {
"recordsCurrentPage": 11,
"totalRecords": 11,
"totalPages": 1,
"bulkDetailedUploadCardsRecordPojo": [
{
"businessDisplayName": "NSDL_27 June 2024_11.06 AM",
"cardHolderName": "Beryle Burchnall",
"cardId": "240627131101020ID1CARD6157060",
"businessName": "Kara-Brar",
"customerId": "240627131100958ID1CUSTID7591780",
"cardHolderMobile": "915563622269",
"cardHolderEmail": "[email protected]",
"cardProgramName": "Robert Johnston"
},
{
"businessDisplayName": "YES EM Test",
"cardHolderName": "Beryle Burchnall",
"cardId": "240627131101020ID1CARD6157060",
"businessName": "Kara-Brar",
"customerId": "240627131100958ID1CUSTID7591780",
"cardHolderMobile": "915563622269",
"cardHolderEmail": "[email protected]",
"cardProgramName": "Robert Johnston"
},
{
"businessDisplayName": "YES EM Test",
"cardHolderName": "Beryle Burchnall",
"cardId": "240627131101020ID1CARD6157060",
"businessName": "Kara-Brar",
"customerId": "240627131100958ID1CUSTID7591780",
"cardHolderMobile": "915563622269",
"cardHolderEmail": "[email protected]",
"cardProgramName": "Robert Johnston"
},
{
"businessDisplayName": "YES EM Test",
"cardHolderName": "Beryle Burchnall",
"cardId": "240627131101020ID1CARD6157060",
"businessName": "Kara-Brar",
"customerId": "240627131100958ID1CUSTID7591780",
"cardHolderMobile": "915563622269",
"cardHolderEmail": "[email protected]",
"cardProgramName": "Robert Johnston"
},
{
"businessDisplayName": "YES EM Test",
"cardHolderName": "Beryle Burchnall",
"cardId": "240627131101020ID1CARD6157060",
"businessName": "Kara-Brar",
"customerId": "240627131100958ID1CUSTID7591780",
"cardHolderMobile": "915563622269",
"cardHolderEmail": "[email protected]",
"cardProgramName": "Robert Johnston"
},
{
"businessDisplayName": "YES EM Test",
"cardHolderName": "Beryle Burchnall",
"cardId": "240627131101020ID1CARD6157060",
"businessName": "Kara-Brar",
"customerId": "240627131100958ID1CUSTID7591780",
"cardHolderMobile": "915563622269",
"cardHolderEmail": "[email protected]",
"cardProgramName": "Robert Johnston"
},
{
"businessDisplayName": "YES EM Test",
"cardHolderName": "Beryle Burchnall",
"cardId": "240627131101020ID1CARD6157060",
"businessName": "Kara-Brar",
"customerId": "240627131100958ID1CUSTID7591780",
"cardHolderMobile": "915563622269",
"cardHolderEmail": "[email protected]",
"cardProgramName": "Robert Johnston"
},
{
"businessDisplayName": "YES EM Test",
"cardHolderName": "Beryle Burchnall",
"cardId": "240627131101020ID1CARD6157060",
"businessName": "Kara-Brar",
"customerId": "240627131100958ID1CUSTID7591780",
"cardHolderMobile": "915563622269",
"cardHolderEmail": "[email protected]",
"cardProgramName": "Robert Johnston"
},
{
"businessDisplayName": "YES EM Test",
"cardHolderName": "Beryle Burchnall",
"cardId": "240627131101020ID1CARD6157060",
"businessName": "Kara-Brar",
"customerId": "240627131100958ID1CUSTID7591780",
"cardHolderMobile": "915563622269",
"cardHolderEmail": "[email protected]",
"cardProgramName": "Robert Johnston"
},
{
"businessDisplayName": "YES EM Test",
"cardHolderName": "Beryle Burchnall",
"cardId": "240627131101020ID1CARD6157060",
"businessName": "Kara-Brar",
"customerId": "240627131100958ID1CUSTID7591780",
"cardHolderMobile": "915563622269",
"cardHolderEmail": "[email protected]",
"cardProgramName": "Robert Johnston"
},
{
"businessDisplayName": "YES EM Test",
"cardHolderName": "Beryle Burchnall",
"cardId": "240627131101020ID1CARD6157060",
"businessName": "Kara-Brar",
"customerId": "240627131100958ID1CUSTID7591780",
"cardHolderMobile": "915563622269",
"cardHolderEmail": "[email protected]",
"cardProgramName": "Robert Johnston"
}
],
"currentPage": 1
}
}
Response
Description: In Case of GC bulk upload id
{
{
"Status": 200,
"Headers": {
"Transfer-Encoding": [
"chunked"
],
"X-Frame-Options": [
"DENY"
],
"Strict-Transport-Security": [
"max-age=31536000 ; includeSubDomains"
],
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"X-Content-Type-Options": [
"nosniff"
],
"X-Xss-Protection": [
"1; mode=block"
],
"Connection": [
"keep-alive"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"Expires": [
"0"
],
"Pragma": [
"no-cache"
],
"Date": [
"Fri, 21 Jun 2024 06:35:59 GMT"
],
"Content-Type": [
"application/json"
]
},
"Data": {
"recordsCurrentPage": 11,
"totalRecords": 11,
"totalPages": 1,
"bulkDetailedUploadCardsRecordPojo": [
{
"businessName": "Bedi, Tank and Dugar",
"businessDisplayName": "NSDL_21 June 2024_12.07 PM",
"cardProgramName": "Christina Jimenez",
"amount": "1671.00",
"lastFourDigits": "4266",
"kitNumber": "240000561163",
"cardHolderName": "Josiah Bentame",
"cardHolderMobile": "912519363751",
"cardHolderEmail": "",
"customerId": "240621070637989ID1CUSTID3P21340",
"cardId": "240621070637945ID1CARD3P21340"
}
],
"currentPage": 1
}
}
Method 18: Link Wallet
Description
- This method allows you to link wallet ids
JsonObjects need to be passed in function as parameters to call the method.
- Required fields to call the function
- token (string, required): Token needed for authorization.
- environment (string, required): The Name of the Environment.
- cardId (String, required): The Card ID.
- walletIds (Object, required): List of wallet Ids.
Sample Request
JSONObject config = new JSONObject();
config.put(TOKEN, "lije5KPGC50omMeA9MspcPLqvJNpVWneII4JlBc=");
config.put(ENVIRONMENT, "PROD");
// mandatory fields
JSONObject payload = new JSONObject();
payload.put("cardId", "240520100823479ID1CARD9372200");
JSONArray jsonArray = new JSONArray();
jsonArray.put("c374c038-c0e0-4ceb-9ef6-34a5abdbe9");
payload.put("walletIds", jsonArray);
// Call function - linkWallet
Card91BusinessSDK card91BusinessSDK = new Card91BusinessSDK();
JSONObject response = card91BusinessSDK.linkWallet(config, payload);
Sample Response
{
"Status": 200,
"Headers": {
"Transfer-Encoding": [
"chunked"
],
"X-Frame-Options": [
"DENY"
],
"Strict-Transport-Security": [
"max-age=31536000 ; includeSubDomains"
],
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"X-Content-Type-Options": [
"nosniff"
],
"X-Xss-Protection": [
"1; mode=block"
],
"Connection": [
"keep-alive"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"Expires": [
"0"
],
"Pragma": [
"no-cache"
],
"Date": [
"Thu, 11 Jul 2024 05:10:27 GMT"
],
"Content-Type": [
"application/json"
]
},
"Data": {
"message": "1 wallets successfully linked to card"
}
}
Method 19: Update CardHOlder Details
Description
- This method allows you to Update CardHolder details
JsonObjects need to be passed in function as parameters to call the method.
-
Required fields to call the function
- token (string, required): Token needed for authorization.
- environment (string, required): The Name of the Environment.
- cardId (String, required): The Card ID.
- customerId (String, required): The Customer ID.
- mobile (String, optional) : The mobile Number
- nameOnCard (String, optional) : Name on card
- fullName (String, optional) : Full Name
-
NOTE: At least any one of the mobile, nameOncard, fullName should be present in request.
Sample Request
JSONObject config = new JSONObject();
config.put(TOKEN, "lije5KPGC50omMeA9MspcPLqvJNpVWneII4JlBc=");
config.put(ENVIRONMENT, "PROD");
// mandatory fields
JSONObject payload = new JSONObject();
payload.put("cardId", "240520100823479ID1CARD9372200");
payload.put("customerId", "240520100823479CUSTID9372200");
// Optional but atleast one is required
payload.put("mobile", "9372200455");
payload.put("nameOncard", "Vishal");
payload.put("fullName", "Vishal Kumar");
// Call function - updateCardHolderDetails
Card91BusinessSDK card91BusinessSDK = new Card91BusinessSDK();
JSONObject response = card91BusinessSDK.updateCardHolderDetails(config, payload);
Sample Response
{
"Status": 200,
"Headers": {
"Transfer-Encoding": [
"chunked"
],
"X-Frame-Options": [
"DENY"
],
"Strict-Transport-Security": [
"max-age=31536000 ; includeSubDomains"
],
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"X-Content-Type-Options": [
"nosniff"
],
"X-Xss-Protection": [
"1; mode=block"
],
"Connection": [
"keep-alive"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"Expires": [
"0"
],
"Pragma": [
"no-cache"
],
"Date": [
"Tue, 13 Aug 2024 08:38:21 GMT"
],
"Content-Type": [
"application/json"
]
},
"Data": {
"message": "Customer details update Successfully"
}
}
SERVICE RESPONSE CODE DESCRIPTION
Response can be traced on the call back event object Card91RemoteResponse
| Response code | Description |
|---|---|
| 200-299 | Between 200-299 is considered as success response. |
| 400-499 | 401 Invalid auth token, 403 Forbidden, 400 Request structure is malformed or incorrect 415 Missing header request etc |
| 500-599 | Server Error |