PayPal

Create a PayPal PayIn

Changed on
<Warning icon="fa-regular fa-triangle-exclamation"> **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 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
  • Support for tracking information to sync evidence of shipped goods
  • Additional API payload data such as shipping preference, platform references, and PayPal user information
</Warning>
post/v2.01/{ClientId}/payins/paypal/web

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/payins/paypal/web
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

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

Request body

Tagstring

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

AuthorIdstring required

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

CreditedWalletIdstring required

The unique identifier of the credited wallet.

ReturnURLstring required

Max. length: 255 characters

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

Culturestring

Allowed values: One of the supported languages in the ISO 639-1 format: DE, EN, ES, FR, IT, NL, PL, PT.

The language in which the payment page is to be displayed.

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.

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, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

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.

CreditedUserIdstring

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

The unique identifier of the user whose wallet is credited.

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.

DebitedWalletIdstring

The unique identifier of the debited wallet.

PaymentTypestring

Returned values: PAYPAL

The payment type of the pay-in.

ExecutionTypestring

Returned values: WEB

The execution type of the pay-in.

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.

ReturnURLstring

Max. length: 255 characters

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

Culturestring

Returned values: One of the supported languages in the ISO 639-1 format: DE, EN, ES, FR, IT, NL, PL, PT.

The language in which the payment page is to be displayed.

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.

PaypalBuyerAccountEmailstring

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

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id create_paypal_payin_web removed and replaced with paypal_create_paypal_payin_web