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>"

{
  "AuthorId": "user_m_01JHX34N3Y9BCQP7KR9QWWETDQ",
  "Billing": {
    "Address": {
      "AddressLine1": "6 rue de la Cité",
      "AddressLine2": "Appartement 3",
      "City": "Paris",
      "Country": "FR",
      "PostalCode": "75003",
      "Region": "île-de-France"
    },
    "FirstName": "Alex",
    "LastName": "Smith"
  },
  "CardId": "card_m_UsklnOoXBWyyqhsN",
  "CreditedUserId": "user_m_01JHX34N3Y9BCQP7KR9QWWETDQ",
  "CreditedWalletId": "wlt_m_01JJ70WZ9JRAZ9GE0DA36Q84NQ",
  "CurrentState": {
    "CumulatedDebitedAmount": {
      "Amount": 20000,
      "Currency": "EUR"
    },
    "CumulatedFeesAmount": {
      "Amount": 1000,
      "Currency": "EUR"
    },
    "LastPayinId": "payin_m_01JJP59QGFVTMF9Y6YP0K3DXR0",
    "PayinsLinked": 2
  },
  "CycleNumber": null,
  "EndDate": null,
  "FirstTransactionDebitedFunds": {
    "Amount": 10000,
    "Currency": "EUR"
  },
  "FirstTransactionFees": {
    "Amount": 500,
    "Currency": "EUR"
  },
  "FixedNextAmount": true,
  "FlowDescriptor": {
    "Beneficiaries": [
      {
        "UserId": "user_m_02APAYTWSDYXHXN1FRTKX9WMA2"
      }
    ],
    "FlowId": "flow_wt_97448e0a-5bc6-4b83-ac29-cdfcadf60a08"
  },
  "FractionedPayment": false,
  "FreeCycles": 0,
  "Frequency": "Monthly",
  "Id": "recpayinreg_m_01JJP2KS2A47A0P7S7CEBQPHT9",
  "Migration": false,
  "NextTransactionDebitedFunds": null,
  "NextTransactionFees": null,
  "PaymentType": "CARD_DIRECT",
  "RecurringType": "CUSTOM",
  "ResultCode": null,
  "ResultMessage": null,
  "Shipping": {
    "Address": {
      "AddressLine1": "6 rue de la Cité",
      "AddressLine2": "Appartement 3",
      "City": "Paris",
      "Country": "FR",
      "PostalCode": "75003",
      "Region": "île-de-France"
    },
    "FirstName": "Alex",
    "LastName": "Smith"
  },
  "Status": "IN_PROGRESS",
  "TotalAmount": null
}

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.

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.