​
Description

Mangopay relies on the Recurring PayIn Registration object to store all the relevant information about a series of recurring pay-ins. To use the recurring registration with PayPal, set the PaymentType to PAYPAL during the POST call. The same object is used to link recurring card payments, but with different features available. For more information about recurring payments with PayPal, refer to the PayPal guide.

​
Attributes

​
Id
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
Status
string
Returned values: CREATED, AUTHENTICATION_NEEDED, IN_PROGRESS, ENDEDThe 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 has 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 handle errors or for filtering purposes.
​
ResultMessage
string
The explanation of the result code.
​
CurrentState
object
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
string
Returned values: CUSTOMFor PayPal recurring registrations, this value is always CUSTOM.
​
CycleNumber
integer
For PayPal recurring registrations, this value is returned null.
​
AuthorId
string
The unique identifier of the user at the source of the transaction.
​
CardId
string
For PayPal recurring registrations, this value is returned null.
​
CreditedUserId
string
Default value: The unique identifier of the owner of the credited wallet.The unique identifier of the user whose wallet is credited.
​
CreditedWalletId
string
The unique identifier of the credited wallet.
​
Shipping
object
Information about the end user’s shipping address.
​
EndDate
Unix timestamp
For PayPal recurring registrations, this value is returned null.
​
Frequency
string
For PayPal recurring registrations, this value is returned null.
​
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
boolean
For PayPal recurring registrations, this value is returned null.
​
FreeCycles
integer
For PayPal recurring registrations, this value is returned 0.
​
FirstTransactionDebitedFunds
object
The amount of the first recurring pay-in.
This value can be different from the NextTransactionDebitedFunds
​
FirstTransactionFees
object
The fees of the first recurring pay-in.
This amount can be different from the NextTransactionDebitedFunds.
​
NextTransactionFees
object
The fees of the subsequent recurring pay-ins.
​
Migration
boolean
deprecated
For PayPal recurring registrations, this value is returned false.
​
ProfilingAttemptReference
string
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.

Guide

Learn more about recurring PayPal payments