Outlets
Get an outlet
GET
/
outlets
/
{outletId}
Fetch a single outlet by its outletId. Returns the same shape as POST /outlets, including both wallet payloads and the live ledgerBalance / availableBalance for each wallet.
When to use this vs the list endpoint
GET /outlets/{outletId}when you already have the id (e.g. you stored it after creation, or resolved it viaGET /outlets?search=...). One round-trip, full payload.GET /outlets?search=...when you only have a partner-side identifier (yourexternalReference) and need to discover the Kele-sideoutletId.
404 semantics
404 OUTLET_NOT_FOUND: out_<id> is returned for two distinct cases:
- The
outletIddoesn’t exist anywhere in the system. - The
outletIdexists but belongs to a different Business.
The two cases are deliberately not distinguished — Kele will not leak the existence of cross-tenant outlets. Treat both as “this is not yours.”
Authorizations
x-api-key
string
headerrequiredPartner public key (pk_live_… or pk_test_…). Required on every request.
x-api-secret
string
headerrequiredPartner secret. Used in the v1-static profile only.
Path Parameters
outletId
string
requiredThe Outlet ULID returned by POST /outlets.
Response
200 - application/json
status
boolean
requiredBoolean success flag.
statusCode
integer
requiredHTTP status code mirrored in the body for convenience.
data
object
A partner outlet. Owns exactly two wallets:
collectionWallet— fronts a permanent virtual account; receives customer payments.depositWallet— funded by the partner; used to pay customers.
message
string
required