API Reference · Payouts

Query payout status

Check the status of one of your dashboard payouts by its reference, within the environment in X-Tenant-ID, which this endpoint requires. Sign it with HMAC-SHA256 the same way as Create a payin, with POST, /payment/merchant-api/payout/status as the path and reference=<your reference> as the canonical body. Unsigned requests are refused. Not working on production at the moment: no payout gateway is configured, so a reference that matches a payout answers "No preferred ACTIVE gateway is configured".

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

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

reference

stringrequired

Payout reference used at initiation. The only signed field.

Request body

application/json

{
  "reference": "<your payout reference>"
}

Responses

A reference that matches a payout 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"
}