POST
/
api
/
transactions
/
payouts
/
mobilemoney
{
  "requestId": "72399933543589",//Id from your system to uniquely identify the transaction
  "batchId": "batch5678",
  "amount": 1000,
  "type": "PAYOUT", //use DEPOSIT to fund your account, PAYOUT to fund other accounts
  "message": "Payment received for invoice #1234",
  "metadata": "InvoicePayment",
  "product": {
    "id": "AIRTELDATABUNDLESUG",
    "productItemId": "AIRTELDATABUNDLESUG_24510766" 
  },
  "beneficiary": {
    "id": "ben003", //Id from your system to identify beneficiary
    "name": "John Doe",
    "emailAddress": "johndoe@example.com",
    "phoneNumber": "+1234567890", 
    "data": {
      "phoneNumber": "+1234567890" //The mobile money number to deposit or remove funds from
    }
  }
}
{
  "message": "Transaction Has Been Successfully Received. Notification Will Be Sent Shortly",
  "data": {
    "requestId": "e482caf1-18c4-4312-a708-8032969541d4",
    "batchId": "123123123123",
    "transactionId": "0f9182ad-bf5e-4854-799e-08dc2bc9741e",
    "status": "PROCESSING",
    "message": "Processing Debit Transaction. Instant Payment Notification will be sent shortly",
    "createdOn": "2/12/2024 12:52:21 PM"
  },
  "code": 0,
  "status": "success"
}

Body

requestId
string
A unique identifier for the request.
batchId
string
A unique identifier for the batch.
accountNumber
string
The account number associated with the request.
amount
number
The monetary amount involved in the request.
type
string
The type of request, initially not set.
message
string
An optional message associated with the request.
metadata
string
Additional metadata as a string.
product.id
string
The product’s unique identifier.
product.productItemId
string
A specific item identifier within the product.
beneficiary.id
string
The beneficiary’s unique identifier.
beneficiary.name
string
The beneficiary’s name.
beneficiary.emailAddress
string
The beneficiary’s email address.
beneficiary.phoneNumber
string
The beneficiary’s phone number.
beneficiary.data.phoneNumber
string
Another phone number associated with the beneficiary, potentially for different purposes.

Response

code
number
Indicates whether the call was successful. 0 if successful, error code if not.
status
string
Status message on outcome of the API call.
message
string
General message about the transaction status.
data
object
The contents of the transaction data.
{
  "requestId": "72399933543589",//Id from your system to uniquely identify the transaction
  "batchId": "batch5678",
  "amount": 1000,
  "type": "PAYOUT", //use DEPOSIT to fund your account, PAYOUT to fund other accounts
  "message": "Payment received for invoice #1234",
  "metadata": "InvoicePayment",
  "product": {
    "id": "AIRTELDATABUNDLESUG",
    "productItemId": "AIRTELDATABUNDLESUG_24510766" 
  },
  "beneficiary": {
    "id": "ben003", //Id from your system to identify beneficiary
    "name": "John Doe",
    "emailAddress": "johndoe@example.com",
    "phoneNumber": "+1234567890", 
    "data": {
      "phoneNumber": "+1234567890" //The mobile money number to deposit or remove funds from
    }
  }
}
{
  "message": "Transaction Has Been Successfully Received. Notification Will Be Sent Shortly",
  "data": {
    "requestId": "e482caf1-18c4-4312-a708-8032969541d4",
    "batchId": "123123123123",
    "transactionId": "0f9182ad-bf5e-4854-799e-08dc2bc9741e",
    "status": "PROCESSING",
    "message": "Processing Debit Transaction. Instant Payment Notification will be sent shortly",
    "createdOn": "2/12/2024 12:52:21 PM"
  },
  "code": 0,
  "status": "success"
}