Overview
User management
- Users
- User regulatory status
- User e-money
User verification
- User data format
- KYC documents
- UBO declarations
Wallets
- User wallets
- Client wallets
Cards
- Card registrations
- Cards
- Metadata
- Card validations
Card pay-ins
- Direct card pay-ins
- Recurring card pay-ins
- Preauthorizations
- Deposit preauthorizations
- Web card pay-ins
Banking pay-ins
- Bank wires
- Virtual IBAN
- Direct debits
- Web direct debits
APM pay-ins
- Apple Pay
- Bancontact
- BLIK
- Giropay
- Google Pay
- iDEAL
- Klarna
- MB WAY
- Multibanco
- Payconiq
- PayPal
- The PayPal PayIn object
- POSTCreate a PayPal PayIn
- PUTAdd tracking information to a PayPal PayIn
- GETView a PayIn (PayPal)
- POST[Deprecated] Create a PayPal PayIn
- The Recurring PayIn Registration object (PayPal)
- POSTCreate a Recurring PayIn Registration (PayPal)
- PUTUpdate a Recurring PayIn Registration (PayPal)
- GETView a Recurring PayIn Registration (PayPal)
- The Recurring PayPal PayIn object
- POSTCreate a Recurring PayPal PayIn (CIT)
- POSTCreate a Recurring PayPal PayIn (MIT)
- Satispay
- Swish
- TWINT
Transfers
- Transfers
Refunds
- Refunds
Disputes
- Disputes
- Dispute documents
- Repudiations
- Dispute settlement
Payouts
- Bank accounts
- Payouts
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
[Deprecated] Create a PayPal PayIn
{
"Tag": "Example of deprecated PayPal pay-in",
"AuthorId": "user_m_01JJ6ZQESERHQ3PYWZY5QFS1Z1",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 1980
},
"Fees": {
"Currency": "EUR",
"Amount": 0
},
"CreditedWalletId": "wlt_m_01JJ25YQA60D8FVZYEBMXG733F",
"ReturnURL": "https://example.com",
"Culture": "EN",
"ShippingAddress": {
"RecipientName": "Alex Smith",
"Address": {
"AddressLine1": "6 rue de la Cité",
"AddressLine2": "Appartement 3",
"City": "Paris",
"Region": "île-de-france",
"PostalCode": "75003",
"Country": "FR"
}
},
"StatementDescriptor": null
}
{
"Id": "payin_m_01JJ6ZR0EG3WEFX06DWD672816",
"Tag": "Example of deprecated PayPal pay-in",
"CreationDate": 1737544865,
"AuthorId": "user_m_01JJ6ZQESERHQ3PYWZY5QFS1Z1",
"CreditedUserId": "user_m_01JJ6ZQESERHQ3PYWZY5QFS1Z1",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 1980
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 1980
},
"Fees": {
"Currency": "EUR",
"Amount": 0
},
"Status": "CREATED",
"ResultCode": null,
"ResultMessage": null,
"ExecutionDate": null,
"Type": "PAYIN",
"Nature": "REGULAR",
"CreditedWalletId": "wlt_m_01JJ25YQA60D8FVZYEBMXG733F",
"DebitedWalletId": null,
"PaymentType": "PAYPAL",
"ExecutionType": "WEB",
"RedirectURL": "https://www.paypal.com/checkoutnow?token=1WB42231AB437123G",
"ReturnURL": "https://example.com?transactionId=payin_m_01JJ6ZR0EG3WEFX06DWD672816",
"Culture": "EN",
"ShippingAddress": {
"RecipientName": "Alex Smith",
"Address": {
"AddressLine1": "6 rue de la Cité",
"AddressLine2": "Appartement 3",
"City": "Paris",
"Region": "île-de-france",
"PostalCode": "75003",
"Country": "FR"
}
},
"PaypalBuyerAccountEmail": null,
"StatementDescriptor": null
}
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
Body parameters
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.
The unique identifier of the user at the source of the transaction.
Information about the debited funds. The amount must be equal to the total of all UnitAmount and TaxAmount of all LineItems.
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.
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).
Information about the fees.
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.
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).
The unique identifier of the credited wallet.
Max. length: 255 characters
The URL to which the user is returned after the payment, whether the transaction is successful or not.
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.
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.
The full name of the shipping addressee.
Information about the shipping address.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
Required if Country is US, CA, or MX.
The region of the address.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country of the address.
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.
Responses
The unique identifier of the object.
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.
The date and time at which the object was created.
The unique identifier of the user at the source of the transaction.
Default value: The unique identifier of the owner of the credited wallet.
The unique identifier of the user whose wallet is credited.
Information about the debited funds. The amount must be equal to the total of all UnitAmount and TaxAmount of all LineItems.
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.
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).
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
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.
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).
Information about the fees.
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.
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).
Returned values: CREATED, SUCCEEDED, FAILED
The status of the transaction.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
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.
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT
The type of the transaction.
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.
The unique identifier of the credited wallet.
The unique identifier of the debited wallet.
Returned values: PAYPAL
The type of pay-in.
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION
The type of execution for the pay-in.
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.
Max. length: 255 characters
The URL to which the user is returned after the payment, whether the transaction is successful or not.
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.
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.
The full name of the shipping addressee.
Information about the shipping address.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the Country is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country of the address.
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.
The email address registered on the PayPal account used to make the payment.
{
"Id": "payin_m_01JJ6ZR0EG3WEFX06DWD672816",
"Tag": "Example of deprecated PayPal pay-in",
"CreationDate": 1737544865,
"AuthorId": "user_m_01JJ6ZQESERHQ3PYWZY5QFS1Z1",
"CreditedUserId": "user_m_01JJ6ZQESERHQ3PYWZY5QFS1Z1",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 1980
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 1980
},
"Fees": {
"Currency": "EUR",
"Amount": 0
},
"Status": "CREATED",
"ResultCode": null,
"ResultMessage": null,
"ExecutionDate": null,
"Type": "PAYIN",
"Nature": "REGULAR",
"CreditedWalletId": "wlt_m_01JJ25YQA60D8FVZYEBMXG733F",
"DebitedWalletId": null,
"PaymentType": "PAYPAL",
"ExecutionType": "WEB",
"RedirectURL": "https://www.paypal.com/checkoutnow?token=1WB42231AB437123G",
"ReturnURL": "https://example.com?transactionId=payin_m_01JJ6ZR0EG3WEFX06DWD672816",
"Culture": "EN",
"ShippingAddress": {
"RecipientName": "Alex Smith",
"Address": {
"AddressLine1": "6 rue de la Cité",
"AddressLine2": "Appartement 3",
"City": "Paris",
"Region": "île-de-france",
"PostalCode": "75003",
"Country": "FR"
}
},
"PaypalBuyerAccountEmail": null,
"StatementDescriptor": null
}
{
"Tag": "Example of deprecated PayPal pay-in",
"AuthorId": "user_m_01JJ6ZQESERHQ3PYWZY5QFS1Z1",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 1980
},
"Fees": {
"Currency": "EUR",
"Amount": 0
},
"CreditedWalletId": "wlt_m_01JJ25YQA60D8FVZYEBMXG733F",
"ReturnURL": "https://example.com",
"Culture": "EN",
"ShippingAddress": {
"RecipientName": "Alex Smith",
"Address": {
"AddressLine1": "6 rue de la Cité",
"AddressLine2": "Appartement 3",
"City": "Paris",
"Region": "île-de-france",
"PostalCode": "75003",
"Country": "FR"
}
},
"StatementDescriptor": null
}
Was this page helpful?
{
"Tag": "Example of deprecated PayPal pay-in",
"AuthorId": "user_m_01JJ6ZQESERHQ3PYWZY5QFS1Z1",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 1980
},
"Fees": {
"Currency": "EUR",
"Amount": 0
},
"CreditedWalletId": "wlt_m_01JJ25YQA60D8FVZYEBMXG733F",
"ReturnURL": "https://example.com",
"Culture": "EN",
"ShippingAddress": {
"RecipientName": "Alex Smith",
"Address": {
"AddressLine1": "6 rue de la Cité",
"AddressLine2": "Appartement 3",
"City": "Paris",
"Region": "île-de-france",
"PostalCode": "75003",
"Country": "FR"
}
},
"StatementDescriptor": null
}
{
"Id": "payin_m_01JJ6ZR0EG3WEFX06DWD672816",
"Tag": "Example of deprecated PayPal pay-in",
"CreationDate": 1737544865,
"AuthorId": "user_m_01JJ6ZQESERHQ3PYWZY5QFS1Z1",
"CreditedUserId": "user_m_01JJ6ZQESERHQ3PYWZY5QFS1Z1",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 1980
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 1980
},
"Fees": {
"Currency": "EUR",
"Amount": 0
},
"Status": "CREATED",
"ResultCode": null,
"ResultMessage": null,
"ExecutionDate": null,
"Type": "PAYIN",
"Nature": "REGULAR",
"CreditedWalletId": "wlt_m_01JJ25YQA60D8FVZYEBMXG733F",
"DebitedWalletId": null,
"PaymentType": "PAYPAL",
"ExecutionType": "WEB",
"RedirectURL": "https://www.paypal.com/checkoutnow?token=1WB42231AB437123G",
"ReturnURL": "https://example.com?transactionId=payin_m_01JJ6ZR0EG3WEFX06DWD672816",
"Culture": "EN",
"ShippingAddress": {
"RecipientName": "Alex Smith",
"Address": {
"AddressLine1": "6 rue de la Cité",
"AddressLine2": "Appartement 3",
"City": "Paris",
"Region": "île-de-france",
"PostalCode": "75003",
"Country": "FR"
}
},
"PaypalBuyerAccountEmail": null,
"StatementDescriptor": null
}