Skip to content
SkanPay Docs
api.skanpay.websiteDashboard

Payout wallets

Your business's own verified MTN and Airtel wallets: the only places a withdrawal can go. Read-only over the API.

Wallets are added by an owner or admin in the dashboard (Balances → Payout wallets), approved by an owner, and usable 24 hours after approval. API keys can list them but never add, approve or revoke one. See setting up a payout wallet.

The payout wallet object

{
  "id": "wal_01J9Z3K8Q4W6XK2M7N5P0R3T8V",
  "object": "payout_destination",
  "label": "Main MTN business line",
  "msisdn_masked": "+2567****111",
  "country": "UG",
  "network": "MTN",
  "status": "ACTIVE",
  "activates_at": "2026-09-20T12:00:00.000Z",
  "approved_at": "2026-09-19T12:00:00.000Z",
  "revoked_at": null,
  "created_at": "2026-09-19T09:15:00.000Z"
}

Attributes

idstring
Unique id, prefixed wal_.
objectstring
Always "payout_destination".
labelstring
The name your team gave it.
msisdn_maskedstring
The wallet number, masked (+2567****456). Full numbers are never returned.
countryenum
The wallet's country: UG, KE or GH.
networkenum
MTN or AIRTEL.
statusenum
See below.
activates_atstring | null
When it can first receive a withdrawal (approval + 24 h).
approved_atstring | null
When an owner approved it.
revoked_atstring | null
When it was revoked.
created_atstring
ISO 8601, UTC.
statusCan receive withdrawals?Meaning
PENDING_APPROVALNoAdded, waiting for an owner to approve it.
COOLING_OFFNoApproved; usable at activates_at.
ACTIVEYesReady.
REVOKEDNoRevoked by your team. Permanently unusable.

List payout wallets

GET/v1/payout_destinations

Returns every wallet on your account (not paginated).

curl https://api.skanpay.website/v1/payout_destinations \
  -H "Authorization: Bearer $SKANPAY_SECRET_KEY"
Response
{ "object": "list", "data": [ { "id": "wal_…", "object": "payout_destination", ... } ] }