Delete consent

DELETE 
/v1/consents/consentId

Description

Revoke a consent for certain actions within the PSD2 framework. You can remove any permissions associated with a specific consent, ultimately providing greater control over data access and usage.

tip

This step should be used with caution. Once a consent is revoked, the TPP (Third-Party Provider) will no longer have access to the data associated with the consent.

Request

Path Parameters

consentId stringrequired

The ID of the consent as returned by the consent request.

Header Parameters

X-Request-ID uuidrequired

The unique request identifier associated with the consent.

Certificate stringrequired

The certificate used for signature verification.

ClientId stringrequired

The client ID associated with the request.

Ocp-Apim-Subscription-Key stringrequired

A unique identifier related to the registered merchant in the corresponding API environment, available within the application's details.

Responses

400

Bad Request

application/json

Schema

Schema

tppMessages object[]
Array [
category int32
Possible values: [0, 1]

Description: 0 = "ERROR", 1 = "WARNING"
code int32
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

Description: 0 = "FORMATERROREnum", 1 = "PARAMETERNOTCONSISTENTEnum", 2 = "PARAMETERNOTSUPPORTEDEnum", 3 = "SERVICEINVALIDEnum", 4 = "RESOURCEUNKNOWNEnum", 5 = "RESOURCEEXPIREDEnum", 6 = "RESOURCEBLOCKEDEnum", 7 = "TIMESTAMPINVALIDEnum", 8 = "PERIODINVALIDEnum", 9 = "SCAMETHODUNKNOWNEnum", 10 = "CONSENTUNKNOWNEnum", 11 = "SESSIONSNOTSUPPORTEDEnum", 12 = "INVALIDTOTALAMOUNTEnum"
path string
text string
]
links object
property name object
href string

Example (from schema)

{
  "tppMessages": [
    {
      "category": 0,
      "code": 0,
      "path": "string",
      "text": "string"
    }
  ],
  "links": {}
}

401

Unauthorized

application/json

Schema

Schema

tppMessages object[]
Array [
category int32
Possible values: [0, 1]

Description: 0 = "ERROR", 1 = "WARNING"
code int32
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]

Description: 0 = "CERTIFICATEINVALIDEnum", 1 = "CERTIFICATEEXPIREDEnum", 2 = "CERTIFICATEBLOCKEDEnum", 3 = "CERTIFICATEREVOKEEnum", 4 = "CERTIFICATEMISSINGEnum", 5 = "SIGNATUREINVALIDEnum", 6 = "SIGNATUREMISSINGEnum", 7 = "CORPORATEIDINVALIDEnum", 8 = "PSUCREDENTIALSINVALIDEnum", 9 = "CONSENTINVALIDEnum", 10 = "CONSENTEXPIREDEnum", 11 = "TOKENUNKNOWNEnum", 12 = "TOKENINVALIDEnum", 13 = "TOKENEXPIREDEnum"
path string
text string
]
links object
property name object
href string

Example (from schema)

{
  "tppMessages": [
    {
      "category": 0,
      "code": 0,
      "path": "string",
      "text": "string"
    }
  ],
  "links": {}
}

403

Forbidden

application/json

Schema

Schema

authenticationSchemes string[]
properties object
items object
property name string
tppMessages object[]
Array [
category int32
Possible values: [0, 1]

Description: 0 = "ERROR", 1 = "WARNING"
code int32
Possible values: [0, 1, 2, 3]

Description: 0 = "CONSENTUNKNOWNEnum", 1 = "SERVICEBLOCKEDEnum", 2 = "RESOURCEUNKNOWNEnum", 3 = "RESOURCEEXPIREDEnum"
path string
text string
]
links object
property name object
href string

Example (from schema)

{
  "authenticationSchemes": [
    "string"
  ],
  "properties": {
    "items": {}
  },
  "tppMessages": [
    {
      "category": 0,
      "code": 0,
      "path": "string",
      "text": "string"
    }
  ],
  "links": {}
}

404

Not found

application/json

Schema

Schema

statusCode int32
tppMessages object[]
Array [
category int32
Possible values: [0, 1]

Description: 0 = "ERROR", 1 = "WARNING"
code int32
Possible values: [0]

Description: 0 = "UNKNOWNEnum"
path string
text string
]
links object
property name object
href string

Example (from schema)

{
  "statusCode": 0,
  "tppMessages": [
    {
      "category": 0,
      "code": 0,
      "path": "string",
      "text": "string"
    }
  ],
  "links": {}
}

405

Method Not Allowed

application/json

Schema

Schema

tppMessages object[]
Array [
category int32
Possible values: [0, 1]

Description: 0 = "ERROR", 1 = "WARNING"
code int32
Possible values: [0]

Description: 0 = "INVALIDEnum"
path string
text string
]
links object
property name object
href string

Example (from schema)

{
  "tppMessages": [
    {
      "category": 0,
      "code": 0,
      "path": "string",
      "text": "string"
    }
  ],
  "links": {}
}

406

Not Acceptable

application/json

Schema

Schema

tppMessages object[]
Array [
category int32
Possible values: [0, 1]

Description: 0 = "ERROR", 1 = "WARNING"
code int32
Possible values: [0]

Description: 0 = "INVALIDEnum"
path string
text string
]
links object
property name object
href string

Example (from schema)

{
  "tppMessages": [
    {
      "category": 0,
      "code": 0,
      "path": "string",
      "text": "string"
    }
  ],
  "links": {}
}

409

Conflict

application/json

Schema

Schema

tppMessages object[]
Array [
category int32
Possible values: [0, 1]

Description: 0 = "ERROR", 1 = "WARNING"
code int32
Possible values: [0]

Description: 0 = "INVALIDEnum"
path string
text string
]
links object
property name object
href string

Example (from schema)

{
  "tppMessages": [
    {
      "category": 0,
      "code": 0,
      "path": "string",
      "text": "string"
    }
  ],
  "links": {}
}

429

Too Many Requests

application/json

Schema

Schema

tppMessages object[]
Array [
category int32
Possible values: [0, 1]

Description: 0 = "ERROR", 1 = "WARNING"
code int32
Possible values: [0]

Description: 0 = "EXCEEDEDEnum"
path string
text string
]
links object
property name object
href string

Example (from schema)

{
  "tppMessages": [
    {
      "category": 0,
      "code": 0,
      "path": "string",
      "text": "string"
    }
  ],
  "links": {}
}

Loading...