--- title: "Create a PayPal PayIn" method: POST path: "/v2.01/{ClientId}/payins/paypal/web" tags: ["PayPal"] --- # Create a PayPal PayIn `POST /v2.01/{ClientId}/payins/paypal/web` **Caution – Deprecated legacy integration** This endpoint is the legacy integration of PayPal with Mangopay. If you are integrating PayPal for the first time, use the new [POST Create a PayPal PayIn](/api-reference/paypal/create-paypal-payin) endpoint. Existing legacy integrations continue to be supported, but any integration enhancements are only developed on the new endpoint. Platforms are strongly encouraged to move to the new integration to benefit from additional features, including: - [Recurring payment flows](/guides/payment-methods/paypal#recurring-payments) - Support for [tracking information](/guides/payment-methods/paypal#tracking-information) to sync evidence of shipped goods - Additional API payload data such as shipping preference, platform references, and PayPal user information ## Path parameters - `ClientId` string, required ## Headers - `Authorization` string, required ## Request body - DeprecatedCreateAPayPalPayInRequest - `Tag` string — Max. length: 255 characters Custom data that you can add to this object. - `AuthorId` string, required — The unique identifier of the user at the source of the transaction. - `DebitedFunds` DeprecatedCreateAPayPalPayInRequestDebitedFunds, required — Information about the debited funds. - `Currency` string, required — **Allowed 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 amount. - `Amount` integer, required — 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` DeprecatedCreateAPayPalPayInRequestFees, required — Information about the fees. - `Currency` string, required — **Allowed 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 amount. - `Amount` integer, required — 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`. - `CreditedWalletId` string, required — The unique identifier of the credited wallet. - `ReturnURL` string, required — Max. length: 255 characters The URL to which the user is returned after the payment, whether the transaction is successful or not. - `Culture` string — **Allowed values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): DE, EN, ES, FR, IT, NL, PL, PT. The language in which the payment page is to be displayed. - `ShippingAddress` DeprecatedCreateAPayPalPayInRequestShippingAddress — Information about the shipping recipient and address for the transaction. If sent, this information overrides the user's PayPal shipping address. If not sent, the user's PayPal shipping address is used. - `RecipientName` string, required — The full name of the shipping addressee. - `Address` AddressSubPropsRequired, required — The postal address. - `AddressLine1` string, required — The first line of the address. - `AddressLine2` string — The second line of the address. - `City` string, required — The city of the address. - `Region` string — Required if `Country` is US, CA, or MX. The region of the address. - `PostalCode` string, required — The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces. - `Country` string, required — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `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 Customizing bank statement references article for details. ## Response `200` Success - DeprecatedPayPalPayInResponse - `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. - `CreditedUserId` string — **Default value:** The unique identifier of the owner of the credited wallet. The unique identifier of the user whose wallet is credited. - `DebitedFunds` DeprecatedPayPalPayInResponseDebitedFunds — Information about the debited funds. - `Currency` string — **Allowed 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 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` DeprecatedPayPalPayInResponseCreditedFunds — Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`). - `Currency` string — **Allowed 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 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` DeprecatedPayPalPayInResponseFees — Information about the fees. - `Currency` string — **Allowed 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 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 handle errors 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. - `DebitedWalletId` string — The unique identifier of the debited wallet. - `PaymentType` string — **Returned values:** `PAYPAL` The payment type of the pay-in. - `ExecutionType` string — **Returned values:** `WEB` The execution type of the pay-in. - `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. - `ReturnURL` string — Max. length: 255 characters The URL to which the user is returned after the payment, whether the transaction is successful or not. - `Culture` string — **Returned values:** One of the supported languages in the [ISO 639-1 format](/api-reference/overview/data-formats): DE, EN, ES, FR, IT, NL, PL, PT. The language in which the payment page is to be displayed. - `ShippingAddress` DeprecatedPayPalPayInResponseShippingAddress — Information about the shipping recipient and address for the transaction. If sent, this information overrides the user's PayPal shipping address. If not sent, the user's PayPal shipping address is used. - `RecipientName` string — The full name of the shipping addressee. - `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. - `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 Customizing bank statement references article for details. - `PaypalBuyerAccountEmail` string — The email address registered on the PayPal account used to make the payment. --- [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)