This document explains the API specification that a biller needs to implement so that EBPP can pull customer, customer account and billing related information in real-time.

EBPP supports API Keys over HTTP Headers.

In this authentication scheme, EBPP would send API Keys, in the form of HTTP headers, as part of the request. These API Keys must be configured in EBPP by the biller/client beforehand. Clients can check for the authenticity of the request by comparing the API keys and values received in the request with the ones configured in EBPP. Clients can configure more than one API Keys based on their business needs.

This API specification supports standard HTTP response codes to return the status of an API call. Additional information, such as errors, may be useful to the caller (EBPP). An HTTP response code of 2xx indicates success. An HTTP response code of 4xx indicates a client error and 5xx indicates a processing error. In these cases, billers are expected to return the list of errors in the format specified in the Error Codes section. Each error has a code, message and specifics on which field the error pertains to (if applicable.)

An HTTP response code of 4xx indicates a client error and 5xx indicates a processing error. Each error has a code, message and field.

Example :

{
  "errors": [
   {
      "code": "error_field",
      "message": "The error returned if a mandatory field is missing value or if the value is invalid. This is accompanied by the field that caused the error.",
      "field": "account_number"
   }
  ]
}

The following error codes can be implemented by the biller.

Customers holds Customer Accounts. A Payment is always made against a Customer Account by/on behalf of a Customer using an associated Funding Account.

Customer : The individual or entity associated with a Customer Account.

Customer Account : The billing account against which a Customer makes payments.

This section outlines the API required to exchange and manage customer information, such as customer account details.