v2
latestOpenAPI 3.1.02026-07-262279731.3 MBrecurringPayinRegistrations
Create a Recurring PayIn Registration
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) |
| 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) |
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. </Note>
post/v2.01/{ClientId}/recurringpayinregistrations
Path parameters
ClientIdstring required
Platform's API account identifier, associated with the API key.
Headers
Authorizationstring required
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.
Request body
Response
Success