Chimoney’s Canadian Bill Payment Endpoint and How it Works

The Chimoney Canadian Bill Payment endpoint is designed to automate and streamline bill payments to various Canadian merchants. It ensures secure, quick, and accurate transactions, making it a great integration for businesses looking to manage their bill payments efficiently.

This article delves into the specifics of how Chimoney's Payout Canadian Bill Payment API works, highlighting practical applications, and its integration process.

Key Features of the Canadian Bill Payment Endpoint

The Canadian Bill Payment endpoint of Chimoney's Payout API is tailored to meet the needs of users looking to pay bills directly from their applications. Here are some of its standout features:

• Wide Range of Supported Billers: The API supports a comprehensive list of Canadian billers, ensuring that users can pay most of their regular bills, such as utilities, telecom, and credit card bills, through a single interface.
• Real-time Payment Processing: Payments made through the API are processed in real time, ensuring that bills are paid promptly and reducing the risk of late fees or service interruptions.
• Secure Transactions: Security is a top priority for Chimoney. The API uses advanced encryption and security protocols to protect sensitive information and ensure that all transactions are secure.

Practical Applications

Chimoney's Payout Canadian Bill Payment API can be used in various scenarios, including:

• Personal Finance Apps: Integration into personal finance apps allows users to manage and pay their bills directly from the app.
• Corporate Expense Management: Businesses can automate the payment of utility and service bills.
• Financial Institutions: Banks and financial service providers can offer bill payment services to their customers, adding value to their offerings.
• Flexible Payment Options: Users can choose from various payment methods, including direct bank transfers, making it convenient to pay bills using their preferred method.
• Tuition Payments: Schools and universities can integrate the API to automate the collection of tuition fees from students.

Integration Guide

To get started with the Payout Canadian Bill Payment endpoint using Nodejs, you first need to download the axios by running this:

npm install axios

Then you need to authenticate and make a POST request. Here is a sample code snippet demonstrating the process:

const axios = require('axios');

const options = {
  method: 'POST',
  url: 'https://api.chimoney.io/v0.2/payouts/bills/ca',
  headers: {
    accept: 'application/json',
    'content-type': 'application/json',
    'X-API-KEY': '97608b5f3b966e0aed35614b308a90e0f9e301296711e70af51cafb875786c03'
  }

This snippet initializes axios, authenticates using an API key, and makes a request to the Canadian bill payment endpoint. The response is logged to the console if successful, or an error is logged if the request fails.

Body Parameters

Executing a bill payment requires several parameters. These parameters are passed in the body of the POST request:

• subAccount (string): Specifies the subaccount (wallet account) to payout from. Optional.
• turnOffNotification (boolean): If true, disables email and other notifications from Chimoney. Optional.
• debitCurrency (string): Specifies the wallet currency to debit from.
• billingData (array of objects): Contains the billing details. Required.

Billing Data Object Parameters

Each object in the billingData array must include the following fields:

• email (string): Required. The email of the payer.
• firstname (string): Required. The first name of the payer.
• lastname (string): Required. The last name of the payer.
• payeeCode (string): Required. The merchant's payee code.
• payeeName (string): Required. The merchant's payee name.
• valueInUSD (string): Required. The amount to pay the merchant in USD.
• amount (string): Required. The amount to pay the merchant.
• accountID (string): Required. The customer's account number for the specified payee.
• narration (string): Optional. A brief description of the transaction provided by the merchant.
• collectionPaymentIssueID (string): Optional. The issue ID for the payment payout initiated.

Example of a Complete Request Body

Here is an example of how the request body might look:

const axios = require('axios');

const options = {
  method: 'POST',
  url: 'https://api-v2-sandbox.chimoney.io/v0.2/payouts/bills/ca',
  headers: {
    accept: 'application/json',
    'content-type': 'application/json',
    'X-API-KEY': '97608b5f3b966e0aed35614b308a90e0f9e301296711e70af51cafb875786c03'
  },
  data: {
    billingData: [
      {
        email: 'payer@example.com',
        firstname: 'John',
        lastname: 'Doe',
        payeeCode: 'M123',
        payeeName: 'Utility Company',
        valueInUSD: '100.00',
        amount: '130.00',
        accountID: 'ACC12345678',
        narration: 'June utility bill payment',
        collectionPaymentIssueID: 'ISSUE98765'
      }
    ],
    subAccount: 'sub12345',
    turnOffNotification: false,
    debitCurrency: 'CAD'
  }
};

axios
  .request(options)
  .then(function (response) {
    console.log(response.data);
  })
  .catch(function (error) {
    console.error(error);
  });

In this example, the subAccount and turnOffNotification fields are optional and can be omitted if not needed. The billingData array contains an object with all the required details for the bill payment.

Conclusion

Chimoney's Payout Canadian Bill Payment endpoint is a great integration for automating bill payments. Businesses and organizations can integrate it into their systems to enhance efficiency and accuracy in handling Canadian bill payments.

Book a meeting today to learn more about how Chimoney's Payout API can benefit your business.