v2

latestOpenAPI 3.1.02026-07-262279731.3 MB

PayPal

Add tracking information to a PayPal PayIn

<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>

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.

put/v2.01/{ClientId}/payins/{PayInId}/trackings

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

PayInIdstring required

The unique identifier of the pay-in.

Headers

Authorizationstring required

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Request body

TrackingNumberstring required

The shipment’s tracking number provided by the carrier.

Carrierstring required

The carrier for the shipment. Use the country-specific version of the carrier if it exists, otherwise use its global version.

NotifyBuyerboolean

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

Success

Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

AuthorIdstring

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

Statusstring

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ResultCodestring

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.

ResultMessagestring

The explanation of the result code.

ExecutionDateinteger

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.

Typestring

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Naturestring

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.

CreditedWalletIdstring

The unique identifier of the credited wallet.

CreditedUserIdstring

Default value: The unique identifier of the owner of the credited wallet.

The unique identifier of the user whose wallet is credited.

PaymentTypestring

Returned values: PAYPAL

The payment type of the pay-in.

ExecutionTypestring

Returned values: WEB

The execution type of the pay-in.

ReturnURLstring

Max. length: 255 characters

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

RedirectURLstring

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.

StatementDescriptorstring

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.

Culturestring

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.

ShippingPreferencestring

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.

PaypalBuyerAccountEmailstring

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

Referencestring

Max. length: 127 characters (truncated after)

The platform’s order reference for the transaction.

CancelURLstring

The URL to which the user is returned after canceling the payment. If not provided, the Cancel button returns the user to the RedirectURL.

PaypalOrderIDstring

PayPal's unique identifier for the order.

BuyerCountrystring

The country of the buyer.

BuyerFirstnamestring

The first name of the buyer.

BuyerPhonestring

The mobile phone number of the buyer.

BuyerLastnamestring

The last name of the buyer.

PaypalPayerIDstring

The PayPal identifier of the buyer.