v1

latestOpenAPI 3.0.32026-07-248079274.0 KB

Components

Generate a session_id

When using our Components solution, you are required to submit a request that includes payment details to create a session_id. This session_id will hold transaction-specific information and will be used to complete the payment. At a minimum you are required to submit the order_id, amount & currency. We also recommend submitting your 3DS requirements at this stage.

post/payment-sessions

Headers

Company-Idstring uuid

Unique ID assigned by Acquired.com for your company.

Midstring uuid

Unique ID assigned by Acquired.com connecting to a specific acquiring bank.

Request body

webhook_urlstring uri

Where we should send webhook notifications throughout the authorisation process.

save_cardboolean

Set to true if you want to display the save card checkbox (use this only for the Payment and Form components).

is_recurringboolean

Set to true if you want to save the card for future use for Apple Pay and Google Pay only (use this only for the Payment component).

payment_methodsstring[]

Used to specify which payment methods should be displayed on the Checkout. (This can only be passed when using the Payment component).

company_domainsstring[]

Can be optionally provided to restrict the session scope to a subset of domains registered to your company. All domains must be registered via the Hub's 'SDK' settings.

Example request

{
  "transaction": {
    "order_id": "1f1f2a61-5b68-4725-a0ce-9560514ec00b",
    "amount": 15.02,
    "currency": "gbp",
    "custom_data": "L3BheW1lbnQtbGlua3MgcGF5IGN1c3RvbV9kYXRh"
  },
  "customer": {
    "reference": "customer_number_00001",
    "first_name": "Edward",
    "last_name": "Johnson",
    "dob": "1988-10-03",
    "custom_data": "L3BheW1lbnQtbGlua3MgcGF5IGN1c3RvbV9kYXRh",
    "billing": {
      "address": {
        "line_1": "152 Aldgate Drive",
        "city": "London",
        "postcode": "E1 7RT",
        "country_code": "GB"
      },
      "email": "ejohnson@acquired.com",
      "phone": {
        "country_code": "44",
        "number": "2039826580"
      }
    },
    "shipping": {
      "address": {
        "line_1": "152 Aldgate Drive",
        "city": "London",
        "postcode": "E1 7RT",
        "country_code": "GB"
      },
      "email": "ejohnson@acquired.com",
      "phone": {
        "country_code": "44",
        "number": "2039826580"
      }
    }
  },
  "tds": {
    "challenge_preference": "no_preference",
    "challenge_window_size": "full_screen",
    "contact_url": "https://example.com/contact",
    "redirect_url": "https://example.com/redirect",
    "webhook_url": "https://example.com/webhook"
  },
  "webhook_url": "https://example.com/webhook",
  "save_card": true,
  "is_recurring": true,
  "company_domains": [
    "https://store.example.com/"
  ]
}

Response

session_idstring uuid

Unique ID assigned by Acquired.com which contains the payment information that will be loaded when initialising the Components checkout.