@adyen/api-library
Version:
The Adyen API Library for NodeJS enables you to work with Adyen APIs.
216 lines (215 loc) • 12.4 kB
TypeScript
import { Address } from "./address";
import { Amount } from "./amount";
import { ApplicationInfo } from "./applicationInfo";
import { CheckoutSessionThreeDS2RequestData } from "./checkoutSessionThreeDS2RequestData";
import { FundOrigin } from "./fundOrigin";
import { FundRecipient } from "./fundRecipient";
import { InstallmentOption } from "./installmentOption";
import { LineItem } from "./lineItem";
import { Name } from "./name";
import { PlatformChargebackLogic } from "./platformChargebackLogic";
import { RiskData } from "./riskData";
import { Split } from "./split";
export declare class PaymentLinkResponse {
/**
* 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: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`
*/
"allowedPaymentMethods"?: Array<string>;
"amount": Amount;
"applicationInfo"?: ApplicationInfo | null;
"billingAddress"?: Address | null;
/**
* 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: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`
*/
"blockedPaymentMethods"?: Array<string>;
/**
* The delay between the authorisation and scheduled auto-capture, specified in hours.
*/
"captureDelayHours"?: number;
/**
* The shopper\'s two-letter country code.
*/
"countryCode"?: string;
/**
* The shopper\'s date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD
*/
"dateOfBirth"?: 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**.
*/
"deliverAt"?: Date;
"deliveryAddress"?: Address | null;
/**
* A short description visible on the payment page. Maximum length: 280 characters.
*/
"description"?: 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 expiry date is 70 days after the payment link is created. If not provided, the payment link expires 24 hours after it was created.
*/
"expiresAt"?: Date;
"fundOrigin"?: FundOrigin | null;
"fundRecipient"?: FundRecipient | null;
/**
* A unique identifier of the payment link.
*/
"id": string;
/**
* 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.
*/
"installmentOptions"?: {
[]: InstallmentOption;
};
/**
* Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Riverty.
*/
"lineItems"?: Array<LineItem>;
/**
* Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture).
*/
"manualCapture"?: boolean;
/**
* 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 activity that is conducted by the merchant.
*/
"mcc"?: string;
/**
* The merchant account identifier for which the payment link is created.
*/
"merchantAccount": 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.
*/
"merchantOrderReference"?: string;
/**
* 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 characters per key. Otherwise, error \"178\" occurs: \"Metadata key size exceeds limit\" * A key cannot have the name `checkout.linkId`. Any value that you provide with this key is going to be replaced by the real payment link ID.
*/
"metadata"?: {
[]: string;
};
"platformChargebackLogic"?: PlatformChargebackLogic | null;
/**
* 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, which follows a fixed schedule. * **CardOnFile** – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * **UnscheduledCardOnFile** – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or has variable amounts. For example, automatic top-ups when a cardholder\'s balance drops below a certain amount.
*/
"recurringProcessingModel"?: PaymentLinkResponse.RecurringProcessingModelEnum;
/**
* A reference that is used to uniquely identify the payment in future communications about the payment status.
*/
"reference": string;
/**
* 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/pay-by-link/payment-links/api#shopper-information). Possible values: * **billingAddress** – The address where to send the invoice. * **deliveryAddress** – The address where the purchased goods should be delivered. * **shopperEmail** – The shopper\'s email address. * **shopperName** – The shopper\'s full name. * **telephoneNumber** – The shopper\'s phone number.
*/
"requiredShopperFields"?: Array<PaymentLinkResponse.RequiredShopperFieldsEnum>;
/**
* 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.
*/
"returnUrl"?: string;
/**
* 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.
*/
"reusable"?: boolean;
"riskData"?: RiskData | null;
/**
* The shopper\'s email address.
*/
"shopperEmail"?: 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 [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).
*/
"shopperLocale"?: string;
"shopperName"?: Name | null;
/**
* Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
*/
"shopperReference"?: 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, and special characters **. , \' _ - ? + * /_**.
*/
"shopperStatement"?: string;
/**
* Set to **false** to hide the button that lets the shopper remove a stored payment method.
*/
"showRemovePaymentMethodButton"?: boolean;
/**
* The shopper\'s social security number.
*/
"socialSecurityNumber"?: string;
/**
* Boolean value indicating whether the card payment method should be split into separate debit and credit options.
*/
"splitCardFundingSources"?: boolean;
/**
* An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
*/
"splits"?: Array<Split>;
/**
* 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 make payments. * **completed**: The shopper completed the payment. * **paymentPending**: The shopper is in the process of making the payment. Applies to payment methods with an asynchronous flow.
*/
"status": PaymentLinkResponse.StatusEnum;
/**
* The physical store, for which this payment is processed.
*/
"store"?: 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 provided, the UI lets the shopper choose if they want their payment details to be stored. * **enabled** – If the `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.
*/
"storePaymentMethodMode"?: PaymentLinkResponse.StorePaymentMethodModeEnum;
/**
* The shopper\'s telephone number. The phone number must include a plus sign (+) and a country code (1-3 digits), followed by the number (4-15 digits). If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the `shopperEmail`.
*/
"telephoneNumber"?: 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 theme set as default in your Customer Area.
*/
"themeId"?: string;
"threeDS2RequestData"?: CheckoutSessionThreeDS2RequestData | null;
/**
* 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**.
*/
"updatedAt"?: Date;
/**
* The URL at which the shopper can complete the payment.
*/
"url": string;
static readonly discriminator: string | undefined;
static readonly mapping: {
[]: string;
} | undefined;
static readonly attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
format: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
format: string;
}[];
constructor();
}
export declare namespace PaymentLinkResponse {
enum RecurringProcessingModelEnum {
CardOnFile = "CardOnFile",
Subscription = "Subscription",
UnscheduledCardOnFile = "UnscheduledCardOnFile"
}
enum RequiredShopperFieldsEnum {
BillingAddress = "billingAddress",
DeliveryAddress = "deliveryAddress",
ShopperEmail = "shopperEmail",
ShopperName = "shopperName",
TelephoneNumber = "telephoneNumber"
}
enum StatusEnum {
Active = "active",
Completed = "completed",
Expired = "expired",
Paid = "paid",
PaymentPending = "paymentPending"
}
enum StorePaymentMethodModeEnum {
AskForConsent = "askForConsent",
Disabled = "disabled",
Enabled = "enabled"
}
}