---
title: "Create a Recurring PayIn Registration"
method: POST
path: "/v2.01/{ClientId}/recurringpayinregistrations"
tags: ["recurringPayinRegistrations"]
---

# Create a Recurring PayIn Registration

`POST /v2.01/{ClientId}/recurringpayinregistrations`

Register a series of recurring payment requests for the following payment methods (indicated by `PaymentType`):

| PaymentType | Requires | Captured using | 
| --- | --- | --- |
| `CARD_DIRECT` (default) | Tokenized `CardId` obtained from the card registration process. | [Create a Recurring Card PayIn (CIT or MIT)](/api-reference/recurring-card-payins/create-recurring-card-payin) |
| `APPLEPAY` | Tokenized `PaymentData` object retrieved from the Apple Pay API. | [Create a Recurring Apple Pay PayIn](/api-reference/apple-pay/create-recurring-apple-pay-payin) |
| `GOOGLE_PAY` | Tokenized `PaymentData` string retrieved from the Google Pay API. | [Create a Recurring Google Pay PayIn](/api-reference/google-pay/create-recurring-google-pay-payin) |
| `PAYPAL` | No prerequisites. | [Create a Recurring PayPal PayIn (CIT or MIT)](/api-reference/paypal/create-recurring-paypal-payin) |

<Note icon="fa-regular fa-circle-info">
**Note – Only one registration per user on PayPal**

