The Recurring PayIn Registration object (PayPal)

The unique identifier of the object.

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 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.

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: CUSTOM

For PayPal recurring registrations, this value is always CUSTOM.

For PayPal recurring registrations, this value is returned null.

The unique identifier of the user at the source of the transaction.

For PayPal recurring registrations, this value is returned null.

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.

Information about the end user’s shipping address.

For PayPal recurring registrations, this value is returned null.

For PayPal recurring registrations, this value is returned null.

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.

For PayPal recurring registrations, this value is returned null.

For PayPal recurring registrations, this value is returned 0.

The amount of the first recurring pay-in.
This value can be different from the NextTransactionDebitedFunds

The fees of the first recurring pay-in.
This amount can be different from the NextTransactionDebitedFunds.

The fees of the subsequent recurring pay-ins.

For PayPal recurring registrations, this value is returned false.

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.