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
Create a Recurring PayPal PayIn (MIT)
{
"DebitedFunds": {
"Currency": "EUR",
"Amount": 4500
},
"Fees": {
"Currency": "EUR",
"Amount": 0
},
"ReturnURL": "http://example.com",
"CancelURL" : "http://example.net",
"LineItems": [
{
"Name": "Product C",
"Quantity": 1,
"UnitAmount": 1500,
"TaxAmount": 0,
"Description": "ID of Seller 1",
"Category": "PHYSICAL_GOODS"
},
{
"Name": "Product D",
"Quantity": 1,
"UnitAmount": 3000,
"TaxAmount": 0,
"Description": "ID of Seller 2",
"Category": "PHYSICAL_GOODS"
}
],
"Tag": "Created using the Mangopay API Postman collection",
"RecurringPayinRegistrationId" : "recpayinreg_wt_be7e55b9-8b0c-4a87-a815-00e55748c723",
"ShippingPreference": "SET_PROVIDED_ADDRESS",
"Reference": "abcd-efgh-ijkl",
"StatementDescriptor" : "Example123"
}
{
"Id": "wt_70621ad8-4ea8-4ea5-9893-b4b5ebb1da17",
"Tag": "Created using the Mangopay API Postman collection",
"CreationDate": 1731580317,
"AuthorId": "user_m_01J9KR16BG7EDC8RNEY2M18EXK",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 4500
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 4500
},
"Fees": {
"Currency": "EUR",
"Amount": 0
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1731580323,
"Type": "PAYIN",
"Nature": "REGULAR",
"CreditedWalletId": "wlt_m_01J9KR4A7BH8KVE4PG6DTNS817",
"CreditedUserId": "user_m_01J9KR16BG7EDC8RNEY2M18EXK",
"PaymentType": "PAYPAL",
"ExecutionType": "WEB",
"ReturnURL": "http://example.com?transactionId=wt_70621ad8-4ea8-4ea5-9893-b4b5ebb1da17",
"StatementDescriptor": "Example123",
"Shipping": {
"FirstName": "Leland",
"LastName": "Baumbach",
"Address": {
"AddressLine1": "65247 Hand Walk",
"AddressLine2": "Mraz Neck",
"City": "Paris",
"Region": "Île-de-France",
"PostalCode": "75001",
"Country": "FR"
}
},
"LineItems": [
{
"Name": "Product C",
"Quantity": 1,
"UnitAmount": 1500,
"TaxAmount": 0,
"Description": "ID of Seller 1",
"Category": "PHYSICAL_GOODS"
},
{
"Name": "Product D",
"Quantity": 1,
"UnitAmount": 3000,
"TaxAmount": 0,
"Description": "ID of Seller 2",
"Category": "PHYSICAL_GOODS"
}
],
"Culture": "FR",
"ShippingPreference": "SET_PROVIDED_ADDRESS",
"PaypalBuyerAccountEmail": "sb-xej7a6945106@business.example.com",
"Reference": "abcd-efgh-ijkl",
"Trackings": null,
"CancelURL": "http://google.com?transactionId=wt_70621ad8-4ea8-4ea5-9893-b4b5ebb1da17",
"PaypalPayerID": "RVN3GJJS2KGV4",
"BuyerCountry": "FR",
"BuyerFirstname": "John",
"BuyerLastname": "Doe",
"BuyerPhone": null,
"PaypalOrderID": "9KH88598NK328901B",
"RecurringPayinRegistrationId": "recpayinreg_wt_c1fb7e3f-8204-4427-9251-df886fbb4e42"
}
Read more about the Recurring PayPal PayIn object →
Body parameters
Required if the registration’s NextTransactionDebitedFunds
is empty.
The amount of the subsequent recurring pay-in. If this field is empty, the amount entered in the NextTransactionDebitedFunds
of the Recurring PayIn Registration is taken into account.
Caution: An amount must be transmitted during either the recurring registration or pay-in (if it’s different from the registration one).
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 debited 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
).
Required if the registration’s NextTransactionFees
is empty.
The amount of the subsequent fees. If this field is empty, the amount entered in the NextTransactionFees
of the Recurring PayIn Registration is taken into account.
Caution: An amount must be transmitted during either the recurring registration or pay-in (if it’s different from the registration one).
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
).
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.
Max. length: 255 characters
The URL to which the user is returned after the payment, whether the transaction is successful or not.
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.
Default values: Shipping
information of the registration object (if present).
Required if ShippingPreference
is SET_PROVIDED_ADDRESS
and the shipping information is not present in the recurring registration object.
Information about the end user’s shipping address, managed by ShippingPreference
.
The first name of the user.
Max. length: 100 characters
The last name of the user.
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.
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).
Max. length: 127 characters (truncated after)
The name of the item.
The quantity of the item.
The cost of the item, excluding tax.
The tax amount applied to the item.
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.
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 asDONATION
within a single transaction, however it is not possible to combineDONATION
other line item categories within the same transaction.
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.
Allowed values: SET_PROVIDED_ADDRESS
, GET_FROM_FILE
, NO_SHIPPING
Information about the shipping address behavior on the PayPal payment page:
SET_PROVIDED_ADDRESS
- TheShipping
parameter becomes required and its values are displayed to the end user, who is not able to modify them.GET_FROM_FILE
– TheShipping
parameter is ignored and the end user can choose from registered addresses.NO_SHIPPING
– No shipping address section is displayed.
Max. length: 127 characters (truncated after)
The platform’s order reference for the transaction.
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.
The amount of the subsequent recurring pay-in. If this field is empty, the amount entered in the NextTransactionDebitedFunds
of the Recurring PayIn Registration is taken into account.
Caution: An amount must be transmitted during either the recurring registration or pay-in (if it’s different from the registration one).
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 debited 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 credited 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
).
The amount of the subsequent fees. If this field is empty, the amount entered in the NextTransactionFees
of the Recurring PayIn Registration is taken into account.
Caution: An amount must be transmitted during either the recurring registration or pay-in (if it’s different from the registration one).
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.
Returned values: WEB
, DIRECT
, EXTERNAL_INSTRUCTION
The type of execution for the pay-in.
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.
Default values: Shipping
information of the recurring pay-in registration object (if present).
Information about the end user’s shipping address, managed by ShippingPreference
.
The first name of the user.
Max. length: 100 characters
The last name of the user.
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.
The unique identifier of the recurring pay-in registration. On PayPal, this parameter is only returned if the pay-in is a recurring one.
{
"Id": "wt_70621ad8-4ea8-4ea5-9893-b4b5ebb1da17",
"Tag": "Created using the Mangopay API Postman collection",
"CreationDate": 1731580317,
"AuthorId": "user_m_01J9KR16BG7EDC8RNEY2M18EXK",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 4500
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 4500
},
"Fees": {
"Currency": "EUR",
"Amount": 0
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1731580323,
"Type": "PAYIN",
"Nature": "REGULAR",
"CreditedWalletId": "wlt_m_01J9KR4A7BH8KVE4PG6DTNS817",
"CreditedUserId": "user_m_01J9KR16BG7EDC8RNEY2M18EXK",
"PaymentType": "PAYPAL",
"ExecutionType": "WEB",
"ReturnURL": "http://example.com?transactionId=wt_70621ad8-4ea8-4ea5-9893-b4b5ebb1da17",
"StatementDescriptor": "Example123",
"Shipping": {
"FirstName": "Leland",
"LastName": "Baumbach",
"Address": {
"AddressLine1": "65247 Hand Walk",
"AddressLine2": "Mraz Neck",
"City": "Paris",
"Region": "Île-de-France",
"PostalCode": "75001",
"Country": "FR"
}
},
"LineItems": [
{
"Name": "Product C",
"Quantity": 1,
"UnitAmount": 1500,
"TaxAmount": 0,
"Description": "ID of Seller 1",
"Category": "PHYSICAL_GOODS"
},
{
"Name": "Product D",
"Quantity": 1,
"UnitAmount": 3000,
"TaxAmount": 0,
"Description": "ID of Seller 2",
"Category": "PHYSICAL_GOODS"
}
],
"Culture": "FR",
"ShippingPreference": "SET_PROVIDED_ADDRESS",
"PaypalBuyerAccountEmail": "sb-xej7a6945106@business.example.com",
"Reference": "abcd-efgh-ijkl",
"Trackings": null,
"CancelURL": "http://google.com?transactionId=wt_70621ad8-4ea8-4ea5-9893-b4b5ebb1da17",
"PaypalPayerID": "RVN3GJJS2KGV4",
"BuyerCountry": "FR",
"BuyerFirstname": "John",
"BuyerLastname": "Doe",
"BuyerPhone": null,
"PaypalOrderID": "9KH88598NK328901B",
"RecurringPayinRegistrationId": "recpayinreg_wt_c1fb7e3f-8204-4427-9251-df886fbb4e42"
}
{
"DebitedFunds": {
"Currency": "EUR",
"Amount": 4500
},
"Fees": {
"Currency": "EUR",
"Amount": 0
},
"ReturnURL": "http://example.com",
"CancelURL" : "http://example.net",
"LineItems": [
{
"Name": "Product C",
"Quantity": 1,
"UnitAmount": 1500,
"TaxAmount": 0,
"Description": "ID of Seller 1",
"Category": "PHYSICAL_GOODS"
},
{
"Name": "Product D",
"Quantity": 1,
"UnitAmount": 3000,
"TaxAmount": 0,
"Description": "ID of Seller 2",
"Category": "PHYSICAL_GOODS"
}
],
"Tag": "Created using the Mangopay API Postman collection",
"RecurringPayinRegistrationId" : "recpayinreg_wt_be7e55b9-8b0c-4a87-a815-00e55748c723",
"ShippingPreference": "SET_PROVIDED_ADDRESS",
"Reference": "abcd-efgh-ijkl",
"StatementDescriptor" : "Example123"
}
Was this page helpful?
{
"DebitedFunds": {
"Currency": "EUR",
"Amount": 4500
},
"Fees": {
"Currency": "EUR",
"Amount": 0
},
"ReturnURL": "http://example.com",
"CancelURL" : "http://example.net",
"LineItems": [
{
"Name": "Product C",
"Quantity": 1,
"UnitAmount": 1500,
"TaxAmount": 0,
"Description": "ID of Seller 1",
"Category": "PHYSICAL_GOODS"
},
{
"Name": "Product D",
"Quantity": 1,
"UnitAmount": 3000,
"TaxAmount": 0,
"Description": "ID of Seller 2",
"Category": "PHYSICAL_GOODS"
}
],
"Tag": "Created using the Mangopay API Postman collection",
"RecurringPayinRegistrationId" : "recpayinreg_wt_be7e55b9-8b0c-4a87-a815-00e55748c723",
"ShippingPreference": "SET_PROVIDED_ADDRESS",
"Reference": "abcd-efgh-ijkl",
"StatementDescriptor" : "Example123"
}
{
"Id": "wt_70621ad8-4ea8-4ea5-9893-b4b5ebb1da17",
"Tag": "Created using the Mangopay API Postman collection",
"CreationDate": 1731580317,
"AuthorId": "user_m_01J9KR16BG7EDC8RNEY2M18EXK",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 4500
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 4500
},
"Fees": {
"Currency": "EUR",
"Amount": 0
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1731580323,
"Type": "PAYIN",
"Nature": "REGULAR",
"CreditedWalletId": "wlt_m_01J9KR4A7BH8KVE4PG6DTNS817",
"CreditedUserId": "user_m_01J9KR16BG7EDC8RNEY2M18EXK",
"PaymentType": "PAYPAL",
"ExecutionType": "WEB",
"ReturnURL": "http://example.com?transactionId=wt_70621ad8-4ea8-4ea5-9893-b4b5ebb1da17",
"StatementDescriptor": "Example123",
"Shipping": {
"FirstName": "Leland",
"LastName": "Baumbach",
"Address": {
"AddressLine1": "65247 Hand Walk",
"AddressLine2": "Mraz Neck",
"City": "Paris",
"Region": "Île-de-France",
"PostalCode": "75001",
"Country": "FR"
}
},
"LineItems": [
{
"Name": "Product C",
"Quantity": 1,
"UnitAmount": 1500,
"TaxAmount": 0,
"Description": "ID of Seller 1",
"Category": "PHYSICAL_GOODS"
},
{
"Name": "Product D",
"Quantity": 1,
"UnitAmount": 3000,
"TaxAmount": 0,
"Description": "ID of Seller 2",
"Category": "PHYSICAL_GOODS"
}
],
"Culture": "FR",
"ShippingPreference": "SET_PROVIDED_ADDRESS",
"PaypalBuyerAccountEmail": "sb-xej7a6945106@business.example.com",
"Reference": "abcd-efgh-ijkl",
"Trackings": null,
"CancelURL": "http://google.com?transactionId=wt_70621ad8-4ea8-4ea5-9893-b4b5ebb1da17",
"PaypalPayerID": "RVN3GJJS2KGV4",
"BuyerCountry": "FR",
"BuyerFirstname": "John",
"BuyerLastname": "Doe",
"BuyerPhone": null,
"PaypalOrderID": "9KH88598NK328901B",
"RecurringPayinRegistrationId": "recpayinreg_wt_c1fb7e3f-8204-4427-9251-df886fbb4e42"
}