Bill Payment

base_url: http://sandbox.etranzactng.com/SBP

Description: This endpoint is used for Bill Payment

Sample Request

Request Parameters

Parameter	Description
clientRef	This is the unique transaction id generated per transaction by client and should be between 10 and 25 digits
billQueryRef	This is the unique eTz reference generated in bill-query stage of process. This field will require the exact reference returned upon successful bill query
billId	This is the corresponding Biller ID (First ID returned in the service-type endpoint)
customerId	This holds the biller ID example smartcard number, meter number etc
mobile	Customer’s phone number in 234 prefix format
channel	Channel code (Method of payment). See page 25 for list of channel codes and corresponding description

POST /bill-payment

curl `${base_url}/bill-payment`
-H "Content-type: application/json"
-X POST
-d '{
    "clientRef": "783-745-6771",
    "billQueryRef": "09FG221222221356544JE874V",
    "billId": 18,
    "customerId": "04175299546",
    "amount": 500,
    "mobile": "09039639237",
    "channel": "11"
}
'

info

Payload may differ depending on biller. All billers and their respective payload can be found at Billers Payment Payloads and Sample Customer ID'S Section

Sample Response

Bill-Payment response parameters (Result Payload)

Parameter	Description
clientRef	This is the unique client generated transaction ID from request
paymentRef	This is the eTz client generated transaction ID in response to request. NB: The value of this parameter is required in the billQueryRef field of Bill Payment request payload in order to perform a successful transaction
customerId	This holds the biller ID example smartcard number, meter number etc.
terminalId	Client Identification Number
mobile	Customer’s phone number in 234 prefix format
productId	This holds the product plan paid for
billId	This is the corresponding Biller ID
billName	Biller Name
billerCode	Biller Alias
customerName	This contains customer’s details, the pipe (|) symbol is used as the delimiter (separator) between the Customer’s details
status	Status of query
token	Recharge token from Biller (PHCN)
keyChangeToken1
keyChangeToken2
error	Error code
errorMessage	Error description
receipt	Unique reference generated by Biller

POST /bill-payment

{
  "status": true,
  "message": "Bill Payment was successful",
  "result": {
    "clientRef": "783-745-6771",
    "paymentRef": "09FG221222221417801CTZBZR",
    "customerId": "04175299546",
    "terminalId": "7000000001",
    "mobile": "09039639237",
    "productId": null,
    "billId": 23,
    "billName": "PHCN Abuja PrePaid",
    "billerCode": "phcnabj",
    "customerName": "UNIT:6.8|AMOUNT:500.0|VAT:34.88",
    "status": "PAID_PROCESSED",
    "token": "44352287565454489571",
    "keyChangeToken1": " ",
    "keyChangeToken2": "",
    "error": "0",
    "errorMessage": null,
    "receipt": "7031202212220000150"
  }
}