The Recurring Apple Pay PayIn object

Description

The Recurring Apple Pay PayIn object represents an Apple Pay pay-in linked to a Recurring PayIn Registration object.

There are two types of recurring pay-ins:

  • Customer-initiated transaction (CIT) – First pay-in of the series, which requires the user to authenticate.
  • Merchant-initiated transaction (MIT) – All the pay-ins occurring after a successful CIT, which are executed in the absence of the user.

Note – Prerequisites to using Apple Pay

Using Apple Pay requires activation from Mangopay, and your platform also needs to integrate with Apple Pay directly. See the Apple Pay guide for more information.

Note – Max. 99 pay-ins possible against each registration

A maximum of 99 pay-ins, CIT and MIT included, can be made against each Recurring PayIn Registration. Once you reach this limit, the 100th pay-in will fail with the error 205001.

You need to create a new registration object to restart the recurrence (with a CIT).

Attributes

IdstringOptional
TagstringOptional
CreationDateintegerOptional
AuthorIdstringOptional
The unique identifier of the user at the source of the transaction.
DebitedFundsobjectOptional
CreditedFundsobjectOptional
FeesobjectOptional
Information about the fees.
StatusstringOptional
ResultCodestringOptional
ResultMessagestringOptional
The explanation of the result code.
ExecutionDateintegerOptional
TypestringOptional
NaturestringOptional
CreditedWalletIdstringOptional
The unique identifier of the credited wallet.
CreditedUserIdstringOptional
PaymentTypestringOptional
ExecutionTypestringOptional
StatementDescriptorstringOptional
DebitedWalletIdstringOptional
SecurityInfoobjectOptional
SecureModestringOptional
CardIdstringOptional
SecureModeReturnURLstringOptional
SecureModeRedirectURLstringOptional
SecureModeNeededbooleanOptional
CulturestringOptional
BrowserInfoobjectOptional
IpAddressstringOptional
Requested3DSVersionstringOptional
Applied3DSVersionstringOptional
RecurringPayinRegistrationIdstringOptional
PreferredCardNetworkstringOptional
PaymentCategorystringOptional
CardInfoobjectOptional
AuthenticationResultobjectOptional
BillingobjectOptional
ShippingobjectOptional