logo
API docs by Redocly

PCB-GEO-TEST-PSD2-API (v1)

Download OpenAPI specification:

PCB-GEO-TEST-PSD2-API

Consents

01. Create consent

Authorizations:
apiKeyHeaderapiKeyQuery
header Parameters
X-Request-ID
required
string($uuid)

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

x-jws-signature
required
string

A signature of the request by the TPP on application level.

Digest
required
string

Is contained if and only if the "x-jws-signature" element is contained in the header of the request.

PSU-IP-Address
required
string($ipv4)

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request.

Request Body schema: application/json

Request body for a consents request.

Schema not provided

Responses

Request samples

Content type
application/json
{
  • "access": {
    },
  • "recurringIndicator": true,
  • "validUntil": "2022-02-02",
  • "frequencyPerDay": 4,
  • "combinedServiceIndicator": true
}

Response samples

Content type
application/json
{
  • "consentStatus": "received",
  • "consentId": "d02c9545-cfee-4b33-ae12-6dd4030e2252",
  • "_links": {},
  • "message": "Created"
}

02. Get consent request

Authorizations:
apiKeyHeaderapiKeyQuery
path Parameters
consentId
required
string

ID of the corresponding consent object as returned by an account information consent request.

header Parameters
X-Request-ID
required
string($uuid)

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

x-jws-signature
required
string

A signature of the request by the TPP on application level.

Digest
required
string

Is contained if and only if the "x-jws-signature" element is contained in the header of the request.

PSU-IP-Address
string($ipv4)

The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.

Responses

Response samples

Content type
application/json
{
  • "access": {
    },
  • "recurringIndicator": true,
  • "validUntil": "2022-02-02",
  • "frequencyPerDay": 4,
  • "lastActionDate": "2021-11-11",
  • "consentStatus": "valid"
}

04. Delete consent

Authorizations:
apiKeyHeaderapiKeyQuery
path Parameters
consentId
required
string

ID of the corresponding consent object as returned by an account information consent request.

header Parameters
X-Request-ID
required
string($uuid)

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

x-jws-signature
required
string

A signature of the request by the TPP on application level.

Digest
required
string

Is contained if and only if the "x-jws-signature" element is contained in the header of the request.

PSU-IP-Address
string($ipv4)

The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.

Responses

03. Consent status request

Authorizations:
apiKeyHeaderapiKeyQuery
path Parameters
consentId
required
string

ID of the corresponding consent object as returned by an account information consent request.

header Parameters
X-Request-ID
required
string($uuid)

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

x-jws-signature
required
string

A signature of the request by the TPP on application level.

Digest
required
string

Is contained if and only if the "x-jws-signature" element is contained in the header of the request.

PSU-IP-Address
string($ipv4)

The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.

Responses

Response samples

Content type
application/json
{
  • "consentStatus": "valid"
}

Accounts

05. Read account list

Authorizations:
apiKeyHeaderapiKeyQuery
query Parameters
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.

header Parameters
X-Request-ID
required
string($uuid)

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

Consent-ID
required
string

This then contains the consentId of the related AIS consent.

x-jws-signature
required
string

A signature of the request by the TPP on application level.

Digest
required
string

Is contained if and only if the "x-jws-signature" element is contained in the header of the request.

PSU-IP-Address
string($ipv4)

The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.

Responses

Response samples

Content type
application/json
{
  • "accounts": [
    ]
}

07. Read balance

Authorizations:
apiKeyHeaderapiKeyQuery
path Parameters
account-id
required
string

This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "resourceId" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

header Parameters
X-Request-ID
required
string($uuid)

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

Consent-ID
required
string

This then contains the consentId of the related AIS consent.

x-jws-signature
required
string

A signature of the request by the TPP on application level.

Digest
required
string

Is contained if and only if the "x-jws-signature" element is contained in the header of the request.

PSU-IP-Address
string($ipv4)

The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.

Responses

Response samples

Content type
application/json
{
  • "account": {
    },
  • "balances": [
    ]
}

06. Read account details

Authorizations:
apiKeyHeaderapiKeyQuery
path Parameters
account-id
required
string

This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "resourceId" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

query Parameters
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.

header Parameters
X-Request-ID
required
string($uuid)

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

Consent-ID
required
string

This then contains the consentId of the related AIS consent.

x-jws-signature
required
string

A signature of the request by the TPP on application level.

Digest
required
string

Is contained if and only if the "x-jws-signature" element is contained in the header of the request.

PSU-IP-Address
string($ipv4)

The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.

Responses

Response samples

Content type
application/json
{
  • "account": {
    }
}

08. Read transaction list of an account

Authorizations:
apiKeyHeaderapiKeyQuery
path Parameters
account-id
required
string

This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "resourceId" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

query Parameters
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.

entryReferenceFrom
string

This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification entryReferenceFrom alternatively to the above defined period.

dateFrom
string($date)
dateTo
string($date)
bookingStatus
required
string

