Initial payment

post

https://testapi.multisafepay.com/v1/json/orders

Initialize a subscription order and generate a payment token for future transactions.

How to test

Under Authentication > Query, enter a website API key from your TEST account.
Under Body params, select the type of order you want to create.
Either:
- Enter dummy data for relevant parameters, or
- In the black Request box, click Examples and select a pre-filled template.
Enter a unique order ID, and then click Try it!

❗️ Never use a live API key, or real customer or payment details!

💬 For support, email [email protected]

Body Params

The initial order for recurring payments, which creates a token of the customer's payment details.

type

string

enum

redirect: Customers are redirected to a payment page where they enter their cardholder data.
direct: The API request contains the cardholder data, so customers are redirected to an authentication or success page.

If not set, redirect is used.

For more information, see Direct vs redirect.

Note: To process direct card payments, you must have PCI DSS certification, see Cardholder data.

Allowed:

gateway

string

enum

required

The unique identifier for the payment method (gateway). See Gateway IDs.

Using the generic CREDITCARD gateway improves the customer experience. For redirect requests, the payment page automatically detects the card scheme.

order_id

string

required

length ≤ 50

Your unique (client-defined) identifier for the order.

currency

string

required

length between 3 and 3

The currency of the payment.

Format: ISO-4217 currency code.

amount

integer

required

≥ 0

The payment amount in the currency's smallest unit:

Decimal currencies: Value for 10 EUR = 1000 (1000 cents)
Zero-decimal currencies: Value for 10 JPY = 10

Discounts

To discount:

An entire order, enter a reduced amount.
Specific items in the order, in the shopping_cart, reduce the unit_price of the relevant items.

Zero Authorization

For Zero Authorization orders, set to 0.

description

string

required

length ≤ 200

A description of the customer's order.

Appears on payment pages and customer bank statements (if supported by the bank).

payment_options

object

Contains:

URLs to your success page and cancel page. Make sure your URL only contains specific set of ASCII characters (alphanumeric, -, _, ., :, /).
Your webhook endpoint
Templates for styling payment pages
Settings for displaying available gift cards

customer

object

required

The customer’s personal information.

Required for: All orders except Apple Pay and Google Pay, and Belfius, iDEAL, and WeChat Pay direct orders.

For recurring payments, see reference.
For localizing payment pages and FastCheckout pages, see locale.

gateway_info

object

Information specific to the payment method (gateway).

Required for:

Direct credit and debit card orders
Flexible 3D orders
MOTO orders

delivery

object

The customer's shipping address.

checkout_options

object

Settings for the shopping cart, including taxes and validation.

shopping_cart

object

The array of items in the customer's shopping cart, including the shipping costs, and the tax class (as defined in checkout_options).

We recommend using shopping carts for all orders.

Displays on payment pages, and in your dashboard.

To learn how to calculate the order amount from the shopping_cart, see Rounding rule.

Discounts

See Recipe – Discount an order.

items

string

Displays additional information on payment pages and in payment confirmation emails to customers using HTML, e.g. display order items instead of including a shopping_cart.

For information about supported HTML tags and elements, see Payment pages - Styling.

recurring

object

required

Configuration required for recurring payments.

second_chance

object

For Second Chance.

customer_verification

object

For card payment direct orders.

custom_info

object

Additional information about the order.

days_active

integer

1 to 365

Defaults to 30

For redirect orders, sets the number of days the link to the payment page is valid.

The link lifetime begins when the order is created, or the link is generated. A session_id is returned in the payment page URL.

If Second Chance is enabled, we recommend a minimum lifetime of 48 hours. Second Chance emails the customer 2 payment reminders: 1 hour and 24 hours after the order is created. If the lifetime is less than 24 hours, the link in the second email is no longer active when the customer receives it.

See seconds_active below. If seconds_active is also set, seconds_active is used. If neither is set, the default is used.

seconds_active

string

1 to 31536000

Defaults to 2592000

For redirect orders, sets the number of seconds the link to the payment page is valid.

See days_active above. If days_active is also set, seconds_active is used. If neither is set, the default is used.

var1

string

length ≤ 500

Variable for storing additional data.

var2

string

length ≤ 500

Variable for storing additional data.

var3

string

length ≤ 500

Variable for storing additional data, including split payments metadata.

plugin

object

Information about your integration (useful for debugging).

Responses

How to test

200Request successful

404Error