API Reference

Generate a link_id

post
https://test-api.acquired.com/v1/payment-links

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
transaction
object
payment
object
customer
object
tds
object
boolean
Defaults to false

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

integer
Defaults to 3

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.

integer
Defaults to 259200

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

uuid

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

uri
length ≤ 256

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

uri
length ≤ 256

Where we should send webhook notifications throughout the authorisation process.

payment_methods
array

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.

payment_methods
string
enum

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.

Allowed:
configuration
object

Used to pass additional configuration options to the Hosted Checkout.

Headers
Responses

Updated 10 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 10 months ago