Sign in

v1

latestOpenAPI 3.0.12026-07-225791279.7 KB
Momo And ZAR Collections

Momo, XOF and ZAR Process Collection

This endpoint initiates mobile money collection for various currencies such as KES, GHS, UGX, TZS, LRD, ZAR, XOF and XAF. The Momo collections guide can be found here

Notes:

  • Payaza MOMO collection codes can be accessed <a href="https://docs.google.com/spreadsheets/d/1BOGf_mSLS6rGNm1vn3cO4A2vW9oqZVGI_PxxxXnMK9o/edit?usp=sharing" target="_blank">here</a>.

  • Please be advised that collections to countries other than Nigeria are exclusively available upon request. To initiate this process, kindly send an email to support@payaza.africa. You will be granted access once our team reviews and approves your request.

  • For XOF testing purposes, please use either 225000476807 for the No OTP Required option or 2251114462945 for the OTP Required option. Also, use the OTP value 4567 for your tests.

post/subsidiary/collections/v1/process-collection

Request body

OR
OR

Example request

{
  "amount": 350,
  "customer_number": "2251114462945",
  "transaction_reference": "MOCIV0009383",
  "transaction_description": "Test Payment",
  "customer_bank_code": "MOMCIV",
  "currency_code": "XOF",
  "customer_email": "johndoe@yahoo.com",
  "customer_first_name": "John",
  "customer_last_name": "Doe",
  "customer_phone_number": "2251114462945",
  "country_code": "CI",
  "redirect_url": "https://your-website.com/callback"
}

Response

Momo, XOF and ZAR Process Collection

response_codestring

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

response_messagestring

Text description of the response code.

transaction_referencestring

Unique reference for the initialized transaction.

requires_otpboolean nullable

Indicates if the customer needs to provide an OTP to authorize the payment.

otp_lengthinteger nullable

The expected length of the OTP if required.

before_payment_instructionstring nullable

Instructions to display to the user before they authorize the payment.

after_payment_instructionstring nullable

Instructions to display to the user after payment authorization.

payment_tokenstring nullable

Unique token generated for the payment session.

payeestring nullable

Phone number or identifier of the payee/customer.

payment_methodstring nullable

The specific payment method used (e.g., WAVE, MTN_CI, ORANGE_CI, EFTZAR).

transaction_channelstring nullable

The channel through which the transaction is processed.

redirect_customer_to_url_processingboolean nullable

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

payment_completion_urlstring url nullable

The URL to redirect the customer to complete the ZAR transaction.

redirect_urlstring url nullable

The URL to redirect the customer after the transaction is completed.

Example response

{
  "response_code": "09",
  "response_message": "PENDING",
  "transaction_reference": "MOCIV0009384",
  "otp_length": 4,
  "before_payment_instruction": "Assurez-vous de disposer de fonds suffisants...",
  "after_payment_instruction": "Merci de confirmer le paiement...",
  "payment_token": "e20467b2-d53d-484e-8fd5-a57fcb428d33",
  "payee": "+2250004768076",
  "payment_method": "MTN_CI",
  "transaction_channel": "MOMCIV",
  "redirect_customer_to_url_processing": true,
  "payment_completion_url": "https://pay.wave.com/c/cos-...",
  "redirect_url": "https://merchant.com/callback"
}