Momo, XOF and ZAR Process Collection

curl --request POST \ --url https://api.payaza.africa/live/subsidiary/collections/v1/process-collection \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data ' { "amount": 200.27, "customer_number": "233123456789", "transaction_reference": "UDHJQ012340", "transaction_description": "Test Payment", "customer_bank_code": "SAFKEN", "currency_code": "KES", "customer_email": "bigmaitre@blondmail.com", "customer_first_name": "Robert", "customer_last_name": "Stones", "customer_phone_number": "012345678901", "country_code": "KE" } '

Authorizations

Authorization

string

header

required

Payaza {{Public API Key in Base 64}}

Body

application/json

Momo Process Collection
ZAR Process Collection
XOF Process Collection

amount

number

The amount to be paid

customer_number

string

The mobile money account number to be charged. Ghana, Uganda, Kenya, Tanzania, Cameroon = 12 Digits(country code included), Sierra Leone = 11 Digits(country code included)

transaction_reference

string

The unique identifier of the transaction.

transaction_description

string

The description of the transaction

customer_bank_code

string

This is the customer’s bank code

currency_code

string

The currency code in ISO 4217 format (GHS, KES, TZS, UGX, XAF, LRD, SLE)

customer_email

string

The email address of the customer

customer_first_name

string

The first name of the customer

customer_last_name

string

The last name of the customer

customer_phone_number

string

The phone number of the customer

country_code

string

The ISO Country Code. (ISO 3166-1 alpha-2) (GH-Ghana, TZ-Tanzania, UG- Uganda, KE- Kenya, SL- Sierra Leone, CI- Côte d'Ivoire, BJ- Benin, LR- Liberia, CM - Cameroon)

Response

Momo, XOF and ZAR Process Collection

response_code

string

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

Example:

"09"

response_message

string

Text description of the response code.

Example:

"PENDING"

transaction_reference

string

Unique reference for the initialized transaction.

Example:

"MOCIV0009384"

requires_otp

boolean | null

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

Example:

false

otp_length

integer | null

The expected length of the OTP if required.

Example:

4

before_payment_instruction

string | null

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

Example:

"Assurez-vous de disposer de fonds suffisants..."

after_payment_instruction

string | null

Instructions to display to the user after payment authorization.

Example:

"Merci de confirmer le paiement..."

payment_token

string | null

Unique token generated for the payment session.

Example:

"e20467b2-d53d-484e-8fd5-a57fcb428d33"

payee

string | null

Phone number or identifier of the payee/customer.

Example:

"+2250004768076"

payment_method

string | null

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

Example:

"MTN_CI"

transaction_channel

string | null

The channel through which the transaction is processed.

Example:

"MOMCIV"

redirect_customer_to_url_processing

boolean | null

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

Example:

true

payment_completion_url

string<url> | null

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

Example:

"https://pay.wave.com/c/cos-..."

redirect_url

string<url> | null

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

Example:

"https://merchant.com/callback"