> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mangopay.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Add tracking information to a PayPal PayIn
You can use this call to add the tracking number and carrier for `LineItems` shipments, on both one-time and recurring PayPal pay-ins.
**Caution – Tracking information cannot be edited**
You can’t modify the `TrackingNumber`, `Carrier`, or `NotifyBuyer` once added.\
You can only send a unique tracking number once.
There is no link between the line items and the tracking numbers.
If adding multiple tracking numbers for the same transaction, it is recommended to set `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:** false
If `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
Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details)
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`.
**Returned values:** The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the funds.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`).
Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).
**Returned values:** The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the funds.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`).
Information about the fees.
**Returned values:** The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the fees.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`).
**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.
**Default value:** The unique identifier of the owner of the credited wallet.
The unique identifier of the user whose wallet is credited.
**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`.
The first name of the user.
Max. length: 100 characters
The last name of the user.
Information about the shipping address.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the `Country` is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))
The country of the address.
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).
Max. length: 127 characters (truncated after)
The name of the item.
The quantity of the item.
The cost of the item, excluding tax.
The tax amount applied to the item.
Max. length: 127 characters (truncated after)
The platform’s unique reference for the seller. This value must be consistently used for the given seller. You can use, for example, the Mangopay `UserId` or the seller’s business name or first name and last name.\
Caution: Failure to use a unique seller identifier may result in PayPal restricting your service.
**Allowed values:** PHYSICAL\_GOODS, DIGITAL\_GOODS, DONATION
The category of the item:
* `PHYSICAL_GOODS` – Tangible items that can be physically shipped and received with proof of delivery upon arrival.
* `DIGITAL_GOODS` – Products or services that are distributed and consumed via digital platforms or devices.
* `DONATION` – Voluntary contribution made without any goods or services received in return. Multiple line items can be categorized as `DONATION` within a single transaction, however it is not possible to combine `DONATION` other line item categories within the same transaction.
**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_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.
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 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:** false
If `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.
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.
Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details)
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`.
**Returned values:** The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the funds.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`).
Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).
**Returned values:** The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the funds.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`).
Information about the fees.
**Returned values:** The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the fees.
An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`).
**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.
**Default value:** The unique identifier of the owner of the credited wallet.
The unique identifier of the user whose wallet is credited.
**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`.
The first name of the user.
Max. length: 100 characters
The last name of the user.
Information about the shipping address.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the `Country` is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))
The country of the address.
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).
Max. length: 127 characters (truncated after)
The name of the item.
The quantity of the item.
The cost of the item, excluding tax.
The tax amount applied to the item.
Max. length: 127 characters (truncated after)
The platform’s unique reference for the seller. This value must be consistently used for the given seller. You can use, for example, the Mangopay `UserId` or the seller’s business name or first name and last name.\
Caution: Failure to use a unique seller identifier may result in PayPal restricting your service.
**Allowed values:** PHYSICAL\_GOODS, DIGITAL\_GOODS, DONATION
The category of the item:
* `PHYSICAL_GOODS` – Tangible items that can be physically shipped and received with proof of delivery upon arrival.
* `DIGITAL_GOODS` – Products or services that are distributed and consumed via digital platforms or devices.
* `DONATION` – Voluntary contribution made without any goods or services received in return. Multiple line items can be categorized as `DONATION` within a single transaction, however it is not possible to combine `DONATION` other line item categories within the same transaction.
**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_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.
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 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:** false
If `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.
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.
```json 200 - First tracking number theme={null}
{
"Id": "wt_00a046e2-cc5c-46ba-91e0-1feca23922e4",
"Tag": "Created using the Mangopay API Postman collection",
"CreationDate": 1699367848,
"AuthorId": "204068024",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 1500
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 1200
},
"Fees": {
"Currency": "EUR",
"Amount": 300
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1699368834,
"Type": "PAYIN",
"Nature": "REGULAR",
"CreditedWalletId": "204089031",
"CreditedUserId": "204068024",
"PaymentType": "PAYPAL",
"ExecutionType": "WEB",
"ReturnURL": "http://www.mangopay.com/docs/please-ignore?transactionId=wt_00a046e2-cc5c-46ba-91e0-1feca23922e4",
"RedirectURL": "https://www.sandbox.paypal.com/checkoutnow?token=48X37022FD879043B",
"StatementDescriptor": "Mangopay",
"Shipping": {
"FirstName": "Alex",
"LastName": "Smith",
"Address": {
"AddressLine1": "6 rue de la Cité",
"AddressLine2": "Appartement 3",
"City": "Paris",
"Region": "île-de-france",
"PostalCode": "75003",
"Country": "FR"
}
},
"LineItems": [
{
"Name": "Running shoes",
"Quantity": 2,
"UnitAmount": 400,
"TaxAmount": 100,
"Description": "ID of Seller 1",
"Category": "PHYSICAL_GOODS"
},
{
"Name": "Walking shoes",
"Quantity": 1,
"UnitAmount": 400,
"TaxAmount": 100,
"Description": "ID of Seller 2",
"Category": "PHYSICAL_GOODS"
}
],
"Culture": "FR",
"ShippingPreference": "SET_PROVIDED_ADDRESS",
"PaypalBuyerAccountEmail": "alex.smith@example.com",
"Reference": "1234",
"Trackings": [
{
"TrackingNumber": "123456789",
"Carrier": "DHL",
"NotifyBuyer": true
}
],
"CancelURL": "http://www.example.com/?transactionId=wt_f79a219d-c952-41a0-9bc4-e575f8f1ef7a",
"PaypalPayerID": null,
"BuyerCountry": null,
"BuyerFirstname": null,
"BuyerLastname": null,
"BuyerPhone": null,
"PaypalOrderID": "6MH08891XC585490F"
}
```
```json 200 - Second tracking number theme={null}
{
"Id": "wt_00a046e2-cc5c-46ba-91e0-1feca23922e4",
"Tag": "Created using the Mangopay API Postman collection",
"CreationDate": 1699367848,
"AuthorId": "204068024",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 1500
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 1200
},
"Fees": {
"Currency": "EUR",
"Amount": 300
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1699368834,
"Type": "PAYIN",
"Nature": "REGULAR",
"CreditedWalletId": "204089031",
"CreditedUserId": "204068024",
"PaymentType": "PAYPAL",
"ExecutionType": "WEB",
"ReturnURL": "http://www.mangopay.com/docs/please-ignore?transactionId=wt_00a046e2-cc5c-46ba-91e0-1feca23922e4",
"RedirectURL": "https://www.sandbox.paypal.com/checkoutnow?token=48X37022FD879043B",
"StatementDescriptor": "Mangopay",
"Shipping": {
"FirstName": "Alex",
"LastName": "Smith",
"Address": {
"AddressLine1": "6 rue de la Cité",
"AddressLine2": "Appartement 3",
"City": "Paris",
"Region": "île-de-france",
"PostalCode": "75003",
"Country": "FR"
}
},
"LineItems": [
{
"Name": "Running shoes",
"Quantity": 2,
"UnitAmount": 400,
"TaxAmount": 100,
"Description": "ID of Seller 1",
"Category": "PHYSICAL_GOODS"
},
{
"Name": "Walking shoes",
"Quantity": 1,
"UnitAmount": 400,
"TaxAmount": 100,
"Description": "ID of Seller 2",
"Category": "PHYSICAL_GOODS"
}
],
"Culture": "FR",
"ShippingPreference": "SET_PROVIDED_ADDRESS",
"PaypalBuyerAccountEmail": "alex.smith@example.com",
"Reference": "1234",
"Trackings": [
{
"TrackingNumber": "123456789",
"Carrier": "DHL",
"NotifyBuyer": true
},
{
"TrackingNumber": "987654321",
"Carrier": "DPD",
"NotifyBuyer": false
}
],
"CancelURL": "http://www.example.com/?transactionId=wt_f79a219d-c952-41a0-9bc4-e575f8f1ef7a",
"PaypalPayerID": null,
"BuyerCountry": null,
"BuyerFirstname": null,
"BuyerLastname": null,
"BuyerPhone": null,
"PaypalOrderID": "6MH08891XC585490F"
}
```
```json REST theme={null}
{
"TrackingNumber": "123456789",
"Carrier": "DHL",
"NotifyBuyer": true
}
```
```java Java theme={null}
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.mangopay.MangoPayApi;
import com.mangopay.entities.PayIn;
import com.mangopay.entities.subentities.PayPalWebTracking;
public class AddTrackingInformation {
public static void main(String[] args) throws Exception {
MangoPayApi mangopay = new MangoPayApi();
mangopay.getConfig().setClientId("your-client-id");
mangopay.getConfig().setClientPassword("your-api-key");
var payInId = "wt_5aaccd9f-6129-4689-90b0-1ef0496c5233";
PayPalWebTracking trackingInfo = new PayPalWebTracking();
trackingInfo.setCarrier("DHL");
trackingInfo.setTrackingNumber("562341568");
trackingInfo.setNotifyBuyer(true);
PayIn createPaypalPayin = mangopay.getPayInApi().addPayPalTrackingInformation(payInId, trackingInfo);
Gson prettyPrint = new GsonBuilder().setPrettyPrinting().create();
String prettyJson = prettyPrint.toJson(createPaypalPayin);
System.out.println(prettyJson);
}
}
```