Express Debit 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).

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": 50.25,
  "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.

🚧

Know before you integrate

Foghorn 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.