General

Submit a Subject Erasure Request.

Changed on

Sends the PSP reference containing the shopper data that should be deleted.

post/requestSubjectErasure

Request

  • Base URL
    https://ca-test.adyen.com/ca/services/DataProtectionService/v1
  • URL
    https://ca-test.adyen.com/ca/services/DataProtectionService/v1/requestSubjectErasure
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Request body

forceErasureboolean

Set this to true if you want to delete shopper-related data, even if the shopper has an existing recurring transaction. This only deletes the shopper-related data for the specific payment, but does not cancel the existing recurring transaction.

merchantAccountstring

Your merchant account

pspReferencestring

The PSP reference of the payment. We will delete all shopper-related data for this payment.

Response

OK - the request has succeeded.

result'ACTIVE_RECURRING_TOKEN_EXISTS' | 'ALREADY_PROCESSED' | 'PAYMENT_NOT_FOUND' | 'SUCCESS'

The result of this operation.

Changes

    • breaking

      the request's body type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status