200
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.LastPayinId
references a transaction older than 13 months, it may have been archived.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.EndDate
, FixedNextAmount
, and Frequency
parameters (if defined).EndDate
, FixedNextAmount
, and Frequency
parameters (if defined).Status
.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).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.CycleNumber
value (for recurring objects with an EndDate
, FixedNextAmount
, and Frequency
).DebitedFunds
and Fees
parameters should be ignored. Otherwise, the pay-in will fail with the corresponding error returned.NextTransactionDebitedFunds
NextTransactionDebitedFunds
.FixedNextAmount
or FractionedPayment
are true
, the subsequent amount will be the same as FirstTransactionDebitedFunds
amount.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).CARD_DIRECT
, PAYPAL
Default value: CARD_DIRECT
The type of recurring pay-in registration (which must correspond to the pay-ins requested against it).