Available values : booked, pending, both

header Parameters
X-Request-ID
required
string($uuid)

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

Consent-ID
required
string

This then contains the consentId of the related AIS consent.

x-jws-signature
required
string

A signature of the request by the TPP on application level.

Digest
required
string

Is contained if and only if the "x-jws-signature" element is contained in the header of the request.

PSU-IP-Address
string($ipv4)

The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.

Responses

Response samples

Content type
application/json
{
  • "account": {
    },
  • "transactions": {
    }
}

Payments

09. Payment initiation request

Authorizations:
apiKeyHeaderapiKeyQuery
path Parameters
payment-service
required
string
Enum: "payments" "bulk-payments"

There are the following payment services:

  • payments
  • bulk-payments
payment-product
required
string
Enum: "domestic" "foreign"

The following payment products are supported:

  • domestic
  • foreign
header Parameters
X-Request-ID
required
string($uuid)

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

x-jws-signature
required
string

A signature of the request by the TPP on application level.

Digest
required
string

Is contained if and only if the "x-jws-signature" element is contained in the header of the request.

PSU-IP-Address
required
string($ipv4)

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request.

TPP-Rejection-NoFunds-Preferred
boolean

If it equals "true" then the TPP prefers a rejection of the payment initiation in case the ASPSP is providing an integrated confirmation of funds request an the result of this is that not sufficient funds are available.

If it equals "false" then the TPP prefers that the ASPSP is dealing with the payment initiation like in the ASPSPs online channel, potentially waiting for a certain time period for funds to arrive to initiate the payment.

Request Body schema: application/json

JSON request body for a payment inition request message.

Schema not provided

Responses

Request samples

Content type
application/json
{
  • "creditorAccount": {
    },
  • "creditorName": "domestic",
  • "remittanceInformationUnstructured": "domestic",
  • "debtorAccount": {
    },
  • "instructedAmount": {
    }
}

Response samples

Content type
application/json
{
  • "transactionStatus": "ACCC",
  • "paymentId": "d712c168-4df2-4674-a7c7-a8da7ec52b63",
  • "_links": {
    },
  • "psuMessage": "Login to e-Banking"
}

11. Payment initiation status request

Authorizations:
apiKeyHeaderapiKeyQuery
path Parameters
payment-service
required
string
Enum: "payments" "bulk-payments"

There are the following payment services:

  • payments
  • bulk-payments
payment-product
required
string
Enum: "domestic" "foreign"

The following payment products are supported:

  • domestic
  • foreign
paymentId
required
string

Resource identification of the generated payment initiation resource.

header Parameters
X-Request-ID
required
string($uuid)

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

x-jws-signature
required
string

A signature of the request by the TPP on application level.

Digest
required
string

Is contained if and only if the "x-jws-signature" element is contained in the header of the request.

Responses

Response samples

Content type
application/json
{
  • "transactionStatus": "ACCC"
}

10. Get payment information

Authorizations:
apiKeyHeaderapiKeyQuery
path Parameters
payment-service
required
string
Enum: "payments" "bulk-payments"

There are the following payment services:

  • payments
  • bulk-payments
payment-product
required
string
Enum: "domestic" "foreign"

The following payment products are supported:

  • domestic
  • foreign
paymentId
required
string

Resource identification of the generated payment initiation resource.

header Parameters
X-Request-ID
required
string($uuid)

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

x-jws-signature
required
string

A signature of the request by the TPP on application level.

Digest
required
string

Is contained if and only if the "x-jws-signature" element is contained in the header of the request.

Responses

Response samples

Content type
application/json
{
  • "debtorAccount": {
    },
  • "debtorIdentification": {
    },
  • "instructedAmount": {
    },
  • "creditorAccount": {
    },
  • "creditorAgent": "MIBGGE22",
  • "creditorName": "ფარეიშვილი ნოდარ",
  • "creditorIdentification": {
    },
  • "chargeBearer": "DEBT",
  • "remittanceInformationUnstructured": "საკუთარ ანგარიშებს შორის გადარიცხვა",
  • "remittanceInformationUnstructuredArray": [ ],
  • "instructionPriority": "HIGH",
  • "transactionStatus": "RCVD"
}

12. Payment cancellation request

Authorizations:
apiKeyHeaderapiKeyQuery
path Parameters
payment-service
required
string
Enum: "payments" "bulk-payments"

There are the following payment services:

  • payments
  • bulk-payments
payment-product
required
string
Enum: "domestic" "foreign"

The following payment products are supported:

  • domestic
  • foreign
paymentId
required
string

Resource identification of the generated payment initiation resource.

header Parameters
X-Request-ID
required
string($uuid)

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

x-jws-signature
required
string

A signature of the request by the TPP on application level.

Digest
required
string

Is contained if and only if the "x-jws-signature" element is contained in the header of the request.

PSU-IP-Address
string($ipv4)

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

Responses