On PayPal, only one recurring pay-in registration can be used per `UserId`. You can [end a user's existing registration](/api-reference/recurring-payin-registrations/update-recurring-payin-registration) object to create a new one with the same user.

This restriction does not apply to other payment methods.
</Note>

## Path parameters

- `ClientId` string, required

## Headers

- `Authorization` string, required

## Request body

- union
  - CreateARecurringPayInRegistrationCardRequest — Request body for card recurring pay-in registrations, using a tokenized `CardId`.
    - `AuthorId` string, required — The unique identifier of the user at the source of the transaction.
    - `CreditedWalletId` string, required — The unique identifier of the credited wallet.
    - `FlowDescriptor` FlowDescriptorRequest — Information about the Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made ([read more](/guides/payin-beneficiaries)). If the `FlowDescriptor.Beneficiaries` is sent in the API request, then: - The transaction's `CreditedWalletId` holder is disregarded in KYC/KYB checks. - **ALL** `UserId` values in the array must be one of: - `OWNER` whose `KYCLevel` is `REGULAR` - `PLATFORM` The pay-in `Status` becomes `FAILED` with `ResultCode` [002951](/errors/codes/002951) if at least one `FlowDescriptor.Beneficiaries.UserId` is: - `PAYER` - `OWNER` whose `KYCLevel` is `LIGHT` If the `FlowDescriptor.Beneficiaries` is not sent in the API request, then the `CreditedWalletId` holder is subject to KYC/KYB checks. This property is optional for backwards compatibility but is recommended for all pay-in flows, even when the `CreditedWalletId` holder is a `PAYER` or the same value as one of the `FlowDescriptor.Beneficiaries`.
      - `Beneficiaries` FlowDescriptorRequestBeneficiariesItems[], nullable — Max. length: 5 items The list of up to 5 Natural or Legal Users declared as beneficiaries of the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made. The pay-in also fails if the `Beneficiaries` array contains nulled objects or invalid `UserId` values.
        - `UserId` string — The unique identifier of the Natural User or Legal User declared as a beneficiary of the pay-in.
    - `FirstTransactionDebitedFunds` CreateARecurringPayInRegistrationCardRequestFirstTransactionDebitedFunds, required — The amount of the first recurring pay-in. This value can be different from the `NextTransactionDebitedFunds``.
      - `Currency` string, required — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer, required — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `FirstTransactionFees` CreateARecurringPayInRegistrationCardRequestFirstTransactionFees, required — The fees of the first recurring pay-in. This amount can be different from the `NextTransactionDebitedFunds`.
      - `Currency` string, required — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer, required — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `Billing` BillingDefaultsShippingUserRequest — **Default values:** `FirstName`, `LastName`, and `Address` information of the `Shipping` object if sent, otherwise of the `AuthorId` (if address values present). Information about the billing address.
      - `FirstName` string — The first name of the user.
      - `LastName` string — The last name of the user.
      - `Address` AddressSubPropsRequired — The postal address.
        - `AddressLine1` string, required — The first line of the address.
        - `AddressLine2` string — The second line of the address.
        - `City` string, required — The city of the address.
        - `Region` string — Required if `Country` is US, CA, or MX. The region of the address.
        - `PostalCode` string, required — The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
        - `Country` string, required — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address.
    - `Shipping` ShippingDefaultsBillingUserRequest — **Default values:** `FirstName`, `LastName`, and `Address` information of the `Billing` object if sent, otherwise of the `AuthorId` (if address values present). Information about the shipping address.
      - `FirstName` string — The first name of the user.
      - `LastName` string — The last name of the user.
      - `Address` AddressSubPropsRequired — The postal address.
        - `AddressLine1` string, required — The first line of the address.
        - `AddressLine2` string — The second line of the address.
        - `City` string, required — The city of the address.
        - `Region` string — Required if `Country` is US, CA, or MX. The region of the address.
        - `PostalCode` string, required — The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
        - `Country` string, required — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address.
    - `NextTransactionDebitedFunds` CreateARecurringPayInRegistrationCardRequestNextTransactionDebitedFunds — The amount of the subsequent recurring pay-ins. If this field is empty and either `FixedNextAmount` or `FractionedPayment` are true, the subsequent amount will be the same as `FirstTransactionDebitedFunds` amount.
      - `Currency` string, required — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer, required — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `NextTransactionFees` CreateARecurringPayInRegistrationCardRequestNextTransactionFees — The fees of the subsequent recurring pay-ins.
      - `Currency` string, required — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer, required — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `ProfilingAttemptReference` string — The unique reference generated for the profiling session, used by the <a href="/guides/fraud-prevention">fraud prevention</a> solution to produce recommendations for the transaction using the profiling data. **Note:** Parameter not returned by the API. Profiling feature available on request – contact Mangopay <a href="https://hub.mangopay.com/" target="_blank">via the Dashboard</a> for more information.
    - `CardId` string, required — The unique identifier of the Card object, obtained during the card registration process.
    - `EndDate` integer — The date and time at which the recurring pay-ins will end. This value has no impact on the recurring registration `Status`. **Caution:** If the `EndDate` is left unspecified, please bear in mind that one could be defined by default and be displayed to your end users (not taken into account in the payment recurrence).
    - `FixedNextAmount` boolean — Whether or not the recurring pay-ins' debited amounts remain the same for all the pay-ins linked to the recurring registration object.
    - `Frequency` string — **Allowed values:** `Daily`, `Weekly`, `TwiceAMonth`, `Monthly`, `Bimonthly`, `Quarterly`, `Semiannual`, `Annual`, `Biannual` The frequency at which the recurring pay-ins will occur: - `Daily` – 1 transaction per day. - `Weekly` – 1 transaction every 7 days. - `TwiceAMonth` – 2 transactions per month. - `Monthly` – 1 transaction per month. - `Bimonthly` – 1 transaction every 2 months. - `Quarterly` – 1 transaction every 3 months. - `Semiannual` – 1 transaction every 6 months. - `Annual` – 1 transaction per year. - `Biannual` – 1 transaction every 2 years.
    - `FractionedPayment` boolean — Whether or not the recurring pay-ins are being made to split a payment in several installments.
    - `FreeCycles` integer — The number of initial consecutive pay-ins where there will be no debited funds nor fees. This value cannot exceed the `CycleNumber` value (for recurring objects with an `EndDate`, `FixedNextAmount`, and `Frequency`). **Note:** When creating a recurring pay-in (CIT or MIT) for a pay-in subject to a free cycle, the `DebitedFunds` and `Fees` parameters cannot be sent.
    - `Migration` boolean — Whether or not to attempt the first recurring pay-in as a merchant-initiated transaction (MIT). **Caution:** Migration is no longer supported. You can only use objects with `Migration` set to `false`. When Mangopay decommissions this parameter (date communicated by email), the `false` value will be forced on all objects, including existing ones. Before decommissioning, you need to re-create the object; after decommissioning, you can re-authenticate the same object. The need to re-authenticate may be indicated by the `Status` changing to `AUTHENTICATION_NEEDED` or by errors on the pay-in request, for example: non-existent card account (<a href="/errors/codes/008008">008008</a>), soft decline (<a href="/errors/codes/101305">101305</a>), expired card (<a href="/errors/codes/101105">101105</a>), or stolen card (<a href="/errors/codes/008003">008003</a>).
    - `PaymentType` string — **Allowed values:** `CARD_DIRECT` **Default value:** `CARD_DIRECT` Optional on create. If omitted, defaults to `CARD_DIRECT`. The type of recurring pay-in registration (which must correspond to the pay-ins requested against it): - `CARD_DIRECT` – Card payments using a tokenized `CardId`.
  - CreateARecurringPayInRegistrationApplePayRequest — Request body for Apple Pay recurring pay-in registrations, using the tokenized `PaymentData` object retrieved from the Apple Pay API.
    - `AuthorId` string, required — The unique identifier of the user at the source of the transaction.
    - `CreditedWalletId` string, required — The unique identifier of the credited wallet.
    - `FlowDescriptor` FlowDescriptorRequest — Information about the Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made ([read more](/guides/payin-beneficiaries)). If the `FlowDescriptor.Beneficiaries` is sent in the API request, then: - The transaction's `CreditedWalletId` holder is disregarded in KYC/KYB checks. - **ALL** `UserId` values in the array must be one of: - `OWNER` whose `KYCLevel` is `REGULAR` - `PLATFORM` The pay-in `Status` becomes `FAILED` with `ResultCode` [002951](/errors/codes/002951) if at least one `FlowDescriptor.Beneficiaries.UserId` is: - `PAYER` - `OWNER` whose `KYCLevel` is `LIGHT` If the `FlowDescriptor.Beneficiaries` is not sent in the API request, then the `CreditedWalletId` holder is subject to KYC/KYB checks. This property is optional for backwards compatibility but is recommended for all pay-in flows, even when the `CreditedWalletId` holder is a `PAYER` or the same value as one of the `FlowDescriptor.Beneficiaries`.
      - `Beneficiaries` FlowDescriptorRequestBeneficiariesItems[], nullable — Max. length: 5 items The list of up to 5 Natural or Legal Users declared as beneficiaries of the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made. The pay-in also fails if the `Beneficiaries` array contains nulled objects or invalid `UserId` values.
        - `UserId` string — The unique identifier of the Natural User or Legal User declared as a beneficiary of the pay-in.
    - `FirstTransactionDebitedFunds` CreateARecurringPayInRegistrationApplePayRequestFirstTransactionDebitedFunds, required — The amount of the first recurring pay-in. This value can be different from the `NextTransactionDebitedFunds``.
      - `Currency` string, required — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer, required — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `FirstTransactionFees` CreateARecurringPayInRegistrationApplePayRequestFirstTransactionFees, required — The fees of the first recurring pay-in. This amount can be different from the `NextTransactionDebitedFunds`.
      - `Currency` string, required — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer, required — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `Billing` BillingDefaultsShippingUserRequest — **Default values:** `FirstName`, `LastName`, and `Address` information of the `Shipping` object if sent, otherwise of the `AuthorId` (if address values present). Information about the billing address.
      - `FirstName` string — The first name of the user.
      - `LastName` string — The last name of the user.
      - `Address` AddressSubPropsRequired — The postal address.
        - `AddressLine1` string, required — The first line of the address.
        - `AddressLine2` string — The second line of the address.
        - `City` string, required — The city of the address.
        - `Region` string — Required if `Country` is US, CA, or MX. The region of the address.
        - `PostalCode` string, required — The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
        - `Country` string, required — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address.
    - `Shipping` ShippingDefaultsBillingUserRequest — **Default values:** `FirstName`, `LastName`, and `Address` information of the `Billing` object if sent, otherwise of the `AuthorId` (if address values present). Information about the shipping address.
      - `FirstName` string — The first name of the user.
      - `LastName` string — The last name of the user.
      - `Address` AddressSubPropsRequired — The postal address.
        - `AddressLine1` string, required — The first line of the address.
        - `AddressLine2` string — The second line of the address.
        - `City` string, required — The city of the address.
        - `Region` string — Required if `Country` is US, CA, or MX. The region of the address.
        - `PostalCode` string, required — The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
        - `Country` string, required — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address.
    - `NextTransactionDebitedFunds` CreateARecurringPayInRegistrationApplePayRequestNextTransactionDebitedFunds — The amount of the subsequent recurring pay-ins. If this field is empty and either `FixedNextAmount` or `FractionedPayment` are true, the subsequent amount will be the same as `FirstTransactionDebitedFunds` amount.
      - `Currency` string, required — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer, required — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `NextTransactionFees` CreateARecurringPayInRegistrationApplePayRequestNextTransactionFees — The fees of the subsequent recurring pay-ins.
      - `Currency` string, required — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer, required — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `ProfilingAttemptReference` string — The unique reference generated for the profiling session, used by the <a href="/guides/fraud-prevention">fraud prevention</a> solution to produce recommendations for the transaction using the profiling data. **Note:** Parameter not returned by the API. Profiling feature available on request – contact Mangopay <a href="https://hub.mangopay.com/" target="_blank">via the Dashboard</a> for more information.
    - `PaymentData` ApplePayRecurringPaymentData, required — The data returned by Apple Pay containing information about the payment.
      - `TokenData` string, required — The encrypted string for the payment request.
      - `TransactionId` string, required — Apple Pay's unique identifier of the payment.
      - `Network` string, required — The payment network used for the payment request. **Returned values:** MasterCard, Visa, cartesBancaires
    - `PaymentType` string, required — **Allowed values:** `APPLEPAY` The type of recurring pay-in registration (which must correspond to the pay-ins requested against it): - `CARD_DIRECT` – Card payments using a tokenized `CardId`. - `APPLEPAY` – Apple Pay payments using the tokenized `PaymentData` object retrieved from the Apple Pay API. - `GOOGLE_PAY` – Google Pay payments using the tokenized `PaymentData` string retrieved from the Google Pay API. - `PAYPAL` – PayPal payments, redirecting the user to authenticate via PayPal.
    - `EndDate` integer — The date and time at which the recurring pay-ins will end. This value has no impact on the recurring registration `Status`. **Caution:** If the `EndDate` is left unspecified, please bear in mind that one could be defined by default and be displayed to your end users (not taken into account in the payment recurrence).
    - `FixedNextAmount` boolean — Whether or not the recurring pay-ins' debited amounts remain the same for all the pay-ins linked to the recurring registration object.
    - `Frequency` string — **Allowed values:** `Daily`, `Weekly`, `TwiceAMonth`, `Monthly`, `Bimonthly`, `Quarterly`, `Semiannual`, `Annual`, `Biannual` The frequency at which the recurring pay-ins will occur: - `Daily` – 1 transaction per day. - `Weekly` – 1 transaction every 7 days. - `TwiceAMonth` – 2 transactions per month. - `Monthly` – 1 transaction per month. - `Bimonthly` – 1 transaction every 2 months. - `Quarterly` – 1 transaction every 3 months. - `Semiannual` – 1 transaction every 6 months. - `Annual` – 1 transaction per year. - `Biannual` – 1 transaction every 2 years.
    - `FractionedPayment` boolean — Whether or not the recurring pay-ins are being made to split a payment in several installments.
    - `FreeCycles` integer — The number of initial consecutive pay-ins where there will be no debited funds nor fees. This value cannot exceed the `CycleNumber` value (for recurring objects with an `EndDate`, `FixedNextAmount`, and `Frequency`). **Note:** When creating a recurring pay-in (CIT or MIT) for a pay-in subject to a free cycle, the `DebitedFunds` and `Fees` parameters cannot be sent.
  - CreateARecurringPayInRegistrationGooglePayRequest — Request body for Google Pay recurring pay-in registrations, using the tokenized `PaymentData` string retrieved from the Google Pay API.
    - `AuthorId` string, required — The unique identifier of the user at the source of the transaction.
    - `CreditedWalletId` string, required — The unique identifier of the credited wallet.
    - `FlowDescriptor` FlowDescriptorRequest — Information about the Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made ([read more](/guides/payin-beneficiaries)). If the `FlowDescriptor.Beneficiaries` is sent in the API request, then: - The transaction's `CreditedWalletId` holder is disregarded in KYC/KYB checks. - **ALL** `UserId` values in the array must be one of: - `OWNER` whose `KYCLevel` is `REGULAR` - `PLATFORM` The pay-in `Status` becomes `FAILED` with `ResultCode` [002951](/errors/codes/002951) if at least one `FlowDescriptor.Beneficiaries.UserId` is: - `PAYER` - `OWNER` whose `KYCLevel` is `LIGHT` If the `FlowDescriptor.Beneficiaries` is not sent in the API request, then the `CreditedWalletId` holder is subject to KYC/KYB checks. This property is optional for backwards compatibility but is recommended for all pay-in flows, even when the `CreditedWalletId` holder is a `PAYER` or the same value as one of the `FlowDescriptor.Beneficiaries`.
      - `Beneficiaries` FlowDescriptorRequestBeneficiariesItems[], nullable — Max. length: 5 items The list of up to 5 Natural or Legal Users declared as beneficiaries of the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made. The pay-in also fails if the `Beneficiaries` array contains nulled objects or invalid `UserId` values.
        - `UserId` string — The unique identifier of the Natural User or Legal User declared as a beneficiary of the pay-in.
    - `FirstTransactionDebitedFunds` CreateARecurringPayInRegistrationGooglePayRequestFirstTransactionDebitedFunds, required — The amount of the first recurring pay-in. This value can be different from the `NextTransactionDebitedFunds``.
      - `Currency` string, required — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer, required — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `FirstTransactionFees` CreateARecurringPayInRegistrationGooglePayRequestFirstTransactionFees, required — The fees of the first recurring pay-in. This amount can be different from the `NextTransactionDebitedFunds`.
      - `Currency` string, required — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer, required — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `Billing` BillingDefaultsShippingUserRequest — **Default values:** `FirstName`, `LastName`, and `Address` information of the `Shipping` object if sent, otherwise of the `AuthorId` (if address values present). Information about the billing address.
      - `FirstName` string — The first name of the user.
      - `LastName` string — The last name of the user.
      - `Address` AddressSubPropsRequired — The postal address.
        - `AddressLine1` string, required — The first line of the address.
        - `AddressLine2` string — The second line of the address.
        - `City` string, required — The city of the address.
        - `Region` string — Required if `Country` is US, CA, or MX. The region of the address.
        - `PostalCode` string, required — The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
        - `Country` string, required — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address.
    - `Shipping` ShippingDefaultsBillingUserRequest — **Default values:** `FirstName`, `LastName`, and `Address` information of the `Billing` object if sent, otherwise of the `AuthorId` (if address values present). Information about the shipping address.
      - `FirstName` string — The first name of the user.
      - `LastName` string — The last name of the user.
      - `Address` AddressSubPropsRequired — The postal address.
        - `AddressLine1` string, required — The first line of the address.
        - `AddressLine2` string — The second line of the address.
        - `City` string, required — The city of the address.
        - `Region` string — Required if `Country` is US, CA, or MX. The region of the address.
        - `PostalCode` string, required — The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
        - `Country` string, required — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address.
    - `NextTransactionDebitedFunds` CreateARecurringPayInRegistrationGooglePayRequestNextTransactionDebitedFunds — The amount of the subsequent recurring pay-ins. If this field is empty and either `FixedNextAmount` or `FractionedPayment` are true, the subsequent amount will be the same as `FirstTransactionDebitedFunds` amount.
      - `Currency` string, required — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer, required — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `NextTransactionFees` CreateARecurringPayInRegistrationGooglePayRequestNextTransactionFees — The fees of the subsequent recurring pay-ins.
      - `Currency` string, required — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer, required — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `ProfilingAttemptReference` string — The unique reference generated for the profiling session, used by the <a href="/guides/fraud-prevention">fraud prevention</a> solution to produce recommendations for the transaction using the profiling data. **Note:** Parameter not returned by the API. Profiling feature available on request – contact Mangopay <a href="https://hub.mangopay.com/" target="_blank">via the Dashboard</a> for more information.
    - `PaymentData` string, required — The data returned by Google Pay containing information about the payment.
    - `PaymentType` string, required — **Allowed values:** `GOOGLE_PAY` The type of recurring pay-in registration (which must correspond to the pay-ins requested against it): - `CARD_DIRECT` – Card payments using a tokenized `CardId`. - `APPLEPAY` – Apple Pay payments using the tokenized `PaymentData` object retrieved from the Apple Pay API. - `GOOGLE_PAY` – Google Pay payments using the tokenized `PaymentData` string retrieved from the Google Pay API. - `PAYPAL` – PayPal payments, redirecting the user to authenticate via PayPal.
    - `EndDate` integer — The date and time at which the recurring pay-ins will end. This value has no impact on the recurring registration `Status`. **Caution:** If the `EndDate` is left unspecified, please bear in mind that one could be defined by default and be displayed to your end users (not taken into account in the payment recurrence).
    - `Frequency` string — **Allowed values:** `Daily`, `Weekly`, `TwiceAMonth`, `Monthly`, `Bimonthly`, `Quarterly`, `Semiannual`, `Annual`, `Biannual` The frequency at which the recurring pay-ins will occur: - `Daily` – 1 transaction per day. - `Weekly` – 1 transaction every 7 days. - `TwiceAMonth` – 2 transactions per month. - `Monthly` – 1 transaction per month. - `Bimonthly` – 1 transaction every 2 months. - `Quarterly` – 1 transaction every 3 months. - `Semiannual` – 1 transaction every 6 months. - `Annual` – 1 transaction per year. - `Biannual` – 1 transaction every 2 years.
    - `FixedNextAmount` boolean — Whether or not the recurring pay-ins' debited amounts remain the same for all the pay-ins linked to the recurring registration object.
    - `FractionedPayment` boolean — Whether or not the recurring pay-ins are being made to split a payment in several installments.
    - `FreeCycles` integer — The number of initial consecutive pay-ins where there will be no debited funds nor fees. This value cannot exceed the `CycleNumber` value (for recurring objects with an `EndDate`, `FixedNextAmount`, and `Frequency`). **Note:** When creating a recurring pay-in (CIT or MIT) for a pay-in subject to a free cycle, the `DebitedFunds` and `Fees` parameters cannot be sent.
  - CreateARecurringPayInRegistrationPayPalRequest — Request body for PayPal recurring pay-in registrations, redirecting the user to authenticate via PayPal. Note that for PayPal: - Only one active `PAYPAL` registration object can exist for a user. - You can use `NextTransactionDebitedFunds` and `NextTransactionFees` in the registration (and therefore omit them from MIT pay-in requests). The `RecurringType` is always `CUSTOM`, and the `FixedNextAmount` parameter is not supported. - The `FreeCycles` property is not supported.
    - `AuthorId` string, required — The unique identifier of the user at the source of the transaction.
    - `CreditedWalletId` string, required — The unique identifier of the credited wallet.
    - `FlowDescriptor` FlowDescriptorRequest — Information about the Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made ([read more](/guides/payin-beneficiaries)). If the `FlowDescriptor.Beneficiaries` is sent in the API request, then: - The transaction's `CreditedWalletId` holder is disregarded in KYC/KYB checks. - **ALL** `UserId` values in the array must be one of: - `OWNER` whose `KYCLevel` is `REGULAR` - `PLATFORM` The pay-in `Status` becomes `FAILED` with `ResultCode` [002951](/errors/codes/002951) if at least one `FlowDescriptor.Beneficiaries.UserId` is: - `PAYER` - `OWNER` whose `KYCLevel` is `LIGHT` If the `FlowDescriptor.Beneficiaries` is not sent in the API request, then the `CreditedWalletId` holder is subject to KYC/KYB checks. This property is optional for backwards compatibility but is recommended for all pay-in flows, even when the `CreditedWalletId` holder is a `PAYER` or the same value as one of the `FlowDescriptor.Beneficiaries`.
      - `Beneficiaries` FlowDescriptorRequestBeneficiariesItems[], nullable — Max. length: 5 items The list of up to 5 Natural or Legal Users declared as beneficiaries of the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made. The pay-in also fails if the `Beneficiaries` array contains nulled objects or invalid `UserId` values.
        - `UserId` string — The unique identifier of the Natural User or Legal User declared as a beneficiary of the pay-in.
    - `FirstTransactionDebitedFunds` CreateARecurringPayInRegistrationPayPalRequestFirstTransactionDebitedFunds, required — The amount of the first recurring pay-in. This value can be different from the `NextTransactionDebitedFunds``.
      - `Currency` string, required — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer, required — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `FirstTransactionFees` CreateARecurringPayInRegistrationPayPalRequestFirstTransactionFees, required — The fees of the first recurring pay-in. This amount can be different from the `NextTransactionDebitedFunds`.
      - `Currency` string, required — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer, required — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `Billing` BillingDefaultsShippingUserRequest — **Default values:** `FirstName`, `LastName`, and `Address` information of the `Shipping` object if sent, otherwise of the `AuthorId` (if address values present). Information about the billing address.
      - `FirstName` string — The first name of the user.
      - `LastName` string — The last name of the user.
      - `Address` AddressSubPropsRequired — The postal address.
        - `AddressLine1` string, required — The first line of the address.
        - `AddressLine2` string — The second line of the address.
        - `City` string, required — The city of the address.
        - `Region` string — Required if `Country` is US, CA, or MX. The region of the address.
        - `PostalCode` string, required — The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
        - `Country` string, required — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address.
    - `Shipping` ShippingDefaultsBillingUserRequest — **Default values:** `FirstName`, `LastName`, and `Address` information of the `Billing` object if sent, otherwise of the `AuthorId` (if address values present). Information about the shipping address.
      - `FirstName` string — The first name of the user.
      - `LastName` string — The last name of the user.
      - `Address` AddressSubPropsRequired — The postal address.
        - `AddressLine1` string, required — The first line of the address.
        - `AddressLine2` string — The second line of the address.
        - `City` string, required — The city of the address.
        - `Region` string — Required if `Country` is US, CA, or MX. The region of the address.
        - `PostalCode` string, required — The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
        - `Country` string, required — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address.
    - `NextTransactionDebitedFunds` CreateARecurringPayInRegistrationPayPalRequestNextTransactionDebitedFunds — The amount of the subsequent recurring pay-ins. If this field is empty and either `FixedNextAmount` or `FractionedPayment` are true, the subsequent amount will be the same as `FirstTransactionDebitedFunds` amount.
      - `Currency` string, required — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer, required — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `NextTransactionFees` CreateARecurringPayInRegistrationPayPalRequestNextTransactionFees — The fees of the subsequent recurring pay-ins.
      - `Currency` string, required — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer, required — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `ProfilingAttemptReference` string — The unique reference generated for the profiling session, used by the <a href="/guides/fraud-prevention">fraud prevention</a> solution to produce recommendations for the transaction using the profiling data. **Note:** Parameter not returned by the API. Profiling feature available on request – contact Mangopay <a href="https://hub.mangopay.com/" target="_blank">via the Dashboard</a> for more information.
    - `PaymentType` string, required — **Allowed values:** `PAYPAL` The type of recurring pay-in registration (which must correspond to the pay-ins requested against it): - `CARD_DIRECT` – Card payments using a tokenized `CardId`. - `APPLEPAY` – Apple Pay payments using the tokenized `PaymentData` object retrieved from the Apple Pay API. - `GOOGLE_PAY` – Google Pay payments using the tokenized `PaymentData` string retrieved from the Google Pay API. - `PAYPAL` – PayPal payments, redirecting the user to authenticate via PayPal.

## Response `200`

Success

- union
  - RecurringPayInRegistrationCardResponse — Response object for card recurring pay-in registrations.
    - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object.
    - `Status` string — **Returned values:** `CREATED`, `AUTHENTICATION_NEEDED`, `IN_PROGRESS`, `ENDED` The status of the recurring registration: - `CREATED` – The recurring registration was created, but no recurring pay-in has yet been made. - `AUTHENTICATION_NEEDED` – The latest recurring pay-in linked to the registration object was refused. The registration object can still be used, but you need to execute a new customer-initiated transaction (CIT) for the end user to reauthenticate. - `IN_PROGRESS` – The recurring registration object is in use and the subsequent corresponding recurring pay-ins can be made. - `ENDED` – The recurrence ended: the registration can no longer be modified nor reused.
    - `ResultCode` string — The code indicating the result of the operation. This information is mostly used to <a href="/errors/codes">handle errors</a> or for filtering purposes.
    - `ResultMessage` string — The explanation of the result code.
    - `CurrentState` RecurringPayInRegistrationCardResponseCurrentState — Information about the recurring pay-ins related to the registration object. **Note:** If the `LastPayinId` references a transaction older than 13 months, it may have been <a href="/api-reference/overview/data-availability-periods">archived</a>.
      - `PayinsLinked` integer — The number of recurring pay-ins already made for the registration object.
      - `CumulatedDebitedAmount` RecurringPayInRegistrationCardResponseCurrentStateCumulatedDebitedAmount — Information about the cumulated debited funds amount.
        - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
        - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
      - `CumulatedFeesAmount` RecurringPayInRegistrationCardResponseCurrentStateCumulatedFeesAmount — Information about the cumulated fees amount.
        - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
        - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
      - `LastPayinId` string — The unique identifier of the last recurring pay-in made for the registration.
    - `RecurringType` string — **Returned values:** `CLASSIC_SUBSCRIPTION`, `FRACTIONED_PAYMENT`, `CUSTOM` The type of recurrence, which can be one of the following: - `CLASSIC_SUBSCRIPTION` – For fixed-amount subscriptions. The `Amount` of each pay-in and the subscription's `EndDate` are known, and these values cannot be modified during the recurrence. - `FRACTIONED_PAYMENT` – For payments in 3 or 4 times. The `Amount` of each pay-in and the registration's `EndDate` are known, and these values cannot be modified during the recurrence. - `CUSTOM` – For recurring registrations where the `Amount` and `EndDate` are unknown.
    - `TotalAmount` RecurringPayInRegistrationCardResponseTotalAmount — Information about the total amount. This value is automatically calculated based on the `EndDate`, `FixedNextAmount`, and `Frequency` parameters (if defined).
      - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `CycleNumber` integer — The number of cycles in the registration (and therefore the number of payments). This value is automatically calculated based on the `EndDate`, `FixedNextAmount`, and `Frequency` parameters (if defined).
    - `AuthorId` string — The unique identifier of the user at the source of the transaction.
    - `CardId` string — The unique identifier of the Card object, obtained during the card registration process.
    - `CreditedUserId` string — **Default value:** The unique identifier of the owner of the credited wallet. The unique identifier of the user whose wallet is credited.
    - `FlowDescriptor` FlowDescriptorResponse — Information about the Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made ([read more](/guides/payin-beneficiaries)). If the `FlowDescriptor.Beneficiaries` is sent in the API request, then: - The transaction's `CreditedWalletId` holder is disregarded in KYC/KYB checks. - **ALL** `UserId` values in the array must be one of: - `OWNER` whose `KYCLevel` is `REGULAR` - `PLATFORM` The pay-in `Status` becomes `FAILED` with `ResultCode` [002951](/errors/codes/002951) if at least one `FlowDescriptor.Beneficiaries.UserId` is: - `PAYER` - `OWNER` whose `KYCLevel` is `LIGHT` If the `FlowDescriptor.Beneficiaries` is not sent in the API request, then the `CreditedWalletId` holder is subject to KYC/KYB checks. This property is optional for backwards compatibility but is recommended for all pay-in flows, even when the `CreditedWalletId` holder is a `PAYER` or the same value as one of the `FlowDescriptor.Beneficiaries`.
      - `FlowId` string — Unique identifier of the payment flow, used by Mangopay for internal purposes.
      - `Beneficiaries` FlowDescriptorResponseBeneficiariesItems[], nullable — Max. length: 5 items The list of up to 5 Natural or Legal Users declared as beneficiaries of the pay-in, who must all be KYC/KYB verified when the pay-in request is made. The pay-in also fails if the `Beneficiaries` array contains nulled objects or invalid `UserId` values.
        - `UserId` string — The unique identifier of the Natural User or Legal User declared as a beneficiary of the pay-in.
    - `CreditedWalletId` string — The unique identifier of the credited wallet.
    - `Billing` BillingDefaultsShippingUserResponse — **Default values:** `FirstName`, `LastName`, and `Address` information of the `Shipping` object if sent, otherwise of the `AuthorId` (if address values present). Information about the billing address.
      - `FirstName` string — The first name of the user.
      - `LastName` string — The last name of the user.
      - `Address` Address — The postal address.
        - `AddressLine1` string — The first line of the address.
        - `AddressLine2` string — The second line of the address.
        - `City` string — The city of the address.
        - `Region` string — Required if `Country` is US, CA, or MX. The region of the address.
        - `PostalCode` string — The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
        - `Country` string — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address.
    - `Shipping` ShippingDefaultsBillingUserResponse — **Default values:** `FirstName`, `LastName`, and `Address` information of the `Billing` object if sent, otherwise of the `AuthorId` (if address values present). Information about the shipping address.
      - `FirstName` string — The first name of the user.
      - `LastName` string — The last name of the user.
      - `Address` AddressSubPropsRequired — The postal address.
        - `AddressLine1` string, required — The first line of the address.
        - `AddressLine2` string — The second line of the address.
        - `City` string, required — The city of the address.
        - `Region` string — Required if `Country` is US, CA, or MX. The region of the address.
        - `PostalCode` string, required — The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
        - `Country` string, required — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address.
    - `EndDate` integer — Unix timestamp (UTC) of the date and time the recurring pay-ins will end. This value has no impact on the recurring registration `Status`. **Caution:** If the `EndDate` is left unspecified, please bear in mind that one could be defined by default and be displayed to your end users (not taken into account in the payment recurrence).
    - `Frequency` string — **Returned values:** `Daily`, `Weekly`, `TwiceAMonth`, `Monthly`, `Bimonthly`, `Quarterly`, `Semiannual`, `Annual`, `Biannual` The frequency at which the recurring pay-ins will occur: - `Daily` – 1 transaction per day. - `Weekly` – 1 transaction every 7 days. - `TwiceAMonth` – 2 transactions per month. - `Monthly` – 1 transaction per month. - `Bimonthly` – 1 transaction every 2 months. - `Quarterly` – 1 transaction every 3 months. - `Semiannual` – 1 transaction every 6 months. - `Annual` – 1 transaction per year. - `Biannual` – 1 transaction every 2 years.
    - `FixedNextAmount` boolean — Whether or not the recurring pay-ins' debited amounts remain the same for all the pay-ins linked to the recurring registration object.
    - `FractionedPayment` boolean — Whether or not the recurring pay-ins are being made to split a payment in several installments.
    - `FreeCycles` integer — The number of initial consecutive pay-ins where there will be no debited funds nor fees. This value cannot exceed the `CycleNumber` value (for recurring objects with an `EndDate`, `FixedNextAmount`, and `Frequency`). **Note:** When creating a recurring pay-in (CIT or MIT) for a pay-in subject to a free cycle, the `DebitedFunds` and `Fees` parameters cannot be sent.
    - `FirstTransactionDebitedFunds` RecurringPayInRegistrationCardResponseFirstTransactionDebitedFunds — The amount of the first recurring pay-in. This value can be different from the `NextTransactionDebitedFunds`
      - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `FirstTransactionFees` RecurringPayInRegistrationCardResponseFirstTransactionFees — The fees of the first recurring pay-in. This amount can be different from the `NextTransactionDebitedFunds`.
      - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `NextTransactionDebitedFunds` RecurringPayInRegistrationCardResponseNextTransactionDebitedFunds — The amount of the subsequent recurring pay-ins. If this field is empty and either `FixedNextAmount` or `FractionedPayment` are `true`, the subsequent amount will be the same as `FirstTransactionDebitedFunds` amount.
      - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `NextTransactionFees` RecurringPayInRegistrationCardResponseNextTransactionFees — The fees of the subsequent recurring pay-ins.
      - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `Migration` boolean — Whether or not to attempt the first recurring pay-in as a merchant-initiated transaction (MIT). **Caution:** Migration is no longer supported. You can only use objects with `Migration` set to `false`. When Mangopay decommissions this parameter (date communicated by email), the `false` value will be forced on all objects, including existing ones. Before decommissioning, you need to re-create the object; after decommissioning, you can re-authenticate the same object. The need to re-authenticate may be indicated by the `Status` changing to `AUTHENTICATION_NEEDED` or by errors on the pay-in request, for example: non-existent card account (<a href="/errors/codes/008008">008008</a>), soft decline (<a href="/errors/codes/101305">101305</a>), expired card (<a href="/errors/codes/101105">101105</a>), or stolen card (<a href="/errors/codes/008003">008003</a>).
    - `PaymentType` string — **Returned values:** `CARD_DIRECT` **Default value:** `CARD_DIRECT` The type of recurring pay-in registration (which must correspond to the pay-ins requested against it): - `CARD_DIRECT` – Card payments using a tokenized `CardId`. - `APPLEPAY` – Apple Pay payments using the tokenized `PaymentData` object retrieved from the Apple Pay API. - `GOOGLE_PAY` – Google Pay payments using the tokenized `PaymentData` string retrieved from the Google Pay API. - `PAYPAL` – PayPal payments, redirecting the user to authenticate via PayPal.
  - RecurringPayInRegistrationPayPalResponse — Response object for PayPal recurring pay-in registrations.
    - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object.
    - `Status` string — **Returned values:** `CREATED`, `AUTHENTICATION_NEEDED`, `IN_PROGRESS`, `ENDED` The status of the recurring registration for PayPal: - `CREATED` – The recurring registration was created, but no recurring pay-in has yet been made. - `AUTHENTICATION_NEEDED` – A customer-initiated transaction (CIT) has been initiated against the registration but not authenticated. Note that there is no re-authentication process with PayPal: this status is only returned after the CIT is initiated but not yet successful. - `IN_PROGRESS` – The CIT was successful and subsequent merchant-initiated transactions (MIT) can be requested. - `ENDED` – The registration can no longer be modified nor reused. A new one can be created for the same user.
    - `ResultCode` string — The code indicating the result of the operation. This information is mostly used to <a href="/errors/codes">handle errors</a> or for filtering purposes.
    - `ResultMessage` string — The explanation of the result code.
    - `CurrentState` RecurringPayInRegistrationPayPalResponseCurrentState — Information about the recurring pay-ins related to the registration object. **Note:** If the `LastPayinId` references a transaction older than 13 months, it may have been <a href="/api-reference/overview/data-availability-periods">archived</a>.
      - `PayinsLinked` integer — The number of recurring pay-ins already made for the registration object.
      - `CumulatedDebitedAmount` RecurringPayInRegistrationPayPalResponseCurrentStateCumulatedDebitedAmount — Information about the cumulated debited funds amount.
        - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
        - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
      - `CumulatedFeesAmount` RecurringPayInRegistrationPayPalResponseCurrentStateCumulatedFeesAmount — Information about the cumulated fees amount.
        - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
        - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
      - `LastPayinId` string — The unique identifier of the last recurring pay-in made for the registration.
    - `RecurringType` string — **Returned values:** `CUSTOM` For PayPal recurring registrations, this value is always `CUSTOM`.
    - `TotalAmount` unknown
    - `CycleNumber` unknown
    - `AuthorId` string — The unique identifier of the user at the source of the transaction.
    - `CardId` unknown
    - `CreditedUserId` string — **Default value:** The unique identifier of the owner of the credited wallet. The unique identifier of the user whose wallet is credited.
    - `FlowDescriptor` FlowDescriptorResponse — Information about the Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made ([read more](/guides/payin-beneficiaries)). If the `FlowDescriptor.Beneficiaries` is sent in the API request, then: - The transaction's `CreditedWalletId` holder is disregarded in KYC/KYB checks. - **ALL** `UserId` values in the array must be one of: - `OWNER` whose `KYCLevel` is `REGULAR` - `PLATFORM` The pay-in `Status` becomes `FAILED` with `ResultCode` [002951](/errors/codes/002951) if at least one `FlowDescriptor.Beneficiaries.UserId` is: - `PAYER` - `OWNER` whose `KYCLevel` is `LIGHT` If the `FlowDescriptor.Beneficiaries` is not sent in the API request, then the `CreditedWalletId` holder is subject to KYC/KYB checks. This property is optional for backwards compatibility but is recommended for all pay-in flows, even when the `CreditedWalletId` holder is a `PAYER` or the same value as one of the `FlowDescriptor.Beneficiaries`.
      - `FlowId` string — Unique identifier of the payment flow, used by Mangopay for internal purposes.
      - `Beneficiaries` FlowDescriptorResponseBeneficiariesItems[], nullable — Max. length: 5 items The list of up to 5 Natural or Legal Users declared as beneficiaries of the pay-in, who must all be KYC/KYB verified when the pay-in request is made. The pay-in also fails if the `Beneficiaries` array contains nulled objects or invalid `UserId` values.
        - `UserId` string — The unique identifier of the Natural User or Legal User declared as a beneficiary of the pay-in.
    - `CreditedWalletId` string — The unique identifier of the credited wallet.
    - `Billing` BillingDefaultsShippingUserResponse — **Default values:** `FirstName`, `LastName`, and `Address` information of the `Shipping` object if sent, otherwise of the `AuthorId` (if address values present). Information about the billing address.
      - `FirstName` string — The first name of the user.
      - `LastName` string — The last name of the user.
      - `Address` Address — The postal address.
        - `AddressLine1` string — The first line of the address.
        - `AddressLine2` string — The second line of the address.
        - `City` string — The city of the address.
        - `Region` string — Required if `Country` is US, CA, or MX. The region of the address.
        - `PostalCode` string — The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
        - `Country` string — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address.
    - `Shipping` ShippingDefaultsBillingUserResponse — **Default values:** `FirstName`, `LastName`, and `Address` information of the `Billing` object if sent, otherwise of the `AuthorId` (if address values present). Information about the shipping address.
      - `FirstName` string — The first name of the user.
      - `LastName` string — The last name of the user.
      - `Address` AddressSubPropsRequired — The postal address.
        - `AddressLine1` string, required — The first line of the address.
        - `AddressLine2` string — The second line of the address.
        - `City` string, required — The city of the address.
        - `Region` string — Required if `Country` is US, CA, or MX. The region of the address.
        - `PostalCode` string, required — The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
        - `Country` string, required — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address.
    - `EndDate` unknown
    - `Frequency` unknown
    - `FixedNextAmount` boolean — For PayPal recurring registrations, this value is ignored if sent and automatically returned `false`. However, you can specify `NextTransactionDebitedFunds` and `NextTransactionFees` to set up a fixed-amount recurrence.
    - `FractionedPayment` unknown
    - `FreeCycles` integer — For PayPal recurring registrations, this value is returned `0`.
    - `FirstTransactionDebitedFunds` RecurringPayInRegistrationPayPalResponseFirstTransactionDebitedFunds — The amount of the first recurring pay-in. This value can be different from the `NextTransactionDebitedFunds`
      - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `FirstTransactionFees` RecurringPayInRegistrationPayPalResponseFirstTransactionFees — The fees of the first recurring pay-in. This amount can be different from the `NextTransactionDebitedFunds`.
      - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `NextTransactionDebitedFunds` RecurringPayInRegistrationPayPalResponseNextTransactionDebitedFunds — The amount of the subsequent recurring pay-ins. If this field is empty and either `FixedNextAmount` or `FractionedPayment` are `true`, the subsequent amount will be the same as `FirstTransactionDebitedFunds` amount.
      - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `NextTransactionFees` RecurringPayInRegistrationPayPalResponseNextTransactionFees — The fees of the subsequent recurring pay-ins.
      - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `Migration` boolean — For PayPal recurring registrations, this value is returned `false`.
    - `PaymentType` string — **Returned values:** `PAYPAL` The type of recurring pay-in registration (which must correspond to the pay-ins requested against it): - `CARD_DIRECT` – Card payments using a tokenized `CardId`. - `APPLEPAY` – Apple Pay payments using the tokenized `PaymentData` object retrieved from the Apple Pay API. - `GOOGLE_PAY` – Google Pay payments using the tokenized `PaymentData` string retrieved from the Google Pay API. - `PAYPAL` – PayPal payments, redirecting the user to authenticate via PayPal.
  - RecurringPayInRegistrationApplePayResponse — Response object for Apple Pay recurring pay-in registrations.
    - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object.
    - `Status` string — **Returned values:** `CREATED`, `AUTHENTICATION_NEEDED`, `IN_PROGRESS`, `ENDED` The status of the recurring registration: - `CREATED` – The recurring registration was created, but no recurring pay-in has yet been made. - `AUTHENTICATION_NEEDED` – The latest recurring pay-in linked to the registration object was refused. The registration object can still be used, but you need to execute a new customer-initiated transaction (CIT) for the end user to reauthenticate. - `IN_PROGRESS` – The recurring registration object is in use and the subsequent corresponding recurring pay-ins can be made. - `ENDED` – The recurrence ended: the registration can no longer be modified nor reused.
    - `CurrentState` RecurringPayInRegistrationApplePayResponseCurrentState — Information about the recurring pay-ins related to the registration object. **Note:** If the LastPayinId references a transaction older than 13 months, it may have been archived.
      - `PayinsLinked` integer — The number of recurring pay-ins already made for the registration object.
      - `CumulatedDebitedAmount` RecurringPayInRegistrationApplePayResponseCurrentStateCumulatedDebitedAmount — The sum of the DebitedFunds amounts of the recurring pay-ins made for the registration.
        - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
        - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
      - `CumulatedFeesAmount` RecurringPayInRegistrationApplePayResponseCurrentStateCumulatedFeesAmount — The sum of the Fees amounts of the recurring pay-ins made for the registration.
        - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
        - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
      - `LastPayinId` string — The unique identifier of the last recurring pay-in made for the registration.
    - `RecurringType` string
    - `TotalAmount` RecurringPayInRegistrationApplePayResponseTotalAmount
      - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `CycleNumber` integer
    - `AuthorId` string — The unique identifier of the user at the source of the transaction.
    - `CreditedUserId` string — **Default value:** The unique identifier of the owner of the credited wallet. The unique identifier of the user whose wallet is credited.
    - `FlowDescriptor` FlowDescriptorResponse — Information about the Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made ([read more](/guides/payin-beneficiaries)). If the `FlowDescriptor.Beneficiaries` is sent in the API request, then: - The transaction's `CreditedWalletId` holder is disregarded in KYC/KYB checks. - **ALL** `UserId` values in the array must be one of: - `OWNER` whose `KYCLevel` is `REGULAR` - `PLATFORM` The pay-in `Status` becomes `FAILED` with `ResultCode` [002951](/errors/codes/002951) if at least one `FlowDescriptor.Beneficiaries.UserId` is: - `PAYER` - `OWNER` whose `KYCLevel` is `LIGHT` If the `FlowDescriptor.Beneficiaries` is not sent in the API request, then the `CreditedWalletId` holder is subject to KYC/KYB checks. This property is optional for backwards compatibility but is recommended for all pay-in flows, even when the `CreditedWalletId` holder is a `PAYER` or the same value as one of the `FlowDescriptor.Beneficiaries`.
      - `FlowId` string — Unique identifier of the payment flow, used by Mangopay for internal purposes.
      - `Beneficiaries` FlowDescriptorResponseBeneficiariesItems[], nullable — Max. length: 5 items The list of up to 5 Natural or Legal Users declared as beneficiaries of the pay-in, who must all be KYC/KYB verified when the pay-in request is made. The pay-in also fails if the `Beneficiaries` array contains nulled objects or invalid `UserId` values.
        - `UserId` string — The unique identifier of the Natural User or Legal User declared as a beneficiary of the pay-in.
    - `CreditedWalletId` string — The unique identifier of the credited wallet.
    - `Billing` BillingDefaultsShippingUserResponse — **Default values:** `FirstName`, `LastName`, and `Address` information of the `Shipping` object if sent, otherwise of the `AuthorId` (if address values present). Information about the billing address.
      - `FirstName` string — The first name of the user.
      - `LastName` string — The last name of the user.
      - `Address` Address — The postal address.
        - `AddressLine1` string — The first line of the address.
        - `AddressLine2` string — The second line of the address.
        - `City` string — The city of the address.
        - `Region` string — Required if `Country` is US, CA, or MX. The region of the address.
        - `PostalCode` string — The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
        - `Country` string — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address.
    - `Shipping` ShippingDefaultsBillingUserResponse — **Default values:** `FirstName`, `LastName`, and `Address` information of the `Billing` object if sent, otherwise of the `AuthorId` (if address values present). Information about the shipping address.
      - `FirstName` string — The first name of the user.
      - `LastName` string — The last name of the user.
      - `Address` AddressSubPropsRequired — The postal address.
        - `AddressLine1` string, required — The first line of the address.
        - `AddressLine2` string — The second line of the address.
        - `City` string, required — The city of the address.
        - `Region` string — Required if `Country` is US, CA, or MX. The region of the address.
        - `PostalCode` string, required — The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
        - `Country` string, required — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address.
    - `EndDate` integer — The date and time at which the recurring pay-ins will end. This value has no impact on the recurring registration Status. **Caution:** If the EndDate is left unspecified, please bear in mind that one could be defined by default and be displayed to your end users (not taken into account in the payment recurrence).
    - `Frequency` string — **Returned values:** `Daily`, `Weekly`, `TwiceAMonth`, `Monthly`, `Bimonthly`, `Quarterly`, `Semiannual`, `Annual`, `Biannual` The frequency at which the recurring pay-ins will occur: - `Daily` – 1 transaction per day. - `Weekly` – 1 transaction every 7 days. - `TwiceAMonth` – 2 transactions per month. - `Monthly` – 1 transaction per month. - `Bimonthly` – 1 transaction every 2 months. - `Quarterly` – 1 transaction every 3 months. - `Semiannual` – 1 transaction every 6 months. - `Annual` – 1 transaction per year. - `Biannual` – 1 transaction every 2 years.
    - `FixedNextAmount` boolean — Whether or not the recurring pay-ins' debited amounts remain the same for all the pay-ins linked to the recurring registration object.
    - `FractionedPayment` boolean — Whether or not the recurring pay-ins are being made to split a payment in several installments.
    - `FreeCycles` integer — The number of initial consecutive pay-ins where there will be no debited funds nor fees. This value cannot exceed the CycleNumber value (for recurring objects with an EndDate, FixedNextAmount, and Frequency). **Note:** When creating a recurring pay-in (CIT or MIT) for a pay-in subject to a free cycle, the DebitedFunds and Fees parameters cannot be sent.
    - `FirstTransactionDebitedFunds` RecurringPayInRegistrationApplePayResponseFirstTransactionDebitedFunds — The amount of the first recurring pay-in.
      - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `FirstTransactionFees` RecurringPayInRegistrationApplePayResponseFirstTransactionFees — The fees of the first recurring pay-in.
      - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `NextTransactionDebitedFunds` RecurringPayInRegistrationApplePayResponseNextTransactionDebitedFunds — The amount of the subsequent recurring pay-ins.
      - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `NextTransactionFees` RecurringPayInRegistrationApplePayResponseNextTransactionFees — The fees of the subsequent recurring pay-ins.
      - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `Migration` boolean
    - `ProfilingAttemptReference` string — The unique reference generated for the profiling session, used by the <a href="/guides/fraud-prevention">fraud prevention</a> solution to produce recommendations for the transaction using the profiling data. **Note:** Parameter not returned by the API. Profiling feature available on request – contact Mangopay <a href="https://hub.mangopay.com/" target="_blank">via the Dashboard</a> for more information.
    - `PaymentType` string — **Returned values:** `APPLEPAY` The type of recurring pay-in registration (which must correspond to the pay-ins requested against it): - `CARD_DIRECT` – Card payments using a tokenized `CardId`. - `APPLEPAY` – Apple Pay payments using the tokenized `PaymentData` object retrieved from the Apple Pay API. - `GOOGLE_PAY` – Google Pay payments using the tokenized `PaymentData` string retrieved from the Google Pay API. - `PAYPAL` – PayPal payments, redirecting the user to authenticate via PayPal.
    - `ResultCode` string — The code indicating the result of the operation. This information is mostly used to <a href="/errors/codes">handle errors</a> or for filtering purposes.
    - `ResultMessage` string — The explanation of the result code.
    - `CardInfo` CardInfo — Information about the card used for the transaction. If the information or data is not available, `null` is returned.
      - `BIN` string — The bank identification number (BIN) of the card.
      - `IssuingBank` string — The name of the bank that issued the card.
      - `IssuerCountryCode` string — The country code of the card issuer.
      - `Type` string — The type of card (for example, `CREDIT` or `DEBIT`).
      - `SubType` string, nullable — The sub-type of the card, if available.
      - `Brand` string — The card brand (for example, `VISA` or `MASTERCARD`).
  - RecurringPayInRegistrationGooglePayResponse — Response object for Google Pay recurring pay-in registrations.
    - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object.
    - `Status` string — **Returned values:** `CREATED`, `AUTHENTICATION_NEEDED`, `IN_PROGRESS`, `ENDED` The status of the recurring registration: - `CREATED` – The recurring registration was created, but no recurring pay-in has yet been made. - `AUTHENTICATION_NEEDED` – The latest recurring pay-in linked to the registration object was refused. The registration object can still be used, but you need to execute a new customer-initiated transaction (CIT) for the end user to reauthenticate. - `IN_PROGRESS` – The recurring registration object is in use and the subsequent corresponding recurring pay-ins can be made. - `ENDED` – The recurrence ended: the registration can no longer be modified nor reused.
    - `CurrentState` RecurringPayInRegistrationGooglePayResponseCurrentState — Information about the recurring pay-ins related to the registration object. **Note:** If the LastPayinId references a transaction older than 13 months, it may have been archived.
      - `PayinsLinked` integer — The number of recurring pay-ins already made for the registration object.
      - `CumulatedDebitedAmount` RecurringPayInRegistrationGooglePayResponseCurrentStateCumulatedDebitedAmount — The sum of the DebitedFunds amounts of the recurring pay-ins made for the registration.
        - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
        - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
      - `CumulatedFeesAmount` RecurringPayInRegistrationGooglePayResponseCurrentStateCumulatedFeesAmount — The sum of the Fees amounts of the recurring pay-ins made for the registration.
        - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
        - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
      - `LastPayinId` string — The unique identifier of the last recurring pay-in made for the registration.
    - `RecurringType` string
    - `TotalAmount` RecurringPayInRegistrationGooglePayResponseTotalAmount
      - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `CycleNumber` integer
    - `AuthorId` string — The unique identifier of the user at the source of the transaction.
    - `CreditedUserId` string — **Default value:** The unique identifier of the owner of the credited wallet. The unique identifier of the user whose wallet is credited.
    - `FlowDescriptor` FlowDescriptorResponse — Information about the Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made ([read more](/guides/payin-beneficiaries)). If the `FlowDescriptor.Beneficiaries` is sent in the API request, then: - The transaction's `CreditedWalletId` holder is disregarded in KYC/KYB checks. - **ALL** `UserId` values in the array must be one of: - `OWNER` whose `KYCLevel` is `REGULAR` - `PLATFORM` The pay-in `Status` becomes `FAILED` with `ResultCode` [002951](/errors/codes/002951) if at least one `FlowDescriptor.Beneficiaries.UserId` is: - `PAYER` - `OWNER` whose `KYCLevel` is `LIGHT` If the `FlowDescriptor.Beneficiaries` is not sent in the API request, then the `CreditedWalletId` holder is subject to KYC/KYB checks. This property is optional for backwards compatibility but is recommended for all pay-in flows, even when the `CreditedWalletId` holder is a `PAYER` or the same value as one of the `FlowDescriptor.Beneficiaries`.
      - `FlowId` string — Unique identifier of the payment flow, used by Mangopay for internal purposes.
      - `Beneficiaries` FlowDescriptorResponseBeneficiariesItems[], nullable — Max. length: 5 items The list of up to 5 Natural or Legal Users declared as beneficiaries of the pay-in, who must all be KYC/KYB verified when the pay-in request is made. The pay-in also fails if the `Beneficiaries` array contains nulled objects or invalid `UserId` values.
        - `UserId` string — The unique identifier of the Natural User or Legal User declared as a beneficiary of the pay-in.
    - `CreditedWalletId` string — The unique identifier of the credited wallet.
    - `Billing` BillingDefaultsShippingUserResponse — **Default values:** `FirstName`, `LastName`, and `Address` information of the `Shipping` object if sent, otherwise of the `AuthorId` (if address values present). Information about the billing address.
      - `FirstName` string — The first name of the user.
      - `LastName` string — The last name of the user.
      - `Address` Address — The postal address.
        - `AddressLine1` string — The first line of the address.
        - `AddressLine2` string — The second line of the address.
        - `City` string — The city of the address.
        - `Region` string — Required if `Country` is US, CA, or MX. The region of the address.
        - `PostalCode` string — The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
        - `Country` string — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address.
    - `Shipping` ShippingDefaultsBillingUserResponse — **Default values:** `FirstName`, `LastName`, and `Address` information of the `Billing` object if sent, otherwise of the `AuthorId` (if address values present). Information about the shipping address.
      - `FirstName` string — The first name of the user.
      - `LastName` string — The last name of the user.
      - `Address` AddressSubPropsRequired — The postal address.
        - `AddressLine1` string, required — The first line of the address.
        - `AddressLine2` string — The second line of the address.
        - `City` string, required — The city of the address.
        - `Region` string — Required if `Country` is US, CA, or MX. The region of the address.
        - `PostalCode` string, required — The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
        - `Country` string, required — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address.
    - `EndDate` integer — The date and time at which the recurring pay-ins will end. This value has no impact on the recurring registration Status. **Caution:** If the EndDate is left unspecified, please bear in mind that one could be defined by default and be displayed to your end users (not taken into account in the payment recurrence).
    - `Frequency` string — **Returned values:** `Daily`, `Weekly`, `TwiceAMonth`, `Monthly`, `Bimonthly`, `Quarterly`, `Semiannual`, `Annual`, `Biannual` The frequency at which the recurring pay-ins will occur: - `Daily` – 1 transaction per day. - `Weekly` – 1 transaction every 7 days. - `TwiceAMonth` – 2 transactions per month. - `Monthly` – 1 transaction per month. - `Bimonthly` – 1 transaction every 2 months. - `Quarterly` – 1 transaction every 3 months. - `Semiannual` – 1 transaction every 6 months. - `Annual` – 1 transaction per year. - `Biannual` – 1 transaction every 2 years.
    - `FixedNextAmount` boolean — Whether or not the recurring pay-ins' debited amounts remain the same for all the pay-ins linked to the recurring registration object.
    - `FractionedPayment` boolean — Whether or not the recurring pay-ins are being made to split a payment in several installments.
    - `FreeCycles` integer — The number of initial consecutive pay-ins where there will be no debited funds nor fees. This value cannot exceed the CycleNumber value (for recurring objects with an EndDate, FixedNextAmount, and Frequency). **Note:** When creating a recurring pay-in (CIT or MIT) for a pay-in subject to a free cycle, the DebitedFunds and Fees parameters cannot be sent.
    - `FirstTransactionDebitedFunds` RecurringPayInRegistrationGooglePayResponseFirstTransactionDebitedFunds — The amount of the first recurring pay-in.
      - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `FirstTransactionFees` RecurringPayInRegistrationGooglePayResponseFirstTransactionFees — The fees of the first recurring pay-in.
      - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `NextTransactionDebitedFunds` RecurringPayInRegistrationGooglePayResponseNextTransactionDebitedFunds — The amount of the subsequent recurring pay-ins.
      - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `NextTransactionFees` RecurringPayInRegistrationGooglePayResponseNextTransactionFees — The fees of the subsequent recurring pay-ins.
      - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
      - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
    - `Migration` boolean
    - `ProfilingAttemptReference` string — The unique reference generated for the profiling session, used by the <a href="/guides/fraud-prevention">fraud prevention</a> solution to produce recommendations for the transaction using the profiling data. **Note:** Parameter not returned by the API. Profiling feature available on request – contact Mangopay <a href="https://hub.mangopay.com/" target="_blank">via the Dashboard</a> for more information.
    - `PaymentType` string — **Returned values:** `GOOGLE_PAY` The type of recurring pay-in registration (which must correspond to the pay-ins requested against it): - `CARD_DIRECT` – Card payments using a tokenized `CardId`. - `APPLEPAY` – Apple Pay payments using the tokenized `PaymentData` object retrieved from the Apple Pay API. - `GOOGLE_PAY` – Google Pay payments using the tokenized `PaymentData` string retrieved from the Google Pay API. - `PAYPAL` – PayPal payments, redirecting the user to authenticate via PayPal.
    - `ResultCode` string — The code indicating the result of the operation. This information is mostly used to <a href="/errors/codes">handle errors</a> or for filtering purposes.
    - `ResultMessage` string — The explanation of the result code.
    - `CardInfo` CardInfo — Information about the card used for the transaction. If the information or data is not available, `null` is returned.
      - `BIN` string — The bank identification number (BIN) of the card.
      - `IssuingBank` string — The name of the bank that issued the card.
      - `IssuerCountryCode` string — The country code of the card issuer.
      - `Type` string — The type of card (for example, `CREDIT` or `DEBIT`).
      - `SubType` string, nullable — The sub-type of the card, if available.
      - `Brand` string — The card brand (for example, `VISA` or `MASTERCARD`).

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.dev/mangopay/apis/api-reference.md) · [All operations](https://skmtc.dev/mangopay/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mangopay/api-reference/revisions/fafbd0c69654/schema)