Wallet

Create Wallet

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

Endpoint

POST {{baseUrl}}/issuing/api/:version/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 Path Parameters

Parameter	Type	Required	Description
version	string	Yes	API version number

Request Headers

Parameter	Type	Required	Description
x-api-key	string	Yes	Shared X-API key
x-product-id	string	Yes	Shared ProductID
x-cardholder-id	string	Yes	Unique identifier of the cardholder
x-request-id	string	Yes	Idempotency key for request tracking
Content-Type	string	Yes	Must be application/json

Request Body Parameters

Parameter	Type	Required	Description
currency	string	Yes	Currency code for the wallet (e.g., "USD")

Request Example

cURL

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

Response Example

200: Success

{
  "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: Error

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

Get Wallet Details

Retrieves wallet details of a specific cardholder.

Endpoint

GET {{baseUrl}}/issuing/api/:version/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 Path Parameters

Parameter	Type	Required	Description
version	string	Yes	API version number

Request Headers

Parameter	Type	Required	Description
x-api-key	string	Yes	Shared X-API key
x-product-id	string	Yes	Shared ProductID
x-cardholder-id	string	Yes	Unique identifier of the cardholder
x-request-id	string	Yes	Idempotency key for request tracking
Content-Type	string	Yes	Must be application/json

Request Example

cURL

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

Response Example

200: Success

{
  "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: Error

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

Get Wallet History

Retrieves the transaction history of a specific wallet.

Endpoint

GET {{baseUrl}}/issuing/api/:version/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 Path Parameters

Parameter	Type	Required	Description
version	string	Yes	API version number

Request Headers

Parameter	Type	Required	Description
x-api-key	string	Yes	Shared X-API key
x-product-id	string	Yes	Shared ProductID
x-cardholder-id	string	Yes	Unique identifier of the cardholder
x-wallet-id	string	Yes	Unique identifier of the wallet
x-request-id	string	Yes	Idempotency key for request tracking
Content-Type	string	Yes	Must be application/json

Request Query Parameters

Parameter	Type	Required	Description
from_date	string	No	Start date for filtering transactions (YYYY-MM-DD)
to_date	string	No	End date for filtering transactions (YYYY-MM-DD)
page	integer	No	Page number for pagination
size	integer	No	Number of records per page

Request Example

cURL

curl --location --request GET \
--url '{{baseUrl}}/issuing/api/:version/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-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \

Response Example

200: Success

{
  "status": "success",
  "message": "wallet history",
  "code": 200,
  "data": [
    {
      "id": "WALLET39",
      "wallet_id": "wallet-id",
      "txn_currency": "USD",
      "txn_amount": 1.00,
      "available_amount": 24.10,
      "available_currency": "USD",
      "settle_amount": 1.00,
      "settle_currency": "USD",
      "billing_amount": 1.00,
      "billing_currency": "USD",
      "txn_type": "M2P",
      "txn_ref_id": "PFTMCS000010489BE6EC7E54F4E",
      "txn_status": "SUCCESS",
      "card_acceptor_name": null,
      "initiated_by": "Prefund Transfer API",
      "initiatedAt": "2025-09-26T09:48:41"
    },
    {
      "id": "WALLET36",
      "wallet_id": "wallet-id",
      "txn_currency": "USD",
      "txn_amount": 1.00,
      "available_amount": 23.10,
      "available_currency": "USD",
      "settle_amount": 1.00,
      "settle_currency": "USD",
      "billing_amount": 1.00,
      "billing_currency": "USD",
      "txn_type": "M2P",
      "txn_ref_id": "PFTMCS000013A52E46BC90145C2",
      "txn_status": "SUCCESS",
      "card_acceptor_name": null,
      "initiated_by": "Prefund Transfer API",
      "initiatedAt": "2025-09-26T06:29:14"
    }
  ]
}

400: Error

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