Skip to main content
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.
​
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.
​
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.
​
PaymentType
string
Returned values: PAYPALThe type of pay-in.
​
ExecutionType
string
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.
​
ReturnURL
string
Max. length: 255 charactersThe 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 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.
​
LineItems
array
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
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_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.
​
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.
​
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.
​
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.
{
    "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"
}