Skip to main content
POST
/
v2.01
/
{ClientId}
/
payins
/
payment-methods
/
paypal
/
recurring
{
    "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://example.net?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

​
DebitedFunds
object
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).
​
Fees
object
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).
​
Tag
string
Max. length: 255 charactersCustom 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.
​
ReturnURL
string
required
Max. length: 255 charactersThe 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 spacesCustom 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
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.
​
LineItems
array
required
objectInformation 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).
​
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_SHIPPINGInformation 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.
​
DataCollectionId
string
The unique identifier of the Data Collection object containing the data sent for this pay-in via the POST Submit data for a PayPal PayIn endpoint.Each pay-in requires a new DataCollectionId and the property is not returned on the pay-in endpoint.

​
Responses

​
Id
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
Tag
string
Max. length: 255 charactersCustom 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
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).
​
CreditedFunds
object
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
​
Fees
object
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).
​
Status
string
Returned values: CREATED, SUCCEEDED, FAILEDThe 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, PAYOUTThe type of the transaction.
​
Nature
string
Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENTThe 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.
​
ExecutionType
string
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.
​
StatementDescriptor
string
Max. length: 10 characters; only alphanumeric and spacesCustom 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
Default values: Shipping information of the recurring pay-in registration object (if present).Information about the end user’s shipping address, managed by ShippingPreference.
​
RecurringPayinRegistrationId
string
The unique identifier of the recurring pay-in registration. On PayPal, this parameter is only returned if the pay-in is a recurring one.
{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "6224dcac-cf20-4305-98f0-6ba622090e53",
    "Date": 1760624922.0,
    "errors": {
        "DebitedFunds": "must not be specified for a free cycle."
    }
}

{
    "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://example.net?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"
}