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",
    "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_wt_HodULFWKVRMEecCa",
    "CreditedWalletId": "wlt_m_01KHXAHH2NA3AAMPGE1SJPHJDJ",
    "FirstTransactionDebitedFunds": {
      "Amount": 10000,
      "Currency": "EUR"
    },
    "FirstTransactionFees": {
      "Amount": 1000,
      "Currency": "EUR"
    },
    "FixedNextAmount": true,
    "FlowDescriptor": {
      "Beneficiaries": [
        {
          "UserId": "user_m_02APAYTWSDYXHXN1FRTKX9WMA2"
        }
      ]
    },
    "FractionedPayment": false,
    "Frequency": "Monthly",
    "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"
    }
  }
}'

{
  "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": 0,
      "Currency": "EUR"
    },
    "CumulatedFeesAmount": {
      "Amount": 0,
      "Currency": "EUR"
    },
    "LastPayinId": null,
    "PayinsLinked": 0
  },
  "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": "CREATED",
  "TotalAmount": null
}

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.

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.

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