Adyen · Schema
PaymentLinkResponse
PaymentLinkResponse schema from Adyen API
PaymentsFinancial ServicesFintech
Properties
| Name | Type | Description |
|---|---|---|
| allowedPaymentMethods | array | List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `"allowedPay |
| amount | object | The payment amount and currency. |
| applicationInfo | object | Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). |
| billingAddress | object | The address where to send the invoice. |
| blockedPaymentMethods | array | List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `"blockedPaym |
| captureDelayHours | integer | The delay between the authorisation and scheduled auto-capture, specified in hours. |
| countryCode | string | The shopper's two-letter country code. |
| dateOfBirth | string | The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD |
| deliverAt | string | The date and time when the purchased goods should be delivered. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**. |
| deliveryAddress | object | The address where the purchased goods should be delivered. |
| description | string | A short description visible on the payment page. Maximum length: 280 characters. |
| expiresAt | string | The date when the payment link expires. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with time zone offset: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**. The maximum e |
| id | string | A unique identifier of the payment link. |
| installmentOptions | object | 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 f |
| lineItems | array | 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 Afte |
| manualCapture | boolean | Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture). |
| mcc | string | The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activi |
| merchantAccount | string | The merchant account identifier for which the payment link is created. |
| merchantOrderReference | string | 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 | object | Metadata consists of entries, each of which includes a key and a value. Limitations: * Maximum 20 key-value pairs per request. Otherwise, error "177" occurs: "Metadata size exceeds limit" * Maximum 20 |
| recurringProcessingModel | string | Defines a recurring payment type. Required when `storePaymentMethodMode` is set to **askForConsent** or **enabled**. Possible values: * **Subscription** – A transaction for a fixed or variable amount, |
| reference | string | A reference that is used to uniquely identify the payment in future communications about the payment status. |
| requiredShopperFields | array | 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](https://docs.adyen.com/unified-commerce/p |
| returnUrl | string | 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 U |
| reusable | boolean | 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. |
| riskData | object | Any risk-related settings to apply to the payment. |
| shopperEmail | string | The shopper's email address. |
| shopperLocale | string | 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 [Languag |
| shopperName | object | 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. |
| shopperReference | string | 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 exam |
| shopperStatement | string | 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, |
| showRemovePaymentMethodButton | boolean | Set to **false** to hide the button that lets the shopper remove a stored payment method. |
| socialSecurityNumber | string | The shopper's social security number. |
| splitCardFundingSources | boolean | Boolean value indicating whether the card payment method should be split into separate debit and credit options. |
| splits | array | An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information), [Classic Plat |
| status | string | Status of the payment link. Possible values: * **active**: The link can be used to make payments. * **expired**: The expiry date for the payment link has passed. Shoppers can no longer use the link to |
| store | string | The physical store, for which this payment is processed. |
| storePaymentMethodMode | string | Indicates if the details of the payment method will be stored for the shopper. Possible values: * **disabled** – No details will be stored (default). * **askForConsent** – If the `shopperReference` is |
| telephoneNumber | string | The shopper's telephone number. |
| themeId | string | A [theme](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#themes) to customize the appearance of the payment page. If not specified, the payment page is rendered according to the |
| updatedAt | string | The date when the payment link status was updated. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**. |
| url | string | The URL at which the shopper can complete the payment. |