v1

latestOpenAPI 3.0.12026-07-225791279.7 KB

Momo And ZAR Collections

XOF Process OTP

This endpoint processes the One Time Password that was retrieved by the user which would be used to complete the XOF(Orange only) Collection. For testing purposes, please use 2251114462945 for the OTP Required option. Also, use the OTP value 4567 for your tests..

post/subsidiary/collections/v1/process-otp

Request body

payment_tokenstring required

The payment token, this can be retrieved from the “Process Collection” API response.

otp_codestring required

The One Time Password sent to the customer.

payeestring required

The mobile money account number to be charged.

payment_methodstring required

The payment method. The default value is ORANGE_CI.

transaction_referencestring required

The unique identifier of the transaction.

transaction_channelstring required

This is the customer’s mobile money bank code.

country_codestring required

The ISO Country Code. (ISO 3166-1 alpha-2).

Example request

{
  "payment_token": "45c3d124-7831-4f97-8844-581bf497a20b",
  "otp_code": "4567",
  "payee": "+2251114462945",
  "payment_method": "ORANGE_CI",
  "transaction_reference": "MOCIV0009383",
  "transaction_channel": "MOMCIV",
  "country_code": "CI"
}

Response

Funding Successful

response_codestring

Code representing the status of the request (e.g., '09' for pending).

response_messagestring

Text description of the response code.

redirect_customer_to_url_processingboolean

Indicates whether the customer must be redirected to a URL to complete the action.

Example response

{
  "response_code": "09",
  "response_message": "PENDING"
}