Recurring card pay-ins
Update a Recurring PayIn Registration
PUT
This call can be used to change the following parameters:
Status– To manually close the recurring pay-in registration with theENDEDstatus. When doing so, no recurring pay-in can be created based on the registration anymore.CardId– To modify the card to use for recurring pay-ins. When doing so, a new CIT is required (with SCA).BillingandShipping– To change information about billing and shipping.
Path parameters
The unique identifier of the recurring pay-in registration.
Body parameters
The unique identifier of the Card object, obtained during the card registration process.
Allowed values:
ENDEDThe 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.
Default value: FirstName, LastName, and Address information of the Billing object, if supplied, otherwise of the user (author).Information about the end user’s shipping address. If left empty, the default values will be automatically taken into account.
Default value: FirstName, LastName, and Address information of the Shipping object if any, otherwise the user (author).Information about the end user billing address. If left empty, the default values will be automatically taken into account.
Responses
200
200
Max length: 128 characters (see data formats for details)The unique identifier of the object.
Returned values:
CREATED, AUTHENTICATION_NEEDED, IN_PROGRESS, ENDEDThe 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.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
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.Returned values:
CLASSIC_SUBSCRIPTION, FRACTIONED_PAYMENT, CUSTOMThe type of recurrence, which can be one of the following:CLASSIC_SUBSCRIPTION– For fixed-amount subscriptions. TheAmountof each pay-in and the subscription’sEndDateare known, and these values cannot be modified during the recurrence.FRACTIONED_PAYMENT– For payments in 3 or 4 times. TheAmountof each pay-in and the registration’sEndDateare known, and these values cannot be modified during the recurrence.CUSTOM– For recurring registrations where theAmountandEndDateare unknown.
The total amount in the registration.This value is automatically calculated based on the
EndDate, FixedNextAmount, and Frequency parameters (if defined).The number of cycles in the registration (and therefore the number of payments).
This value is automatically calculated based on the
This value is automatically calculated based on the
EndDate, FixedNextAmount, and Frequency parameters (if defined).The unique identifier of the user at the source of the transaction.
The unique identifier of the Card object, obtained during the card registration process.
Default value: The unique identifier of the owner of the credited wallet.The unique identifier of the user whose wallet is credited.
The unique identifier of the credited wallet.
Default value: FirstName, LastName, and Address information of the Shipping object if any, otherwise the user (author).Information about the end user billing address. If left empty, the default values will be automatically taken into account.
Default value: FirstName, LastName, and Address information of the Billing object, if supplied, otherwise of the user (author).Information about the end user’s shipping address. If left empty, the default values will be automatically taken into account.
The date and time at which the recurring pay-ins will end. This value has no impact on the recurring registration
Caution: If the
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).Returned values:
Daily, Weekly, TwiceAMonth, Monthly, Bimonthly, Quarterly, Semiannual, Annual, BiannualThe 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.
Whether or not the recurring pay-ins’ debited amounts remain the same for all the pay-ins linked to the recurring registration object.
Whether or not the recurring pay-ins are being made to split a payment in several installments.
The number of initial consecutive pay-ins where there will be no debited funds nor fees.
This value cannot exceed the
Note: When creating a recurring pay-in (CIT or MIT) for a pay-in subject to a free cycle, the
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.The amount of the first recurring pay-in.
This value can be different from the
This value can be different from the
NextTransactionDebitedFundsThe fees of the first recurring pay-in.
This amount can be different from the
This amount can be different from the
NextTransactionDebitedFunds.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.The fees of the subsequent recurring pay-ins.
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).Returned values:
CARD_DIRECT, PAYPALDefault value: CARD_DIRECTThe type of recurring pay-in registration (which must correspond to the pay-ins requested against it).