Payment Links

Create a Payment Link #

Create a Payment Link and pass through all the payment information, like the amount, currency, country and reference.

Authorizations

bearer

#

HTTP: bearer #

HTTP Authorization Scheme: bearer

Bearer format: JWT

header Parameters #

Authorizationrequired

stringBearer token (API Key).

Request Body schema: application/json #

Request body for creating a Payment Link.

amountrequired	number >= 1 The payment amount. The exact format depends on the currency.
currencyrequired	string = 3 characters The three-letter ISO currency code of the payment.
billingrequired	objectThe billing details.
payment_type	string Default: “Regular” Enum:”Regular””Recurring”This must be specified for card payments where the cardholder is not present.
payment_ip	string <= 45 characters The customer’s IP address. Only IPv4 and IPv6 addresses are accepted.
billing_descriptor	objectAn optional description that is displayed on the customer’s statement identifying a purchase.
reference	string <= 50 characters A reference you can use to identify the payment (max 50 chars, Amex: 30, iDEAL: 35, Benefit: unique alphanumeric).
description	string <= 100 characters A description of the payment (max 100 chars).
display_name	stringThe merchant name to display to customers on the checkout page.
processing_channel_id	string^(pc)_(\w{26})$The processing channel to be used for the payment.
amount_allocations	Array of objectsThe sub-entities that the payment is being processed on behalf of.
expires_in	number [ 1 .. 5184000 ] Default: 86400The time for which the link remains valid, in seconds.
customer	objectThe customer’s details.
shipping	objectThe address any products are being sent to.
recipient	objectInformation about the recipient of the payment’s funds.
processing	objectUse the processing object to influence or override the data sent during card processing.
allow_payment_methods	Array of stringsSpecifies which payment method options to present to the customer.
disabled_payment_methods	Array of stringsSpecifies which payment method options to not present to the customer.
products	Array of objectsContains details about the products in the order.
metadata	objectAllows you to store additional information about the transaction. Only one level of depth is allowed.
3ds	objectInformation required for 3D Secure payments.
risk	objectConfigures the risk assessment performed during payment processing.
customer_retry	objectConfigures the parameters for customer retries.
sender	objectThe sender of the payment.
return_url	string <= 255 characters If provided, the success page will include a button that redirects your customer to the provided URL.
locale	string Default: “en-GB”Creates a translated version of the page in the specified language.
capture	booleanWhether to capture the payment (if applicable).
capture_on	stringA timestamp (ISO 8601 code) that determines when the payment should be captured. Providing this field will automatically set capture to true.
instruction	objectDetails about the payment instruction.
payment_method_configuration	objectConfiguration options for specific payment methods.

Responses #

201 Create Payment Link Page

Response Schema: application/json #

idrequired	stringThe unique identifier for a Payment Link.
_linksrequired	objectThe links related to the Payment Link session.
expires_onrequired	string <date-time> The date and time when the Payment Link expires.
referencerequired	stringA reference you can later use to identify this payment, such as an order number.
warnings	Array of objectsWarnings related to the allow_payment_methods object in the request.

401 Unauthorized

422 Invalid data was sent.

Response Schema: application/json #

request_idrequired	stringThe unique request identifier.
error_typerequired	stringThe error type.
error_codesrequired	Array of stringsThe error codes.

#

Get Payment Link details #

Retrieve details about a specific Payment Link using its ID returned when the link was created. In the response, you will see the status of the Payment Link.

Authorizations

bearer

#

HTTP: bearer #

HTTP Authorization Scheme: bearer

Bearer format: JWT

path Parameters #

idrequired

string = 15 characters ^pl_[A-Za-z0-9_-]{12}$The unique identifier for a Payment Link.

header Parameters #

Authorizationrequired

string

Responses #

200 Payment Link details retrieved successfully

Response Schema: application/json #

idrequired	stringThe unique identifier for a Payment Link.
statusrequired	string Enum:”Active””Payment Received””Expired”The status of the Payment Link.
amountrequired	numberThe original payment amount.
currencyrequired	stringThe three-letter ISO currency code of the payment.
expires_onrequired	string <date-time> The date and time when the Payment Link expires.
created_onrequired	string <date-time> The date and time when the Payment Link was created.
billingrequired	objectThe billing details.
_linksrequired	objectThe links related to the Payment Link.
payment_id	stringUnique identifier for an in progress or completed payment for this Payment Link.
reference	stringYour reference for the payment.
description	stringA description of the payment.
processing_channel_id	string^(pc)_(\w{26})$The processing channel to be used for the payment.
amount_allocations	Array of objectsThe sub-entities that the payment is being processed on behalf of.
customer	objectThe customer’s details.
shipping	objectThe address any products are being sent to.
products	Array of objectsContains details about the products in the order.
metadata	objectAny additional information stored at the point of creation.
locale	string Enum:”ar””da-DK””de-DE””el””en-GB””es-ES””fi-FI””fil-PH””fr-FR””hi-IN””id-ID””it-IT””ja-JP””ms-MY””nb-NO””nl-NL””pt-PT””sv-SE””th-TH””vi-VN””zh-CN””zh-HK””zh-TW”The language that the Payment Link page is displayed in.
return_url	string <= 255 characters If provided, the success page will include a button that redirects your customer to the provided URL.

401 Unauthorized

404 Payment Link session not found

Response Schema: application/json #

request_idrequired	stringThe unique request identifier.
error_typerequired	stringThe error type.
error_codesrequired	Array of stringsThe error codes.