Xtrempay Api Documentation

Initiate Bill Payment

Cloud Mock

https://mock.apidog.com/m1/918700-0-default

POST

/v1/biller/payment

Maintainer:Xtrempay Devs

Create a pending bill-payment record and emit a BillingPaymentInitiated event to kick off the saga.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Examples

Tv SubscriptionAirtimeElectricityData purchase

{
  "accountNumber": "1111111111111",
  "amount": 500,
  "fee": 0,
  "total": 500,
  "pin": 1234,
  "serviceType": "electricity-bill",
  "phoneNumber": "08132069992",
  "productCode": "Eko Electric Payment - EKEDC prepaid",
  "providerCode": "eko-electric",
  "transactionReference": "{{transactionReference}}"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Tv SubscriptionAirtimeElectricityData purchase

curl --location --request POST 'https://mock.apidog.com/m1/918700-0-default/v1/biller/payment' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "accountNumber": "1111111111111",
  "amount": 500,
  "fee": 0,
  "total": 500,
  "pin": 1234,
  "serviceType": "electricity-bill",
  "phoneNumber": "08132069992",
  "productCode": "Eko Electric Payment - EKEDC prepaid",
  "providerCode": "eko-electric",
  "transactionReference": "{{transactionReference}}"
}'

Responses

🟢200Success

application/json

Body

Example

{"timestamp":"2025-07-27T05:52:29.088607","status":200,"success":true,"message":"Bill payment Initiated","data":{"transactionReference":"1b9ae2d4-e583-4627-9164-7be563c2779d","status":"SUCCESSFUL","amount":6500,"unit":null,"token":"Token : 11786621902768210244"}}

🟠400Invalid input

Modified at 2025-09-19 12:09:39

List Products for a Biller

Customer Validation