Bulk payment links CSV parameters
When creating and sending bulk payment links, the CSV file that you upload must adhere to the following restrictions, you cannot add your own parameters:
| Column | Description | Type | Format | Condition |
|---|---|---|---|---|
INVOICE_ID | The merchant-provided reference number. | String (8-255) | AN255 \n[\s\S]{8,255} | Required |
AMOUNT | The payment request amount. | Number (0.01 - 1000000.00) | N10.N2 \n[0-9]{1,10}(.[0-9]{2})? | Required |
CURRENCY | The payment request's amount ISO 4217 currency code. | String (3) | A3 \n[A-Z]{3} | Required |
NOTES | The payment note less than 141 characters. | String (0-140) | AN \n[\s\S]{0,140} | Optional |
EXPIRY_TIME | The time in minutes until the link expires. The default and maximum expiry time is 30 days. | Number (5 - 43200) | Number | Optional |
CUSTOMER_GIVEN_NAME | The customer's first or given name. Required if you send any other customer parameters, also required for some risk checks and payment providers. Truncated after 48 characters. | String (2-50) | AN \n[\s\S]{2,50} | Required |
CUSTOMER_SURNAME | The customer's last name or surname. Required if you send any other customer parameters, also required for some risk checks and payment providers. Truncated after 48 characters. | String (2-50) | AN \n[\s\S]{2,50} | Required |
CUSTOMER_EMAIL | The customer's email address. Required for communicating with customers about payment. Required if SEND_EMAIL is true. | String (6-128) | AN128 \n[\s\S]{6,128} | Conditional |
CUSTOMER_MOBILE | The customer's mobile number. Required for communicating with customers about payment. Format should be +27123456789. Required if SEND_SMS is true. | String (5-25) | AN25 \n[+0-9][0-9 \.()/-]{5,25} | Conditional |
CUSTOMER_WHATSAPP | The customer's WhatsApp number. Required for communicating with customers about payment. Format should be +27123456789. Required if SEND_WHATSAPP is true. | String (5-25) | AN25 \n[+0-9][0-9 \.()/-]{5,25} | Conditional |
BILLING_STREET1 | The door number, floor, building number, building name, and street name of the address. | String (1-100) | AN100 \n[\s\S]{1,100} | Optional |
BILLING_CITY | The town, district, or city of the billing address. Mandatory for 3-D Secure 2. | String (1-48) | AN48 \n[\s\S]{1,48} | Optional |
BILLING_STATE | The county, state, or region of the address. | String (1-50) | AN50 \n[\s\S]{1,50} | Optional |
BILLING_POSTALCODE | The postal code or ZIP code of the address. | String (1-16) | AN16 \n[\s\S]{1,16} | Optional |
BILLING_COUNTRY | The country of the address. | String (2) ISO 3166-1 alpha 2 | A2 \n[A-Z]{2} | Optional |
SEND_EMAIL | Specifies whether to send an email to the customer after creating the payment link. | Boolean | False: false, no, n, 0, blank \nTrue: true, yes, y, 1 | Conditional |
SEND_SMS | Specifies whether to send an SMS to the customer after creating the payment link. | Boolean | False: false, no, n, 0, blank \nTrue: true, yes, y, 1 | Conditional |
SEND_WHATSAPP | Specifies whether to send a WhatsApp message to the customer after creating the payment link. | Boolean | False: false, no, n, 0, blank \nTrue: true, yes, y, 1 | Conditional |
EMAIL_CC | List of comma-separated email addresses. | String (0-128) | AN128 \n[\s\S]{6,128} | Optional |
EMAIL_BCC | List of comma-separated email addresses. | String (0-128) | AN128 \n[\s\S]{6,128} | Optional |
Updated about 5 hours ago