Skip to main content

🇪🇺 Berlin Group v1.3 - Read the SCA status of the payment cancellation's authorisation

Not supported

Payment cancellation is not supported, so no cancellation authorisation is ever created.

GET https://open-banking-api.paysera.com/xs2a/berlin/1.3/v1/payments/{payment-product}/{paymentId}/cancellation-authorisations/{authorisationId}

This method returns the SCA status of a payment initiation's authorisation sub-resource.

Authorization​

This endpoint requires mTLS (Mutual TLS) authentication using a valid QWAC certificate. Consent and payment endpoints authenticate on the certificate alone: no access token or Consent-ID header is needed.

Requirements:

  • Valid QWAC certificate issued by a qualified trust service provider (QTSP)
  • Certificate must be registered with Paysera
  • Certificate organization identifier must match your TPP registration in the EBA register
  • X-Request-ID header with a UUID on every request

Request signing: not used. This API does not read the Digest, x-jws-signature or TPP-Signature-Certificate headers — see Security.

For detailed authentication guide, see Authentication.

Parameters​

Path Parameters​

NameTypeRequiredDescription
payment-productstring✓The addressed payment product. Supported values: sepa-credit-transfers, instant-sepa-credit-transfers, target-2-payments, domestic-ron-transfers.
paymentIdstring✓Resource identification of the generated payment initiation resource.
authorisationIdstring✓Resource identification of the related SCA.

Errors​

This endpoint may return the following errors. The list is shared by every endpoint of this API, so not every code applies to every endpoint.

Every error listed below is returned with a tppMessages array. Each message has a category and a code, and may add a path (the header or field at fault) and a text.

400 - Bad Request​

The request could not be understood by the server due to malformed syntax or invalid parameters.

Common error codes:

  • CONSENT_UNKNOWN - The consent in the Consent-ID header is unknown or cannot be used by this TPP
  • FORMAT_ERROR - Invalid request format or syntax, for example a malformed body field or an X-Request-ID that is not a UUID
  • FORMAT_INVALID - The mandatory Consent-ID header is missing
  • PARAMETER_NOT_SUPPORTED - Request contains unsupported parameters
  • PERIOD_INVALID - The requested consent validity period is outside the allowed range
  • SERVICE_INVALID - The addressed service is not valid for the addressed resources
  • SESSIONS_NOT_SUPPORTED - Combined AIS and PIS sessions (combinedServiceIndicator) are not supported

Example response:

{
"tppMessages": [
{
"category": "ERROR",
"code": "FORMAT_ERROR",
"path": "X-Request-ID",
"text": "Request ID must be a valid UUID string."
}
]
}

401 - Unauthorized​

The certificate, the access token or the consent could not be used to authenticate the request.

Common error codes:

  • CERTIFICATE_INVALID - The TPP certificate is not valid or is not registered with Paysera
  • CERTIFICATE_MISSING - The TPP certificate is missing in the request
  • CONSENT_EXPIRED - The consent has expired and can no longer be used
  • CONSENT_INVALID - The consent is invalid for this operation
  • ROLE_INVALID - The TPP certificate does not have the role this endpoint requires (AIS or PIS)
  • TOKEN_INVALID - The access token does not carry the scope this endpoint requires
  • TOKEN_EXPIRED - The access token has expired, has been revoked or could not be verified
  • TOKEN_UNKNOWN - The access token is unknown or invalid

Example response:

{
"tppMessages": [
{
"category": "ERROR",
"code": "CERTIFICATE_INVALID"
}
]
}

403 - Forbidden​

The TPP does not have the necessary permissions or the resource access is forbidden.

Common error codes:

  • CONSENT_UNKNOWN - The addressed consent is unknown to this TPP, or the TPP may not perform this consent operation
  • RESOURCE_UNKNOWN - The addressed resource is unknown to this TPP

Example response:

{
"tppMessages": [
{
"category": "ERROR",
"code": "CONSENT_UNKNOWN"
}
]
}

404 - Not Found​

The requested resource could not be found.

Common error codes:

  • RESOURCE_UNKNOWN - The addressed resource is not found or does not exist
  • SERVICE_INVALID - The request path does not match any endpoint of this API

Example response:

{
"tppMessages": [
{
"category": "ERROR",
"code": "RESOURCE_UNKNOWN"
}
]
}

405 - Method Not Allowed​

The HTTP method used is not allowed for this endpoint.

Common error codes:

  • SERVICE_INVALID - The HTTP method is not supported for this service

Example response:

{
"tppMessages": [
{
"category": "ERROR",
"code": "SERVICE_INVALID"
}
]
}

429 - Too Many Requests​

The TPP has used up the account data accesses its consent allows.

Each consent allows its agreed frequencyPerDay accesses (4 by default, or a higher value agreed with Paysera) to each account data resource per 24 hours. Requests sent with the PSU-IP-Address header under a recurring consent do not count towards the limit.

Common error codes:

  • ACCESS_EXCEEDED - The consent's frequencyPerDay limit for this resource has been reached

Example response:

{
"tppMessages": [
{
"category": "ERROR",
"code": "ACCESS_EXCEEDED"
}
]
}

500 - Internal Server Error​

An unexpected error occurred on the server side. This indicates a problem with the ASPSP's system. Please try again later or contact Paysera support if the issue persists.

Common error codes:

  • INTERNAL_SERVER_ERROR - The request could not be completed; try again later
  • INVALID_TPP_CONFIGURATION - The TPP's configuration at Paysera is invalid; contact Paysera support

Example response:

{
"tppMessages": [
{
"category": "ERROR",
"code": "INTERNAL_SERVER_ERROR"
}
]
}

AUTHORIZATION: HTTP

REQUEST

Base URL
https://open-banking-api.paysera.com

RESPONSE

OK
{}