curl --location --request POST 'https://api.xente.co/api/transactions/payouts/utilities' \
--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,
"type": "DEBIT",
"message": "Your custom message",
"metadata": "InvoicePayment",
"product": {
"id": "NWSCWATERUG",
"productItemId": "NWSCWATERUG_NWSCWATERUG"
},
"beneficiary": {
"name": "John Doe",
"emailAddress": "johndoe@example.com",
"phoneNumber": "+1234567890",
"data": {
"customerReference": "4637738888" //Your Electricity/National Water Account Number,
"area": "Kampala" //Area is required for National water bill payments but optional for Electricity
}
}
}'
{
"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"
}
Bills
Post bill pay
This endpoint posts a new bill pay transaction
POST
/
api
/
transactions
/
payouts
/
utilities
curl --location --request POST 'https://api.xente.co/api/transactions/payouts/utilities' \
--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,
"type": "DEBIT",
"message": "Your custom message",
"metadata": "InvoicePayment",
"product": {
"id": "NWSCWATERUG",
"productItemId": "NWSCWATERUG_NWSCWATERUG"
},
"beneficiary": {
"name": "John Doe",
"emailAddress": "johndoe@example.com",
"phoneNumber": "+1234567890",
"data": {
"customerReference": "4637738888" //Your Electricity/National Water Account Number,
"area": "Kampala" //Area is required for National water bill payments but optional for Electricity
}
}
}'
{
"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
string
A unique identifier for the request.
string
A unique identifier for the batch.
string
The account number associated with the request.
number
The monetary amount involved in the request.
string
The type of request, initially not set.
string
An optional message associated with the request.
string
Additional metadata as a string.
string
The product’s unique identifier.
string
A specific item identifier within the product.
string
The beneficiary’s unique identifier.
string
The beneficiary’s name.
string
The beneficiary’s email address.
string
The beneficiary’s phone number.
string
Your Electricity/National Water Account Number.
string
Area is required for National water bill payments but optional for Electricity
Response
number
Indicates whether the call was successful. 0 if successful, error code if not.
string
Status message on outcome of the API call.
string
General message about the transaction status.
object
The contents of the transaction data.
Show Toggle object
Show Toggle object
curl --location --request POST 'https://api.xente.co/api/transactions/payouts/utilities' \
--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,
"type": "DEBIT",
"message": "Your custom message",
"metadata": "InvoicePayment",
"product": {
"id": "NWSCWATERUG",
"productItemId": "NWSCWATERUG_NWSCWATERUG"
},
"beneficiary": {
"name": "John Doe",
"emailAddress": "johndoe@example.com",
"phoneNumber": "+1234567890",
"data": {
"customerReference": "4637738888" //Your Electricity/National Water Account Number,
"area": "Kampala" //Area is required for National water bill payments but optional for Electricity
}
}
}'
{
"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"
}