---
title: "Add tracking information to a PayPal PayIn"
method: PUT
path: "/v2.01/{ClientId}/payins/{PayInId}/trackings"
tags: ["PayPal"]
---

# Add tracking information to a PayPal PayIn

`PUT /v2.01/{ClientId}/payins/{PayInId}/trackings`

<Warning icon="fa-regular fa-triangle-exclamation">   
**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.   
</Warning>

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.

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

- `ClientId` string, required
- `PayInId` string, required

## Headers

- `Authorization` string, required

## Request body

- AddTrackingInformationToAPayPalPayInRequest
  - `TrackingNumber` string, required — The shipment’s tracking number provided by the carrier.
  - `Carrier` string, required — The carrier for the shipment. Use the country-specific version of the carrier if it exists, otherwise use its global version.
  - `NotifyBuyer` boolean — **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.

## Response `200`

Success

- AddTrackingInformationToAPayPalPayInResponse
  - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object.
  - `Tag` string — Max. length: 255 characters Custom data that you can add to this object.
  - `CreationDate` integer — Unix timestamp (UTC) of the date and time the object was created.
  - `AuthorId` string — The unique identifier of the user at the source of the transaction.
  - `DebitedFunds` AddTrackingInformationToAPayPalPayInResponseDebitedFunds — Information about the debited funds.
    - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
    - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
  - `CreditedFunds` AddTrackingInformationToAPayPalPayInResponseCreditedFunds — Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).
    - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
    - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
  - `Fees` AddTrackingInformationToAPayPalPayInResponseFees — Information about the fees.
    - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
    - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
  - `Status` string — **Returned values:** `CREATED`, `SUCCEEDED`, `FAILED` The status of the transaction.
  - `ResultCode` string — The code indicating the result of the operation. This information is mostly used to <a href="/errors/codes">handle errors</a> or for filtering purposes.
  - `ResultMessage` string — The explanation of the result code.
  - `ExecutionDate` integer — Unix timestamp (UTC) of the date and time the status changed to `SUCCEEDED`, indicating that the transaction occurred. The statuses `CREATED` and `FAILED` return an `ExecutionDate` of `null`.
  - `Type` string — **Returned values:** `PAYIN`, `TRANSFER`, `CONVERSION`, `PAYOUT` The type of the transaction.
  - `Nature` string — **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.
  - `CreditedWalletId` string — The unique identifier of the credited wallet.
  - `CreditedUserId` string — **Default value:** The unique identifier of the owner of the credited wallet. The unique identifier of the user whose wallet is credited.
  - `PaymentType` string — **Returned values:** `PAYPAL` The payment type of the pay-in.
  - `ExecutionType` string — **Returned values:** `WEB` The execution type of the pay-in.
  - `ReturnURL` string — Max. length: 255 characters The URL to which the user is returned after the payment, whether the transaction is successful or not.
  - `RedirectURL` string — 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.
  - `StatementDescriptor` string — 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 <a href="/bank-statements">Customizing bank statement references</a> article for details.
  - `Shipping` AddTrackingInformationToAPayPalPayInResponseShipping — Required if `ShippingPreference` is `SET_PROVIDED_ADDRESS`. Information about the end user’s shipping address, managed by `ShippingPreference`.
    - `FirstName` string — The first name of the user.
    - `LastName` string — The last name of the user.
    - `Address` Address — The postal address.
      - `AddressLine1` string — The first line of the address.
      - `AddressLine2` string — The second line of the address.
      - `City` string — The city of the address.
      - `Region` string — Required if `Country` is US, CA, or MX. The region of the address.
      - `PostalCode` string — The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
      - `Country` string — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address.
  - `LineItems` AddTrackingInformationToAPayPalPayInResponseLineItemsItems[] — 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).
    - `Name` string — The name of the item.
    - `Quantity` integer — The quantity of the item.
    - `UnitAmount` integer — The cost of the item, excluding tax.
    - `TaxAmount` integer — The tax amount applied to the item.
    - `Description` string — 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.
    - `Category` string — **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.
  - `Culture` string — **Returned values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): 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.
  - `ShippingPreference` string — **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.
  - `PaypalBuyerAccountEmail` string — The email address registered on the PayPal account used to make the payment.
  - `Reference` string — Max. length: 127 characters (truncated after) The platform’s order reference for the transaction.
  - `Trackings` AddTrackingInformationToAPayPalPayInResponseTrackingsItems[] — Shipping information of the `LineItems` added to the pay-in object.
    - `TrackingNumber` string — The shipment’s tracking number provided by the carrier.
    - `Carrier` string — The carrier for the shipment. Use the country-specific version of the carrier if it exists, otherwise use its global version.
    - `NotifyBuyer` boolean — **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.
  - `CancelURL` string — The URL to which the user is returned after canceling the payment. If not provided, the Cancel button returns the user to the `RedirectURL`.
  - `PaypalOrderID` string — PayPal's unique identifier for the order.
  - `BuyerCountry` string — The country of the buyer.
  - `BuyerFirstname` string — The first name of the buyer.
  - `BuyerPhone` string — The mobile phone number of the buyer.
  - `BuyerLastname` string — The last name of the buyer.
  - `PaypalPayerID` string — The PayPal identifier of the buyer.

---

[API](https://skmtc.net/mangopay/apis/api-reference.md) · [All operations](https://skmtc.net/mangopay/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mangopay/api-reference/versions/795281070285/schema)