mangopay4-nodejs-sdk 1.68.0 → 2.1.0

package/typings/models/payIn.d.ts

@@ -149,6 +149,11 @@ export namespace payIn {
          * used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.
          */
         ProfilingAttemptReference?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
     }
 
     interface CardWebPayInData extends BasePayInData {
@@ -330,6 +335,11 @@ export namespace payIn {
          * used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.
          */
         ProfilingAttemptReference?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
     }
 
     interface CardDirectPayInData extends BasePayInData {
@@ -735,6 +745,11 @@ export namespace payIn {
          * Preferred Card Network
          */
         PreferredCardNetwork?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
     }
 
     interface CreateMbwayWebPayIn {
@@ -784,6 +799,11 @@ export namespace payIn {
          * used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.
          */
         ProfilingAttemptReference?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
     }
 
     interface CreateBancontactWebPayIn {
@@ -842,6 +862,11 @@ export namespace payIn {
          * used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.
          */
         ProfilingAttemptReference?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
     }
 
     interface CreateBizumWebPayIn {
@@ -896,6 +921,11 @@ export namespace payIn {
          * Custom data that you can add to this item
          */
         Tag?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
     }
 
     interface CreatePayPalWebPayIn {
@@ -961,6 +991,11 @@ export namespace payIn {
         CancelURL?: string;
 
         DataCollectionId?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
     }
 
     interface CreateMultibancoWebPayIn {
@@ -1009,6 +1044,11 @@ export namespace payIn {
          * used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.
          */
         ProfilingAttemptReference?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
     }
 
     interface CreateSatispayWebPayIn {
@@ -1062,6 +1102,11 @@ export namespace payIn {
          * used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.
          */
         ProfilingAttemptReference?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
     }
 
     interface CreateBlikWebPayIn {
@@ -1128,6 +1173,11 @@ export namespace payIn {
          * used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.
          */
         ProfilingAttemptReference?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
     }
 
     interface LineItemData {
@@ -1261,6 +1311,11 @@ export namespace payIn {
          * used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.
          */
         ProfilingAttemptReference?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
     }
 
     interface DirectDebitWebPayInData extends BasePayInData {
@@ -1348,6 +1403,11 @@ export namespace payIn {
          * used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.
          */
         ProfilingAttemptReference?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
     }
 
     interface CardPreAuthorizedPayInData extends BasePayInData {
@@ -1492,6 +1552,11 @@ export namespace payIn {
          * used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.
          */
         ProfilingAttemptReference?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
     }
 
     interface PayInRecurringRegistrationState {
@@ -1549,270 +1614,1271 @@ export namespace payIn {
         Shipping: BillingOrShippingRecurringPayInData;
 
         /**
-         * Date on which the recurring payments will end
+         * Date on which the recurring payments will end
+         */
+        EndDate: Timestamp;
+
+        /**
+         * Frequency at which the recurring payments will be made
+         */
+        Frequency: FrequencyType;
+
+        /**
+         * Indicates whether the payment amount is likely to change during the payment period
+         */
+        FixedNextAmount: boolean;
+
+        /**
+         * Indicates whether this recurring payment is a payment in installments in N times
+         */
+        FractionedPayment: boolean;
+
+        FreeCycles?: number;
+
+        /**
+         * Amount of the first payment. This amount may be different from the NextTransactionDebitedFunds.
+         */
+        FirstTransactionDebitedFunds: MoneyData;
+
+        /**
+         * Amount of the first payment fees. This amount may be different from the NextTransactionFees.
+         */
+        FirstTransactionFees: MoneyData;
+
+        /**
+         * Amount of subsequent payments. If this field is empty and either FixedNextAmount or FractionedPayment are TRUE,
+         * we will take the amount of the FirstTransactionDebitedFunds as the subsequent payment amount.
+         */
+        NextTransactionDebitedFunds: MoneyData;
+
+        /**
+         * Amount of subsequent fees. If this field is empty and either FixedNextAmount or FractionedPayment are TRUE,
+         * we will take the amount of the FirstTransactionFees as the subsequent fees.
+         */
+        NextTransactionFees: MoneyData;
+
+        /**
+         * Indicates whether the object is being used to attempt registration of an existing recurring payment
+         */
+        Migration: boolean;
+
+        PaymentType: RecurringPayInRegistrationPaymentType;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
+    }
+
+    interface RecurringPayInRegistrationData extends entityBase.EntityBaseData {
+        /**
+         * The status of the transaction
+         */
+        Status: RecurringPaymentStatus;
+
+        /**
+         * The code indicating the result of the operation
+         */
+        ResultCode: string;
+
+        /**
+         * The explanation of the result code
+         */
+        ResultMessage: string;
+
+        /**
+         * Current state
+         */
+        CurrentState: PayInRecurringRegistrationState;
+
+        /**
+         * Recurring type
+         */
+        RecurringType: RecurringType;
+
+        /**
+         * Total amount
+         */
+        TotalAmount: MoneyData;
+
+        /**
+         * Cycle number
+         */
+        CycleNumber: number;
+
+        /**
+         * A user's ID
+         */
+        AuthorId: string;
+
+        /**
+         * The ID of a card
+         */
+        CardId: string;
+
+        /**
+         * The user ID who is credited (defaults to the owner of the wallet)
+         */
+        CreditedUserId: string;
+
+        /**
+         * The ID of the wallet where money will be credited
+         */
+        CreditedWalletId: string;
+
+        /**
+         * Contains every useful informations related to the user billing
+         */
+        Billing: BillingOrShippingRecurringPayInData;
+
+        /**
+         * Contains every useful information's related to the user shipping
+         */
+        Shipping: BillingOrShippingRecurringPayInData;
+
+        /**
+         * Date on which the recurring payments will end
+         */
+        EndDate: Timestamp;
+
+        /**
+         * Frequency at which the recurring payments will be made
+         */
+        Frequency: FrequencyType;
+
+        /**
+         * Indicates whether the payment amount is likely to change during the payment period
+         */
+        FixedNextAmount: boolean;
+
+        /**
+         * Indicates whether this recurring payment is a payment in installments in N times
+         */
+        FractionedPayment: boolean;
+
+        /**
+         * Free cycles
+         */
+        FreeCycles: number;
+
+        /**
+         * Amount of the first payment. This amount may be different from the NextTransactionDebitedFunds.
+         */
+        FirstTransactionDebitedFunds: MoneyData;
+
+        /**
+         * Amount of the first payment fees. This amount may be different from the NextTransactionFees.
+         */
+        FirstTransactionFees: MoneyData;
+
+        /**
+         * Amount of subsequent payments. If this field is empty and either FixedNextAmount or FractionedPayment are TRUE,
+         * we will take the amount of the FirstTransactionDebitedFunds as the subsequent payment amount.
+         */
+        NextTransactionDebitedFunds: MoneyData;
+
+        /**
+         * Amount of subsequent fees. If this field is empty and either FixedNextAmount or FractionedPayment are TRUE,
+         * we will take the amount of the FirstTransactionFees as the subsequent fees.
+         */
+        NextTransactionFees: MoneyData;
+
+        /**
+         * Indicates whether the object is being used to attempt registration of an existing recurring payment
+         * @deprecated
+         */
+        Migration: boolean;
+
+        /**
+         * Payment type
+         */
+        PaymentType: RecurringPayInRegistrationPaymentType;
+
+        /**
+         * Card info
+         */
+        CardInfo: CardInfoData;
+
+        /**
+         * The unique reference generated for the profiling session, used by the fraud prevention solution to produce
+         * recommendations for the transaction using the profiling data.
+         */
+        ProfilingAttemptReference: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor: FlowDescriptor;
+    }
+
+    interface CreatePayInRecurringRegistration {
+        /**
+         * A user's ID
+         */
+        AuthorId: string;
+
+        /**
+         * The ID of a card
+         */
+        CardId: string;
+
+        /**
+         * The user ID who is credited (defaults to the owner of the wallet)
+         */
+        CreditedUserId?: string;
+
+        /**
+         * The ID of the wallet where money will be credited
+         */
+        CreditedWalletId: string;
+
+        /**
+         * Amount of the first payment. This amount may be different from the NextTransactionDebitedFunds.
+         */
+        FirstTransactionDebitedFunds: MoneyData;
+
+        /**
+         * Amount of the first payment fees. This amount may be different from the NextTransactionFees.
+         */
+        FirstTransactionFees: MoneyData;
+
+        /**
+         * Contains every useful informations related to the user billing
+         */
+        Billing?: BillingOrShippingRecurringPayInData;
+
+        /**
+         * Contains every useful information's related to the user shipping
+         */
+        Shipping?: BillingOrShippingRecurringPayInData;
+
+        /**
+         * Date on which the recurring payments will end
+         */
+        EndDate?: Timestamp;
+
+        /**
+         * Frequency at which the recurring payments will be made
+         */
+        Frequency?: FrequencyType;
+
+        /**
+         * Indicates whether the payment amount is likely to change during the payment period
+         */
+        FixedNextAmount?: boolean;
+
+        /**
+         * Indicates whether this recurring payment is a payment in installments in N times
+         */
+        FractionedPayment?: boolean;
+
+        /**
+         * Indicates whether the object is being used to attempt registration of an existing recurring payment
+         */
+        Migration?: boolean;
+
+        /**
+         * Amount of subsequent payments. If this field is empty and either FixedNextAmount or FractionedPayment are TRUE,
+         * we will take the amount of the FirstTransactionDebitedFunds as the subsequent payment amount.
+         */
+        NextTransactionDebitedFunds?: MoneyData;
+
+        /**
+         * Amount of subsequent fees. If this field is empty and either FixedNextAmount or FractionedPayment are TRUE,
+         * we will take the amount of the FirstTransactionFees as the subsequent fees.
+         */
+        NextTransactionFees?: MoneyData;
+
+        FreeCycles?: number;
+
+        PaymentType?: RecurringPayInRegistrationPaymentType
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
+    }
+
+    interface CreateRecurringCardPayInRegistration {
+        /**
+         * A user's ID
+         */
+        AuthorId: string;
+
+        /**
+         * The ID of a card
+         */
+        CardId: string;
+
+        /**
+         * The user ID who is credited (defaults to the owner of the wallet)
+         */
+        CreditedUserId?: string;
+
+        /**
+         * The ID of the wallet where money will be credited
+         */
+        CreditedWalletId: string;
+
+        /**
+         * Amount of the first payment. This amount may be different from the NextTransactionDebitedFunds.
+         */
+        FirstTransactionDebitedFunds: MoneyData;
+
+        /**
+         * Amount of the first payment fees. This amount may be different from the NextTransactionFees.
+         */
+        FirstTransactionFees: MoneyData;
+
+        /**
+         * Contains every useful informations related to the user billing
+         */
+        Billing?: CreateBilling;
+
+        /**
+         * Contains every useful information's related to the user shipping
+         */
+        Shipping?: CreateShipping;
+
+        /**
+         * Date on which the recurring payments will end
+         */
+        EndDate?: Timestamp;
+
+        /**
+         * Frequency at which the recurring payments will be made
+         */
+        Frequency?: FrequencyType;
+
+        /**
+         * Indicates whether the payment amount is likely to change during the payment period
+         */
+        FixedNextAmount?: boolean;
+
+        /**
+         * Indicates whether this recurring payment is a payment in installments in N times
+         */
+        FractionedPayment?: boolean;
+
+        /**
+         * Indicates whether the object is being used to attempt registration of an existing recurring payment
+         * @deprecated
+         */
+        Migration?: boolean;
+
+        /**
+         * Amount of subsequent payments. If this field is empty and either FixedNextAmount or FractionedPayment are TRUE,
+         * we will take the amount of the FirstTransactionDebitedFunds as the subsequent payment amount.
+         */
+        NextTransactionDebitedFunds?: MoneyData;
+
+        /**
+         * Amount of subsequent fees. If this field is empty and either FixedNextAmount or FractionedPayment are TRUE,
+         * we will take the amount of the FirstTransactionFees as the subsequent fees.
+         */
+        NextTransactionFees?: MoneyData;
+
+        /**
+         * The number of initial consecutive pay-ins where there will be no debited funds nor fees.
+         */
+        FreeCycles?: number;
+
+        /**
+         * The unique reference generated for the profiling session, used by the fraud prevention solution to produce
+         * recommendations for the transaction using the profiling data.
+         */
+        ProfilingAttemptReference?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
+    }
+
+    interface CreateRecurringPayPalPayInRegistration {
+        /**
+         * A user's ID
+         */
+        AuthorId: string;
+
+        /**
+         * The ID of the wallet where money will be credited
+         */
+        CreditedWalletId: string;
+
+        /**
+         * Amount of the first payment. This amount may be different from the NextTransactionDebitedFunds.
+         */
+        FirstTransactionDebitedFunds: MoneyData;
+
+        /**
+         * Amount of the first payment fees. This amount may be different from the NextTransactionFees.
+         */
+        FirstTransactionFees: MoneyData;
+
+        /**
+         * Contains every useful informations related to the user billing
+         */
+        Billing?: CreateBilling;
+
+        /**
+         * Contains every useful information's related to the user shipping
+         */
+        Shipping?: CreateShipping;
+
+        /**
+         * Indicates whether the payment amount is likely to change during the payment period
+         */
+        FixedNextAmount?: boolean;
+
+        /**
+         * Amount of subsequent payments. If this field is empty and either FixedNextAmount or FractionedPayment are TRUE,
+         * we will take the amount of the FirstTransactionDebitedFunds as the subsequent payment amount.
+         */
+        NextTransactionDebitedFunds?: MoneyData;
+
+        /**
+         * Amount of subsequent fees. If this field is empty and either FixedNextAmount or FractionedPayment are TRUE,
+         * we will take the amount of the FirstTransactionFees as the subsequent fees.
+         */
+        NextTransactionFees?: MoneyData;
+
+        /**
+         * Payment type
+         */
+        PaymentType?: RecurringPayInRegistrationPaymentType
+
+        /**
+         * The unique reference generated for the profiling session, used by the fraud prevention solution to produce
+         * recommendations for the transaction using the profiling data.
+         */
+        ProfilingAttemptReference?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
+    }
+
+    interface CreateRecurringApplePayPayInRegistration {
+        /**
+         * A user's ID
+         */
+        AuthorId: string;
+
+        /**
+         * The user ID who is credited (defaults to the owner of the wallet)
+         */
+        CreditedUserId?: string;
+
+        /**
+         * The ID of the wallet where money will be credited
+         */
+        CreditedWalletId: string;
+
+        /**
+         * Amount of the first payment. This amount may be different from the NextTransactionDebitedFunds.
+         */
+        FirstTransactionDebitedFunds: MoneyData;
+
+        /**
+         * Amount of the first payment fees. This amount may be different from the NextTransactionFees.
+         */
+        FirstTransactionFees: MoneyData;
+
+        /**
+         * The data returned by Apple Pay containing information about the payment.
+         */
+        PaymentData: ApplePayPaymentData;
+
+        /**
+         * Contains every useful informations related to the user billing
+         */
+        Billing?: CreateBilling;
+
+        /**
+         * Contains every useful information's related to the user shipping
+         */
+        Shipping?: CreateShipping;
+
+        /**
+         * Payment type
+         */
+        PaymentType: RecurringPayInRegistrationPaymentType
+
+        /**
+         * Date on which the recurring payments will end
+         */
+        EndDate?: Timestamp;
+
+        /**
+         * Frequency at which the recurring payments will be made
+         */
+        Frequency?: FrequencyType;
+
+        /**
+         * Indicates whether the payment amount is likely to change during the payment period
+         */
+        FixedNextAmount?: boolean;
+
+        /**
+         * Indicates whether this recurring payment is a payment in installments in N times
+         */
+        FractionedPayment?: boolean;
+
+        /**
+         * Amount of subsequent payments. If this field is empty and either FixedNextAmount or FractionedPayment are TRUE,
+         * we will take the amount of the FirstTransactionDebitedFunds as the subsequent payment amount.
+         */
+        NextTransactionDebitedFunds?: MoneyData;
+
+        /**
+         * Amount of subsequent fees. If this field is empty and either FixedNextAmount or FractionedPayment are TRUE,
+         * we will take the amount of the FirstTransactionFees as the subsequent fees.
+         */
+        NextTransactionFees?: MoneyData;
+
+        /**
+         * The number of initial consecutive pay-ins where there will be no debited funds nor fees.
+         */
+        FreeCycles?: number;
+
+        /**
+         * The unique reference generated for the profiling session, used by the fraud prevention solution to produce
+         * recommendations for the transaction using the profiling data.
+         */
+        ProfilingAttemptReference?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
+    }
+
+    interface CreateRecurringGooglePayPayInRegistration {
+        /**
+         * A user's ID
+         */
+        AuthorId: string;
+
+        /**
+         * The user ID who is credited (defaults to the owner of the wallet)
+         */
+        CreditedUserId?: string;
+
+        /**
+         * The ID of the wallet where money will be credited
+         */
+        CreditedWalletId: string;
+
+        /**
+         * Amount of the first payment. This amount may be different from the NextTransactionDebitedFunds.
+         */
+        FirstTransactionDebitedFunds: MoneyData;
+
+        /**
+         * Amount of the first payment fees. This amount may be different from the NextTransactionFees.
+         */
+        FirstTransactionFees: MoneyData;
+
+        /**
+         * The data returned by Google Pay containing information about the payment.
+         */
+        PaymentData: string;
+
+        /**
+         * Contains every useful informations related to the user billing
+         */
+        Billing?: CreateBilling;
+
+        /**
+         * Contains every useful information's related to the user shipping
+         */
+        Shipping?: CreateShipping;
+
+        /**
+         * Payment type
+         */
+        PaymentType: RecurringPayInRegistrationPaymentType
+
+        /**
+         * Date on which the recurring payments will end
+         */
+        EndDate?: Timestamp;
+
+        /**
+         * Frequency at which the recurring payments will be made
+         */
+        Frequency?: FrequencyType;
+
+        /**
+         * Indicates whether the payment amount is likely to change during the payment period
+         */
+        FixedNextAmount?: boolean;
+
+        /**
+         * Indicates whether this recurring payment is a payment in installments in N times
+         */
+        FractionedPayment?: boolean;
+
+        /**
+         * Amount of subsequent payments. If this field is empty and either FixedNextAmount or FractionedPayment are TRUE,
+         * we will take the amount of the FirstTransactionDebitedFunds as the subsequent payment amount.
+         */
+        NextTransactionDebitedFunds?: MoneyData;
+
+        /**
+         * Amount of subsequent fees. If this field is empty and either FixedNextAmount or FractionedPayment are TRUE,
+         * we will take the amount of the FirstTransactionFees as the subsequent fees.
+         */
+        NextTransactionFees?: MoneyData;
+
+        /**
+         * The number of initial consecutive pay-ins where there will be no debited funds nor fees.
+         */
+        FreeCycles?: number;
+
+        /**
+         * The unique reference generated for the profiling session, used by the fraud prevention solution to produce
+         * recommendations for the transaction using the profiling data.
+         */
+        ProfilingAttemptReference?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
+    }
+
+    interface UpdatePayInRecurringRegistration {
+        CardId?: string;
+
+        Billing?: BillingOrShippingRecurringPayInData;
+
+        Shipping?: BillingOrShippingRecurringPayInData;
+
+        Status?: UpdateRecurringPaymentStatus;
+    }
+
+    interface UpdateRecurringCardPayInRegistration {
+        Id: string;
+
+        CardId?: string;
+
+        Billing?: BillingOrShippingRecurringPayInData;
+
+        Shipping?: BillingOrShippingRecurringPayInData;
+
+        Status?: UpdateRecurringPaymentStatus;
+    }
+
+    interface UpdateRecurringPayPalPayInRegistration {
+        Id: string;
+
+        Billing?: BillingOrShippingRecurringPayInData;
+
+        Shipping?: BillingOrShippingRecurringPayInData;
+
+        Status?: UpdateRecurringPaymentStatus;
+    }
+
+    interface UpdateRecurringApplePayPayInRegistration {
+        Id: string;
+
+        PaymentData?: ApplePayPaymentData;
+
+        Billing?: BillingOrShippingRecurringPayInData;
+
+        Shipping?: BillingOrShippingRecurringPayInData;
+
+        Status?: UpdateRecurringPaymentStatus;
+    }
+
+    interface UpdateRecurringGooglePayPayInRegistration {
+        Id: string;
+
+        PaymentData?: string;
+
+        Billing?: BillingOrShippingRecurringPayInData;
+
+        Shipping?: BillingOrShippingRecurringPayInData;
+
+        Status?: UpdateRecurringPaymentStatus;
+    }
+
+    interface RecurringPayInData extends BasePayInData {
+        /**
+         * The SecureMode corresponds to '3D secure' for CB Visa and MasterCard. This field lets you activate it manually.
+         * The field lets you activate it automatically with "DEFAULT" (Secured Mode will be activated from €50 or when MANGOPAY detects there is a higher risk ),
+         * "FORCE" (if you wish to specifically force the secured mode).
+         */
+        SecureMode: SecureMode;
+
+        /**
+         * The ID of a card
+         */
+        CardId: string;
+
+        /**
+         * The value is 'true' if the SecureMode was used
+         */
+        SecureModeNeeded: boolean;
+
+        /**
+         * This is the URL where to redirect users to proceed to 3D secure validation
+         */
+        SecureModeRedirectURL: string;
+
+        /**
+         * This is the URL where users are automatically redirected after 3D secure validation (if activated)
+         */
+        SecureModeReturnURL: string;
+
+        /**
+         * The language to use for the payment page - needs to be the ISO code of the language
+         */
+        Culture: CountryISO;
+
+        /**
+         * Contains useful information related to security and fraud
+         */
+        SecurityInfo: SecurityInfoData;
+
+        /**
+         * A custom description to appear on the user's bank statement. It can be up to 10 characters long, and can only include alphanumeric characters or spaces.
+         * See here for important info. Note that each bank handles this information differently, some show less or no information.
+         */
+        StatementDescriptor: string;
+
+        /**
+         * This object describes the Browser being used by an end user
+         */
+        BrowserInfo: BrowserInfoData;
+
+        /**
+         * IP Address of the end user (format IPV4 or IPV6)
+         */
+        IpAddress: string;
+
+        /**
+         * Contains every useful information related to the user billing
+         */
+        Billing: BillingOrShippingRecurringPayInData;
+
+        /**
+         * Contains every useful information's related to the user shipping
+         */
+        Shipping: BillingOrShippingRecurringPayInData;
+
+        /**
+         * The 3DS protocol version requested
+         */
+        Requested3DSVersion: _3DSVersion;
+
+        /**
+         * The 3DS protocol version applied
+         */
+        Applied3DSVersion: _3DSVersion;
+
+        /**
+         * The unique identifier of the recurring pay-in registration
+         */
+        RecurringPayinRegistrationId: string;
+
+        /**
+         * Information about the card
+         */
+        CardInfo: CardInfoData;
+
+        /**
+         * Payment category
+         */
+        PaymentCategory?: string;
+
+        /**
+         * Preferred Card Network
+         */
+        PreferredCardNetwork?: string;
+
+        /**
+         * Authentication result
+         */
+        AuthenticationResult?: AuthenticationResult;
+
+        /**
+         * Information about the items bought by the customer
+         */
+        LineItems?: LineItemData[];
+
+        /**
+         * The URL where users are automatically redirected after the payment is validated
+         */
+        ReturnURL?: string;
+
+        /**
+         * The URL to which the user is redirected to complete the payment
+         */
+        RedirectURL?: string;
+
+        /**
+         * The URL to which the user is returned after canceling the payment
+         */
+        CancelURL?: string;
+
+        /**
+         * Information about the shipping address behavior on the PayPal payment page
+         */
+        ShippingPreference?: ShippingPreference;
+
+        /**
+         * The platform's order reference for the transaction
+         */
+        Reference?: string;
+
+        /**
+         * Shipping information of the LineItems added to the pay-in object
+         */
+        Trackings?: PayPalWebTrackingData;
+
+        /**
+         * The email address registered on the PayPal account used to make the payment
+         */
+        PaypalBuyerAccountEmail?: string;
+
+        /**
+         * The unique identifier of the PayPal order
+         */
+        PaypalOrderID?: string;
+
+        /**
+         * The unique identifier of the PayPal payer
+         */
+        PaypalPayerID?: string;
+
+        /**
+         * The country of the buyer
+         */
+        BuyerCountry?: string;
+
+        /**
+         * The first name of the buyer
+         */
+        BuyerFirstname?: string;
+
+        /**
+         * The last name of the buyer
+         */
+        BuyerLastname?: string;
+
+        /**
+         * The phone number of the buyer
+         */
+        BuyerPhone?: string;
+    }
+
+    interface CreateRecurringPayInCIT {
+        /**
+         * The recurring's ID
+         */
+        RecurringPayinRegistrationId: string;
+
+        /**
+         * This object describes the Browser being user by an end user
+         */
+        BrowserInfo: BrowserInfoData;
+
+        /**
+         * IP Address of the end user (format IPV4 or IPV6)
+         */
+        IpAddress: string;
+
+        /**
+         * This is the URL where users are automatically redirected after 3D secure validation (if activated)
+         */
+        SecureModeReturnURL: string;
+
+        /**
+         * A custom description to appear on the user's bank statement. It can be up to 10 characters long,
+         * and can only include alphanumeric characters or spaces. See here for important info.
+         * Note that each bank handles this information differently, some show less or no information.
+         */
+        StatementDescriptor?: string;
+
+        /**
+         * Custom data that you can add to this item
+         */
+        Tag?: string;
+
+        /**
+         * Amount of the subsequent payment. If this field is empty we will take the amount entered in the NextTransactionDebitedFunds of the Recurring PayIn Registration.
+         * An amount must be transmitted during either registration or pay-in (if it’s different from the registration one).
+         */
+        DebitedFunds?: MoneyData;
+
+        /**
+         * Amount of the subsequent fees. If this field is empty we will take the amount entered in the NextTransactionFees
+         * of the Recurring PayIn Registration. An amount must be transmitted during either registration or pay-in.
+         */
+        Fees?: MoneyData;
+
+        PaymentCategory?: string;
+    }
+
+    interface CreateRecurringCardPayInCIT {
+        ExecutionType: "DIRECT";
+
+        PaymentType: "CARD";
+
+        /**
+         * The recurring's ID
+         */
+        RecurringPayinRegistrationId: string;
+
+        /**
+         * This object describes the Browser being user by an end user
+         */
+        BrowserInfo: BrowserInfoData;
+
+        /**
+         * IP Address of the end user (format IPV4 or IPV6)
+         */
+        IpAddress: string;
+
+        /**
+         * This is the URL where users are automatically redirected after 3D secure validation (if activated)
+         */
+        SecureModeReturnURL: string;
+
+        /**
+         * A custom description to appear on the user's bank statement. It can be up to 10 characters long,
+         * and can only include alphanumeric characters or spaces. See here for important info.
+         * Note that each bank handles this information differently, some show less or no information.
+         */
+        StatementDescriptor?: string;
+
+        /**
+         * Custom data that you can add to this item
+         */
+        Tag?: string;
+
+        /**
+         * Amount of the subsequent payment. If this field is empty we will take the amount entered in the NextTransactionDebitedFunds of the Recurring PayIn Registration.
+         * An amount must be transmitted during either registration or pay-in (if it’s different from the registration one).
+         */
+        DebitedFunds?: MoneyData;
+
+        /**
+         * Amount of the subsequent fees. If this field is empty we will take the amount entered in the NextTransactionFees
+         * of the Recurring PayIn Registration. An amount must be transmitted during either registration or pay-in.
+         */
+        Fees?: MoneyData;
+
+        /**
+         * Payment category
+         */
+        PaymentCategory?: string;
+
+        /**
+         * Preferred Card Network
+         */
+        PreferredCardNetwork?: string;
+    }
+
+    interface CreateRecurringCardPayInMIT {
+        ExecutionType: "DIRECT";
+
+        PaymentType: "CARD";
+
+        /**
+         * The recurring's ID
+         */
+        RecurringPayinRegistrationId: string;
+
+        /**
+         * Amount of the subsequent payment. If this field is empty we will take the amount entered in the NextTransactionDebitedFunds
+         * of the Recurring PayIn Registration. An amount must be transmitted during either registration or pay-in (if it’s different from the registration one).
+         */
+        DebitedFunds?: MoneyData;
+
+        /**
+         * Amount of the subsequent fees. If this field is empty we will take the amount entered in the NextTransactionFees
+         * of the Recurring PayIn Registration. An amount must be transmitted during either registration or pay-in.
+         */
+        Fees?: MoneyData;
+
+        /**
+         * A custom description to appear on the user's bank statement. It can be up to 10 characters long, and can only include alphanumeric characters or spaces.
+         * See here for important info. Note that each bank handles this information differently, some show less or no information.
+         */
+        StatementDescriptor?: string;
+
+        /**
+         * Custom data that you can add to this item
+         */
+        Tag?: string;
+
+        /**
+         * Payment category
+         */
+        PaymentCategory?: string;
+    }
+
+    interface CreateRecurringApplePayPayInCIT {
+        ExecutionType: "DIRECT";
+
+        PaymentType: "APPLEPAY";
+
+        /**
+         * The recurring's ID
+         */
+        RecurringPayinRegistrationId: string;
+
+        /**
+         * The amount of the subsequent recurring pay-in. If this field is empty, the amount entered in the
+         * NextTransactionDebitedFunds of the Recurring PayIn Registration is taken into account.
+         */
+        DebitedFunds: MoneyData;
+
+        /**
+         * The amount of the subsequent recurring pay-in. If this field is empty, the amount entered in the
+         * NextTransactionDebitedFunds of the Recurring PayIn Registration is taken into account.
+         */
+        Fees: MoneyData;
+
+        /**
+         * Custom data that you can add to this item
+         */
+        Tag?: string;
+    }
+
+    interface CreateRecurringApplePayPayInMIT {
+        ExecutionType: "DIRECT";
+
+        PaymentType: "APPLEPAY";
+
+        /**
+         * The recurring's ID
          */
-        EndDate: Timestamp;
+        RecurringPayinRegistrationId: string;
 
         /**
-         * Frequency at which the recurring payments will be made
+         * The amount of the subsequent recurring pay-in. If this field is empty, the amount entered in the
+         * NextTransactionDebitedFunds of the Recurring PayIn Registration is taken into account.
          */
-        Frequency: FrequencyType;
+        DebitedFunds: MoneyData;
 
         /**
-         * Indicates whether the payment amount is likely to change during the payment period
+         * The amount of the subsequent recurring pay-in. If this field is empty, the amount entered in the
+         * NextTransactionDebitedFunds of the Recurring PayIn Registration is taken into account.
          */
-        FixedNextAmount: boolean;
+        Fees: MoneyData;
 
         /**
-         * Indicates whether this recurring payment is a payment in installments in N times
+         * The unique identifier of the user at the source of the transaction.
          */
-        FractionedPayment: boolean;
-
-        FreeCycles?: number;
+        AuthorId: string;
 
         /**
-         * Amount of the first payment. This amount may be different from the NextTransactionDebitedFunds.
+         * Only necessary if the CreditedUserId is different from the AuthorId.
          */
-        FirstTransactionDebitedFunds: MoneyData;
+        CreditedUserId?: string;
 
         /**
-         * Amount of the first payment fees. This amount may be different from the NextTransactionFees.
+         * You can override the Billing address details of the Recurring Registration by providing data here.
+         * If not provided, the Billing details from the Recurring Registration are used.
          */
-        FirstTransactionFees: MoneyData;
+        Billing?: CreateBilling;
 
         /**
-         * Amount of subsequent payments. If this field is empty and either FixedNextAmount or FractionedPayment are TRUE,
-         * we will take the amount of the FirstTransactionDebitedFunds as the subsequent payment amount.
+         * You can override the Shipping address details of the Recurring Registration by providing data here.
+         * If not provided, the Shipping details from the Recurring Registration are used.
          */
-        NextTransactionDebitedFunds: MoneyData;
+        Shipping?: CreateShipping;
 
         /**
-         * Amount of subsequent fees. If this field is empty and either FixedNextAmount or FractionedPayment are TRUE,
-         * we will take the amount of the FirstTransactionFees as the subsequent fees.
+         * Custom description
          */
-        NextTransactionFees: MoneyData;
+        StatementDescriptor?: string;
 
         /**
-         * Indicates whether the object is being used to attempt registration of an existing recurring payment
+         * Custom data that you can add to this item
          */
-        Migration: boolean;
-
-        PaymentType: RecurringPayInRegistrationPaymentType;
+        Tag?: string;
     }
 
-    interface CreatePayInRecurringRegistration {
+    interface CreateRecurringGooglePayPayInCIT {
+        ExecutionType: "DIRECT";
+
+        PaymentType: "GOOGLE_PAY";
+
         /**
-         * A user's ID
+         * The unique identifier of the recurring pay-in registration.
          */
-        AuthorId: string;
+        RecurringPayinRegistrationId: string;
 
         /**
-         * The ID of a card
+         * Debited funds.
          */
-        CardId: string;
+        DebitedFunds: MoneyData;
 
         /**
-         * The user ID who is credited (defaults to the owner of the wallet)
+         * Fees.
          */
-        CreditedUserId?: string;
+        Fees: MoneyData;
 
         /**
-         * The ID of the wallet where money will be credited
+         * IP Address of the end user (format IPV4 or IPV6).
          */
-        CreditedWalletId: string;
+        IpAddress: string;
 
         /**
-         * Amount of the first payment. This amount may be different from the NextTransactionDebitedFunds.
+         * URL where users are automatically redirected after 3D secure validation (if activated).
          */
-        FirstTransactionDebitedFunds: MoneyData;
+        SecureModeReturnURL: string;
 
         /**
-         * Amount of the first payment fees. This amount may be different from the NextTransactionFees.
+         * A custom description to appear on the user's bank statement.
          */
-        FirstTransactionFees: MoneyData;
+        StatementDescriptor?: string;
 
         /**
-         * Contains every useful informations related to the user billing
+         * SecureMode { DEFAULT, FORCE }.
          */
-        Billing?: BillingOrShippingRecurringPayInData;
+        SecureMode?: SecureMode;
 
         /**
-         * Contains every useful information's related to the user shipping
+         * Describes the browser being used by the end user.
          */
-        Shipping?: BillingOrShippingRecurringPayInData;
+        BrowserInfo: BrowserInfoData;
 
         /**
-         * Date on which the recurring payments will end
+         * Author identifier.
          */
-        EndDate?: Timestamp;
+        AuthorId?: string;
 
         /**
-         * Frequency at which the recurring payments will be made
+         * Credited user identifier.
          */
-        Frequency?: FrequencyType;
+        CreditedUserId?: string;
 
         /**
-         * Indicates whether the payment amount is likely to change during the payment period
+         * Credited wallet identifier.
          */
-        FixedNextAmount?: boolean;
+        CreditedWalletId?: string;
 
         /**
-         * Indicates whether this recurring payment is a payment in installments in N times
+         * Billing information.
          */
-        FractionedPayment?: boolean;
+        Billing?: CreateBilling;
 
         /**
-         * Indicates whether the object is being used to attempt registration of an existing recurring payment
+         * Shipping information.
          */
-        Migration?: boolean;
+        Shipping?: CreateShipping;
 
         /**
-         * Amount of subsequent payments. If this field is empty and either FixedNextAmount or FractionedPayment are TRUE,
-         * we will take the amount of the FirstTransactionDebitedFunds as the subsequent payment amount.
+         * The URL to which the user is returned after the payment, whether the transaction is successful or not.
          */
-        NextTransactionDebitedFunds?: MoneyData;
+        ReturnURL?: string;
 
         /**
-         * Amount of subsequent fees. If this field is empty and either FixedNextAmount or FractionedPayment are TRUE,
-         * we will take the amount of the FirstTransactionFees as the subsequent fees.
+         * Custom data that you can add to this item
          */
-        NextTransactionFees?: MoneyData;
-
-        FreeCycles?: number;
-
-        PaymentType?: RecurringPayInRegistrationPaymentType
+        Tag?: string;
     }
 
-    interface UpdatePayInRecurringRegistration {
-        CardId?: string;
-
-        Billing?: BillingOrShippingRecurringPayInData;
-
-        Shipping?: BillingOrShippingRecurringPayInData;
+    interface CreateRecurringGooglePayPayInMIT {
+        ExecutionType: "DIRECT";
 
-        Status?: UpdateRecurringPaymentStatus;
-    }
+        PaymentType: "GOOGLE_PAY";
 
-    interface RecurringPayInData extends BasePayInData {
         /**
-         * The SecureMode corresponds to '3D secure' for CB Visa and MasterCard. This field lets you activate it manually.
-         * The field lets you activate it automatically with "DEFAULT" (Secured Mode will be activated from €50 or when MANGOPAY detects there is a higher risk ),
-         * "FORCE" (if you wish to specifically force the secured mode).
+         * The unique identifier of the recurring pay-in registration.
          */
-        SecureMode: SecureMode;
+        RecurringPayinRegistrationId: string;
 
         /**
-         * The ID of a card
+         * Debited funds.
          */
-        CardId: string;
+        DebitedFunds: MoneyData;
 
         /**
-         * The value is 'true' if the SecureMode was used
+         * Fees.
          */
-        SecureModeNeeded: boolean;
+        Fees: MoneyData;
 
         /**
-         * This is the URL where to redirect users to proceed to 3D secure validation
+         * IP Address of the end user (format IPV4 or IPV6).
          */
-        SecureModeRedirectURL: string;
+        IpAddress: string;
 
         /**
-         * This is the URL where users are automatically redirected after 3D secure validation (if activated)
+         * URL where users are automatically redirected after 3D secure validation (if activated).
          */
         SecureModeReturnURL: string;
 
         /**
-         * The language to use for the payment page - needs to be the ISO code of the language
+         * A custom description to appear on the user's bank statement.
          */
-        Culture: CountryISO;
+        StatementDescriptor?: string;
 
         /**
-         * Contains useful information related to security and fraud
+         * SecureMode { DEFAULT, FORCE }.
          */
-        SecurityInfo: SecurityInfoData;
+        SecureMode?: SecureMode;
 
         /**
-         * A custom description to appear on the user's bank statement. It can be up to 10 characters long, and can only include alphanumeric characters or spaces.
-         * See here for important info. Note that each bank handles this information differently, some show less or no information.
+         * Describes the browser being used by the end user.
          */
-        StatementDescriptor: string;
-
         BrowserInfo: BrowserInfoData;
 
-        IpAddress: string;
-
-        Billing: BillingOrShippingRecurringPayInData;
-
-        Shipping: BillingOrShippingRecurringPayInData;
-
-        Requested3DSVersion: _3DSVersion;
-
-        Applied3DSVersion: _3DSVersion;
-
-        RecurringPayinRegistrationId: string;
-
         /**
-         * Information about the card
-         */
-        CardInfo: CardInfoData;
-
-        PaymentCategory?: string;
-
-        /**
-         * Authentication result
+         * Author identifier.
          */
-        AuthenticationResult?: AuthenticationResult;
-    }
+        AuthorId: string;
 
-    interface CreateRecurringPayInCIT {
         /**
-         * The recurring's ID
+         * Credited user identifier.
          */
-        RecurringPayinRegistrationId: string;
+        CreditedUserId?: string;
 
         /**
-         * This object describes the Browser being user by an end user
+         * Credited wallet identifier.
          */
-        BrowserInfo: BrowserInfoData;
+        CreditedWalletId?: string;
 
         /**
-         * IP Address of the end user (format IPV4 or IPV6)
+         * Billing information.
          */
-        IpAddress: string;
+        Billing?: CreateBilling;
 
         /**
-         * This is the URL where users are automatically redirected after 3D secure validation (if activated)
+         * Shipping information.
          */
-        SecureModeReturnURL: string;
+        Shipping?: CreateShipping;
 
         /**
-         * A custom description to appear on the user's bank statement. It can be up to 10 characters long,
-         * and can only include alphanumeric characters or spaces. See here for important info.
-         * Note that each bank handles this information differently, some show less or no information.
+         * The URL to which the user is returned after the payment, whether the transaction is successful or not.
          */
-        StatementDescriptor?: string;
+        ReturnURL?: string;
 
         /**
          * Custom data that you can add to this item
          */
         Tag?: string;
+    }
 
+    interface CreateRecurringPayPalPayInCIT {
         /**
-         * Amount of the subsequent payment. If this field is empty we will take the amount entered in the NextTransactionDebitedFunds of the Recurring PayIn Registration.
-         * An amount must be transmitted during either registration or pay-in (if it’s different from the registration one).
+         * ExecutionType. Marked as optional until the old method is removed and mandatory after.
          */
-        DebitedFunds?: MoneyData;
+        ExecutionType?: "WEB";
 
         /**
-         * Amount of the subsequent fees. If this field is empty we will take the amount entered in the NextTransactionFees
-         * of the Recurring PayIn Registration. An amount must be transmitted during either registration or pay-in.
+         * PaymentType. Marked as optional until the old method is removed and mandatory after.
          */
-        Fees?: MoneyData;
-
-        PaymentCategory?: string;
-    }
+        PaymentType?: "PAYPAL";
 
-    interface CreateRecurringPayPalPayInCIT {
         /**
          * The unique identifier of the recurring pay-in registration.
          */
@@ -1908,6 +2974,16 @@ export namespace payIn {
     }
 
     interface CreateRecurringPayPalPayInMIT {
+        /**
+         * ExecutionType. Marked as optional until the old method is removed and mandatory after.
+         */
+        ExecutionType?: "WEB";
+
+        /**
+         * PaymentType. Marked as optional until the old method is removed and mandatory after.
+         */
+        PaymentType?: "PAYPAL";
+
         /**
          * The unique identifier of the recurring pay-in registration.
          */
@@ -1986,6 +3062,9 @@ export namespace payIn {
         DataCollectionId?: string;
     }
 
+    /**
+     * @deprecated Use 'CreateDepositPreAuthorizedPayIn' instead
+     */
     interface CreateCardPreAuthorizedDepositPayIn {
         AuthorId?: string;
 
@@ -2000,6 +3079,23 @@ export namespace payIn {
         Tag?: string;
     }
 
+    interface CreateDepositPreAuthorizedPayIn {
+        AuthorId: string;
+
+        CreditedWalletId: string;
+
+        DebitedFunds: MoneyData;
+
+        Fees: MoneyData;
+
+        DepositId: string;
+
+        Tag?: string;
+    }
+
+    /**
+     * @deprecated Use 'DepositPreAuthorizedPayInData' instead
+     */
     interface CardPreAuthorizedDepositPayInData extends entityBase.EntityBaseData {
         AuthorId: string;
 
@@ -2030,6 +3126,38 @@ export namespace payIn {
         Fees: MoneyData;
     }
 
+    interface DepositPreAuthorizedPayInData extends entityBase.EntityBaseData {
+        AuthorId: string;
+
+        CreditedUserId: string;
+
+        DepositId: string;
+
+        ResultCode: string;
+
+        ResultMessage: string;
+
+        Status: transaction.TransactionStatus;
+
+        ExecutionDate: Timestamp;
+
+        Type: transaction.TransactionType;
+
+        Nature: transaction.TransactionNature;
+
+        PaymentType: PayInPaymentType;
+
+        ExecutionType: PayInExecutionType;
+
+        DebitedFunds: MoneyData;
+
+        CreditedFunds: MoneyData;
+
+        Fees: MoneyData;
+
+        AuthenticationResult: AuthenticationResult;
+    }
+
     interface CreateApplePayPayIn {
         ExecutionType: "DIRECT";
 
@@ -2072,6 +3200,11 @@ export namespace payIn {
          * used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.
          */
         ProfilingAttemptReference?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
     }
     interface ApplePayPayInData extends BasePayInData {
         ExecutionType: "DIRECT";
@@ -2211,6 +3344,11 @@ export namespace payIn {
          * used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.
          */
         ProfilingAttemptReference?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
     }
 
     interface GooglePayDirectPayInData extends BasePayInData {
@@ -2450,6 +3588,11 @@ export namespace payIn {
          * used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.
          */
         ProfilingAttemptReference?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
     }
 
     interface IdealWebPayInData extends BasePayInData {
@@ -2535,6 +3678,11 @@ export namespace payIn {
          * used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.
          */
         ProfilingAttemptReference?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
     }
 
     interface GiropayWebPayInData extends BasePayInData {
@@ -2728,6 +3876,11 @@ export namespace payIn {
          * used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.
          */
         ProfilingAttemptReference?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
     }
 
     interface CreateTwintWebPayIn {
@@ -2776,6 +3929,11 @@ export namespace payIn {
          * used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.
          */
         ProfilingAttemptReference?: string;
+
+        /**
+         * Information about the payment flow and its Beneficiaries.
+         */
+        FlowDescriptor?: FlowDescriptor;
     }
 
     interface BinData {
@@ -3985,4 +5143,13 @@ export namespace payIn {
     interface AuthenticationResult {
         AuthenticationType?: string;
     }
-}
+
+    interface FlowDescriptor {
+        FlowId?: string;
+        Beneficiaries?: FlowDescriptorBeneficiary[];
+    }
+
+    interface FlowDescriptorBeneficiary {
+        UserId: string;
+    }
+}