v1

latestOpenAPI 3.0.32026-07-248079274.0 KB

Payments

Send a payment link

Send a payment link via email or SMS to your customer, the customer can then follow the link and make the payment. You are required to generate a Hosted Checkout payment link using the /payment-links endpoint and then append the link_id to this request.

post/payment-links/{link_id}/send

Path parameters

link_idstring uuid required

Unique ID assigned by Acquired.com for the payment link.

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

type'sms' | 'email'

The type of payment link being sent to the customer.

emailstring email

The customer's email address.

messagestring

The message to be sent with the payment link. This should include both the text and the fully constructed payment link. (The payment link that will be displayed to the customer will be shortened.)

Example request

{
  "type": "sms",
  "phone": {
    "country_code": "44",
    "number": "2039826580"
  },
  "email": "ejohnson@acquired.com",
  "message": "Click the link to complete payment: <payment_link>."
}

Response

status'success'

The outcome of the request