Create a Recurring PayPal PayIn (MIT)
Read more about the Recurring PayPal PayIn object →
Body parameters
Required if the registration’s NextTransactionDebitedFunds is empty.
The amount of the subsequent recurring pay-in. If this field is empty, the amount entered in the NextTransactionDebitedFunds of the Recurring PayIn Registration is taken into account.
Caution: An amount must be transmitted during either the recurring registration or pay-in (if it’s different from the registration one).
Required if the registration’s NextTransactionFees is empty.
The amount of the subsequent fees. If this field is empty, the amount entered in the NextTransactionFees of the Recurring PayIn Registration is taken into account.
Caution: An amount must be transmitted during either the recurring registration or pay-in (if it’s different from the registration one).
Max. length: 255 characters
Custom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.
Max. length: 255 characters
The URL to which the user is returned after the payment, whether the transaction is successful or not.
Max. length: 10 characters; only alphanumeric and spaces
Custom description to appear on the user’s bank statement along with the platform name. Different banks may show more or less information. See the Customizing bank statement references article for details.
Default values: Shipping information of the registration object (if present).
Required if ShippingPreference is SET_PROVIDED_ADDRESS and the shipping information is not present in the recurring registration object.
Information about the end user’s shipping address, managed by ShippingPreference.
object
Information about the items purchased in the transaction. The total of all line items’ UnitAmount and TaxAmount must equal the DebitedFunds amount (negative amounts not allowed).
Allowed values: One of the supported languages in the ISO 639-1 format: AT, BR, CA, CH, CN, DE, DK, ES, FR, GB, ID, IL, IT, JK, JP, NL, NO, PL, PT, RU, SE, TH, TR, TW, US.
The language in which the PayPal payment page is to be displayed.
Allowed values: SET_PROVIDED_ADDRESS, GET_FROM_FILE, NO_SHIPPING
Information about the shipping address behavior on the PayPal payment page:
SET_PROVIDED_ADDRESS- TheShippingparameter becomes required and its values are displayed to the end user, who is not able to modify them.GET_FROM_FILE– TheShippingparameter is ignored and the end user can choose from registered addresses.NO_SHIPPING– No shipping address section is displayed.
Max. length: 127 characters (truncated after)
The platform’s order reference for the transaction.
Responses
Was this page helpful?