Check security status

GET 
/v1/payment-service/payment-product/paymentId/authorisations/authorisationId

Description

Retrieve the Strong Customer Authentication (SCA) status of a specific payment authorisation.

tip

Check the current status of the authorisation process and take actions based on the returned status information.

Request

Path Parameters

payment-service stringrequired

The payment service that is used to initiate the payment.
Available options: payments.

payment-product stringrequired

The addressed payment product endpoint, e.g., for SEPA Credit Transfers (SCT).
Available options: internal-transfers, sepa-credit-transfers.

paymentId stringrequired

The unique ID of the addressed payment.

authorisationId stringrequired

The unique ID of the addressed authorisation.

Header Parameters

X-Request-ID uuidrequired

ID of the request, unique to the call, as determined by the initiating party.

Certificate stringrequired

The certificate used for signature verification.

ClientId stringrequired

The unique 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

200

OK

application/json

Schema

Schema

scaStatus int32

The status of the SCA performed by the ASPSP.
Possible values: 0 = "received", 1 = "psuIdentified", 2 = "psuAuthenticated", < b>3 = "scaMethodSelected", 4 = "started", 5 = "finalised", 6 = "failed", 7 = "exempted".

Example (from schema)

{
  "scaStatus": 0
}

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 = "PAYMENTFAILEDEnum", 12 = "EXECUTIONDATEINVALIDEnum"
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

statusCode int32
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, 14]

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", 14 = "REQUIREDKIDMISSINGEnum"
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": {}
}

403

Forbidden

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]

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

Example (from schema)

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

404

Not found

application/json

Schema

Schema

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

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

Description: 0 = "RESOURCEUNKNOWNEnum", 1 = "PRODUCTUNKNOWNEnum"
path string
text string
]
links object
property name* object
href string

Example (from schema)

{
  "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": {}
}

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": {}
}

Loading...