> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.mangopay.com/api-reference/recurring-payin-registrations/recurring-payin-registration-object/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.mangopay.com/_mcp/server.
# The Recurring PayIn Registration object
### Description
The Recurring PayIn Registration objects links a series of recurring payments and stores information about the user, Mangopay wallets, and the recurrence.
Pay-ins requested against a recurring registration are of two types:
* **CIT** – Customer-initiated transaction requested when the user is on session to authenticate the payment
* **MIT** – Subsequent merchant-initiated transactions in the absence of the user, based on the initial successful authentication
The registration object can be used with 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) |
Read more about the payment flow in the guide for each payment method:
#### [Card](/guides/payment-methods/card/recurring)
Learn more about recurring card payments
#### [Apple Pay](/guides/payment-methods/apple-pay#recurring-payments)
Learn more about recurring Apple Pay payments
#### [Google Pay](/guides/payment-methods/google-pay#recurring-payments)
Learn more about Google Pay payments
#### [PayPal](/guides/payment-methods/paypal#recurring-payments)
Learn more about PayPal payments
### Attributes
### Schema (`RecurringPayInRegistrationResponse`)
```yaml
components:
schemas:
Id:
type: string
description: >-
Max length: 128 characters (see [data
formats](/api-reference/overview/data-formats) for details)
The unique identifier of the object.
title: Id
ResultCode:
type: string
description: >-
The code indicating the result of the operation. This information is
mostly used to handle errors or for
filtering purposes.
title: ResultCode
ResultMessage:
type: string
description: The explanation of the result code.
title: ResultMessage
Currency:
type: string
description: >-
**Allowed values:** The three-letter ISO 4217
code (EUR, GBP, etc.) of a supported currency (depends on feature, contract,
and activation settings).
The currency of the amount.
title: Currency
Amount:
type: integer
description: >-
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`.
title: Amount
RecurringPayInRegistrationCardResponseCurrentStateCumulatedDebitedAmount:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: Information about the cumulated debited funds amount.
title: RecurringPayInRegistrationCardResponseCurrentStateCumulatedDebitedAmount
RecurringPayInRegistrationCardResponseCurrentStateCumulatedFeesAmount:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: Information about the cumulated fees amount.
title: RecurringPayInRegistrationCardResponseCurrentStateCumulatedFeesAmount
RecurringPayInRegistrationCardResponseCurrentState:
type: object
properties:
PayinsLinked:
type: integer
description: >-
The number of recurring pay-ins already made for the registration
object.
CumulatedDebitedAmount:
$ref: >-
#/components/schemas/RecurringPayInRegistrationCardResponseCurrentStateCumulatedDebitedAmount
description: Information about the cumulated debited funds amount.
CumulatedFeesAmount:
$ref: >-
#/components/schemas/RecurringPayInRegistrationCardResponseCurrentStateCumulatedFeesAmount
description: Information about the cumulated fees amount.
LastPayinId:
type: string
description: >-
The unique identifier of the last recurring pay-in made for the
registration.
description: >-
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.
title: RecurringPayInRegistrationCardResponseCurrentState
RecurringPayInRegistrationCardResponseTotalAmount:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: >-
Information about the total amount.
This value is automatically calculated based on the `EndDate`,
`FixedNextAmount`, and `Frequency` parameters (if defined).
title: RecurringPayInRegistrationCardResponseTotalAmount
AuthorId:
type: string
description: The unique identifier of the user at the source of the transaction.
title: AuthorId
CreditedUserId:
type: string
description: >-
**Default value:** The unique identifier of the owner of the credited
wallet.
The unique identifier of the user whose wallet is credited.
title: CreditedUserId
FlowDescriptorResponseBeneficiariesItems:
type: object
properties:
UserId:
type: string
description: >-
The unique identifier of the Natural User or Legal User declared as
a beneficiary of the pay-in.
title: FlowDescriptorResponseBeneficiariesItems
FlowDescriptorResponse:
type: object
properties:
FlowId:
type: string
description: >-
Unique identifier of the payment flow, used by Mangopay for internal
purposes.
Beneficiaries:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/FlowDescriptorResponseBeneficiariesItems'
description: >-
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.
description: >
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`.
title: FlowDescriptorResponse
Address:
type: object
properties:
AddressLine1:
type: string
description: The first line of the address.
AddressLine2:
type: string
description: The second line of the address.
City:
type: string
description: The city of the address.
Region:
type: string
description: Required if `Country` is US, CA, or MX. The region of the address.
PostalCode:
type: string
description: >-
The postal code of the address. The postal code can contain the
following characters: alphanumeric, dashes, and spaces.
Country:
type: string
description: >-
Format: Two-letter country code ([ISO 3166-1 alpha-2
format](/api-reference/overview/data-formats))
The country of the address.
description: The postal address.
title: Address
Billing_DefaultsShippingUser_Response:
type: object
properties:
FirstName:
type: string
description: The first name of the user.
LastName:
type: string
description: The last name of the user.
Address:
$ref: '#/components/schemas/Address'
description: >-
**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.
title: Billing_DefaultsShippingUser_Response
Address_SubPropsRequired:
type: object
properties:
AddressLine1:
type: string
description: The first line of the address.
AddressLine2:
type: string
description: The second line of the address.
City:
type: string
description: The city of the address.
Region:
type: string
description: Required if `Country` is US, CA, or MX. The region of the address.
PostalCode:
type: string
description: >-
The postal code of the address. The postal code can contain the
following characters: alphanumeric, dashes, and spaces.
Country:
type: string
description: >-
Format: Two-letter country code ([ISO 3166-1 alpha-2
format](/api-reference/overview/data-formats))
The country of the address.
required:
- AddressLine1
- City
- PostalCode
- Country
description: The postal address.
title: Address_SubPropsRequired
Shipping_DefaultsBillingUser_Response:
type: object
properties:
FirstName:
type: string
description: The first name of the user.
LastName:
type: string
description: The last name of the user.
Address:
$ref: '#/components/schemas/Address_SubPropsRequired'
description: >-
**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.
title: Shipping_DefaultsBillingUser_Response
RecurringPayInRegistrationCardResponseFirstTransactionDebitedFunds:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: |-
The amount of the first recurring pay-in.
This value can be different from the `NextTransactionDebitedFunds`
title: RecurringPayInRegistrationCardResponseFirstTransactionDebitedFunds
RecurringPayInRegistrationCardResponseFirstTransactionFees:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: |-
The fees of the first recurring pay-in.
This amount can be different from the `NextTransactionDebitedFunds`.
title: RecurringPayInRegistrationCardResponseFirstTransactionFees
RecurringPayInRegistrationCardResponseNextTransactionDebitedFunds:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: >-
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.
title: RecurringPayInRegistrationCardResponseNextTransactionDebitedFunds
RecurringPayInRegistrationCardResponseNextTransactionFees:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: The fees of the subsequent recurring pay-ins.
title: RecurringPayInRegistrationCardResponseNextTransactionFees
RecurringPayInRegistrationCardResponse:
type: object
properties:
Id:
$ref: '#/components/schemas/Id'
Status:
type: string
description: >-
**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:
$ref: '#/components/schemas/ResultCode'
ResultMessage:
$ref: '#/components/schemas/ResultMessage'
CurrentState:
$ref: >-
#/components/schemas/RecurringPayInRegistrationCardResponseCurrentState
description: >-
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.
RecurringType:
type: string
description: >-
**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:
$ref: >-
#/components/schemas/RecurringPayInRegistrationCardResponseTotalAmount
description: >-
Information about the total amount.
This value is automatically calculated based on the `EndDate`,
`FixedNextAmount`, and `Frequency` parameters (if defined).
CycleNumber:
type: integer
description: >-
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:
$ref: '#/components/schemas/AuthorId'
CardId:
type: string
description: >-
The unique identifier of the Card object, obtained during the card
registration process.
CreditedUserId:
$ref: '#/components/schemas/CreditedUserId'
FlowDescriptor:
$ref: '#/components/schemas/FlowDescriptorResponse'
CreditedWalletId:
type: string
description: The unique identifier of the credited wallet.
Billing:
$ref: '#/components/schemas/Billing_DefaultsShippingUser_Response'
Shipping:
$ref: '#/components/schemas/Shipping_DefaultsBillingUser_Response'
EndDate:
type: integer
description: >-
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:
type: string
description: >-
**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:
type: boolean
description: >-
Whether or not the recurring pay-ins' debited amounts remain the
same for all the pay-ins linked to the recurring registration
object.
FractionedPayment:
type: boolean
description: >-
Whether or not the recurring pay-ins are being made to split a
payment in several installments.
FreeCycles:
type: integer
description: >-
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:
$ref: >-
#/components/schemas/RecurringPayInRegistrationCardResponseFirstTransactionDebitedFunds
description: |-
The amount of the first recurring pay-in.
This value can be different from the `NextTransactionDebitedFunds`
FirstTransactionFees:
$ref: >-
#/components/schemas/RecurringPayInRegistrationCardResponseFirstTransactionFees
description: |-
The fees of the first recurring pay-in.
This amount can be different from the `NextTransactionDebitedFunds`.
NextTransactionDebitedFunds:
$ref: >-
#/components/schemas/RecurringPayInRegistrationCardResponseNextTransactionDebitedFunds
description: >-
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.
NextTransactionFees:
$ref: >-
#/components/schemas/RecurringPayInRegistrationCardResponseNextTransactionFees
description: The fees of the subsequent recurring pay-ins.
Migration:
type: boolean
description: >-
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 (008008), soft decline (101305), expired card (101105), or stolen card (008003).
PaymentType:
type: string
description: >-
**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.
description: Response object for card recurring pay-in registrations.
title: RecurringPayInRegistrationCardResponse
RecurringPayInRegistrationPayPalResponseCurrentStateCumulatedDebitedAmount:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: Information about the cumulated debited funds amount.
title: >-
RecurringPayInRegistrationPayPalResponseCurrentStateCumulatedDebitedAmount
RecurringPayInRegistrationPayPalResponseCurrentStateCumulatedFeesAmount:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: Information about the cumulated fees amount.
title: RecurringPayInRegistrationPayPalResponseCurrentStateCumulatedFeesAmount
RecurringPayInRegistrationPayPalResponseCurrentState:
type: object
properties:
PayinsLinked:
type: integer
description: >-
The number of recurring pay-ins already made for the registration
object.
CumulatedDebitedAmount:
$ref: >-
#/components/schemas/RecurringPayInRegistrationPayPalResponseCurrentStateCumulatedDebitedAmount
description: Information about the cumulated debited funds amount.
CumulatedFeesAmount:
$ref: >-
#/components/schemas/RecurringPayInRegistrationPayPalResponseCurrentStateCumulatedFeesAmount
description: Information about the cumulated fees amount.
LastPayinId:
type: string
description: >-
The unique identifier of the last recurring pay-in made for the
registration.
description: >-
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.
title: RecurringPayInRegistrationPayPalResponseCurrentState
RecurringPayInRegistrationPayPalResponseFirstTransactionDebitedFunds:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: |-
The amount of the first recurring pay-in.
This value can be different from the `NextTransactionDebitedFunds`
title: RecurringPayInRegistrationPayPalResponseFirstTransactionDebitedFunds
RecurringPayInRegistrationPayPalResponseFirstTransactionFees:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: |-
The fees of the first recurring pay-in.
This amount can be different from the `NextTransactionDebitedFunds`.
title: RecurringPayInRegistrationPayPalResponseFirstTransactionFees
RecurringPayInRegistrationPayPalResponseNextTransactionDebitedFunds:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: >-
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.
title: RecurringPayInRegistrationPayPalResponseNextTransactionDebitedFunds
RecurringPayInRegistrationPayPalResponseNextTransactionFees:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: The fees of the subsequent recurring pay-ins.
title: RecurringPayInRegistrationPayPalResponseNextTransactionFees
RecurringPayInRegistrationPayPalResponse:
type: object
properties:
Id:
$ref: '#/components/schemas/Id'
Status:
type: string
description: >-
**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:
$ref: '#/components/schemas/ResultCode'
ResultMessage:
$ref: '#/components/schemas/ResultMessage'
CurrentState:
$ref: >-
#/components/schemas/RecurringPayInRegistrationPayPalResponseCurrentState
description: >-
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.
RecurringType:
type: string
description: |-
**Returned values:** `CUSTOM`
For PayPal recurring registrations, this value is always `CUSTOM`.
TotalAmount:
description: For PayPal recurring registrations, this value is returned `null`.
CycleNumber:
description: For PayPal recurring registrations, this value is returned `null`.
AuthorId:
$ref: '#/components/schemas/AuthorId'
CardId:
description: For PayPal recurring registrations, this value is returned `null`.
CreditedUserId:
$ref: '#/components/schemas/CreditedUserId'
FlowDescriptor:
$ref: '#/components/schemas/FlowDescriptorResponse'
CreditedWalletId:
type: string
description: The unique identifier of the credited wallet.
Billing:
$ref: '#/components/schemas/Billing_DefaultsShippingUser_Response'
Shipping:
$ref: '#/components/schemas/Shipping_DefaultsBillingUser_Response'
EndDate:
description: For PayPal recurring registrations, this value is returned `null`.
Frequency:
description: For PayPal recurring registrations, this value is returned `null`.
FixedNextAmount:
type: boolean
description: >-
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:
description: For PayPal recurring registrations, this value is returned `null`.
FreeCycles:
type: integer
description: For PayPal recurring registrations, this value is returned `0`.
FirstTransactionDebitedFunds:
$ref: >-
#/components/schemas/RecurringPayInRegistrationPayPalResponseFirstTransactionDebitedFunds
description: |-
The amount of the first recurring pay-in.
This value can be different from the `NextTransactionDebitedFunds`
FirstTransactionFees:
$ref: >-
#/components/schemas/RecurringPayInRegistrationPayPalResponseFirstTransactionFees
description: |-
The fees of the first recurring pay-in.
This amount can be different from the `NextTransactionDebitedFunds`.
NextTransactionDebitedFunds:
$ref: >-
#/components/schemas/RecurringPayInRegistrationPayPalResponseNextTransactionDebitedFunds
description: >-
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.
NextTransactionFees:
$ref: >-
#/components/schemas/RecurringPayInRegistrationPayPalResponseNextTransactionFees
description: The fees of the subsequent recurring pay-ins.
Migration:
type: boolean
description: For PayPal recurring registrations, this value is returned `false`.
deprecated: true
PaymentType:
type: string
description: >-
**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.
description: Response object for PayPal recurring pay-in registrations.
title: RecurringPayInRegistrationPayPalResponse
RecurringPayInRegistrationApplePayResponseCurrentStateCumulatedDebitedAmount:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: >-
The sum of the DebitedFunds amounts of the recurring pay-ins made for
the registration.
title: >-
RecurringPayInRegistrationApplePayResponseCurrentStateCumulatedDebitedAmount
RecurringPayInRegistrationApplePayResponseCurrentStateCumulatedFeesAmount:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: >-
The sum of the Fees amounts of the recurring pay-ins made for the
registration.
title: >-
RecurringPayInRegistrationApplePayResponseCurrentStateCumulatedFeesAmount
RecurringPayInRegistrationApplePayResponseCurrentState:
type: object
properties:
PayinsLinked:
type: integer
description: >-
The number of recurring pay-ins already made for the registration
object.
CumulatedDebitedAmount:
$ref: >-
#/components/schemas/RecurringPayInRegistrationApplePayResponseCurrentStateCumulatedDebitedAmount
description: >-
The sum of the DebitedFunds amounts of the recurring pay-ins made
for the registration.
CumulatedFeesAmount:
$ref: >-
#/components/schemas/RecurringPayInRegistrationApplePayResponseCurrentStateCumulatedFeesAmount
description: >-
The sum of the Fees amounts of the recurring pay-ins made for the
registration.
LastPayinId:
type: string
description: >-
The unique identifier of the last recurring pay-in made for the
registration.
description: >-
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.
title: RecurringPayInRegistrationApplePayResponseCurrentState
RecurringPayInRegistrationApplePayResponseTotalAmount:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
title: RecurringPayInRegistrationApplePayResponseTotalAmount
RecurringPayInRegistrationApplePayResponseFirstTransactionDebitedFunds:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: The amount of the first recurring pay-in.
title: RecurringPayInRegistrationApplePayResponseFirstTransactionDebitedFunds
RecurringPayInRegistrationApplePayResponseFirstTransactionFees:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: The fees of the first recurring pay-in.
title: RecurringPayInRegistrationApplePayResponseFirstTransactionFees
RecurringPayInRegistrationApplePayResponseNextTransactionDebitedFunds:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: The amount of the subsequent recurring pay-ins.
title: RecurringPayInRegistrationApplePayResponseNextTransactionDebitedFunds
RecurringPayInRegistrationApplePayResponseNextTransactionFees:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: The fees of the subsequent recurring pay-ins.
title: RecurringPayInRegistrationApplePayResponseNextTransactionFees
ProfilingAttemptReference:
type: string
description: >-
The unique reference generated for the profiling session, used by the fraud prevention 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 via the Dashboard for more information.
title: ProfilingAttemptReference
CardInfo:
type: object
properties:
BIN:
type: string
description: The bank identification number (BIN) of the card.
IssuingBank:
type: string
description: The name of the bank that issued the card.
IssuerCountryCode:
type: string
description: The country code of the card issuer.
Type:
type: string
description: The type of card (for example, `CREDIT` or `DEBIT`).
SubType:
type:
- string
- 'null'
description: The sub-type of the card, if available.
Brand:
type: string
description: The card brand (for example, `VISA` or `MASTERCARD`).
description: >-
Information about the card used for the transaction. If the information
or data is not available, `null` is returned.
title: CardInfo
RecurringPayInRegistrationApplePayResponse:
type: object
properties:
Id:
$ref: '#/components/schemas/Id'
Status:
type: string
description: >-
**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:
$ref: >-
#/components/schemas/RecurringPayInRegistrationApplePayResponseCurrentState
description: >-
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.
RecurringType:
type: string
TotalAmount:
$ref: >-
#/components/schemas/RecurringPayInRegistrationApplePayResponseTotalAmount
CycleNumber:
type: integer
AuthorId:
$ref: '#/components/schemas/AuthorId'
CreditedUserId:
$ref: '#/components/schemas/CreditedUserId'
FlowDescriptor:
$ref: '#/components/schemas/FlowDescriptorResponse'
CreditedWalletId:
type: string
description: The unique identifier of the credited wallet.
Billing:
$ref: '#/components/schemas/Billing_DefaultsShippingUser_Response'
Shipping:
$ref: '#/components/schemas/Shipping_DefaultsBillingUser_Response'
EndDate:
type: integer
description: >-
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:
type: string
description: >-
**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:
type: boolean
description: >-
Whether or not the recurring pay-ins' debited amounts remain the
same for all the pay-ins linked to the recurring registration
object.
FractionedPayment:
type: boolean
description: >-
Whether or not the recurring pay-ins are being made to split a
payment in several installments.
FreeCycles:
type: integer
description: >-
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:
$ref: >-
#/components/schemas/RecurringPayInRegistrationApplePayResponseFirstTransactionDebitedFunds
description: The amount of the first recurring pay-in.
FirstTransactionFees:
$ref: >-
#/components/schemas/RecurringPayInRegistrationApplePayResponseFirstTransactionFees
description: The fees of the first recurring pay-in.
NextTransactionDebitedFunds:
$ref: >-
#/components/schemas/RecurringPayInRegistrationApplePayResponseNextTransactionDebitedFunds
description: The amount of the subsequent recurring pay-ins.
NextTransactionFees:
$ref: >-
#/components/schemas/RecurringPayInRegistrationApplePayResponseNextTransactionFees
description: The fees of the subsequent recurring pay-ins.
Migration:
type: boolean
ProfilingAttemptReference:
$ref: '#/components/schemas/ProfilingAttemptReference'
PaymentType:
type: string
description: >-
**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:
$ref: '#/components/schemas/ResultCode'
ResultMessage:
$ref: '#/components/schemas/ResultMessage'
CardInfo:
$ref: '#/components/schemas/CardInfo'
description: Response object for Apple Pay recurring pay-in registrations.
title: RecurringPayInRegistrationApplePayResponse
RecurringPayInRegistrationGooglePayResponseCurrentStateCumulatedDebitedAmount:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: >-
The sum of the DebitedFunds amounts of the recurring pay-ins made for
the registration.
title: >-
RecurringPayInRegistrationGooglePayResponseCurrentStateCumulatedDebitedAmount
RecurringPayInRegistrationGooglePayResponseCurrentStateCumulatedFeesAmount:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: >-
The sum of the Fees amounts of the recurring pay-ins made for the
registration.
title: >-
RecurringPayInRegistrationGooglePayResponseCurrentStateCumulatedFeesAmount
RecurringPayInRegistrationGooglePayResponseCurrentState:
type: object
properties:
PayinsLinked:
type: integer
description: >-
The number of recurring pay-ins already made for the registration
object.
CumulatedDebitedAmount:
$ref: >-
#/components/schemas/RecurringPayInRegistrationGooglePayResponseCurrentStateCumulatedDebitedAmount
description: >-
The sum of the DebitedFunds amounts of the recurring pay-ins made
for the registration.
CumulatedFeesAmount:
$ref: >-
#/components/schemas/RecurringPayInRegistrationGooglePayResponseCurrentStateCumulatedFeesAmount
description: >-
The sum of the Fees amounts of the recurring pay-ins made for the
registration.
LastPayinId:
type: string
description: >-
The unique identifier of the last recurring pay-in made for the
registration.
description: >-
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.
title: RecurringPayInRegistrationGooglePayResponseCurrentState
RecurringPayInRegistrationGooglePayResponseTotalAmount:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
title: RecurringPayInRegistrationGooglePayResponseTotalAmount
RecurringPayInRegistrationGooglePayResponseFirstTransactionDebitedFunds:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: The amount of the first recurring pay-in.
title: RecurringPayInRegistrationGooglePayResponseFirstTransactionDebitedFunds
RecurringPayInRegistrationGooglePayResponseFirstTransactionFees:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: The fees of the first recurring pay-in.
title: RecurringPayInRegistrationGooglePayResponseFirstTransactionFees
RecurringPayInRegistrationGooglePayResponseNextTransactionDebitedFunds:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: The amount of the subsequent recurring pay-ins.
title: RecurringPayInRegistrationGooglePayResponseNextTransactionDebitedFunds
RecurringPayInRegistrationGooglePayResponseNextTransactionFees:
type: object
properties:
Currency:
$ref: '#/components/schemas/Currency'
Amount:
$ref: '#/components/schemas/Amount'
description: The fees of the subsequent recurring pay-ins.
title: RecurringPayInRegistrationGooglePayResponseNextTransactionFees
RecurringPayInRegistrationGooglePayResponse:
type: object
properties:
Id:
$ref: '#/components/schemas/Id'
Status:
type: string
description: >-
**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:
$ref: >-
#/components/schemas/RecurringPayInRegistrationGooglePayResponseCurrentState
description: >-
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.
RecurringType:
type: string
TotalAmount:
$ref: >-
#/components/schemas/RecurringPayInRegistrationGooglePayResponseTotalAmount
CycleNumber:
type: integer
AuthorId:
$ref: '#/components/schemas/AuthorId'
CreditedUserId:
$ref: '#/components/schemas/CreditedUserId'
FlowDescriptor:
$ref: '#/components/schemas/FlowDescriptorResponse'
CreditedWalletId:
type: string
description: The unique identifier of the credited wallet.
Billing:
$ref: '#/components/schemas/Billing_DefaultsShippingUser_Response'
Shipping:
$ref: '#/components/schemas/Shipping_DefaultsBillingUser_Response'
EndDate:
type: integer
description: >-
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:
type: string
description: >-
**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:
type: boolean
description: >-
Whether or not the recurring pay-ins' debited amounts remain the
same for all the pay-ins linked to the recurring registration
object.
FractionedPayment:
type: boolean
description: >-
Whether or not the recurring pay-ins are being made to split a
payment in several installments.
FreeCycles:
type: integer
description: >-
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:
$ref: >-
#/components/schemas/RecurringPayInRegistrationGooglePayResponseFirstTransactionDebitedFunds
description: The amount of the first recurring pay-in.
FirstTransactionFees:
$ref: >-
#/components/schemas/RecurringPayInRegistrationGooglePayResponseFirstTransactionFees
description: The fees of the first recurring pay-in.
NextTransactionDebitedFunds:
$ref: >-
#/components/schemas/RecurringPayInRegistrationGooglePayResponseNextTransactionDebitedFunds
description: The amount of the subsequent recurring pay-ins.
NextTransactionFees:
$ref: >-
#/components/schemas/RecurringPayInRegistrationGooglePayResponseNextTransactionFees
description: The fees of the subsequent recurring pay-ins.
Migration:
type: boolean
ProfilingAttemptReference:
$ref: '#/components/schemas/ProfilingAttemptReference'
PaymentType:
type: string
description: >-
**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:
$ref: '#/components/schemas/ResultCode'
ResultMessage:
$ref: '#/components/schemas/ResultMessage'
CardInfo:
$ref: '#/components/schemas/CardInfo'
description: Response object for Google Pay recurring pay-in registrations.
title: RecurringPayInRegistrationGooglePayResponse
RecurringPayInRegistrationResponse:
oneOf:
- $ref: '#/components/schemas/RecurringPayInRegistrationCardResponse'
- $ref: '#/components/schemas/RecurringPayInRegistrationPayPalResponse'
- $ref: '#/components/schemas/RecurringPayInRegistrationApplePayResponse'
- $ref: '#/components/schemas/RecurringPayInRegistrationGooglePayResponse'
title: RecurringPayInRegistrationResponse
```