API Reference · Payouts

Initiate a payout

Transfer funds to a verified beneficiary bank account.

POSThttps://payment.klustar.io/payment/merchant-api/payout

Headers

X-Tenant-ID

stringrequired

Your tenant identifier (provided during onboarding).

X-API-KEY

stringrequired

Public API key from the merchant dashboard.

X-Merchant-ID

stringrequired

Your business profile / merchant ID (same as appId).

X-Nonce

stringrequired

Unique per-request value (UUID recommended). Never reuse.

X-Timestamp

stringrequired

Unix epoch seconds when the request is signed. 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 for JSON bodies.

Defaults to application/json

Body params

amount

stringrequired

Payout amount as a string decimal.

currency

stringrequired

Currency code. Currently NGN.

beneficiaryAccount

stringrequired

Beneficiary NUBAN account number.

beneficiaryName

stringrequired

Account name returned from account enquiry.

beneficiaryBankCode

stringrequired

Bank code from List banks.

beneficiaryPhone

stringoptional

Beneficiary phone number.

reference

stringrequired

Unique payout reference from your system.

notifyUrl

stringoptional

Optional webhook URL for payout updates.

narration

stringoptional

Transfer narration.

Request body

application/json

{
  "amount": "10000",
  "currency": "NGN",
  "beneficiaryAccount": "0123456789",
  "beneficiaryName": "JANE DOE",
  "beneficiaryBankCode": "KBC-0618",
  "beneficiaryPhone": "08012345678",
  "notifyUrl": "https://merchant.example/webhooks/payout",
  "narration": "Vendor settlement",
  "reference": "PO-7c9e6679-7425-40de-944b-e07fc1f90ae7"
}

Responses

Response body

{
  "success": true,
  "status": "success",
  "code": "00000000",
  "message": "success",
  "data": {
    "amount": 10000,
    "orderId": "PO-7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "currency": "NGN",
    "fee": { "fee": 1000, "vat": 0 }
  }
}

{
  "success": true,
  "status": "success",
  "code": "00000000",
  "message": "success",
  "data": {
    "amount": 10000,
    "orderId": "PO-7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "currency": "NGN",
    "fee": { "fee": 1000, "vat": 0 }
  }
}