mollie-api-typescript 1.12.2 → 1.12.3

package/src/models/paymentresponse.ts

@@ -9,12 +9,7 @@ import { safeParse } from "../lib/schemas.js";
 import * as openEnums from "../types/enums.js";
 import { OpenEnum } from "../types/enums.js";
 import { Result as SafeParseResult } from "../types/fp.js";
-import { RFCDate } from "../types/rfcdate.js";
 import { Amount, Amount$inboundSchema } from "./amount.js";
-import {
-  AmountNullable,
-  AmountNullable$inboundSchema,
-} from "./amountnullable.js";
 import {
   CaptureModeResponse,
   CaptureModeResponse$inboundSchema,
@@ -43,45 +38,9 @@ import {
   PaymentAddress$inboundSchema,
 } from "./paymentaddress.js";
 import {
-  PaymentDetailsCardAuditionResponse,
-  PaymentDetailsCardAuditionResponse$inboundSchema,
-} from "./paymentdetailscardauditionresponse.js";
-import {
-  PaymentDetailsCardFundingResponse,
-  PaymentDetailsCardFundingResponse$inboundSchema,
-} from "./paymentdetailscardfundingresponse.js";
-import {
-  PaymentDetailsCardLabelResponse,
-  PaymentDetailsCardLabelResponse$inboundSchema,
-} from "./paymentdetailscardlabelresponse.js";
-import {
-  PaymentDetailsCardSecurityResponse,
-  PaymentDetailsCardSecurityResponse$inboundSchema,
-} from "./paymentdetailscardsecurityresponse.js";
-import {
-  PaymentDetailsFailureReasonResponse,
-  PaymentDetailsFailureReasonResponse$inboundSchema,
-} from "./paymentdetailsfailurereasonresponse.js";
-import {
-  PaymentDetailsFeeRegionResponse,
-  PaymentDetailsFeeRegionResponse$inboundSchema,
-} from "./paymentdetailsfeeregionresponse.js";
-import {
-  PaymentDetailsReceiptCardReadMethodResponse,
-  PaymentDetailsReceiptCardReadMethodResponse$inboundSchema,
-} from "./paymentdetailsreceiptcardreadmethodresponse.js";
-import {
-  PaymentDetailsReceiptCardVerificationMethodResponse,
-  PaymentDetailsReceiptCardVerificationMethodResponse$inboundSchema,
-} from "./paymentdetailsreceiptcardverificationmethodresponse.js";
-import {
-  PaymentDetailsSellerProtectionResponse,
-  PaymentDetailsSellerProtectionResponse$inboundSchema,
-} from "./paymentdetailssellerprotectionresponse.js";
-import {
-  PaymentDetailsWalletResponse,
-  PaymentDetailsWalletResponse$inboundSchema,
-} from "./paymentdetailswalletresponse.js";
+  PaymentDetails,
+  PaymentDetails$inboundSchema,
+} from "./paymentdetails.js";
 import {
   PaymentLineTypeResponse,
   PaymentLineTypeResponse$inboundSchema,
@@ -161,31 +120,6 @@ export type PaymentResponseAmountChargedBack = {
   value: string;
 };
 
-/**
- * **Deprecated.** This field will be removed on January 1st, 2027. Use the [Settlements API](list-settlements) or
- *
- * @remarks
- * the [List balance transactions endpoint](list-balance-transactions) for settlement data.
- *
- * The amount that will be settled to your account, converted to the currency your account is settled in. Only
- * available once the payment is finalized and the final settlement amount has been determined.
- *
- * Amounts not settled by Mollie are not reflected here (e.g. PayPal or gift cards). If no amount is settled by
- * Mollie, this field is omitted from the response.
- *
- * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
- */
-export type PaymentResponseSettlementAmount = {
-  /**
-   * A three-character ISO 4217 currency code.
-   */
-  currency: string;
-  /**
-   * A string containing an exact monetary amount in the given currency.
-   */
-  value: string;
-};
-
 export type PaymentResponseLine = {
   /**
    * The type of product purchased. For example, a physical or a digital product.
@@ -403,328 +337,6 @@ export const PaymentResponseStatus = {
  */
 export type PaymentResponseStatus = OpenEnum<typeof PaymentResponseStatus>;
 
-/**
- * The Point of sale receipt object.
- */
-export type PaymentResponseReceipt = {
-  /**
-   * A unique code provided by the cardholder’s bank to confirm that the transaction was successfully approved.
-   */
-  authorizationCode?: string | null | undefined;
-  /**
-   * The unique number that identifies a specific payment application on a chip card.
-   */
-  applicationIdentifier?: string | null | undefined;
-  /**
-   * The method by which the card was read by the terminal.
-   */
-  cardReadMethod?:
-    | PaymentDetailsReceiptCardReadMethodResponse
-    | null
-    | undefined;
-  /**
-   * The method used to verify the cardholder's identity.
-   */
-  cardVerificationMethod?:
-    | PaymentDetailsReceiptCardVerificationMethodResponse
-    | null
-    | undefined;
-};
-
-/**
- * Optional include. If a QR code was requested during payment creation for a QR-compatible payment method,
- *
- * @remarks
- * the QR code details will be available in this object.
- *
- * The QR code can be scanned by the customer to complete the payment on their mobile device. For example,
- * Bancontact QR payments can be completed by the customer using the Bancontact app.
- */
-export type PaymentResponseQrCode = {
-  /**
-   * The height of the QR code image in pixels.
-   */
-  height?: number | undefined;
-  /**
-   * The width of the QR code image in pixels.
-   */
-  width?: number | undefined;
-  /**
-   * The URL to the QR code image. The image is a PNG file, and can be displayed directly in the browser or
-   *
-   * @remarks
-   * downloaded.
-   */
-  src?: string | undefined;
-};
-
-/**
- * An object containing payment details collected during the payment process. For example, details may include the
- *
- * @remarks
- * customer's card or bank details and a payment reference. For the full list of details, please refer to the
- * [method-specific parameters](extra-payment-parameters) guide.
- */
-export type PaymentResponseDetails = {
-  /**
-   * The customer's name, if made available by the payment method. For card payments, refer to details.cardHolder.
-   */
-  consumerName?: string | null | undefined;
-  /**
-   * The customer's account reference.
-   *
-   * @remarks
-   *
-   * For banking-based payment methods — such as iDEAL — this is normally either an IBAN or a domestic bank account
-   * number.
-   *
-   * For PayPal, the account reference is an email address.
-   *
-   * For card and Bancontact payments, refer to details.cardNumber.
-   */
-  consumerAccount?: string | null | undefined;
-  /**
-   * The BIC of the customer's bank account, if applicable.
-   */
-  consumerBic?: string | null | undefined;
-  /**
-   * For wallet payment methods — such as Apple Pay and PayPal — the shipping address is often already known by the
-   *
-   * @remarks
-   * wallet provider. In these cases the shipping address may be available as a payment detail.
-   */
-  shippingAddress?: { [k: string]: any } | null | undefined;
-  /**
-   * For bancontact, it will be the customer's masked card number. For cards, it will be the last 4-digit of the
-   *
-   * @remarks
-   * PAN. For Point-of-sale, it will be the the last 4 digits of the customer's masked card number.
-   */
-  cardNumber?: string | null | undefined;
-  /**
-   * The name of the bank that the customer will need to make the bank transfer payment towards.
-   */
-  bankName?: string | undefined;
-  /**
-   * The bank account number the customer will need to make the bank transfer payment towards.
-   */
-  bankAccount?: string | undefined;
-  /**
-   * The BIC of the bank the customer will need to make the bank transfer payment towards.
-   */
-  bankBic?: string | undefined;
-  /**
-   * The Mollie-generated reference the customer needs to use when transfering the amount. Do not apply any
-   *
-   * @remarks
-   * formatting here; show it to the customer as-is.
-   */
-  transferReference?: string | null | undefined;
-  /**
-   * A unique fingerprint for a specific card. Can be used to identify returning customers.
-   *
-   * @remarks
-   *
-   * In the case of Point-of-sale payments, it's a unique identifier assigned to a cardholder's payment account,
-   * linking multiple transactions from wallets and physical card to a single account, also across payment methods
-   * or when the card is reissued.
-   */
-  cardFingerprint?: string | null | undefined;
-  /**
-   * The customer's name as shown on their card.
-   */
-  cardHolder?: string | null | undefined;
-  /**
-   * The card's target audience, if known.
-   */
-  cardAudition?: PaymentDetailsCardAuditionResponse | null | undefined;
-  /**
-   * The card's label, if known.
-   */
-  cardLabel?: PaymentDetailsCardLabelResponse | null | undefined;
-  /**
-   * The ISO 3166-1 alpha-2 country code of the country the card was issued in.
-   */
-  cardCountryCode?: string | null | undefined;
-  /**
-   * The expiry date (MM/YY) of the card as displayed on the card.
-   */
-  cardExpiryDate?: string | null | undefined;
-  /**
-   * The card type.
-   */
-  cardFunding?: PaymentDetailsCardFundingResponse | null | undefined;
-  /**
-   * The level of security applied during card processing.
-   */
-  cardSecurity?: PaymentDetailsCardSecurityResponse | null | undefined;
-  /**
-   * The applicable card fee region.
-   */
-  feeRegion?: PaymentDetailsFeeRegionResponse | null | undefined;
-  /**
-   * The first 6 and last 4 digits of the card number.
-   */
-  cardMaskedNumber?: string | null | undefined;
-  /**
-   * The outcome of authentication attempted on transactions enforced by 3DS (ie valid only for oneoff and first).
-   */
-  card3dsEci?: string | null | undefined;
-  /**
-   * The first 6 digit of the card bank identification number.
-   */
-  cardBin?: string | null | undefined;
-  /**
-   * The issuer of the Card.
-   */
-  cardIssuer?: string | null | undefined;
-  /**
-   * A failure code to help understand why the payment failed.
-   */
-  failureReason?: PaymentDetailsFailureReasonResponse | null | undefined;
-  /**
-   * A human-friendly failure message that can be shown to the customer. The message is translated in accordance
-   *
-   * @remarks
-   * with the payment's locale setting.
-   */
-  failureMessage?: string | null | undefined;
-  /**
-   * The wallet used when creating the payment.
-   */
-  wallet?: PaymentDetailsWalletResponse | null | undefined;
-  /**
-   * PayPal's reference for the payment.
-   */
-  paypalReference?: string | null | undefined;
-  /**
-   * ID of the customer's PayPal account.
-   */
-  paypalPayerId?: string | null | undefined;
-  /**
-   * Indicates to what extent the payment is eligible for PayPal's Seller Protection. Only available for PayPal
-   *
-   * @remarks
-   * payments, and if the information is made available by PayPal.
-   */
-  sellerProtection?: PaymentDetailsSellerProtectionResponse | null | undefined;
-  /**
-   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
-   */
-  paypalFee?: AmountNullable | null | undefined;
-  /**
-   * The paysafecard customer reference either provided via the API or otherwise auto-generated by Mollie.
-   */
-  customerReference?: string | undefined;
-  /**
-   * The ID of the terminal device where the payment took place on.
-   */
-  terminalId?: string | undefined;
-  /**
-   * The first 6 digits & last 4 digits of the customer's masked card number.
-   */
-  maskedNumber?: string | null | undefined;
-  /**
-   * The Point of sale receipt object.
-   */
-  receipt?: PaymentResponseReceipt | undefined;
-  /**
-   * The creditor identifier indicates who is authorized to execute the payment. In this case, it is a
-   *
-   * @remarks
-   * reference to Mollie.
-   */
-  creditorIdentifier?: string | null | undefined;
-  /**
-   * Estimated date the payment is debited from the customer's bank account, in YYYY-MM-DD format.
-   */
-  dueDate?: RFCDate | null | undefined;
-  /**
-   * Date the payment has been signed by the customer, in YYYY-MM-DD format. Only available if the payment
-   *
-   * @remarks
-   * has been signed.
-   */
-  signatureDate?: RFCDate | null | undefined;
-  /**
-   * The official reason why this payment has failed. A detailed description of each reason is available on the
-   *
-   * @remarks
-   * website of the European Payments Council.
-   */
-  bankReasonCode?: string | null | undefined;
-  /**
-   * A human-friendly description of the failure reason.
-   */
-  bankReason?: string | null | undefined;
-  /**
-   * The end-to-end identifier you provided in the batch file.
-   */
-  endToEndIdentifier?: string | null | undefined;
-  /**
-   * The mandate reference you provided in the batch file.
-   */
-  mandateReference?: string | null | undefined;
-  /**
-   * The batch reference you provided in the batch file.
-   */
-  batchReference?: string | null | undefined;
-  /**
-   * The file reference you provided in the batch file.
-   */
-  fileReference?: string | null | undefined;
-  /**
-   * Optional include. If a QR code was requested during payment creation for a QR-compatible payment method,
-   *
-   * @remarks
-   * the QR code details will be available in this object.
-   *
-   * The QR code can be scanned by the customer to complete the payment on their mobile device. For example,
-   * Bancontact QR payments can be completed by the customer using the Bancontact app.
-   */
-  qrCode?: PaymentResponseQrCode | undefined;
-  /**
-   * For payments with gift cards: the masked gift card number of the first gift card applied to the payment.
-   */
-  voucherNumber?: string | undefined;
-  /**
-   * An array of detail objects for each gift card that was used on this payment, if any.
-   */
-  giftcards?: Array<{ [k: string]: any }> | undefined;
-  /**
-   * For payments with vouchers: the brand name of the first voucher applied.
-   */
-  issuer?: string | undefined;
-  /**
-   * An array of detail objects for each voucher that was used on this payment, if any.
-   */
-  vouchers?: Array<{ [k: string]: any }> | undefined;
-  /**
-   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
-   */
-  remainderAmount?: Amount | undefined;
-  /**
-   * The payment method used to pay the remainder amount, after all gift cards or vouchers were applied.
-   */
-  remainderMethod?: string | undefined;
-  /**
-   * Optional include. The full payment method details of the remainder payment.
-   */
-  remainderDetails?: { [k: string]: any } | undefined;
-  /**
-   * Multibanco payment reference of the transaction
-   */
-  multibancoReference?: string | null | undefined;
-  /**
-   * Multibanco entity reference of the transaction
-   */
-  multibancoEntity?: string | null | undefined;
-  /**
-   * Bizum payment reference of the transaction
-   */
-  bizumReference?: string | null | undefined;
-};
-
 /**
  * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
  */
@@ -856,21 +468,6 @@ export type PaymentResponse = {
    * zero.
    */
   amountChargedBack?: PaymentResponseAmountChargedBack | undefined;
-  /**
-   * **Deprecated.** This field will be removed on January 1st, 2027. Use the [Settlements API](list-settlements) or
-   *
-   * @remarks
-   * the [List balance transactions endpoint](list-balance-transactions) for settlement data.
-   *
-   * The amount that will be settled to your account, converted to the currency your account is settled in. Only
-   * available once the payment is finalized and the final settlement amount has been determined.
-   *
-   * Amounts not settled by Mollie are not reflected here (e.g. PayPal or gift cards). If no amount is settled by
-   * Mollie, this field is omitted from the response.
-   *
-   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
-   */
-  settlementAmount?: PaymentResponseSettlementAmount | undefined;
   /**
    * The URL your customer will be redirected to after the payment process.
    *
@@ -1101,7 +698,7 @@ export type PaymentResponse = {
    * customer's card or bank details and a payment reference. For the full list of details, please refer to the
    * [method-specific parameters](extra-payment-parameters) guide.
    */
-  details?: PaymentResponseDetails | null | undefined;
+  details?: PaymentDetails | null | undefined;
   /**
    * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
    */
@@ -1234,26 +831,6 @@ export function paymentResponseAmountChargedBackFromJSON(
   );
 }
 
-/** @internal */
-export const PaymentResponseSettlementAmount$inboundSchema: z.ZodType<
-  PaymentResponseSettlementAmount,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  currency: z.string(),
-  value: z.string(),
-});
-
-export function paymentResponseSettlementAmountFromJSON(
-  jsonString: string,
-): SafeParseResult<PaymentResponseSettlementAmount, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => PaymentResponseSettlementAmount$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'PaymentResponseSettlementAmount' from JSON`,
-  );
-}
-
 /** @internal */
 export const PaymentResponseLine$inboundSchema: z.ZodType<
   PaymentResponseLine,
@@ -1343,133 +920,6 @@ export const PaymentResponseStatus$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(PaymentResponseStatus);
 
-/** @internal */
-export const PaymentResponseReceipt$inboundSchema: z.ZodType<
-  PaymentResponseReceipt,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  authorizationCode: z.nullable(z.string()).optional(),
-  applicationIdentifier: z.nullable(z.string()).optional(),
-  cardReadMethod: z.nullable(
-    PaymentDetailsReceiptCardReadMethodResponse$inboundSchema,
-  ).optional(),
-  cardVerificationMethod: z.nullable(
-    PaymentDetailsReceiptCardVerificationMethodResponse$inboundSchema,
-  ).optional(),
-});
-
-export function paymentResponseReceiptFromJSON(
-  jsonString: string,
-): SafeParseResult<PaymentResponseReceipt, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => PaymentResponseReceipt$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'PaymentResponseReceipt' from JSON`,
-  );
-}
-
-/** @internal */
-export const PaymentResponseQrCode$inboundSchema: z.ZodType<
-  PaymentResponseQrCode,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  height: z.number().int().optional(),
-  width: z.number().int().optional(),
-  src: z.string().optional(),
-});
-
-export function paymentResponseQrCodeFromJSON(
-  jsonString: string,
-): SafeParseResult<PaymentResponseQrCode, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => PaymentResponseQrCode$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'PaymentResponseQrCode' from JSON`,
-  );
-}
-
-/** @internal */
-export const PaymentResponseDetails$inboundSchema: z.ZodType<
-  PaymentResponseDetails,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  consumerName: z.nullable(z.string()).optional(),
-  consumerAccount: z.nullable(z.string()).optional(),
-  consumerBic: z.nullable(z.string()).optional(),
-  shippingAddress: z.nullable(z.record(z.any())).optional(),
-  cardNumber: z.nullable(z.string()).optional(),
-  bankName: z.string().optional(),
-  bankAccount: z.string().optional(),
-  bankBic: z.string().optional(),
-  transferReference: z.nullable(z.string()).optional(),
-  cardFingerprint: z.nullable(z.string()).optional(),
-  cardHolder: z.nullable(z.string()).optional(),
-  cardAudition: z.nullable(PaymentDetailsCardAuditionResponse$inboundSchema)
-    .optional(),
-  cardLabel: z.nullable(PaymentDetailsCardLabelResponse$inboundSchema)
-    .optional(),
-  cardCountryCode: z.nullable(z.string()).optional(),
-  cardExpiryDate: z.nullable(z.string()).optional(),
-  cardFunding: z.nullable(PaymentDetailsCardFundingResponse$inboundSchema)
-    .optional(),
-  cardSecurity: z.nullable(PaymentDetailsCardSecurityResponse$inboundSchema)
-    .optional(),
-  feeRegion: z.nullable(PaymentDetailsFeeRegionResponse$inboundSchema)
-    .optional(),
-  cardMaskedNumber: z.nullable(z.string()).optional(),
-  card3dsEci: z.nullable(z.string()).optional(),
-  cardBin: z.nullable(z.string()).optional(),
-  cardIssuer: z.nullable(z.string()).optional(),
-  failureReason: z.nullable(PaymentDetailsFailureReasonResponse$inboundSchema)
-    .optional(),
-  failureMessage: z.nullable(z.string()).optional(),
-  wallet: z.nullable(PaymentDetailsWalletResponse$inboundSchema).optional(),
-  paypalReference: z.nullable(z.string()).optional(),
-  paypalPayerId: z.nullable(z.string()).optional(),
-  sellerProtection: z.nullable(
-    PaymentDetailsSellerProtectionResponse$inboundSchema,
-  ).optional(),
-  paypalFee: z.nullable(AmountNullable$inboundSchema).optional(),
-  customerReference: z.string().optional(),
-  terminalId: z.string().optional(),
-  maskedNumber: z.nullable(z.string()).optional(),
-  receipt: z.lazy(() => PaymentResponseReceipt$inboundSchema).optional(),
-  creditorIdentifier: z.nullable(z.string()).optional(),
-  dueDate: z.nullable(z.string().transform(v => new RFCDate(v))).optional(),
-  signatureDate: z.nullable(z.string().transform(v => new RFCDate(v)))
-    .optional(),
-  bankReasonCode: z.nullable(z.string()).optional(),
-  bankReason: z.nullable(z.string()).optional(),
-  endToEndIdentifier: z.nullable(z.string()).optional(),
-  mandateReference: z.nullable(z.string()).optional(),
-  batchReference: z.nullable(z.string()).optional(),
-  fileReference: z.nullable(z.string()).optional(),
-  qrCode: z.lazy(() => PaymentResponseQrCode$inboundSchema).optional(),
-  voucherNumber: z.string().optional(),
-  giftcards: z.array(z.record(z.any())).optional(),
-  issuer: z.string().optional(),
-  vouchers: z.array(z.record(z.any())).optional(),
-  remainderAmount: Amount$inboundSchema.optional(),
-  remainderMethod: z.string().optional(),
-  remainderDetails: z.record(z.any()).optional(),
-  multibancoReference: z.nullable(z.string()).optional(),
-  multibancoEntity: z.nullable(z.string()).optional(),
-  bizumReference: z.nullable(z.string()).optional(),
-});
-
-export function paymentResponseDetailsFromJSON(
-  jsonString: string,
-): SafeParseResult<PaymentResponseDetails, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => PaymentResponseDetails$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'PaymentResponseDetails' from JSON`,
-  );
-}
-
 /** @internal */
 export const PaymentResponseLinks$inboundSchema: z.ZodType<
   PaymentResponseLinks,
@@ -1525,8 +975,6 @@ export const PaymentResponse$inboundSchema: z.ZodType<
   amountChargedBack: z.lazy(() =>
     PaymentResponseAmountChargedBack$inboundSchema
   ).optional(),
-  settlementAmount: z.lazy(() => PaymentResponseSettlementAmount$inboundSchema)
-    .optional(),
   redirectUrl: z.nullable(z.string()).optional(),
   cancelUrl: z.nullable(z.string()).optional(),
   webhookUrl: z.nullable(z.string()).optional(),
@@ -1558,8 +1006,7 @@ export const PaymentResponse$inboundSchema: z.ZodType<
   status: PaymentResponseStatus$inboundSchema,
   statusReason: z.nullable(StatusReason$inboundSchema).optional(),
   isCancelable: z.nullable(z.boolean()).optional(),
-  details: z.nullable(z.lazy(() => PaymentResponseDetails$inboundSchema))
-    .optional(),
+  details: z.nullable(PaymentDetails$inboundSchema).optional(),
   createdAt: z.string(),
   authorizedAt: z.nullable(z.string()).optional(),
   paidAt: z.nullable(z.string()).optional(),