Sign in

v1

latestOpenAPI 3.0.32026-07-248079274.0 KB
Hosted Checkout

Generate a link_id

Generate a payment-link which contains detail of the order or payment. This link_id can then be appended to the required environment and shared with the customer like this https://test-pay.acquired.com/v1/{link_id}. In production, remove the test prefix.

post/payment-links

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

is_recurringboolean

Set to true if you want to ensure card details are saved at checkout, allowing for further recurring payments.

count_retryinteger

Number of times that a payment can be attempted using the payment link before the link becomes inactive. The default is 3 and the maximum is 10.

expires_ininteger

Time for which the payment link is valid, in seconds. Default is 259200 and the maximum is 2678400.

template_idstring uuid

Unique ID assigned by Acquired.com which can be updated to change the template displayed to the user when the page is loaded.

redirect_urlstring uri

Where the user should be redirected to once the authorisation process has been completed.

webhook_urlstring uri

Where we should send webhook notifications throughout the authorisation process.

payment_methodsstring[]

Used to specify which payment methods should be displayed on the Checkout page. If the 'Enable Custom Payment Method Order' toggle is set to 'On' in the Hosted Checkout settings, the order of payment methods on the Checkout page will match the sequence defined in this array.

submit_type'pay' | 'buy' | 'checkout' | 'donate' | 'register' | 'subscribe'

Describes the type of transaction and customises the text displayed to Checkout user, such as the submit button. Enum values accepted only. If blank, pay is used.

Example request

{
  "transaction": {
    "order_id": "1f1f2a61-5b68-4725-a0ce-9560514ec00b",
    "amount": 15.02,
    "currency": "gbp",
    "custom_data": "L3BheW1lbnQtbGlua3MgcGF5IGN1c3RvbV9kYXRh"
  },
  "payment": {
    "reference": "Custom Ref 001"
  },
  "customer": {
    "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"
      }
    },
    "shipping": {
      "address_match": true
    },
    "email": "ejohnson@acquired.com",
    "phone": {
      "country_code": "44",
      "number": "2039826580"
    }
  },
  "tds": {
    "is_active": true,
    "challenge_preference": "no_preference",
    "contact_url": "https://example.com/contact"
  },
  "recurring": {
    "term": {
      "start_date": "2026-06-15",
      "end_date": "2027-06-15"
    }
  },
  "redirect_url": "https://example.com/redirect",
  "webhook_url": "https://example.com/webhook",
  "submit_type": "pay",
  "configuration": {
    "variable_recurring_payment": {
      "type": "sweeping",
      "periodic_limit": {
        "per_payment": {
          "maximum_amount": 100
        },
        "day": {
          "maximum_amount": 100,
          "alignment": "consent"
        },
        "week": {
          "maximum_amount": 100,
          "alignment": "consent"
        },
        "fortnight": {
          "maximum_amount": 100
        },
        "month": {
          "maximum_amount": 100,
          "alignment": "consent"
        },
        "half_year": {
          "maximum_amount": 100,
          "alignment": "consent"
        },
        "year": {
          "maximum_amount": 100,
          "alignment": "consent"
        }
      }
    }
  }
}

Response

Created

status'success'
link_idstring uuid

Unique ID assigned by Acquired.com which should be appended to the known base URL and used to load the hosted checkout.

Example response

{
  "status": "success"
}