Initiate mobile money push payment

Method: GET /payments/transactions/initiate

Resource URL:

Test

https://api.sandbox.irembopay.com/payments/transactions/initiate

Production

Method: POST

Headers:

• irembopay-secretKey: secretKey

• X-API-Version: 2

This API does not require authentication.

Request body

Data representation: JSON

Name	Type	Mandatory?	Comments
accountIdentifier	String	Yes	Identifier of the user account to be charged. Phone numbers should be valid Rwanda phone numbers in the format 07********
paymentProvider	String	Yes	Possible values: MTN, AIRTEL
invoiceNumber	String	Yes	Invoice Number to be charged to the user.
transactionReference	String	No	Optional transaction reference from the provider

---

Response body payload

For this endpoint, the "data" payload in the response will have the fields below:

Name	Type	Mandatory?	Comments
accountIdentifier	String	Yes	Identifier of the user account to be charged. Phone numbers should be valid Rwanda phone numbers in the format 07********
paymentProvider	String	Yes	Possible values: MTN, AIRTEL
invoiceNumber	String	Yes	Invoice Number to be charged to the user.
amount	double	Yes	Amount of the invoice.
referenceId	String	Yes	IremboPay unique identifier of the request

---

Error codes

HTTP code	Error code	Description
400	PHONE_NUMBER_MISSING	No phone number provided
400	INVOICE_EXPIRED	The invoice has expired
400	INVOICE_ALREADY_PAID	The invoice is already paid
400	INVOICE_ALREADY_IN_BATCH	The invoice is part of a batch invoice and cannot be paid individually.
400	BAD_DATA	Currency of the invoice is not RWF.
400	BAD_PAYMENT_PROVIDER	The value of the payment provider is not valid.
400	INVOICE_MISSING	Invoice number is not provided in the request body
400	PAYMENT_PROVIDER_ERROR	MTN number provided for AIRTEL payment provider or vice versa
400	BAD_PHONE_NUMBER	The account identifier provided is more or less than 12 digits
404	INVOICE_NOT_FOUND	The invoice provided does not exist

Initiate a mobile money transaction

post

This endpoint initiates a mobile money transaction with the provided payment details.

Body

application/json

accountIdentifierstringRequiredExample: 0781110011

paymentProviderstringRequiredExample: MTN

invoiceNumberstringRequiredExample: 880310977877

transactionReferencestringRequiredExample: MTN_001

Responses

201

Transaction initiated successfully

application/json

400

Bad request, invalid input

application/json

post

/payments/transactions/initiate

PayloadJavaScriptJavaPython

{
  "accountIdentifier": "0781110011",
  "paymentProvider": "MTN",
  "invoiceNumber": "880310977877",
  "transactionReference": "MTN_001"
}

{
  "message": "Momo transaction initiated successfully",
  "success": true,
  "data": {
    "accountIdentifier": "0780000000",
    "paymentProvider": "MTN",
    "invoiceNumber": "880301716170",
    "amount": 30000,
    "referenceId": "b1571d4b-7cb9-4d1e-b826-b1c05fee08f9"
  }
}