mollie-api-typescript 1.12.2 → 1.12.3

package/src/models/paymentrequest.ts

@@ -236,11 +236,16 @@ export type PaymentRequestApplicationFee = {
 };
 
 /**
- * Billie is a business-to-business (B2B) payment method. It requires extra information to identify the organization
+ * Billie is a business-to-business (B2B) payment method. It requires extra information to identify the
  *
  * @remarks
- * that is completing the payment. It is recommended to include these parameters up front for a seamless flow.
- * Otherwise, Billie will ask the customer to complete the missing fields during checkout.
+ * organization that is completing the payment. It is recommended to include these parameters up front for a
+ * seamless flow. Otherwise, Billie will ask the customer to complete the missing fields during checkout.
+ *
+ * * `billingAddress.organizationName`: The organization's name.
+ * * `registrationNumber` _string_: The organization's registration number.
+ * * `vatNumber` _string_: The organization's VAT number.
+ * * `entityType` _string_: The organization's entity type.
  */
 export type Company = {
   /**
@@ -465,7 +470,19 @@ export type PaymentRequest = {
    */
   profileId?: string | undefined;
   /**
-   * The date by which the payment should be completed in `YYYY-MM-DD` format
+   * The date the bank transfer payment should expire, in `YYYY-MM-DD` format. The minimum date is tomorrow, and the
+   *
+   * @remarks
+   * maximum date is 100 days after tomorrow.
+   *
+   * After you created the payment, you can still update the `dueDate` via [Update payment](update-payment).
+   *
+   * <Callout icon="📘" theme="info">
+   *   If `dueDate` falls out of business days, it will be set to the **next business day** and the payment will
+   *   expire at 00:00 (on the following business day).
+   *   Example: `dueDate` is `2025-12-06` (Saturday) -> `dueDate` will be set for `2025-12-08`, `expiresAt`
+   *   `2025-12-09 00:00`
+   * </Callout>
    */
   dueDate?: string | undefined;
   /**
@@ -486,45 +503,52 @@ export type PaymentRequest = {
    */
   testmode?: boolean | null | undefined;
   /**
-   * The Apple Pay Payment token object (encoded as JSON) that is part of the result of authorizing a payment request.
+   * The [Apple Pay Payment](https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypayment) token
    *
    * @remarks
-   * The token contains the payment information needed to authorize the payment.
+   * object (encoded as JSON) that is part of the result of authorizing a payment request. The token contains the
+   * payment information needed to authorize the payment.
    *
-   * The object should be passed encoded in a JSON string.
+   * The object should be passed encoded in a JSON string. For example:
+   * `{"paymentData": {"version": "EC_v1", "data": "vK3BbrCbI/...."}}`
    */
   applePayPaymentToken?: string | undefined;
   /**
-   * Billie is a business-to-business (B2B) payment method. It requires extra information to identify the organization
+   * Billie is a business-to-business (B2B) payment method. It requires extra information to identify the
    *
    * @remarks
-   * that is completing the payment. It is recommended to include these parameters up front for a seamless flow.
-   * Otherwise, Billie will ask the customer to complete the missing fields during checkout.
+   * organization that is completing the payment. It is recommended to include these parameters up front for a
+   * seamless flow. Otherwise, Billie will ask the customer to complete the missing fields during checkout.
+   *
+   * * `billingAddress.organizationName`: The organization's name.
+   * * `registrationNumber` _string_: The organization's registration number.
+   * * `vatNumber` _string_: The organization's VAT number.
+   * * `entityType` _string_: The organization's entity type.
    */
   company?: Company | undefined;
   /**
-   * When creating credit card payments using Mollie Components, you need to provide the card token you received from
+   * When creating credit card payments using Mollie Components, you need to provide the card token you received
    *
    * @remarks
-   * the card component in this field. The token represents the customer's card information needed to complete the
-   * payment. Note: field only valid for oneoff and first payments. For recurring payments, the customerId alone is
-   * enough.
+   * from the card component in this field. The token represents the customer's card information needed to complete
+   * the payment. **Note:** field only valid for `oneoff` and `first` payments. For recurring payments, the
+   * `customerId` alone is enough.
    */
   cardToken?: string | undefined;
   /**
-   * The Google Pay payment token object (encoded as JSON) returned by the Google Pay SDK after the customer authorizes
+   * The Google Pay payment token object (encoded as JSON) returned by the Google Pay SDK after the customer
    *
    * @remarks
-   * the payment. The token contains the payment information needed to complete the payment.
+   * authorizes the payment. The token contains the payment information needed to complete the payment.
    *
    * The object should be passed encoded in a JSON string.
    */
   googlePayPaymentToken?: string | undefined;
   /**
-   * The card token you received from the card component of Mollie Components. The token represents the customer's card
+   * The card token you received from the card component of Mollie Components. The token represents the customer's
    *
    * @remarks
-   * information needed to complete the payment.
+   * card information needed to complete the payment.
    */
   voucherNumber?: string | undefined;
   /**
@@ -532,10 +556,10 @@ export type PaymentRequest = {
    */
   voucherPin?: string | undefined;
   /**
-   * The customer's date of birth. If not provided via the API, iDeal in3 will ask the customer to provide it during
+   * The customer's date of birth. If not provided via the API, iDeal in3 will ask the customer to provide it
    *
    * @remarks
-   * the payment process.
+   * during the payment process.
    */
   consumerDateOfBirth?: RFCDate | undefined;
   /**
@@ -543,7 +567,11 @@ export type PaymentRequest = {
    *
    * @remarks
    * You can submit your extra data in this field if you have agreed upon this with Klarna. This field should be an
-   * object containing any of the allowed keys and sub-objects described at the Klarna Developer Documentation.
+   * object containing any of the allowed keys and sub-objects described at the
+   * <Anchor label="Klarna Developer Documentation" target="_blank" href="https://docs.klarna.com/acquirer/mollie/api/extra-merchant-data/">Klarna Developer Documentation</Anchor>.
+   *
+   * Reach out to your account manager at Mollie to enable this feature with Klarna, and to agree on which fields
+   * you can send.
    */
   extraMerchantData?: { [k: string]: any } | undefined;
   /**
@@ -554,21 +582,28 @@ export type PaymentRequest = {
    */
   sessionId?: string | undefined;
   /**
-   * Indicate if you are about to deliver digital goods, such as for example a software license. Setting this parameter
+   * Indicate if you are about to deliver digital goods, such as for example a software license. Setting this
    *
    * @remarks
-   * can have consequences for your PayPal Seller Protection. Refer to PayPal's documentation for more information.
+   * parameter can have consequences for your PayPal Seller Protection. Refer to
+   * [PayPal's documentation](https://www.paypal.com/us/webapps/mpp/ua/seller-protection) for more information.
    */
   digitalGoods?: boolean | undefined;
   /**
-   * Used by paysafecard for customer identification across payments. When you generate a customer reference yourself,
+   * Used by paysafecard for customer identification across payments. When you generate a customer reference
    *
    * @remarks
-   * make sure not to put personal identifiable information or IP addresses in the customer reference directly.
+   * yourself, make sure not to put personal identifiable information or IP addresses in the customer reference
+   * directly.
+   *
+   * If not provided, Mollie will use a hashed version of the customer's IP address.
    */
   customerReference?: string | undefined;
   /**
-   * The ID of the terminal device where you want to initiate the payment on.
+   * The ID of the terminal device where you want to initiate the payment on. See also the
+   *
+   * @remarks
+   * [Terminals API](ref:terminals-api).
    */
   terminalId?: string | undefined;
 };