Transfer

POST https://business.novasend.app/v1/direct/payout

This endpoint allows a merchant to initiate a payout, i.e. a transfer of funds from their wallet to an external beneficiary.

Request Headers

Header	Description	Required
Authorization	Used to authenticate the API, `Basic base64(api_key:api_client)`	✅
X-Idempotency-Key	Ensures transaction uniqueness. The value must be a UUID	✅
Content-Type	`application/json`
Accept-Language	Language used for error messages. Supported values: `en`, `fr`

Request

Field	Type	Description
reference	string	Unique transaction identifier.
customerName	string	Name of the transfer recipient.
payout	object	Outgoing transfer details.
payout.amount	number	Transfer amount.
payout.msisdn	string	Recipient phone number (international format).
payout.provider	string	Payment operator (`WAVE`, `ORANGE`, `MOMO`, `MOOV`).
payout.country	string	ISO country code (`CI`, `CM`).

{
  "reference": "{{$randomUUID}}",
  "customerName": "John Do",
  "payout": {
    "amount": 300,
    "msisdn": "{{phone_number}}",
    "provider": "WAVE",
    "country": "CM"
  }
}

Response

{
  "id": "pr_bawy28jjce5btvu8eq1jjvmjlt",
  "type": "payout",
  "reference": "036065a8-081f-46f7-916f-3c4ba24b64a4",
  "status": "processed",
  "confirmationRequired": false,
  "confirmationStatus": "accepted",
  "paymentUrl": null,
  "customer": {
    "name": "Aristide",
    "phoneNumber": "+225xxxxxxxxx"
  },
  "mobileMoney": {
    "provider": {
      "name": "WAVE_CI"
    }
  },
  "isDirect": false,
  "payFee": false,
  "createdAt": "2026-01-19T09:11:42.594Z",
  "amount": 200,
  "fee": 4,
  "chargedAmount": 204,
  "currency": "XOF",
  "failure": null
}

Response Fields

Field	Description
id	Unique transfer (payout) identifier.
type	Transaction type — `payout` (outgoing transfer).
reference	Reference provided by the merchant to identify the transfer.
status	Overall transfer status (`processing`, `processed`, `expired`, etc.).
confirmationRequired	Indicates whether beneficiary confirmation is required before executing the transfer.
confirmationStatus	Current confirmation status (`none`, `pending`, `accepted`, `declined`).
paymentUrl	Transfer confirmation link (`null` if not applicable).
isDirect	Indicates whether the transfer was initiated via a direct flow.
payFee	Indicates whether fees are covered by the merchant.
createdAt	Transfer creation date and time.
amount	Transfer amount (excluding fees).
fee	Applied service fee amount.
chargedAmount	Total amount debited from the merchant account (amount + fees).
currency	Currency used (`XOF`, `USD`, `EUR`, etc.).
failure	Error details in case of transfer failure (`null` if successful).

customer

Field	Description
name	Name of the customer.
phoneNumber	Customer phone number (international format).

mobileMoney

Field	Description
provider	Object containing Mobile Money provider information.
provider.name	Mobile Money provider identifier (e.g. `WAVE_CI`).

Transfer Status

GET https://business.novasend.app/v1/direct/payout/{reference}

This endpoint allows you to retrieve the current status of a transfer at any time.

Response

{
  "id": "pr_bawy28jjce5btvu8eq1jjvmjlt",
  "type": "payout",
  "reference": "036065a8-081f-46f7-916f-3c4ba24b64a4",
  "status": "processed",
  "confirmationRequired": false,
  "confirmationStatus": "accepted",
  "paymentUrl": null,
  "customer": {
    "name": "Aristide",
    "phoneNumber": "+225xxxxxxxxx"
  },
  "mobileMoney": {
    "provider": {
      "name": "WAVE_CI"
    }
  },
  "isDirect": false,
  "payFee": false,
  "createdAt": "2026-01-19T09:11:42.594Z",
  "amount": 200,
  "fee": 4,
  "chargedAmount": 204,
  "currency": "XOF",
  "failure": null
}

On this page