The Recurring PayPal PayIn object

Description

The Recurring PayPal PayIn object allows platforms to process recurring payments with PayPal.

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.

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.
PaymentTypestringOptional
ExecutionTypestringOptional
ReturnURLstringOptional
RedirectURLstringOptional
StatementDescriptorstringOptional
ShippingobjectOptional
LineItemslist of objectsOptional
CulturestringOptional
ShippingPreferencestringOptional
PaypalBuyerAccountEmailstringOptional
The email address registered on the PayPal account used to make the payment.
ReferencestringOptional
Trackingslist of objectsOptional
CancelURLstringOptional
PaypalPayerIDstringOptional
The PayPal identifier of the buyer.
BuyerCountrystringOptional
The country of the buyer.
BuyerFirstnamestringOptional
The first name of the buyer.
BuyerLastnamestringOptional
The last name of the buyer.
BuyerPhonestringOptional
The mobile phone number of the buyer.
PaypalOrderIDstringOptional
PayPal's unique identifier for the order.
RecurringPayinRegistrationIdstringOptional