The PayPal PayIn object

The unique identifier of the object.

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.

The date and time at which the object was created.

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

Information about the debited funds. The amount must be equal to the total of all UnitAmount and TaxAmount of all LineItems.

Information about the credited funds (CreditedFunds = DebitedFunds - Fees).

Information about the fees.

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

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.

The date and time at which the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENT

The nature of the transaction, providing more information about the context in which the transaction occurred:

• REGULAR – Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow.
• REPUDIATION – Automatic withdrawal of funds from the platform’s repudiation wallet as part of the dispute process (when the user has requested a chargeback).
• REFUND – Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay).
• SETTLEMENT – Transfer made to the repudiation wallet by the platform to settle a lost dispute.

The unique identifier of the credited wallet.

Returned values: PAYPAL

The type of pay-in.

Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION

The type of execution for the pay-in.

Max. length: 255 characters

The URL to which the user is returned after the payment, whether the transaction is successful or not.

The URL to which to redirect the user to complete the payment.

Caution: This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.

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.

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.

Returned values: SET_PROVIDED_ADDRESS, GET_FROM_FILE, NO_SHIPPING

Information about the shipping address behavior on the PayPal payment page:

• SET_PROVIDED_ADDRESS - The Shipping parameter becomes required and its values are displayed to the end user, who is not able to modify them.
• GET_FROM_FILE – The Shipping parameter 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.

The email address registered on the PayPal account used to make the payment.

Shipping information of the LineItems added to the pay-in object.

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.

The unique identifier of the recurring pay-in registration. On PayPal, this parameter is only returned if the pay-in is a recurring one.