v2
latestOpenAPI 3.1.02026-07-262279731.3 MBrecurringPayinRegistrations
Update a Recurring PayIn Registration
This call can be used to modify parameters in the following scenarios:
- Reauthentication – Update the CardId (card) or PaymentData (Apple Pay and Google Pay) if re-authentication is necessary (indicated by the Status becoming AUTHENTICATION_NEEDED). This must be followed by a CIT pay-in request.
- User data change – Update Billing or Shipping if required
- Recurrence ending – Set the Status to ENDED if the recurring payments have finished or will no longer be used
The existing registration's PaymentType must match the request variant.
put/v2.01/{ClientId}/recurringpayinregistrations/{RecurringPayinRegistrationId}
Path parameters
ClientIdstring required
Platform's API account identifier, associated with the API key.
RecurringPayinRegistrationIdstring required
The unique identifier of the recurring pay-in registration.
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