Checkout by link
When enrolling a new customer and/or adding a first payment, a redirect link can be sent by email in order to complete the Checkout process. Using a list of email addresses, this same operation can be done for many customers simultaneously with the SlimPay File API.
To do this, you will need to prepare a CSV file that includes:
- Information about you, the merchant
- The number of transaction items to be expected in the file
- The name of the columns used (not all of them are mandatory)
- The transactions themselves. Each transaction line can contain one or more items (for example, signing a mandate and setting up a recurring direct debit plan)
Please note: The emails are sent as soon as you deposit the file into your SFTP folder.
The CSV file begins with the following line:
|"0"||"CHECKOUT_BY_LINK"||Creditor reference||Merchant company name|
Below is an example of a merchant information line.
This is followed by one line for each distinct item type present in the file. The structure of this/these line(s) is:
||Number of items of this type||Total amount
The example line below specifies that the file contains three direct debit orders, totalling €100:
Underneath this is a line defining which columns you intend to use in the file, based on your needs. Some columns are mandatory, others are optional.
The order you place the columns is irrelevant, as long as the values entered below them correspond correctly.
Please note: A line composed of DIRECT_DEBIT/RCUR_DIRECT_DEBIT columns must also include MANDATE columns.
Columns generic to each transaction
Generated by SlimPay if empty
|CUSTOMER_REFERENCE||The unique reference of the customer in the merchant system||Alphanumeric||35|
|CUSTOMER_EMAIL||Customer's email address||Alphanumeric||70|
|MANDATE_REFERENCE||Unique mandate reference
Only if the account has more than one enabled
|CUSTOMER_BIC||Customer's BIC code (or SWIFT code)||Alphanumeric||11|
|CUSTOMER_FIRST_NAME||Customer's first name||Alphabetic||32|
|CUSTOMER_LAST_NAME||Customer's last name||Alphabetic||70|
|CUSTOMER_COMPANY_NAME||Customer's company name||Alphanumeric||35|
|CUSTOMER_COMPANY_ID||Customer's company identification number||Alphanumeric||24|
|CUSTOMER_PHONE||Customer's mobile phone||E.164 standard|
|CUSTOMER_ADDRESS1||Customer's billing address: line 1||Alphanumeric||70|
|CUSTOMER_ADDRESS2||Customer's billing address: line 2||Alphanumeric||70|
|CUSTOMER_POSTAL_CODE||Customer's billing address: postal code||Alphanumeric||15|
|CUSTOMER_CITY||Customer's billing address: city||Alphanumeric||35|
|CUSTOMER_COUNTRY||Customer's billing address: country||ISO 3166-2|
E.g. FR for France
Direct Debit Columns
If empty, SlimPay will apply the earliest possible date
|ISO 8601 Date format|
|DIRECT_DEBIT_LABEL||Label which will appear on the bank statement of the customer||Alphanumeric||140|
|DIRECT_DEBIT_REFERENCE||Unique payment reference||Alphanumeric||35|
Recurrent Direct Debit Columns
|RCUR_DIRECT_DEBIT_FROM_DATE||Date from||ISO 8601 Date format|
|RCUR_DIRECT_DEBIT_FREQUENCY||The frequency of the direct debit payments:
|RCUR_DIRECT_DEBIT_MAX_NUMBER||Number of direct debits created
If empty, the direct debit plan will be unlimited until cancelled
|RCUR_DIRECT_DEBIT_LABEL||Label which will appear on the bank statement of the customer||Alphanumeric||140|
|RCUR_DIRECT_DEBIT_REFERENCE||Unique payment reference
This reference will be appended with
The rest of the file consists of the transactions themselves, each allocated one line. Make sure the values you enter are aligned with the appropriate columns.
Below is an example of the complete CSV file for three direct debit orders, totalling €100:
customer123;email@example.com;SLMP_0003214617;John;Doe;1 Rue des Fleurs;75001;Paris;FR;20.00;Invoice May;paymentRef123;
customer456;firstname.lastname@example.org;SLMP_0008231982;Mark;Bull;15 Rue du Jardin;75002;Paris;FR;30.00;Cinema payment;paymentRef456;
customer789;email@example.com;SLMP_0004127437;Nicolas;Dupont;19 Avenue des Rosiers;75003;Paris;FR;50.00;Gym subscription;paymentRef789;
If the file you deposited is acknowledged, you can expect a reporting file to let you know which transactions where successfully created. For the transactions which were not, the reporting file will detail why they failed.
Please note: A successfully created transaction means the email was sent. You can get information about the transaction status (whether the customer completed the Checkout) by using your SlimPay Dashboard.
The reporting file format starts with the same first line as the file you sent, with the current date added. The second line consists of the columns you sent in the initial file, preceded by two new columns:
- RESULT_CODE: 0 is for a creation success
- RESULT_DESCRIPTION: if the code is not 0, the reason for failure will be specified here