🇬🇪 Georgia v0.8 - Read account list

GET https://open-banking-api.paysera.com/xs2a/georgia/0.8/v1/accounts

Read the identifiers of the available payment account together with booking balance information, depending on the consent granted.

It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed list of accounts depends then on the PSU ID and the stored consent addressed by consentId, respectively the OAuth2 access token.

Returns all identifiers of the accounts, to which an account access has been granted to through the /consents endpoint by the PSU. In addition, relevant information about the accounts and hyperlinks to corresponding account information resources are provided if a related consent has been already granted.

Remark: Note that the /consents endpoint optionally offers to grant an access on all available payment accounts of a PSU. In this case, this endpoint will deliver the information about all available payment accounts of the PSU at this ASPSP.

Authorization

This endpoint requires mTLS (Mutual TLS) authentication using a valid QWAC certificate, an OAuth 2.0 access token and the Consent-ID of the consent that granted the access.

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
Authorization: Bearer <access_token> header with the access token issued when the PSU authorised the consent
Consent-ID header with the ID of that consent; a request without it is rejected with 400 FORMAT_INVALID

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

Example (cURL):

curl https://open-banking-api.paysera.com/xs2a/georgia/0.8/v1/accounts \
  --cert qwac-cert.pem \
  --key qwac-key.pem \
  -H "X-Request-ID: $(uuidgen)" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Consent-ID: $CONSENT_ID"

For detailed authentication guide, see Authentication.

Parameters

Query Parameters

Name	Type	Description
`withBalance`	boolean	If contained, this function reads the list of accessible payment accounts including the booking balance,
if granted by the PSU in the related consent and available by the ASPSP.
This parameter might be ignored by the ASPSP.

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"
    }
  ]
}

Example

Request

GET https://open-banking-api.paysera.com/xs2a/georgia/0.8/v1/accounts?withBalance=value
X-Request-ID: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721
Authorization: Bearer <access_token>
Consent-ID: 7f5eb2a1-4c3d-4f2b-9a6e-1d8c0b5a3e94
# plus the QWAC certificate presented during the TLS handshake

Response

{
  "accounts": [
    {
      "resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e80f",
      "iban": "GE00BG0000000000000001",
      "currency": "GEL",
      "product": "Current Account",
      "cashAccountType": "CACC",
      "name": "Main Account",
      "_links": {
        "balances": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances"
        },
        "transactions": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions"
        }
      }
    },
    {
      "resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e81g",
      "iban": "GE00BG0000000000000002",
      "currency": "GEL",
      "product": "Current Account",
      "cashAccountType": "CACC",
      "name": "Main Account",
      "_links": {
        "balances": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e81g/balances"
        }
      }
    }
  ]

}

AUTHORIZATION: HTTP

REQUEST

Base URL

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

RESPONSE

OK. In case, no account is accessible, the ASPSP shall return an empty array. As this is also considered a positive response, the Response code must still be 200.

{
  "accounts": [
    {
      "resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e80f",
      "iban": "GE00BG0000000000000001",
      "currency": "GEL",
      "product": "Current Account",
      "cashAccountType": "CACC",
      "name": "Main Account",
      "_links": {
        "balances": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances"
        },
        "transactions": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions"
        }
      }
    },
    {
      "resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e81g",
      "iban": "GE00BG0000000000000002",
      "currency": "GEL",
      "product": "Current Account",
      "cashAccountType": "CACC",
      "name": "Main Account",
      "_links": {
        "balances": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e81g/balances"
        }
      }
    }
  ]
}

Authorization​

Parameters​

Query Parameters​

Errors​

400 - Bad Request​

401 - Unauthorized​

403 - Forbidden​

404 - Not Found​

405 - Method Not Allowed​

429 - Too Many Requests​

500 - Internal Server Error​

Example​

Request​

Response​

AUTHORIZATION: HTTP

REQUEST

RESPONSE

Authorization

Parameters

Query Parameters

Errors

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

405 - Method Not Allowed

429 - Too Many Requests

500 - Internal Server Error

Example

Request

Response