Create payment link

post

https://api.truelayer-sandbox.com/v3/payment-links

Create a new payment link

This API must be called using a backend bearer token.

Body Params

type

string

enum

required

The type of the Payment link

Allowed:

expires_at

string

The date and time the payment link will expire at.
If this property isn't specified, the payment link will expire 24 hours after its creation.

payment_configuration

object

required

Configuration of the payment to be created when using the link.
This follows the same structure as the create payment request in payments v3 with a couple of distinctions:

This configuration only supports bank_transfer payment method.
This configuration won't allow data_access_token.

product_items

array of objects

length ≥ 1

List of items associated to this link.

product_items

Product details

name

string

required

Name of the product.

price_in_minor

integer

required

≥ 0

A 'cent' value representing the price of the product. eg 100 == 1GBP or 100 = 1EUR

quantity

integer

required

≥ 1

The product item quantity

url

Url of the product.

reference

string

Reference for the payment link. This reference will be shown in the link's UI.
This reference won't be shared with the provider or any other third-party.

return_uri

url

This URL determines where the end user will be redirected back once they successfully completed
the authorization flow of a payment attempt.
If no URL is provided, the end user won't be redirected anywhere,
but will instead be shown a TrueLayer's page notifying success.

Headers

Idempotency-Key

string

required

An idempotency key to allow safe retrying without the operation being performed multiple times.
The value should be unique for each operation, e.g. a UUID, with the same key being sent on a retry of the same request.

Tl-Signature

string

required

A JWS with detached content, signed with your private key.
See Request Signing

string

enum

Defaults to application/json; charset=UTF-8

Generated from available response content types

Allowed:

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json; charset=UTF-8

application/problem+json; charset=UTF-8

201Payment link

400Invalid Parameters

401Unauthenticated

403Forbidden

409Idempotency-Key Concurrency Conflict

422Idempotency-Key Reuse

429Rate Limit Exceeded

500Unknown Error