ONonlink
Partner API

Your KES payout destinations

The destinations a sell order may name in payoutAccountId. Read-only: destinations are registered by OnLink, not through this API, so your API credential cannot add a place for money to go. Only active destinations are listed. Account numbers are returned as the last four digits only — you select a destination by id and never type its number.

get/v1/payout-accounts

Request

  • Base URL
    https://sandbox.onlink.africa
  • Auth
    API key in header X-OnLink-Key

Response

Your active payout destinations

payoutAccountIdstring uuid required

The id to pass as payoutAccountId on POST /v1/orders/sell. Destinations are registered by OnLink out of band, never through this API, so this is a selection rather than an instruction.

accountNumberLast4string required

The last four digits only of the destination account number. There is no route on this API that returns more, by design — you select a destination by id and never type its number.

accountNamestring required

The beneficiary name exactly as the receiving bank holds it. Returned whole so you can tell two destinations at the same bank apart.

bankCodestring nullable required

The receiving bank’s code. null means an on-us destination at our own bank, not missing data — do not render it as an error or a gap.

labelstring nullable required

The label OnLink recorded for this destination, or null. Never used for routing.

Example response

[
  {
    "payoutAccountId": "dd9f1e6a-0000-4000-8000-000000000003",
    "accountNumberLast4": "6789",
    "accountName": "EXAMPLE TRADING LIMITED",
    "label": "Primary settlement"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.