Sign in

v1

latestOpenAPI 3.1.02026-07-24290159.6 KB
Point of Sale

Create POS order

Create an order for Point of Sale

post/orders

Request body

OR
OR

Example request

{
  "order_id": "test_order_0001",
  "currency": "EUR",
  "amount": 1000,
  "description": "Example order description",
  "payment_options": {
    "notification_url": "https://www.examplewebsite.com/order-updates",
    "notification_method": "POST"
  },
  "customer": {
    "locale": "nl_NL",
    "first_name": "John",
    "last_name": "Doe",
    "email": "example@multisafepay.com"
  },
  "gateway_info": {
    "terminal_id": "00000ABC"
  },
  "shopping_cart": {
    "items": [
      {
        "name": "Backpack",
        "description": "Black cotton backpack with logo.",
        "unit_price": 90,
        "quantity": 1,
        "merchant_item_id": "12345678",
        "tax_table_selector": "VAT-21",
        "weight": {
          "unit": "KG",
          "value": 2
        }
      }
    ]
  }
}

Response

Request successful

successboolean

Indicates whether the request was successful.

Example response

{
  "success": true,
  "data": {
    "order_id": "order_id_example",
    "session_id": "803Xh9fPToqA3UaSKlnS3GcvUwkJF7HVzdF",
    "events_token": "eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NTYwMTkzMTAsImdydCI6WyJtYnVzOnNlc3Npb24ub3JkZXIiLCJtYnVzOndawdasdwaXIiXSwicGlkIjoiODAzWGg5ZlBUb3FBM1VhU0tsblMzR2N2VXdrSkY3SFZ6ZEYiLCJzdWIiOiJwciJ9.o7YxwLwd35OHiIDPbrJkeR3OV0lEqQaQJ6YfTjwAZiE",
    "events_stream_url": "https://api.multisafepay.com/events/stream/"
  }
}