Create a Recurring PayPal PayIn (CIT or MIT)

POST

/v2.01/:ClientId/payins/payment-methods/paypal/recurring

POST

/v2.01/:ClientId/payins/payment-methods/paypal/recurring

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/payins/payment-methods/paypal/recurring \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "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"
>   }
> }'

1 {
2   "Id": "wt_0c7bd61f-c3f0-49b7-94dc-b97bd650be3d",
3   "Tag": "Created using the Mangopay API Postman collection",
4   "CreationDate": 1732630635,
5   "AuthorId": "user_m_01J9KR16BG7EDC8RNEY2M18EXK",
6   "DebitedFunds": {
7     "Currency": "EUR",
8     "Amount": 10000
9   },
10   "CreditedFunds": {
11     "Currency": "EUR",
12     "Amount": 9900
13   },
14   "Fees": {
15     "Currency": "EUR",
16     "Amount": 100
17   },
18   "Status": "CREATED",
19   "ResultCode": null,
20   "ResultMessage": null,
21   "ExecutionDate": null,
22   "Type": "PAYIN",
23   "Nature": "REGULAR",
24   "CreditedWalletId": "wlt_m_01J9KR4A7BH8KVE4PG6DTNS817",
25   "PaymentType": "PAYPAL",
26   "ExecutionType": "WEB",
27   "ReturnURL": "http://example.com?transactionId=wt_0c7bd61f-c3f0-49b7-94dc-b97bd650be3d",
28   "RedirectURL": "https://www.sandbox.paypal.com/agreements/approve?approval_session_id=8C820771K64683846",
29   "StatementDescriptor": "Example123",
30   "Shipping": {
31     "FirstName": "Alex",
32     "LastName": "Smith",
33     "Address": {
34       "AddressLine1": "6 rue de la Cité",
35       "AddressLine2": "Appartement 3",
36       "City": "Paris",
37       "Region": "île-de-france",
38       "PostalCode": "75003",
39       "Country": "FR"
40     }
41   },
42   "LineItems": [
43     {
44       "Name": "Product A subscription package",
45       "Quantity": 1,
46       "UnitAmount": 4000,
47       "TaxAmount": 1000,
48       "Description": "ID of Seller 1",
49       "Category": "PHYSICAL_GOODS"
50     },
51     {
52       "Name": "Product B subscription package",
53       "Quantity": 1,
54       "UnitAmount": 4000,
55       "TaxAmount": 1000,
56       "Description": "ID of Seller 2",
57       "Category": "PHYSICAL_GOODS"
58     }
59   ],
60   "Culture": null,
61   "ShippingPreference": "SET_PROVIDED_ADDRESS",
62   "PaypalBuyerAccountEmail": null,
63   "Reference": "abcd-efgh-ijkl",
64   "Trackings": null,
65   "CancelURL": "http://example.net?transactionId=wt_0c7bd61f-c3f0-49b7-94dc-b97bd650be3d",
66   "PaypalOrderID": null,
67   "BuyerCountry": null,
68   "BuyerFirstname": null,
69   "BuyerPhone": null,
70   "BuyerLastname": null,
71   "PaypalPayerID": null,
72   "RecurringPayinRegistrationId": "recpayinreg_wt_c1fb7e3f-8204-4427-9251-df886fbb4e42",
73   "CreditedUserId": "user_m_01J9KR16BG7EDC8RNEY2M18EXK"
74 }

Request a recurring PayPal pay-in based on a RecurringPayinRegistrationId with PaymentType PAYPAL, obtained from POST Create a Recurring PayIn Registration.

There are two possible paylods:

CIT – Customer-initiated transaction when the user is on session, requiring them to authenticate via PayPal on the RedirectURL returned.
MIT – Subsequent merchant-initiated transactions in the absence of the user, based on the initial successful authentication.

Read the guide to PayPal recurring payments →

Request a recurring PayPal pay-in based on a `RecurringPayinRegistrationId` with `PaymentType` `PAYPAL`, obtained from [POST Create a Recurring PayIn Registration](/api-reference/recurring-payin-registrations/create-recurring-payin-registration). There are two possible paylods: - **CIT** – Customer-initiated transaction when the user is on session, requiring them to authenticate via PayPal on the `RedirectURL` returned. - **MIT** – Subsequent merchant-initiated transactions in the absence of the user, based on the initial successful authentication. Read the guide to [PayPal recurring payments](/guides/payment-methods/paypal#recurring-payments) **→**

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

Request

This endpoint expects an object.

PayPal CITobjectRequired

Request body for a PayPal customer-initiated transaction (CIT).

PayPal MITobjectRequired

Request body for a PayPal merchant-initiated transaction (MIT).

Response

Success

Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

AuthorIdstring

The unique identifier of the user at the source of the transaction.

DebitedFundsobject

Information about the debited funds. The amount must be equal to the total of all UnitAmount and TaxAmount of all LineItems.

CreditedFundsobject

Information about the credited funds (CreditedFunds = DebitedFunds - Fees).

Feesobject

Information about the fees.

Statusstring

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ResultCodestring

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessagestring

The explanation of the result code.

ExecutionDateinteger

Unix timestamp (UTC) of the date and time the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.

Typestring

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Naturestring

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.

CreditedWalletIdstring

The unique identifier of the credited wallet.

PaymentTypestring

Returned values: PAYPAL

The payment type of the pay-in.

ExecutionTypestring

Returned values: DIRECT

The execution type of the pay-in.

ReturnURLstring

Max. length: 255 characters

The URL to which the user is returned after the payment, whether the transaction is successful or not.

RedirectURLstring

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.

StatementDescriptorstring

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.

Shippingobject

Information about the end user’s shipping address, managed by ShippingPreference.

LineItemslist of objects

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).

Culturestring

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.

ShippingPreferencestring

Returned values: SET_PROVIDED_ADDRESS, GET_FROM_FILE, NO_SHIPPING

Information 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.

PaypalBuyerAccountEmailstring

The email address registered on the PayPal account used to make the payment.

Referencestring

Max. length: 127 characters (truncated after)

The platform’s order reference for the transaction.

Trackingslist of objects

Shipping information of the LineItems added to the pay-in object.

CancelURLstring

The URL to which the user is returned after canceling the payment. If not provided, the Cancel button returns the user to the RedirectURL.

PaypalOrderIDstring

PayPal's unique identifier for the order.

BuyerCountrystring

The country of the buyer.

BuyerFirstnamestring

The first name of the buyer.

BuyerPhonestring

The mobile phone number of the buyer.

BuyerLastnamestring

The last name of the buyer.

PaypalPayerIDstring

The PayPal identifier of the buyer.

RecurringPayinRegistrationIdstring

The unique identifier of the recurring pay-in registration.

Errors

400

Bad Request Error