API Reference

Create Payment Request

post
https://api.clik2pay.com/open/v1/payment-requests

Returns a unique {paymentRequestId} for a payment request transaction.

Body Params
string
length between 6 and 32

Optional value to allow tracking a transaction back to your system. The ID must be unique across transactions for a merchant.

double
required
0.01 to 10000

The payment amount in Canadian dollars. (Use “null” when type is FLEX.)

string
enum
required

The type of transaction for the payment request:

  • ECOMM For web-based applications where the payment is initiated directly from your website or online platform. This type is ideal for standard e-commerce checkouts.
  • MOBIL This type has been deprecated.
  • EBILL Designed for scenarios where you need to send payment links externally. This includes generating payment links for distribution via email, SMS, QR codes, or embedding directly into your merchant-managed pages.
  • SMART Read only. Creates reusable payment links. This is suitable for general payment collection where you can set certain parameters to be filled out by the customer prior to making a payment.
  • FLEX Allows the customer to pay an amount within a dynamic range you define, enabling partial payments towards a total. You can specify minimum and/or maximum payment thresholds, giving the customer control over the immediate payment amount until the full balance is paid.
Allowed:
string
date

The date on which the payment request is delivered to the payer.

string
enum

The method to use to notify the payer of the request.

Allowed:
merchant
object

Details of the merchant that owns the payment request.

payer
object
required

The customer fulfilling the payment.

flexDetails
object

Data used for flexible payments. Required only if payment type is FLEX.

date

The date (ISO 8601) on which payment is due. Informational field only; no further action is taken by our systems if the date is surpassed.

string
length between 3 and 250

The message presented to the payer on Interac's Gateway page. If not set, a default message will be displayed.

string
length ≤ 50

Merchant’s invoice number to apply to the transaction for tracking purposes.

string
length ≤ 50

Merchant-defined value. Allows a merchant to refer to their internal business unit, department, division, etc.

emailTemplate
object

Email notification to the payer will be sent with this template.

Responses

401

Unauthorized

Updated 7 months ago

Language
Credentials
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago