POST
/
order
Create a new order.
curl --request POST \
  --url https://playground.runa.io/v2/order \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '{
  "payment_method": {
    "type": "ACCOUNT_BALANCE",
    "currency": "USD"
  },
  "items": [
    {
      "face_value": 10,
      "distribution_method": {
        "type": "EMAIL",
        "email_address": "fred@bloggs.com",
        "template_id": "DT-01HPSF51G0ZWHJ3JTNWRH0WDYK"
      },
      "products": {
        "type": "MULTIPLE",
        "values": [
          "AMZ-US",
          "AIRBNB-US"
        ]
      }
    }
  ],
  "description": "<string>"
}'
{
  "id": "O-01H5WQGHKCBB85MQFM68S9KJ5Q",
  "status": "COMPLETED",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "payment_method": {
    "type": "ACCOUNT_BALANCE"
  },
  "currency": "USD",
  "total_price": "10",
  "total_discount": 123,
  "items": [
    {
      "id": "E-NWPEKW4VL",
      "distribution_method": {
        "type": "EMAIL",
        "email_address": "fred@bloggs.com",
        "template_id": "DT-01HPSF51G0ZWHJ3JTNWRH0WDYK"
      },
      "products": {
        "type": "MULTIPLE",
        "values": [
          "AMZ-US",
          "AIRBNB-US"
        ]
      },
      "face_value": "10",
      "price": "10",
      "discount_multiplier": "0.1",
      "redemption_url": "<string>",
      "payout": {
        "status": "ACTIVE",
        "status_updated_at": "2023-11-07T05:31:56Z",
        "url": "<string>",
        "expiry_date": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

Authorizations

​
X-Api-Key
string
header
required

Headers

​
X-Api-Version
string

The dated version of the API, if not specified a default is used.

​
X-Idempotency-Key
string
required

A unique string that prevents order duplication.

​
X-Execution-Mode
enum<string>
default:async

Choose sync if you want to retrieve the payout links directly from the API response. Choose async if you want to poll for your order. The default if unset is async.

Available options:
async,
sync

Body

application/json

Response

200
application/json

Response that will be returned in sync execution mode. Order has successfully been completed.

Used for an order that has completed. This class is typically used when returning a single order to the client.