recurringPayinRegistrations

Update a Recurring PayIn Registration

Changed on

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}

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/recurringpayinregistrations/{RecurringPayinRegistrationId}
  • Auth
    HTTP bearer

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.

Request body

OR
OR
OR

Response

Success

OR
OR
OR

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id update_recurring_payin_registration removed and replaced with recurringPayinRegistrations_update_recurring_payin_registration