Create a Recurring PayIn Registration

POST

/v2.01/:ClientId/recurringpayinregistrations

POST

/v2.01/:ClientId/recurringpayinregistrations

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/recurringpayinregistrations \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "AuthorId": "user_m_01KHXAHEBRWSZXJY85TPPR56TK",
>     "CardId": "card_wt_HodULFWKVRMEecCa",
>     "CreditedWalletId": "wlt_m_01KHXAHH2NA3AAMPGE1SJPHJDJ",
>     "FirstTransactionDebitedFunds": {
>       "Currency": "EUR",
>       "Amount": 10000
>     },
>     "FirstTransactionFees": {
>       "Currency": "EUR",
>       "Amount": 1000
>     },
>     "Billing": {
>       "FirstName": "Alex",
>       "LastName": "Smith",
>       "Address": {
>         "AddressLine1": "6 rue de la Cité",
>         "AddressLine2": "Appartement 3",
>         "City": "Paris",
>         "Region": "île-de-France",
>         "PostalCode": "75003",
>         "Country": "FR"
>       }
>     },
>     "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"
>       }
>     },
>     "Frequency": "Monthly",
>     "FixedNextAmount": true,
>     "FractionedPayment": false
>   }
> }'

1 {
2   "Id": "recpayinreg_m_01JJP2KS2A47A0P7S7CEBQPHT9",
3   "Status": "CREATED",
4   "ResultCode": null,
5   "ResultMessage": null,
6   "CurrentState": {
7     "PayinsLinked": 0,
8     "CumulatedDebitedAmount": {
9       "Currency": "EUR",
10       "Amount": 0
11     },
12     "CumulatedFeesAmount": {
13       "Currency": "EUR",
14       "Amount": 0
15     },
16     "LastPayinId": null
17   },
18   "RecurringType": "CUSTOM",
19   "TotalAmount": null,
20   "CycleNumber": null,
21   "AuthorId": "user_m_01JHX34N3Y9BCQP7KR9QWWETDQ",
22   "CardId": "card_m_UsklnOoXBWyyqhsN",
23   "CreditedUserId": "user_m_01JHX34N3Y9BCQP7KR9QWWETDQ",
24   "CreditedWalletId": "wlt_m_01JJ70WZ9JRAZ9GE0DA36Q84NQ",
25   "Billing": {
26     "FirstName": "Alex",
27     "LastName": "Smith",
28     "Address": {
29       "AddressLine1": "6 rue de la Cité",
30       "AddressLine2": "Appartement 3",
31       "City": "Paris",
32       "Region": "île-de-France",
33       "PostalCode": "75003",
34       "Country": "FR"
35     }
36   },
37   "Shipping": {
38     "FirstName": "Alex",
39     "LastName": "Smith",
40     "Address": {
41       "AddressLine1": "6 rue de la Cité",
42       "AddressLine2": "Appartement 3",
43       "City": "Paris",
44       "Region": "île-de-France",
45       "PostalCode": "75003",
46       "Country": "FR"
47     }
48   },
49   "EndDate": null,
50   "Frequency": "Monthly",
51   "FixedNextAmount": true,
52   "FractionedPayment": false,
53   "FreeCycles": 0,
54   "FirstTransactionDebitedFunds": {
55     "Currency": "EUR",
56     "Amount": 10000
57   },
58   "FirstTransactionFees": {
59     "Currency": "EUR",
60     "Amount": 500
61   },
62   "NextTransactionDebitedFunds": null,
63   "NextTransactionFees": null,
64   "Migration": false,
65   "PaymentType": "CARD_DIRECT"
66 }

PaymentType	Requires	Captured using
`CARD_DIRECT` (default)	Tokenized `CardId` obtained from the card registration process.	Create a Recurring Card PayIn (CIT or MIT)
`APPLEPAY`	Tokenized `PaymentData` object retrieved from the Apple Pay API.	Create a Recurring Apple Pay PayIn
`GOOGLE_PAY`	Tokenized `PaymentData` string retrieved from the Google Pay API.	Create a Recurring Google Pay PayIn
`PAYPAL`	No prerequisites.	Create a Recurring PayPal PayIn (CIT or MIT)

Note – Only one registration per user on PayPal

On PayPal, only one recurring pay-in registration can be used per UserId. You can end a user’s existing registration object to create a new one with the same user.

This restriction does not apply to other payment methods.

Register a series of recurring payment requests for the following payment methods (indicated by `PaymentType`): | PaymentType | Requires | Captured using | | --- | --- | --- | | `CARD_DIRECT` (default) | Tokenized `CardId` obtained from the card registration process. | [Create a Recurring Card PayIn (CIT or MIT)](/api-reference/recurring-card-payins/create-recurring-card-payin) | | `APPLEPAY` | Tokenized `PaymentData` object retrieved from the Apple Pay API. | [Create a Recurring Apple Pay PayIn](/api-reference/apple-pay/create-recurring-apple-pay-payin) | | `GOOGLE_PAY` | Tokenized `PaymentData` string retrieved from the Google Pay API. | [Create a Recurring Google Pay PayIn](/api-reference/google-pay/create-recurring-google-pay-payin) | | `PAYPAL` | No prerequisites. | [Create a Recurring PayPal PayIn (CIT or MIT)](/api-reference/paypal/create-recurring-paypal-payin) | <Note icon="fa-regular fa-circle-info"> **Note – Only one registration per user on PayPal** On PayPal, only one recurring pay-in registration can be used per `UserId`. You can [end a user's existing registration](/api-reference/recurring-payin-registrations/update-recurring-payin-registration) object to create a new one with the same user. This restriction does not apply to other payment methods. </Note>

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.

CardobjectRequired

Request body for card recurring pay-in registrations, using a tokenized CardId.

Apple PayobjectRequired

Request body for Apple Pay recurring pay-in registrations, using the tokenized PaymentData object retrieved from the Apple Pay API.

Google PayobjectRequired

Request body for Google Pay recurring pay-in registrations, using the tokenized PaymentData string retrieved from the Google Pay API.

PayPalobjectRequired

Request body for PayPal recurring pay-in registrations, redirecting the user to authenticate via PayPal.

Note that for PayPal:

Only one active PAYPAL registration object can exist for a user.
You can use NextTransactionDebitedFunds and NextTransactionFees in the registration (and therefore omit them from MIT pay-in requests). The RecurringType is always CUSTOM, and the FixedNextAmount parameter is not supported.
The FreeCycles property is not supported.

Response

Success

Cardobject

Response object for card recurring pay-in registrations.

PayPalobject

Response object for PayPal recurring pay-in registrations.

Apple Payobject

Response object for Apple Pay recurring pay-in registrations.

Google Payobject

Response object for Google Pay recurring pay-in registrations.

Errors

400

Bad Request Error