Wallet

Create Wallet

Creates a new wallet for a cardholder in the specified currency.

{{baseUrl}}/issuing/api/v1/wallet

Description

This API enables the creation of a wallet under a specific cardholder’s account. A wallet is linked to a cardholder and is initialized in a chosen currency (e.g., USD, EUR).

📩 Request Headers

x-api-key string required

Shared X-API key

x-product-id string required

Shared Product ID

x-cardholder-id string required

Unique identifier of the cardholder

x-client-id string

Client identification key

x-request-id string required

Idempotency key for request tracking

Content-Type string required

Must be application/json

Authorization string

Bearer access token

📦 Request Body

currency string required

Currency code for the wallet (3-letter ISO-4217 code).

🧩 Examples

Request Example

cURL

curl --location --request POST \
--url '{{baseUrl}}/issuing/api/v1/wallet' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-cardholder-id: {{CardholderID}}' \
--header 'x-client-id: {{ClientID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}' \
--data '{
  "currency": "USD"
}'

Python

import requests
import json

url = "{{baseUrl}}/issuing/api/v1/wallet"

payload = json.dumps({
  "currency": "USD"
})
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholder-id': '{{CardholderID}}',
  'x-client-id': '{{ClientID}}',
  'x-request-id': '{{IdempotencyKey}}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{AccessToken}}'
}

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

print(response.text)

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n  \"currency\": \"USD\"\r\n}");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/v1/wallet")
  .method("POST", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholder-id", "{{CardholderID}}")
  .addHeader("x-client-id", "{{ClientID}}")
  .addHeader("x-request-id", "{{IdempotencyKey}}")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{AccessToken}}")
  .build();
Response response = client.newCall(request).execute();

NodeJs

const axios = require('axios');
let data = JSON.stringify({
  "currency": "USD"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/v1/wallet',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholder-id': '{{CardholderID}}', 
    'x-client-id': '{{ClientID}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'Content-Type': 'application/json', 
    'Authorization': 'Bearer {{AccessToken}}'
  },
  data : data
};

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

Response Example

200

{
  "status": "success",
  "message": "wallet created successfully!",
  "code": 200,
  "data": [
    {
      "id": "wallet-id",
      "currency": "USD",
      "amount": 0.00,
      "holdingCurrency": "USD",
      "holdingAmount": 0.00,
      "dailyLimitAmount": 0.00,
      "weeklyLimitAmount": 0.00,
      "monthlyLimitAmount": 0.00,
      "yearlyLimitAmount": 0.00,
      "totalLimitAmount": 0.00,
      "status": "ACTIVE",
      "createdAt": "2025-09-24T06:45:35.803975298"
    }
  ]
}

400

{
  "code": 400,
  "message": "Error Message",
  "status": "error"
}

🧪 Try It Out

💼 Create Wallet — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-cardholder-id:

x-client-id:

x-request-id:

Authorization:

📝 Request Body

{ "currency": "USD" }

💻 Generated cURL Command

❯

Get Wallet Details

Retrieves wallet details of a specific cardholder.

{{baseUrl}}/issuing/api/v1/wallet

Description

This API fetches the wallet information associated with a cardholder using their unique x-cardholder-id. It returns details such as wallet ID, currency, balance, and status.

📩 Request Headers

x-api-key string required

Shared X-API key

x-product-id string required

Shared Product ID

x-cardholder-id string required

Unique identifier of the cardholder

x-client-id string

Client identification key

x-request-id string required

Idempotency key for request tracking

Content-Type string required

Must be application/json

Authorization string

Bearer access token

🧩 Examples

Request Example

cURL

curl --location --request GET \
--url '{{baseUrl}}/issuing/api/v1/wallet' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-cardholder-id: {{CardholderID}}' \
--header 'x-client-id: {{ClientID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}'

Python

import requests
import json

url = "{{baseUrl}}/issuing/api/v1/wallet"

payload = {}
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholder-id': '{{CardholderID}}',
  'x-client-id': '{{ClientID}}',
  'x-request-id': '{{IdempotencyKey}}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{AccessToken}}'
}

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

print(response.text)

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/v1/wallet")
  .method("GET", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholder-id", "{{CardholderID}}")
  .addHeader("x-client-id", "{{ClientID}}")
  .addHeader("x-request-id", "{{IdempotencyKey}}")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{AccessToken}}")
  .build();
Response response = client.newCall(request).execute();

NodeJs

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/v1/wallet',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholder-id': '{{CardholderID}}', 
    'x-client-id': '{{ClientID}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'Content-Type': 'application/json', 
    'Authorization': 'Bearer {{AccessToken}}'
  }
};

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

Response Example

200

{
  "status": "success",
  "message": "wallet details",
  "code": 200,
  "data": [
    {
      "id": "wallet-id",
      "currency": "USD",
      "amount": 10.00,
      "holdingCurrency": "USD",
      "holdingAmount": 0.00,
      "dailyLimitAmount": 0.00,
      "weeklyLimitAmount": 0.00,
      "monthlyLimitAmount": 0.00,
      "yearlyLimitAmount": 0.00,
      "totalLimitAmount": 0.00,
      "status": "ACTIVE",
      "createdAt": "2025-09-24T06:45:35"
    }
  ]
}

