POST
/
v2.01
/
{ClientId}
/
payins
/
payment-methods
/
paypal
/
recurring
{
    "ReturnURL": "http://example.com",
    "CancelURL" : "http://example.net",
    "LineItems": [
        {
            "Name": "Running shoes",
            "Quantity": 1,
            "UnitAmount": 4000,
            "TaxAmount": 1000,
            "Description": "ID of Seller 1",
            "Category": "PHYSICAL_GOODS"
        },
        {
            "Name": "Walking shoes",
            "Quantity": 1,
            "UnitAmount": 4000,
            "TaxAmount": 1000,
            "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_0c7bd61f-c3f0-49b7-94dc-b97bd650be3d",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1732630635,
    "AuthorId": "user_m_01J9KR16BG7EDC8RNEY2M18EXK",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 10000
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 9900
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 100
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01J9KR4A7BH8KVE4PG6DTNS817",
    "CreditedUserId": "user_m_01J9KR16BG7EDC8RNEY2M18EXK",
    "PaymentType": "PAYPAL",
    "ExecutionType": "WEB",
    "ReturnURL": "http://example.com?transactionId=wt_0c7bd61f-c3f0-49b7-94dc-b97bd650be3d",
    "RedirectURL": "https://www.sandbox.paypal.com/agreements/approve?approval_session_id=8C820771K64683846",
    "StatementDescriptor": "Example123",
    "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": "Product A subscription package",
            "Quantity": 1,
            "UnitAmount": 4000,
            "TaxAmount": 1000,
            "Description": "ID of Seller 1",
            "Category": "PHYSICAL_GOODS"
        },
        {
            "Name": "Product B subscription package",
            "Quantity": 1,
            "UnitAmount": 4000,
            "TaxAmount": 1000,
            "Description": "ID of Seller 2",
            "Category": "PHYSICAL_GOODS"
        }
    ],
    "Culture": null,
    "ShippingPreference": "SET_PROVIDED_ADDRESS",
    "PaypalBuyerAccountEmail": null,
    "Reference": "abcd-efgh-ijkl",
    "Trackings": null,
    "CancelURL": "http://example.net?transactionId=wt_0c7bd61f-c3f0-49b7-94dc-b97bd650be3d",
    "PaypalPayerID": null,
    "BuyerCountry": null,
    "BuyerFirstname": null,
    "BuyerLastname": null,
    "BuyerPhone": null,
    "PaypalOrderID": null,
    "RecurringPayinRegistrationId": "recpayinreg_wt_c1fb7e3f-8204-4427-9251-df886fbb4e42"
}
Read more about the Recurring PayPal PayIn object →

​
Body parameters

​
RecurringPayinRegistrationId
string
required
The unique identifier of the recurring pay-in registration.
​
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.
​
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.
​
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.

​
Responses

{
    "Id": "wt_0c7bd61f-c3f0-49b7-94dc-b97bd650be3d",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1732630635,
    "AuthorId": "user_m_01J9KR16BG7EDC8RNEY2M18EXK",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 10000
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 9900
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 100
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01J9KR4A7BH8KVE4PG6DTNS817",
    "CreditedUserId": "user_m_01J9KR16BG7EDC8RNEY2M18EXK",
    "PaymentType": "PAYPAL",
    "ExecutionType": "WEB",
    "ReturnURL": "http://example.com?transactionId=wt_0c7bd61f-c3f0-49b7-94dc-b97bd650be3d",
    "RedirectURL": "https://www.sandbox.paypal.com/agreements/approve?approval_session_id=8C820771K64683846",
    "StatementDescriptor": "Example123",
    "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": "Product A subscription package",
            "Quantity": 1,
            "UnitAmount": 4000,
            "TaxAmount": 1000,
            "Description": "ID of Seller 1",
            "Category": "PHYSICAL_GOODS"
        },
        {
            "Name": "Product B subscription package",
            "Quantity": 1,
            "UnitAmount": 4000,
            "TaxAmount": 1000,
            "Description": "ID of Seller 2",
            "Category": "PHYSICAL_GOODS"
        }
    ],
    "Culture": null,
    "ShippingPreference": "SET_PROVIDED_ADDRESS",
    "PaypalBuyerAccountEmail": null,
    "Reference": "abcd-efgh-ijkl",
    "Trackings": null,
    "CancelURL": "http://example.net?transactionId=wt_0c7bd61f-c3f0-49b7-94dc-b97bd650be3d",
    "PaypalPayerID": null,
    "BuyerCountry": null,
    "BuyerFirstname": null,
    "BuyerLastname": null,
    "BuyerPhone": null,
    "PaypalOrderID": null,
    "RecurringPayinRegistrationId": "recpayinreg_wt_c1fb7e3f-8204-4427-9251-df886fbb4e42"
}

{
    "ReturnURL": "http://example.com",
    "CancelURL" : "http://example.net",
    "LineItems": [
        {
            "Name": "Running shoes",
            "Quantity": 1,
            "UnitAmount": 4000,
            "TaxAmount": 1000,
            "Description": "ID of Seller 1",
            "Category": "PHYSICAL_GOODS"
        },
        {
            "Name": "Walking shoes",
            "Quantity": 1,
            "UnitAmount": 4000,
            "TaxAmount": 1000,
            "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"
}