Checkout

Create Order

POST /checkout

Headers

Accept: application/json
Authorization: Bearer {YOUR_ACCESS_TOKEN}

• type: checkout

Required Attributes:

• first_name: (string) max 255
• last_name: (string) max 255
• email: (email) max 255
• telephone: (string) max 255
• address: (string) max 255
• city: (string) max 255
• postcode: (string) max 255
• bank: (array)
  • account_name: (string) alphabetic+spaces || min 2 || max 50
  • account_number: (numeric) || min 6 || max 10
  • account_sortcode: (numeric) || min 6 || max 6
• order: (array)
  • devices: (array) min 1
    • id: (int) existing 'device-id'
    • grade_id: (int) existing 'device-grade-id'

Optional Attributes:

• date_of_birth: (date) date_format "d/m/Y"
• company_name: (string) max 255
• county: (string) max 255
• country: (string) max 255
• email_optin: (bool) default false

Request

{
    "data": {
        "type": "checkout",
        "attributes": {
            "first_name": "Fake",
            "last_name": "User",
            "email": "fake.user@fakeco.com",
            "telephone": "012345674444",
            "address": "23-25 Fake Street",
            "city": "Fakesford",
            "postcode": "AB1 23C",
            "bank": {
                "account_name": "Fake Account Name",
                "account_number": "12345678",
                "account_sortcode": "123456"
            },
            "order": {
                "devices": [
                    { "id": 1, "grade_id": 1 },
                    { "id": 5, "grade_id": 1 }
                ]
            }
        }
    }
}

Response 200

{
    "data": {
        "type": "checkout",
        "attributes": {
            "order_number": "T00000047",
            "order_date": "26-01-2026",
            "processed_date": null,
            "expiry_date": "09-02-2026",
            "value": 335,
            "order_type": "PYOP",
            "order_status": "Awaiting Delivery",
            "created_at": "2026-01-26T16:24:45.000000Z",
            "updated_at": "2026-01-26T16:24:45.000000Z"
        }
    }
}