Sign in

v1

latestOpenAPI 3.0.32026-07-248257161.1 KB
Payout

Initiate a bulk payout

Use this endpoint to send a bulk payout. After payment is completed merchant webhook is called to notify status of each transation. For security reason, we do not allow merchant to generate permission for this end point, please contact us in order to get a secret key for testing bulk payout on sandbox.

post/batch-payout

Query parameters

payment_type'wave_money' | 'orange_money' | 'maxit' | 'mtn_money' | 'free_money' | 'moov' | 'mobicash' | 'togocell' | 'bictorys' | 'card' required

The type parameter allows to select the payout service provider. E.g mtn_money, orange_money, wave_money, move_money

country_code'SN' | 'CI' | 'ML' required

Country Code of the beneficiaries

Headers

X-Batch-Referencestring

Any reference you want to add to the transaction. This reference will be returned in the webhook payload.

idempotency-keystring uuid

The value of this query parameter guarantees the idempotence of the operation. Several HTTP requests with the same request identified value are interpreted as the same request to be executed only once. This value may be generated randomly by the caller, but the same value should be used in case of retry.

X-Amzn-Trace-Idstring

The parameter Identifies this HTTP request across all services. It helps to diagnostic request errors. The parameter is added automatically by the API gateway

Request body

amountnumber double required

This is the amount to be sent to the customer.

currencystring required

The currency to use.

countrystring

The iSO country code of the phone number used for payout. This field is mandatory except for card payment

customerIdstring uuid

Optional. Unique Id of the customer. If provided, customer object below is ignored.

transactionType'payment' | 'transfer' | 'refund' | 'settlement'

type of transaction

paymentReasonstring

An optional message with a payment reason that is shown to customers in the payment receipt

merchantReferencestring

reference passed by client in the request

Example request

[
  {
    "amount": 10,
    "currency": "XOF",
    "country": "CI",
    "customerId": "fbd2053b-638d-4133-957e-3caf63e6b79c",
    "customerObject": {
      "id": "fbd2053b-638d-4133-957e-3caf63e6b79c",
      "name": "John Dao",
      "email": "john.dao@example.com",
      "address": "23, avenue de la liberté",
      "city": "Dakar",
      "country": "SN",
      "locale": "fr-FR",
      "createdAt": "2022-06-20T17:17:11Z",
      "updatedAt": "2022-06-20T17:17:11Z"
    },
    "paymentReason": "salary payment",
    "merchantReference": "33e1c83b-7cb0-437b-bc50-a7a58e5660ad"
  }
]

Response

The batch payout transaction is initiated.

idstring

Unique identifier of the batch payout transaction

Example response

{
  "id": "bp-a7a58e5660ad"
}