Updates the status of a payment link. Use this endpoint to force the expiry of a payment link.
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
The request has succeeded.
Show more Show lessList of payment methods to be presented to the shopper. To refer to payment methods, use their payment method type.
Example: "allowedPaymentMethods":["ideal","giropay"]
The payment amount and currency.
The amount of the transaction, in minor units.
Information about your application. For more details, see Building Adyen solutions.
Adyen-developed software, such as libraries and plugins, used to interact with the Adyen API. For example, Magento plugin, Java API library, etc.
Adyen-developed software to get payment details. For example, Checkout SDK, Secured Fields SDK, etc.
Third-party developed platform used to initiate payment requests. For example, Magento, Zuora, etc.
Merchant developed software, such as cashier application, used to interact with the Adyen API.
Merchant device information.
Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.
The address where to send the invoice.
The two-character ISO-3166-1 alpha-2 country code. For example, US.
If you don't know the country or are not collecting the country from the shopper, provide
countryasZZ.
The number or name of the house. Maximum length: 3000 characters.
A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
The two-character ISO 3166-2 state or province code. For example, CA in the US or ON in Canada.
Required for the US and Canada.
List of payment methods to be hidden from the shopper. To refer to payment methods, use their payment method type.
Example: "blockedPaymentMethods":["ideal","giropay"]
The delay between the authorisation and scheduled auto-capture, specified in hours.
The shopper's date of birth.
Format ISO-8601: YYYY-MM-DD
The date and time when the purchased goods should be delivered.
ISO 8601 format: YYYY-MM-DDThh:mm:ss+TZD, for example, 2020-12-18T10:15:30+01:00.
The address where the purchased goods should be delivered.
The two-character ISO-3166-1 alpha-2 country code. For example, US.
If you don't know the country or are not collecting the country from the shopper, provide
countryasZZ.
The number or name of the house. Maximum length: 3000 characters.
A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
The two-character ISO 3166-2 state or province code. For example, CA in the US or ON in Canada.
Required for the US and Canada.
The date when the payment link expires.
ISO 8601 format with time zone designator Z: YYYY-MM-DDThh:mm:ss+TZD, for example, 2020-12-18T10:15:30Z.
The maximum expiry date is 70 days after the payment link is created.
If not provided, the payment link expires 24 hours after it was created.
A set of key-value pairs that specifies the installment options available per payment method. The key must be a payment method name in lowercase. For example, card to specify installment options for all cards, or visa or mc. The value must be an object containing the installment options.
Defines the type of installment plan. If not set, defaults to regular.
Possible values:
Price and product information about the purchased items, to be included on the invoice sent to the shopper. This parameter is required for open invoice (buy now, pay later) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.
Indicates if the payment must be captured manually.
The merchant category code (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.
This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate). The reference should be unique per billing cycle.
Metadata consists of entries, each of which includes a key and a value. Limitations:
checkout.linkId. Any value that you provide with this key is going to be replaced by the real payment link ID.Defines a recurring payment type. Required when storePaymentMethodMode is set to askForConsent or enabled.
Possible values:
A reference that is used to uniquely identify the payment in future communications about the payment status.
List of fields that the shopper has to provide on the payment page before completing the payment. For more information, refer to Provide shopper information.
Possible values:
Website URL used for redirection after payment is completed. If provided, a Continue button will be shown on the payment page. If shoppers select the button, they are redirected to the specified URL.
Indicates whether the payment link can be reused for multiple payments. If not provided, this defaults to false which means the link can be used for one successful payment only.
Any risk-related settings to apply to the payment.
Contains client-side data, like the device fingerprint, cookies, and specific browser settings.
An integer value that is added to the normal fraud score. The value can be either positive or negative.
The language to be used in the payment page, specified by a combination of a language and country code. For example, en-US.
For a list of shopper locales that Pay by Link supports, refer to Language and localization.
The shopper's full name. This object is required for some payment methods such as AfterPay, Klarna, or if you're enrolled in the PayPal Seller Protection program.
Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.
Your reference must not include personally identifiable information (PII), for example name or email address.
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
Set to false to hide the button that lets the shopper remove a stored payment method.
Boolean value indicating whether the card payment method should be split into separate debit and credit options.
An array of objects specifying how to split a payment when using Adyen for Platforms, Classic Platforms integration, or Issuing.
Unique identifier of the account where the split amount should be sent. This is required if type is MarketPlace or BalanceAccount.
The amount of this split.
The three-character ISO currency code.
If this value is not provided, the currency in which the payment is made will be used.
The amount in minor units.
Your reference for the split, which you can use to link the split to other operations such as captures and refunds.
This is required if type is MarketPlace or BalanceAccount. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated TransferBalance record type in Adyen for Platforms.
Status of the payment link. Possible values:
Indicates if the details of the payment method will be stored for the shopper. Possible values:
shopperReference is provided, the UI lets the shopper choose if they want their payment details to be stored.shopperReference is provided, the details will be stored without asking the shopper for consent.
When set to askForConsent or enabled, you must also include the recurringProcessingModel parameter.A theme to customize the appearance of the payment page. If not specified, the payment page is rendered according to the theme set as default in your Customer Area.
The date when the payment link status was updated.
ISO 8601 format: YYYY-MM-DDThh:mm:ss+TZD, for example, 2020-12-18T10:15:30+01:00.