Environments:

• Production Host is: https://api.bilrs.com/v2/
• Sandbox: The host is the same, but the key will differ
• Version: 2.0.0
• Contact: [email protected]

The BILRS API is an interface intended for integrating remittance companies and financial institutions with local billers around the world through a single hub, enabling consumers to pay utility bills for their family back home.

The BILRS API is a REST-based web service which can be used to programmatically make balance inquiries and process bill payments. The API uses JSON as its payload. The following sections will describe in detail each of the API endpoints, including the request and response parameters.

Authentication

All API requests to the BILRS API require authentication using a Bearer Token. The token must be included in the Authorization header of each request.

How to Add the Token:

1. Generate or Retrieve a Token:
   • Before making any requests, ensure you have a valid token for your session or authentication.
2. Include the Token in the Request:

   • In every API request, add the token in the Authorization header.

   • The format should be:

     Authorization: Bearer <your-token>
     
     

Example Request with Token:

Here’s an example of how to add the token in the request header:

curl -X POST "<https://api.bilrs.com/v2/balance>" \\\\
-H "Authorization: Bearer <your-token>" \\\\
-H "Content-Type: application/json" \\\\
-d '{
  "Currency": "MXN"
}'

Security Scheme:

The BILRS API uses an API key in the form of a Bearer token. It should be included in the Authorization header for all secured endpoints.