Skip to main content

SlimPay Help Center

  1. SlimPay Help Center
  2. Documentation
  3. Starter Guide

How to integrate the SlimPay solution

Created:

Updated:

Table of contents

Objective

When you are ready to implement the SlimPay payment solution, this document will smoothly guide you step-by-step towards your production implementation (Go Live).

NB: Depending on your project, an Onboarding Manager may be assigned to support you in your technical integration process.

Step 1 - KYC: a legal obligation

CONCEPT-time.png

When?

As soon as possible once you have signed your contract.

 

CONCEPT-easy.png

What for?

To have the right to process transactions and start the implementation process.

 

DOC-mandates.png

What do you do?

Send all the documents needed to your account manager.

CONCEPT-tools.png

What does SlimPay do?

It is a first step of verification - additional documents may be required.

What is KYC?

Why?

What documents
do I need to send?

“Know your Customer” 

To be able to collect money on your behalf in any European country, SlimPay must demonstrate that it has verified the real existence of the company and its performing legal business.

SlimPay requires documents that show the existence of the legal entity and the company’s owners. 

The documents need to be recent (less than 3 months) and legible.

It is a compulsory process for any financial institution.

In effect, SlimPay must ensure that you have an entrepreneurial profile which complies with rules against money laundering and financing terrorism. 

Once all documents are received, the KYC process can be passed within 4 working days.

This is a European and global obligation to prevent money laundering, terrorism funding and financial fraud.

This obligation is required irrespective of the amount collected.

 Please check all the documents you need to send to your account manager and to the Compliance Team (compliance@slimpay.com)

Step 2 - INTEGRATION

Access to your Account  

CONCEPT-time.png

When?

Once you have decided, together with your sales representative, to choose our solution.

 

CONCEPT-easy.png

What for?

Get your Dashboard and API credentials by email.

 

DOC-mandates.png

What do you do?

Ask your Account Manager and verify you can access your test account.

CONCEPT-tools.png

What does SlimPay do?

Send an email with the credentials to the technical contact provided to the Sales representative.

💡 INFORMATION
The access credentials are sent by email to the person identified as the technical contact. Please ensure to whitelist any email coming from the domain @slimpay.com 

 

Dashboard V.2

Dashboard V.1

(Back Office)

REST API

You have a test account at your disposal: begin your tests using the credentials you received via email.

Access to the Dashboard Test Account 

You have a test account at your disposal: begin your tests using the credentials you received via email.

Access to Dashboard V.1 Test Account

To integrate the API, please use the credentials received by email (creditor_reference and App_name)

You can generate an App_Secret in the menu "App management" of the Dashboard.

Please use the Test URL: https://api.preprod.slimpay.com

The Dashboard V.2 is an online interface that allows you to view and manage the orders, authorizations, payments, plans and subscribers that you register with SlimPay.

The Dashboard V.1 corresponds to the former online interface. The Dashboard V.2 is gradually replacing the V.1.

The HAPI Browser is a tool that will help your implementation with code examples in HTTP,  PHP and Java.

Integrate the API 

 

CONCEPT-easy.png

How?

The following table aims to help you during your API integration. 

 

Use Cases

API 

API Browser

Mandate signature 

create-orders (type=signMandate)

https://dev.slimpay.com/hapi/browser#create-orders

change the pre-filled example on top left

Document signature

create-orders (type=document)

https://dev.slimpay.com/hapi/browser#create-orders

change the pre-filled example on top left

Create Direct Debit (one off)

create-payins

https://dev.slimpay.com/hapi/browser#create-payins

Create Direct Debit Plan

create-recurrent-
direct-debits

https://dev.slimpay.com/hapi/browser#create-recurrent-direct-debits

Create a SDD refund

create-payouts (category=refund)

https://dev.slimpay.com/hapi/browser#create-payouts

Create order standalone card alias

create-orders (type=card alias)

https://dev.slimpay.com/hapi/browser#create-orders

change the pre-filled example on top left

 

Create Card Transaction

create-payins

 https://dev.slimpay.com/hapi/browser#create-payins

Create Card Plan

create-recurrent-card-transactions

https://dev.slimpay.com/hapi/browser#create-recurrent-card-transactions

Create a fund transfer (SCT)

create-payouts (category=funds_transfer)

https://dev.slimpay.com/hapi/browser#create-payouts

Perform the tests

 

CONCEPT-easy.png

How?

 Based on the tests you will perform, our Customer Care team will validate your production account (Go Live).
 

WEB API

Dashboard 

Electronic signature 

Mandatory tests: 

Mandatory tests: 

SEPA

Mandatory tests:

  • Create an order
  • Sign mandate
  • Create a one-off SDD

Optional tests: 

  • Create recurring SDD 
  • Make reconciliation 

Mandatory tests: 

  • Sign a mandate by link and/or by delegation
  • Change IBAN for a mandate
  • Create a unique direct debit and create a recurrent direct debit

Optional tests: Discover the tutorials 

CARD

In order to enable card payments, you must integrate our API.

Mandatory tests: 

  • Create an order
  • Create a card alias
  • Create a card transaction

Optional tests:

  • Create recurring card transactions
  • Make reconciliation

Optional tests:

💡 INFORMATION

If your contract includes access to our File API (SFTP), please refer to our Dev Center for information about the tool. If you want to manage your payment flow thought file importation, you can consult our dedicated article and test the different constructions possible.

BEST PRACTICES
Information to keep in mind during your integration

Client

Mandates 

Payments/R-transactions

Each customer/debtor has a unique client reference. 

Refer to our lexicon for more information.

Each customer/debtor has one unique mandate reference. This mandate authorizes all transactions you wish to process.

You can update the bank account details (IBAN) associated with a mandate. 

It is better to use a unique payment/plan reference.

Like any payment method, SEPA Direct Debit may experience unsuccessful transactions. Different error codes correspond to specific reasons for rejection or refund.

For more information, you can refer to our SEPA Direct Debit Timeline.

⚠️

Please do not use real data (IBAN, phone number) during your tests. You can use our IBAN generator and the test data we provide during your integration. The email addresses used must be valid.

💡 INFORMATION

Once you have finished your integration tests, you can request a Go Live by filling in this form (Open an account). Your tests will be validated and you will be able to start your production integration.

Step 3 - GO LIVE

CONCEPT-time.png

When?

When you have completed your tests and the KYC is validated.

 CONCEPT-easy.png

What for?

To create your production environment, obtain API and Dashboard access and start your real transactions.  

DOC-mandates.png

What do you do?

Send a request to our Customer Care team (support@slimpay.com). 

CONCEPT-tools.png

What does SlimPay do?

Creates the production environment and configures your account login.
Configure your account

Accesses

Once your production account is created, your credentials for the Dashboard are sent to your email. 

To integrate the API, please use the credentials received by email (creditor_reference & App_name).

You could generate your App_Secret on the menu "App management" of the Dashboard.
User creation As a user, you can grant access to other users and assign them. Click here for details

 

Was this article helpful?
3 out of 3 found this helpful
Return to top

Related articles