View a Recurring PayIn Registration

GET

/v2.01/:ClientId/recurringpayinregistrations/:RecurringPayinRegistrationId

GET

/v2.01/:ClientId/recurringpayinregistrations/:RecurringPayinRegistrationId

$ curl https://api.sandbox.mangopay.com/v2.01/{ClientId}/recurringpayinregistrations/{RecurringPayinRegistrationId} \
>      -H "Authorization: Bearer <token>"

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

View a Recurring PayIn Registration

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.

RecurringPayinRegistrationIdstringRequired

The unique identifier of the recurring pay-in registration.

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.