400

{
  "code": 400,
  "message": "Error Message",
  "status": "error"
}

🧪 Try It Out

ℹ️ Get Wallet Details — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-cardholder-id:

x-client-id:

x-request-id:

Authorization:

💻 Generated cURL Command

❯

Get Wallet History

Retrieves the transaction history of a specific wallet.

{{baseUrl}}/issuing/api/v1/wallet/history

Description

This API provides a detailed list of transactions linked to a wallet under a cardholder. It requires both the x-cardholder-id and x-wallet-id headers to identify the wallet. The response includes transaction details such as amounts, currency, timestamps, and status.

📩 Request Headers

x-api-key string required

Shared X-API key

x-product-id string required

Shared Product ID

x-cardholder-id string required

Unique identifier of the cardholder

x-wallet-id string required

Unique identifier of the wallet

x-client-id string

Client identification key

x-request-id string required

Idempotency key for request tracking

Content-Type string required

Must be application/json

Authorization string

Bearer access token

🔍 Query Parameters

from_date string

Start date filter. Date must be in ISO 8601 format: YYYY-MM-DD or yyyy-MM-ddTHH:mm:ss.

to_date string

End date filter. Date must be in ISO 8601 format: YYYY-MM-DD or yyyy-MM-ddTHH:mm:ss.

page integer

Page number for pagination

size integer

Number of records per page

🧩 Examples

Request Example

cURL

curl --location --request GET \
--url '{{baseUrl}}/issuing/api/v1/wallet/history' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-cardholder-id: {{CardholderID}}' \
--header 'x-wallet-id: {{WalletID}}' \
--header 'x-client-id: {{ClientID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}'

Python

import requests
import json

url = "{{baseUrl}}/issuing/api/v1/wallet/history"

payload = {}
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholder-id': '{{CardholderID}}',
  'x-wallet-id': '{{WalletID}}',
  'x-client-id': '{{ClientID}}',
  'x-request-id': '{{IdempotencyKey}}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{AccessToken}}'
}

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

print(response.text)

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/v1/wallet/history")
  .method("GET", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholder-id", "{{CardholderID}}")
  .addHeader("x-wallet-id", "{{WalletID}}")
  .addHeader("x-client-id", "{{ClientID}}")
  .addHeader("x-request-id", "{{IdempotencyKey}}")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{AccessToken}}")
  .build();
Response response = client.newCall(request).execute();

NodeJs

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/v1/wallet/history',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholder-id': '{{CardholderID}}', 
    'x-wallet-id': '{{WalletID}}', 
    'x-client-id': '{{ClientID}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'Content-Type': 'application/json', 
    'Authorization': 'Bearer {{AccessToken}}'
  }
};

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

Response Example

200

{
  "status": "success",
  "message": "Wallet Transaction History",
  "code": 200,
  "data": [
    {
      "genericSlNo": 100,
      "slNo": "WALLET3086",
      "wallet_id": "wallet-id",
      "programCode": "ZSTAAS0",
      "txn_currency": "USD",
      "txn_amount": 0.10,
      "available_amount": 45.86,
      "available_currency": "USD",
      "acquirer_amount": "0.10",
      "acquirer_currency": "USD",
      "txn_type": "FEE",
      "txn_direction": "DEBIT",
      "txn_ref_id": "71821_W2W_FEE",
      "txn_email": null,
      "txn_description": null,
      "txn_status": "SUCCESS",
      "card_acceptor_name": null,
      "card_id": null,
      "initiated_by": "Wallet Transfer Fee",
      "settle_amount": 0.10,
      "settle_currency": "USD",
      "billing_amount": 0.10,
      "billing_currency": "USD",
      "initiatedAt": "2026-07-16T12:04:52",
      "updatedAt": null,
      "masked_card_number": null
    },
    {
      "genericSlNo": 98,
      "slNo": "WALLET3084",
      "wallet_id": "wallet-id",
      "programCode": "ZSTAAS0",
      "txn_currency": "USD",
      "txn_amount": 5.00,
      "available_amount": 45.96,
      "available_currency": "USD",
      "acquirer_amount": "5.00",
      "acquirer_currency": "USD",
      "txn_type": "P2P",
      "txn_direction": "DEBIT",
      "txn_ref_id": "WT8d4460e0810e11f1bf6d0aaf5786be",
      "txn_email": "johnsmith11@yopmail.com",
      "txn_description": "testing P2P",
      "txn_status": "SUCCESS",
      "card_acceptor_name": null,
      "card_id": null,
      "initiated_by": "Wallet Transfer Fee",
      "settle_amount": 5.00,
      "settle_currency": "USD",
      "billing_amount": 5.00,
      "billing_currency": "USD",
      "initiatedAt": "2026-07-16T12:04:52",
      "updatedAt": null,
      "masked_card_number": null
    }
  ]
}

400

{
  "code": 400,
  "message": "Error Message",
  "status": "error"
}

🧪 Try It Out

🧾 Get Wallet History — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-cardholder-id:

x-wallet-id:

x-client-id:

x-request-id:

Authorization:

🔍 Query Parameters (Optional)

❯

💻 Generated cURL Command

❯