Api Direct
Transfer

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

HeaderDescriptionRequired
AuthorizationUsed to authenticate the API, Basic base64(api_key:api_client)✅
X-Idempotency-KeyEnsures transaction uniqueness. The value must be a UUID✅
Content-Typeapplication/json
Accept-LanguageLanguage used for error messages. Supported values: en, fr

Request

ChampTypeDescription
referencestringIdentifiant unique de la transaction.
customerNamestringNom du client effectuant le paiement.
payinobjectInformations relatives au paiement entrant.
payin.amountnumberMontant du paiement.
payin.msisdnstringNuméro de téléphone du client (format international).
payin.providerstringOpérateur de paiement (WAVE, ORANGE, MOMO, MOOV).
payin.countrystringCode pays ISO (CI, CM).
 {
 "reference": "{{$randomUUID}}",
 "customerName": "John Do",
 "payin": {
   "amount": 300,
   "msisdn": "{{phone_number}}",
   "provider": "WAVE", // WAVE | ORANGE | MOMO | MOOV
   "country": "CM" // CI | 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 Interpretation

    FieldDescription
    idUnique transfer (payout) identifier.
    typeTransaction type — payout in this case (outgoing transfer).
    referenceReference provided by the merchant to identify the transfer.
    statusOverall transfer status (processing, processed, expired, etc.).
    confirmationRequiredIndicates whether beneficiary confirmation is required before executing the transfer.
    confirmationStatusCurrent confirmation status (none, pending, accepted, declined).
    paymentUrlTransfer confirmation link (null if not applicable).
    isDirectIndicates whether the transfer was initiated via a direct flow.
    payFeeIndicates whether fees are covered by the merchant.
    createdAtTransfer creation date and time.
    amountTransfer amount (excluding fees).
    feeApplied service fee amount.
    chargedAmountTotal amount debited from the merchant account (amount + fees).
    currencyCurrency used (XOF, USD, EUR, etc.).
    failureError details in case of transfer failure (null if successful).

    • customer

      ChampDescription
      nameName of the customer.
      phoneNumberCustomer phone number (international format).

    • mobileMoney

      FieldDescription
      providerObject containing Mobile Money provider information.
      provider.nameMobile 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
}
PaymentAPI Direct Refund