Liquid Internet Payment

1. Liquid Customer Inquiry
GET api/liquid/getcustomerdetails/{emailaddress}

This method returns customer information based on the provided email address.

Access to this endpoint requires setup changes on your account. Contact the technical team for this configuration to be completed.

Request Formats
api/liquid/getcustomerdetails/123@abc.com

where 123 is the email address of the customer

Response Information
Sample Response
{
  "customer_id":"string",
  "customer_name":"string",
  "customer_email":"string",
  "service_id":"string",
  "package":{
    "name":"string",
    "price":"20.00",
    "currency":"USD",
    }
}

2. Liquid Payment Request

POST /api/liquid/payment

This method initiates a purchase request for internet units to the provided customer.

Access to this endpoint requires setup changes on your account. Contact the technical team for this configuration to be completed.

The table below provides information about the properties expected in the payload to be sent to this request:

PropertyDataType (maxSize)RequiredDescription
OrderObjectYesInformation about the operation to be performed
Order.customerFullNameString(180)NoFull Name for customer
Order.customerPhoneNumberString(180)NoPhone Number of the customer
Order.transactionReferenceString(20)YesReference transaction ID from source request to be used in reconciliations
Order.customerEmailAddressString(180)NoEmail address of the customer
Order.currencyString(3)YesChar 3 ISO currency code
Order.amountDecimal(8,2)YesAmount involved in the transaction
DestinationObjectYesInformation about the beneficiary
Destination.customeridStringYesThe customer id
Destination.serviceidStringYesThe service id
Request Formats
Sample Request
{
  "order": {
    "customerFullName": "string",
    "customerPhoneNumber": "string",
    "customerEmailAddress": "string",
    "transactionReference": "string",
    "amount": 10,
    "currency": "USD”
    },
  "destination": {
    "customerid": "string",
    "serviceid": "string"
    }
}
Response Information
Sample Response
{
  "transactionId": "string",
  "originatingTransactionId": "string”,
  “statusCode”:”200”,
  “statusDescription”:”SUCCESS”,
}