Create Payment

post

https://api.clik2pay.com/open/v1/payments

Returns a unique {paymentId} for a payment transaction.

Body Params

merchantTransactionId

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.

amount

double

required

≥ 0.01

The amount in Canadian dollars.

status

string

merchant

object

Details of the merchant that is sending the payment.

recipient

object

required

The person or organization receiving the payment. Both email and mobileNumber are required.

displayMessage

string

length between 3 and 250

The message presented to the recipient on Interac's Gateway page. If not set, a default message in the format agreed upon with the merchant will be displayed.

invoiceNumber

string

length ≤ 50

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

businessUnit

string

length ≤ 50

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

expiryDays

number

1 to 365

Number of days for the payment to expire if not processed by the recipient.

Responses

401

Unauthorized

Language

Credentials

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created

400Bad Request

403Forbidden

429Too Many Requests

500Internal Server Error