Collection West Africa

This endpoint allows you to initiate a collection to to collect XOF/XAF

Please note that orange network requires otp code for 'CI', 'GN', 'BF', 'SN' countries. We will return a redirect url where a merchant can redirect the customer or optionally request the otp from the customer and send it as 'otp' in the request body.

Supported XOF/XAF countries

Country Code	Currency Code	Route Name
CI	XOF	WESTAFRICA_MOBILEMONEY
SN	XOF	WESTAFRICA_MOBILEMONEY
BF	XOF	WESTAFRICA_MOBILEMONEY
CM	XAF	WESTAFRICA_MOBILEMONEY
ML	XOF	WESTAFRICA_MOBILEMONEY
TG	XOF	WESTAFRICA_MOBILEMONEY
BJ	XOF	WESTAFRICA_MOBILEMONEY
GN	XOF	WESTAFRICA_MOBILEMONEY

Create a Collection to XOF/XAF

POST /directdebit

Headers

Name	Value
Content-Type	application/json
Token	token

Body

Name	Type	Description
route_name	string	Payment route to use (e.g., WESTAFRICA_MOBILEMONEY)
debitor_name	string	Debitor/customer full name.
debitor_account	string	Debitor account identifier (often MSISDN or account number depending on route)
debitor_mobile	string	Debitor mobile number (MSISDN)
debitor_currency_code	string	Currency code (e.g., GHS).
debitor_country_code	string	Country code (e.g., GH).
reference_number	string	Unique reference for idempotency/reconciliation
amount	number	Amount to debit/collect.
callback_url	string	URL the system will call asynchronously with status updates

Keep reference_number unique to avoid duplicates.

callback_url should be publicly reachable if callbacks originate outside your network.

Request & Response

Request

{
  "route_name": "WESTAFRICA_MOBILEMONEY",
  "debitor_name": "John Doe",
  "debitor_account": "XV34387",
  "debitor_mobile": "2299550909596",
  "debitor_currency_code": "XOF",
  "debitor_country_code": "CI",
  "reference_number": "43434343N-CI",
  "amount": 20,
  "callback_url":"https://sandbox.yogupay.io/webhook-example"
}

Successful Response

Failed Response