Clik2pay makes real-time payments acceptance easy for businesses. Any device. Any time.

Payment Requests API allows you to initiate customized Interac e-Transfer payment requests to your customers. Payment requests are created through backend sessions which supply a live payment link to your system. Depending on your user interface and the use case, the payment link can be opened in a separate browser window, displayed as a clickable button, QR code, short code, or a link (in a text message).

Features

• Direct-from-account payment link - that's embedded in an email or text message and delivered to the payer. A payment link can be fulfilled by anyone with a Canadian bank account.

• Customized transaction messaging - used for email and text message payment requests, businesses can set relevant data fields to identify the payment for the customer and facilitate reconciliation.

• Clik2pay Flexible Payments - businesses can request their customer to pay an amount within a custom range (minimum and/or maximum) chosen by the business.

• Clik2pay Scheduled Payments - businesses can request a payment for a specific future date, or set up a series of recurring payment requests.

• Cancel a Payment Request- used for terminating transactions that were created in error, created with incorrect values or are no longer needed (eg. the business no longer needs to request money from a payer).

• Refund a Payment Request- used for issuing full or partial refunds on a completed payment request transaction.

• Name Matching- businesses can verify payers' names against account holders' information provided by the financial institutions. Name Matching can be used with both Payment Requests and Payments APIs.

Clik2pay Flexible Payments

Businesses can create a flexible payment link through the Payment Requests API by:

1. Calling our Create Payment Request endpoint
2. Set transaction type field to FLEX
3. Under the flexDetails object, set values for the following fields:
   1. "requested": xx.xx,
   2. "minimum": xx.xx,
   3. "maximum": xx.xx,

For example, the request body would look like this:

{
  "amount": null,
  "type": "FLEX",
  "merchant": {
    "id": "1234",
  },
  "payer": {
    "name": "Jane Doe",
    "merchantAccountId": "AA6789",
    "mobileNumber": "4165551234",
  },
  "flexDetails": {
    "requested": 40.75,
    "minimum": 30.25,
    "maximum": 80.75
}

Clik2pay Scheduled Payments

Businesses can create a scheduled payment link through the Payment Requests API by:

1. Calling our Create Payment Request endpoint
2. Set deliveryMode field to SMS or EMAIL
3. Set deliveryDate field with a future date that you want the SMS or EMAIL to be sent to the payer YYYY-MM-DD

For example, the request body would look like this:

{
  "amount": 50.25,
  "type": "EBILL",
  "deliveryMode": "SMS",
  "deliveryDate": "2022-07-26",
  "merchant": {
    "id": "1234",
  },
  "payer": {
    "name": "Jane Doe",
    "merchantAccountId": "AA6789",
    "mobileNumber": "4165551234",
  },
}

Cancel a Payment Request

Businesses that want to terminate a payment link can use our Cancel a Payment Request endpoint.

Note this action will only cancel unpaid transactions.

Refund a Payment Request

Businesses that want to issue refunds against a completed payment request can use our Refund a Payment Request endpoint.

Note that only one refund can be issued against a payment requested, the payment request status must be either PAID or SETTLED, and the refund amount cannot be greater than the paid amount.

Name Matching

The optional Name Matching feature sources industry-grade data from financial institutions to match against the payers' names, as they appear in the Payment Requests and Payments transactions. The feature uses an algorithm that provides a results score indicating how well the two names match (positive points) or mismatch (negative points).

• Any score between 0.0 – 1.0 is a match, with 0.1 being a low certainty of a match and 1.0 being a high certainty of a match.
• The vice versa is also true: A score between -1.0 – 0.0 is a mismatch, with -1.0 being a high certainty of a mismatch and -0.1 being a low certainty of a mismatch.

Get the payment status

In addition to receiving real-time transaction updates via webhook call, businesses have the option of using our GET Payment Status endpoint.

🚧

Know before you integrate

Clik2pay offers two environments to our merchants. Start your integration with the sandbox environment, then after successful test integration progress to production. We will support you through each step of the development.