Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Create merchant transfers.
POST /v3/transfer
| Field | Description |
|---|---|
currency | Source wallet currency. |
amount | Amount to send. |
destination | Use mobile or sarafa. |
destination_currency | Required for mobile money transfers. |
account_number | Destination phone number or Sarafa account number. |
external_reference | Unique reference from your system. |
callback_url | URL that should receive status callbacks. |
quote | Set true to quote only, or false to create the transfer. |
curl https://serviceapi.sarafa.ss/v3/transfer \
-H "x-api-key: YOUR_API_KEY" \
-H "environment: sandbox" \
-H "Content-Type: application/json" \
-d '{
"currency": "USD",
"amount": 25,
"destination": "mobile",
"destination_currency": "KES",
"account_number": "+254700000000",
"external_reference": "payout-1001",
"callback_url": "https://example.com/sarafa/callback",
"quote": true
}'
quote: false after your customer or operations team accepts the quote.
For transfers to another Sarafa account, use destination: "sarafa" and the recipient account number.