POST
/
api
/
transactions
/
collections
/
mobilemoney

curl --location --request POST 'https://api.xente.co/api/transactions/collections/mobilemoney' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
  "requestId": "92399933543589", //Id from your system to uniquely identify the transaction
  "batchId": "batch5678", //Identifier og the batch from your system.
  "amount": 1000.0,
  "type": "CREDIT",
  "message": "some message or note",
  "metadata": "json string",
  "provider": {
    "providerItemId": "AIRTELMONEYUG_AIRTELMONEYUG"
  },
  "beneficiary": {
    "id": "CUST_1",
    "name": "test001",
    "emailAddress": "test001@gmail.com",
    "phoneNumber": "+256702000000",
    "data": {
      "phoneNumber": "+256702000000" //The mobile money number where funds are to be collected from
    }
  }
}'


{
    "code": 0,
    "message": "Transaction Has Been Successfully Received. Notification Will Be Sent Shortly",
    "data": {
        "requestId": "32399933543589",
        "batchId": "batch5678",
        "transactionId": "ef2ebc1e-1c2e-4fb1-23eb-08dc379d52c7",
        "status": "PROCESSING",
        "message": "Processing Debit Transaction. Instant Payment Notification will be sent shortly",
        "createdOn": "2/27/2024 2:06:41 PM"
    }
}

​
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.
​
provider.id
string
The provider’s unique identifier.
​
provider.providerItemId
string
A specific item identifier within the provider.
​
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
The mobile money number where funds are to be collected from.

​
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.

curl --location --request POST 'https://api.xente.co/api/transactions/collections/mobilemoney' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
  "requestId": "92399933543589", //Id from your system to uniquely identify the transaction
  "batchId": "batch5678", //Identifier og the batch from your system.
  "amount": 1000.0,
  "type": "CREDIT",
  "message": "some message or note",
  "metadata": "json string",
  "provider": {
    "providerItemId": "AIRTELMONEYUG_AIRTELMONEYUG"
  },
  "beneficiary": {
    "id": "CUST_1",
    "name": "test001",
    "emailAddress": "test001@gmail.com",
    "phoneNumber": "+256702000000",
    "data": {
      "phoneNumber": "+256702000000" //The mobile money number where funds are to be collected from
    }
  }
}'


{
    "code": 0,
    "message": "Transaction Has Been Successfully Received. Notification Will Be Sent Shortly",
    "data": {
        "requestId": "32399933543589",
        "batchId": "batch5678",
        "transactionId": "ef2ebc1e-1c2e-4fb1-23eb-08dc379d52c7",
        "status": "PROCESSING",
        "message": "Processing Debit Transaction. Instant Payment Notification will be sent shortly",
        "createdOn": "2/27/2024 2:06:41 PM"
    }
}