Create a PayPal PayIn

Body parameters

Tag · string

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.

AuthorId · string · required

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

DebitedFunds · object · required

Information about the debited funds. The amount must be equal to the total of all UnitAmount and TaxAmount of all LineItems.

Show properties

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

Amount · integer · required

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

Fees · object · required

Information about the fees.

Show properties

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

Amount · integer · required

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

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.

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.

Shipping · object

Required if ShippingPreference is SET_PROVIDED_ADDRESS.

Information about the end user’s shipping address, managed by ShippingPreference.

Show properties

FirstName · string

The first name of the user.

LastName · string

Max. length: 100 characters

The last name of the user.

Address · object · required

Information about the shipping address.

Show properties

AddressLine1 · string · required

Max. length: 255 characters

The first line of the address.

AddressLine2 · string

Max. length: 255 characters

The second line of the address.

City · string · required

Max. length: 255 characters

The city of the address.

Region · string

Max. length: 255 characters

Required if Country is US, CA, or MX.

The region of the address.

PostalCode · string · required

Max. length: 255 characters

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)

The country of the address.

LineItems · array · required

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

Show properties

Name · string · required

Max. length: 127 characters (truncated after)

The name of the item.

Quantity · integer · required

The quantity of the item.

UnitAmount · integer · required

The cost of the item, excluding tax.

TaxAmount · integer

The tax amount applied to the item.

Description · string · required

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.

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

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

ShippingPreference · string

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

Reference · string

Max. length: 127 characters (truncated after)

The platform’s order reference for the transaction.

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.

ProfilingAttemptReference · string

The unique reference generated for the profiling session, used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.

Note: Parameter not returned by the API. Profiling feature available on request – contact Mangopay via the Dashboard for more information.

Responses

200 - Created

Id · string

Max length: 128 characters (see 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.
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.

CreationDate · Unix timestamp

The date and time at which the object was created.

AuthorId · string

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

DebitedFunds · object

Information about the debited funds. The amount must be equal to the total of all UnitAmount and TaxAmount of all LineItems.

Show properties

Currency · string

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.

Amount · integer

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

CreditedFunds · object

Information about the credited funds (CreditedFunds = DebitedFunds - Fees).

Show properties

Currency · string

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.

Amount · integer

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

Fees · object

Information about the fees.

Show properties

Currency · string

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.

Amount · integer

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

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 · Unix timestamp

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.

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.

PaymentType · string

Returned values: PAYPAL

The type of pay-in.

ExecutionType · string

Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION

The type of execution for 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 Customizing bank statement references article for details.

Shipping · object

Information about the end user’s shipping address, managed by ShippingPreference.

Show properties

FirstName · string

The first name of the user.

LastName · string

Max. length: 100 characters

The last name of the user.

Address · object

Information about the shipping address.

Show properties

AddressLine1 · string

Max. length: 255 characters

The first line of the address.

AddressLine2 · string

Max. length: 255 characters

The second line of the address.

City · string

Max. length: 255 characters

The city of the address.

Region · string

Max. length: 255 characters

The region of the address. This field is optional except if the Country is US, CA, or MX.

PostalCode · string

Max. length: 255 characters

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)

The country of the address.

LineItems · array

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

Show properties

Name · string

Max. length: 127 characters (truncated after)

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

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.

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: 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 · array (object)

Shipping information of the LineItems added to the pay-in object.

Show properties

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

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.

400 - Shipping required if ShippingPreference is SET_PROVIDED_ADDRESS

{
    "message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "id": "ec5265c3-4c41-47fe-a7f5-5f6bfc6cc34c",
    "date": 1694613912,
    "type": "param_error",
    "errors": {
        "shipping": "The shipping address is required when `ShippingPreference=SET_PROVIDED_ADDRESS`"
    }
}

400 - DebitedFunds amount must equal LineItems total

{
    "message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "id": "58bf1a12-65e0-4298-a1cb-62dc800bcf84",
    "date": 1699366251,
    "type": "param_error",
    "errors": {
        "debitedAmount": "DebitedAmount has to be equal to the total amount of all the line items."
    }
}  

200 - Created

  {
    "Id": "wt_f79a219d-c952-41a0-9bc4-e575f8f1ef7a",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1711032499,
    "AuthorId": "user_m_01HS10X7WCFSVMAZTBVYY0HPXF",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 1500
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 1200
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 300
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01HS10XBZQHDWSX10WW6RTMRA6",
    "CreditedUserId": "user_m_01HS10X7WCFSVMAZTBVYY0HPXF",
    "PaymentType": "PAYPAL",
    "ExecutionType": "WEB",
    "ReturnURL": "http://www.mangopay.com/docs/please-ignore?transactionId=wt_f79a219d-c952-41a0-9bc4-e575f8f1ef7a",
    "RedirectURL": "https://www.sandbox.paypal.com/checkoutnow?token=6MH08891XC585490F",
    "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": null,
    "Reference": "1234",
    "Trackings": null,
    "CancelURL": "http://www.example.com/?transactionId=wt_f79a219d-c952-41a0-9bc4-e575f8f1ef7a",
    "PaypalPayerID": null,
    "BuyerCountry": null,
    "BuyerFirstname": null,
    "BuyerLastname": null,
    "BuyerPhone": null,
    "PaypalOrderID": "6MH08891XC585490F"
}

REST

{
    "Tag": "Created using the Mangopay API Postman collection",
    "AuthorId": "user_m_01HS10X7WCFSVMAZTBVYY0HPXF",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 1500
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 300
    },
    "CreditedWalletId": "wlt_m_01HS10XBZQHDWSX10WW6RTMRA6",
    "ReturnURL": "http://www.mangopay.com/docs/please-ignore",
    "CancelURL": "http://www.example.com/",
    "StatementDescriptor": "MGP",
    "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",
    "Reference": "1234"
}