Skip to main content

Create a payment link

Creates a payment link that can be shared with customers to allow them to make the payment.

Request Body REQUIRED

Create a payment intent

payment_intent uuid
items object

Details of the items that make up the payment link.

description string REQUIRED

Description of the item.

externalReference string

An external reference to identify the item.

quantity integer REQUIRED

Quantity of the item.

unit_price double REQUIRED

Unit price of the item.

tip object
amount number
external_data string

An object of arbitrary key-value pairs for custom data.

source string
transaction_data object
checkout_url uri
Responses
201

Successful response

Schema OPTIONAL
payment_intent uuid OPTIONAL
items object OPTIONAL

Details of the items that make up the payment link.

description string

Description of the item.

externalReference string OPTIONAL

An external reference to identify the item.

quantity integer

Quantity of the item.

unit_price double

Unit price of the item.

tip object OPTIONAL
amount number OPTIONAL
external_data string OPTIONAL

An object of arbitrary key-value pairs for custom data.

source string OPTIONAL
transaction_data object OPTIONAL
checkout_url uri OPTIONAL