Welcome to the SlimPay
Developer Center

This API portal contains all of the documentation you’ll need to integrate our intuitive payment solution into your application.

Our REST API is the easiest way to enroll customers online for one off, pay-as-you-go or recurring payment plans.

At the same time, our File Transfer interface is also at your disposal for your batch processing needs.

Start integrating now!

Learn how to integrate SlimPay in 30 minutes

Discover our step-by-step guide

Try it yourself!

Create a Checkout transaction (1/3)

curl -X POST 'https://api.preprod.slimpay.com/orders' \

    -H 'Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"' \

    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNzQ5NjU2Nzk0LCJqdGkiOiJTX215YVdnLWdKNGJ5eC1iLTBvb2cyTzJxb0kiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.XUbnLRBG4_9kXE1MsMsAbD0ppiWYT3rd0rJ-FuhCTGk' \

    -H 'Content-Type: application/json' \

    -d '{"started": true, "creditor": {"reference": "democreditor"}, "subscriber": {"reference": "subscriber01"}, "items": [{"type": "signMandate", "mandate": {"signatory": {"billingAddress": {"street1": "27 rue des fleurs", "postalCode": "75008", "city": "Paris", "country": "FR"}, "givenName": "John", "familyName": "Doe", "email": "change.me@slimpay.com", "telephone": "+33612345678"}}}]}'

Redirect your customer to the Checkout (2/3)

Our server’s response contains a link that redirects your customer to the Checkout (click to simulate the Checkout):

{
      "_links": {
        "https://api.slimpay.net/alps#user-approval": {
          "href": ""
        }
      }
    }

Check the order status (3/3)

You can query the state of the order in real time:

curl 'https://api.preprod.slimpay.com/orders?creditorReference=democreditor&reference=' \

    -H 'Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"' \

    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNzQ5NjU2Nzk0LCJqdGkiOiI1em5NNDNEd3BiX0p3bG5lVDBJd2xmRjlQMlkiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.tgANcs-LjVCYPXHbjXhzAyEV-d_axdFEMjfXrOU_pyA'

Order state:

Refresh

You can also take a look at our full guide on how to set up direct debits.

In a subscription business model, the payment step of the checkout usually involves the customer choosing the method of payment (direct debit, for example). This payment method is then authorised and stored by the merchant for future recurring payments.

Certain freemium services also prefer to collect a customer’s payment information when the first payment is due.

SlimPay allows you to embrace this business model - enrolling a new customer and collecting payment in a single operation - with our simple and intuitive Checkout!

Checkout: Capture your customer’s payment information for immediate or future use.; Learn more

Payments: Collect payments and manage payment issues on behalf of your customers.; Learn more

Migration: Import existing payment details and use them to collect payments immediately.; Learn more

Developer Center