API Reference · Payouts

Account enquiry

Verify a beneficiary account number and bank code. Not working on production at the moment: no payout gateway is configured, so after a valid signature every call answers HTTP 200 with "No preferred ACTIVE gateway is configured". The other answers below apply once a gateway is configured. This endpoint reports signature failures inside HTTP 200, so check status and code in the body, not the HTTP status. accountNumber and bankCode are the only signed fields.

POSThttps://payment.klustar.io/payment/merchant-api/account/inquiry

Headers

X-Tenant-ID

stringrequired

The environment of this call: test or live, ignoring case and surrounding spaces. It is not an account identifier, nothing issues it, and it is not signed. On Create a payin and Query payin status a missing or mistyped value means test, with no error. Account enquiry and Query payout status refuse a missing value and treat a mistyped one as test. live needs approval: until then a correctly signed live request gets 403 LIVE_NOT_ENABLED.

X-API-KEY

stringrequired

Public API key from the merchant dashboard. The same key serves test and live.

X-Merchant-ID

stringrequired

Your App ID, shown beside your API key on Profile & Settings → API Keys.

X-Nonce

stringrequired

A new value on every request (UUID recommended), including a retry after a failure. A nonce is recorded before the signature is checked and stays used, so a refused request burns it.

X-Timestamp

stringrequired

Unix epoch seconds when the request is signed, digits only. Must be within ±300s of server time.

X-Signature

stringrequired

Lowercase hex HMAC-SHA256 of the signature base string, using your secret key.

Content-Type

stringrequired

Must be application/json. Any other type gets a 502.

Defaults to application/json

Body params

bankCode

stringrequired

Bank code from the List banks endpoint (e.g. KBC-0007 for Access Bank Nigeria).

accountNumber

stringrequired

10-digit Nigerian NUBAN account number.

Request body

application/json

{
  "bankCode": "KBC-0007",
  "accountNumber": "ACCOUNT_NUMBER"
}

Responses

Every correctly signed call gets this until a payout gateway is configured.

Response body

{
  "status": "error",
  "message": "No preferred ACTIVE gateway is configured"
}

{
  "status": "error",
  "message": "No preferred ACTIVE gateway is configured"
}