Developer Center

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)

Merchant information

The CSV file begins with the following line:

Below is an example of a merchant information line.

0;CHECKOUT_BY_LINK;testCreditor;TestCompany;

This is followed by one line for each distinct item type present in the file. The structure of this/these line(s) is:

The example line below specifies that the file contains three direct debit orders, totalling €100:

1;DIRECT_DEBIT;3;100.00;EUR;sepa_dd_core;

Transaction columns

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.

Columns generic to each transaction

Title	Description	Mandatory	Format	Max length
TRANSACTION_REFERENCE	Transaction reference Generated by SlimPay if empty		Alphanumeric	35
CUSTOMER_REFERENCE	The unique reference of the customer in the merchant system		Alphanumeric	35
CUSTOMER_EMAIL	Customer's email address		Alphanumeric	70

Mandate Columns

Title	Description	Mandatory	Format	Max length
MANDATE_REFERENCE	Unique mandate reference Use -AUTO-GENERATE- to let SlimPay generate it Use -NO-REFERENCE- for mandates with no reference		Alphanumeric	35
MANDATE_SCHEME	Mandate scheme Only if the account has more than one enabled		sepa_dd_core sepa_dd_b2b
CUSTOMER_IBAN	Customer's IBAN		Alphanumeric	34
CUSTOMER_BIC	Customer's BIC code (or SWIFT code)		Alphanumeric	11
CUSTOMER_TITLE	Customer's title: 0 for Mr. 1 for Miss 2 for Mrs		Integer	1
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 E.g. +33612345678	16
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	2

Direct Debit Columns

Title	Description	Mandatory	Format	Max length
DIRECT_DEBIT_AMOUNT	Amount		Decimal	19
DIRECT_DEBIT_EXEC_DATE	Execution date If empty, SlimPay will apply the earliest possible date		ISO 8601 Date format (2020-09-25)	10
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

Title	Description	Mandatory	Format	Max length
RCUR_DIRECT_DEBIT_AMOUNT	Amount		Decimal	19
RCUR_DIRECT_DEBIT_FROM_DATE	Date from		ISO 8601 Date format (2020-09-25)	10
RCUR_DIRECT_DEBIT_FREQUENCY	The frequency of the direct debit payments: 0 for daily 1 for weekly 2 for monthly 3 for every two months 4 for trimestriel 5 for quarterly 6 for semiannual 7 for yearly		Integer	1
RCUR_DIRECT_DEBIT_MAX_NUMBER	Number of direct debits created If empty, the direct debit plan will be unlimited until cancelled		Integer	11
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 -n, n being a number		Alphanumeric	32

Transactions

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:

0;CHECKOUT_BY_LINK;testCreditor;testCompany;
1;DIRECT_DEBIT;3;100.00;EUR;sepa_dd_core;
CUSTOMER_REFERENCE;CUSTOMER_EMAIL;MANDATE_REFERENCE;CUSTOMER_FIRST_NAME;CUSTOMER_LAST_NAME;CUSTOMER_ADDRESS1;CUSTOMER_POSTAL_CODE;CUSTOMER_CITY;CUSTOMER_COUNTRY;DIRECT_DEBIT_AMOUNT;DIRECT_DEBIT_LABEL;DIRECT_DEBIT_REFERENCE;
customer123;john.doe@slimpay.com;SLMP_0003214617;John;Doe;1 Rue des Fleurs;75001;Paris;FR;20.00;Invoice May;paymentRef123;
customer456;mark.bull@slimpay.com;SLMP_0008231982;Mark;Bull;15 Rue du Jardin;75002;Paris;FR;30.00;Cinema payment;paymentRef456;
customer789;nico.dupont@slimpay.com;SLMP_0004127437;Nicolas;Dupont;19 Avenue des Rosiers;75003;Paris;FR;50.00;Gym subscription;paymentRef789;

Reporting file

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.

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