Batch Payment Requests

Streamline Your Payments with Batch Payment Requests

The Batch Upload feature allows you to directly send payment requests in bulk via SMS or email with just one click.

How to Use Batch Upload

Prepare Your CSV File: Input the transaction details into a CSV file. A sample CSV file is available in the Clik2pay Portal for your reference.
Upload Your CSV File: Navigate to the Batch Upload page in the Clik2pay Portal and upload your file.
Review Batch Results: Once uploaded, Clik2pay will automatically generate a Batch Result File in the Portal, showing whether each payment request was successfully scheduled.
Send Payment Notifications: After processing, payment notifications will be sent to customers via SMS or email. You can also access the Clik2pay short payment code, payment link, and QR code link for each payment request.
Monitor Transactions: All payment requests will be visible in the Transactions section of the Clik2pay Portal.
Batch API: Clik2pay also offers a Batch API to further optimize your batch requests. For more details, please visit Batch Submit Payment Request.

Requirements for Uploading a Batch File

To ensure successful processing, your Batch Upload CSV file must meet the following requirements:

Input Fields: Columns A to M are input fields in the Batch Upload file. Refer to the provided table for the required input fields and examples.
Maximum Requests: The Batch Upload feature supports up to 10,000 payment requests per upload.
File Format: Only CSV or text files are supported, with a maximum file size of 5MB.
Field Names: Field input names must match exactly as specified in the sample file. Do not rename the input field row names.
Output Fields: Columns N to W are output fields generated by Clik2pay in the Batch Result file, providing detailed transaction results.

Required Batch Input Fields

Column	Batch Input Fields	Description
A	bill_amount (required)	The amount of the payment in Canadian dollars. Example: *50.25
B	customer_name (required)	The name of the payer. The character length must be between 3 and 100. Example: *Jane Doe
C	cust_account_number (required)	The merchant's account ID for the payer. The character length must be between 4 and 100. Example:* 1234
D	due_date	The date on which payment is due. Note:* that this is an information field and nothing happens if the customer doesn't pay by the due date Format:*YYYY-MM-DD or YYYY/MM/DD
E	customer_mobile_number *(required)	The mobile number to contact the payer. Required when request_notification is SMS. Example: *9051234567
F	customer_email (required)	The email address to contact the payer. Required when request_notification is EMAIL. Example:* [email protected]
G	biller_end2end_id	Unique end-to-end identifier of a payment, as assigned by the merchant. The character length must be between 3 and 100.
H	biller_payment_type (required)	The type of transaction for the payment. Always use EBILL unless this is an e-commerce transaction. Possible values:* EBILL, ECOMM, FLEX
I	request_notification (required)	The method to use to notify the payer of the request. Possible values:* SMS, EMAIL, NONE
J	delivery_date	The date on which payment will be delivered to the customer. Format:*YYYY-MM-DD or YYYY/MM/DD
K	customer_preferred_language	The preferred language of correspondence. Currently, only English and French are supported. Possible values:* en, fr
L	transaction_display_message	The message presented to the payer on Interac's Gateway page. If not set, a default message will be displayed. Minimum length 3, maximum length 250 characters.
M	merchant_invoice_number	An invoice number to apply to the payment for tracking purposes. Maximum length 50 characters.
N	merchant_business_unit	A value to identify the business unit of a merchant to support grouping of payment by unit. Maximum length 50 characters.
O	flex_requested_amount	The requested amount of the payment in Canadian dollars. Example: *50.25
P	flex_minimum_amount	The minimum amount of the payment in Canadian dollars. Example: *10.00
Q	flex_maximum_amount	The maximum amount of the payment in Canadian dollars. Example: *100.50

Batch Fields Returned by Clik2pay

Column	Batch Returned Fields	Description
R	biller_id	The unique identifier of the merchant for the payment.
S	biller_trans_id	The unique identifier of the payment.
T	biller_trans_status	Payment request status Values Returned:* CREATED, SMS_SENT, EMAIL_SENT, FAILED
U	expiry_date	The date when the payment is set to expire.
V	c2p_paymentlink	The direct URL the payer can use to complete the payment.
W	c2p_shortcode	A unique identifier tied to a payment request that can be used by the payer to complete the payment.
X	c2p_QRcodelink	The link to a QR code image which when scanned would direct a payer to the payment link.
Y	created_date	The date the payment was created.
Z	status	The status of a created payment. Possible Values: SUCCESS or FAIL
AA	errors	The error message associated with payments that failed to generate