Welcome to the MultiSafepay API reference (JSON gateway)!

To test using the API sandbox, you need to create a test account.

📘

Support

Email [email protected]

Direct vs redirect

With our API, you can create transactions through direct and redirect requests.

Direct requests connect directly to the payment method, whereas redirect requests first send the customer to a payment page.

For redirect requests, if the gateway for a specific payment method is:

  • Provided: The payment page is tailored for that payment method, e.g. for Visa, the page includes fields for the customer to enter their credit card details.
  • Not provided: The payment page displays all payment methods.

Then, if further customer action is:

  • Required: The customer is redirected to complete payment, e.g. for iDEAL, they are redirected to their online banking environment.
  • Not required: The transaction is completed automatically.

If you provide a redirect_url, after completing payment the customer is directed to your success/thank you page.

For more information about the direct and redirect flows for a specific payment method, see the payment method page.

Flow

Click to magnify.

Wrappers and SDKs

We provide the following SDKs and wrappers to facilitate integrating via our API:

Google Analytics tracking

You can gain insight into customer behavior on payment pages through Google Analytics tracking.

When the customer reaches the payment page, the UA-code is generated and appears in the HTML.

Masked IBANs

International bank account numbers (IBANs) are sensitive data. For security reasons, we mask them so that only the last 4 digits are visible, e.g. *** 1234. We do this by default in:

  • POST webhook notifications
  • GET /orders/{order_id} responses

See also Unmasking IBANs.

Deprecated XML API

Our XML API was superseded by the JSON API.

You can still use the XML endpoint to process transaction requests, but new payment methods, features, and tools are only supported by the JSON API.