LineItems shipments, on both one-time and recurring PayPal pay-ins.
Caution – Tracking information cannot be editedYou can’t modify the
You can only send a unique tracking number once.
TrackingNumber, Carrier, or NotifyBuyer once added.You can only send a unique tracking number once.
NotifyBuyer to true on only one of them.
Path parameters
The unique identifier of the pay-in.
Body parameters
The shipment’s tracking number provided by the carrier.
The carrier for the shipment. Use the country-specific version of the carrier if it exists, otherwise use its global version.
Default value: falseIf
true, sends an email notification to the PaypalBuyerAccountEmail containing the TrackingNumber and Carrier, which allows the end user to track their shipment with the carrier.Responses
200 - First tracking number
200 - First tracking number
Max length: 128 characters (see data formats for details)The unique identifier of the object.
Max. length: 255 charactersCustom 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.
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, FAILEDThe 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, PAYOUTThe type of the transaction.Returned values:
REGULAR, REPUDIATION, REFUND, SETTLEMENTThe 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.
Default value: The unique identifier of the owner of the credited wallet.The unique identifier of the user whose wallet is credited.
Returned values:
PAYPALThe type of pay-in.Returned values:
WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.Max. length: 255 charactersThe 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 spacesCustom 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.objectInformation 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).Returned 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_SHIPPINGInformation 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.
The email address registered on the PayPal account used to make the payment.
Max. length: 127 characters (truncated after)The platform’s order reference for the transaction.
Shipping information of the
LineItems added to the pay-in object.The URL to which the user is returned after canceling the payment. If not provided, the Cancel button returns the user to the RedirectURL.
PayPal’s unique identifier for the order.
The country of the buyer.
The first name of the buyer.
The mobile phone number of the buyer.
The last name of the buyer.
The PayPal identifier of the buyer.
200 - Second tracking number
200 - Second tracking number
Max length: 128 characters (see data formats for details)The unique identifier of the object.
Max. length: 255 charactersCustom 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.
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, FAILEDThe 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, PAYOUTThe type of the transaction.Returned values:
REGULAR, REPUDIATION, REFUND, SETTLEMENTThe 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.
Default value: The unique identifier of the owner of the credited wallet.The unique identifier of the user whose wallet is credited.
Returned values:
PAYPALThe type of pay-in.Returned values:
WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.Max. length: 255 charactersThe 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 spacesCustom 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.objectInformation 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).Returned 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_SHIPPINGInformation 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.
The email address registered on the PayPal account used to make the payment.
Max. length: 127 characters (truncated after)The platform’s order reference for the transaction.
Shipping information of the
LineItems added to the pay-in object.The URL to which the user is returned after canceling the payment. If not provided, the Cancel button returns the user to the RedirectURL.
PayPal’s unique identifier for the order.
The country of the buyer.
The first name of the buyer.
The mobile phone number of the buyer.
The last name of the buyer.
The PayPal identifier of the buyer.