API docs by Redocly

Blusalt Card - External Wallet API (0.0.1)

Download OpenAPI specification:

API for connecting CMS to external wallets

System

Health Check

Check the health status of the external wallet API

Responses

Response samples

Content type
text/plain
OK

Account Operations

Account Enquiry

Retrieve account information and balance from external account/wallet

header Parameters
x-api-key
required
string

API key for authentication

Request Body schema: application/json
required
accountReference
required
string

Unique identifier for the account in the external wallet

transactionReference
required
string

Unique reference for this enquiry transaction

Responses

Request samples

Content type
application/json
{
  • "accountReference": "ACCT123456789",
  • "transactionReference": "TXN-2023-001"
}

Response samples

Content type
application/json
{
  • "accountName": "John Doe",
  • "accountReference": "123456789",
  • "bankName": "Example Bank",
  • "accountType": "personal",
  • "availableBalance": 1500.5,
  • "currencyCode": "566"
}

Transaction Operations

Debit Account

Debit funds from an external account/wallet

path Parameters
accountReference
required
string

Account reference to debit

header Parameters
x-api-key
required
string

API key for authentication

Request Body schema: application/json
required
transactionReference
required
string

Unique reference for this debit transaction. (RRN)

cardAcceptor
string

Card acceptor information (optional)

terminalId
string

Terminal ID

merchantId
string

Merchant ID

stan
string

Stan

amount
required
number <double>

Amount to debit

currencyCode
required
string^[0-9]{3}$

Currency code (ISO 4217 numeric)

Responses

Request samples

Content type
application/json
{
  • "transactionReference": "12343431413",
  • "cardAcceptor": "BLUSALT LTD LAGOS",
  • "terminalId": "122334",
  • "merchantId": "122334",
  • "stan": "111111",
  • "amount": 100.5,
  • "currencyCode": "566"
}

Response samples

Content type
application/json
Example
{
  • "responseCode": "00",
  • "message": "Transaction successful"
}

Reverse Transaction

Reverse a previous debit transaction

path Parameters
accountReference
required
string

Account reference for reversal

header Parameters
x-api-key
required
string

API key for authentication

Request Body schema: application/json
required
transactionReference
required
string

Unique reference for this reversal transaction

originalTransactionReference
required
string

Reference of the original transaction to reverse

amount
required
number <double>

Amount to reverse

currencyCode
string^[0-9]{3}$

Currency code (ISO 4217 numeric)

Responses

Request samples

Content type
application/json
{
  • "transactionReference": "REV-2023-001",
  • "originalTransactionReference": "DEB-2023-001",
  • "amount": 100.5,
  • "currencyCode": "566"
}

Response samples

Content type
application/json
Example
{
  • "responseCode": "00",
  • "message": "Reversal successful"
}

Create Lien

Place a lien on funds in an external account/wallet

path Parameters
accountReference
required
string

Account reference to place lien on

header Parameters
x-api-key
required
string

API key for authentication

Request Body schema: application/json
required
transactionReference
required
string

Unique reference for this debit transaction. (RRN)

cardAcceptor
string

Card acceptor information (optional)

terminalId
string

Terminal ID

merchantId
string

Merchant ID

stan
string

Stan

amount
required
number <double>

Amount to debit

currencyCode
required
string^[0-9]{3}$

Currency code (ISO 4217 numeric)

Responses

Request samples

Content type
application/json
{
  • "transactionReference": "12343431413",
  • "cardAcceptor": "BLUSALT LTD LAGOS",
  • "terminalId": "122334",
  • "merchantId": "122334",
  • "stan": "111111",
  • "amount": 100.5,
  • "currencyCode": "566"
}

Response samples

Content type
application/json
Example
{
  • "responseCode": "00",
  • "message": "Lien placed successfully"
}

Debit Lien

Process a lien and debit wallet. If the amount is partial, the remaining amount should be credited back to the wallet.

path Parameters
accountReference
required
string

Account reference with the lien

originalTransactionReference
required
string

Original lien transaction reference

header Parameters
x-api-key
required
string

API key for authentication

Request Body schema: application/json
required
transactionReference
required
string

Unique reference for this debit transaction. (RRN)

cardAcceptor
string

Card acceptor information (optional)

terminalId
string

Terminal ID

merchantId
string

Merchant ID

stan
string

Stan

amount
required
number <double>

Amount to debit

currencyCode
required
string^[0-9]{3}$

Currency code (ISO 4217 numeric)

Responses

Request samples

Content type
application/json
{
  • "transactionReference": "12343431413",
  • "cardAcceptor": "BLUSALT LTD LAGOS",
  • "terminalId": "122334",
  • "merchantId": "122334",
  • "stan": "111111",
  • "amount": 100.5,
  • "currencyCode": "566"
}

Response samples

Content type
application/json
Example
{
  • "responseCode": "00",
  • "message": "Lien debited successfully"
}