Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/tietoevry-payment-initiation-service-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Tietoevry Payment Initiation Service API
version: '1.0'
description: 'Operations tagged Payment Initiation Service across 5 of this provider''s published API definitions: tietoevry-financial-api-aggregation-swagger.json, tietoevry-openbanking-xs2a-swagger.json, tietoevry-tieto-xs2a-future-dated-payments-premium.v1_3.yaml, tietoevry-tieto-xs2a-payments.v1_2.yaml, tietoevry-tieto-xs2a-payments.v1_3.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://aggregation.api.tieto.com
- url: http://openbanking.api.tieto.com
- url: https://openbanking.api.tieto.com
tags:
- name: Payment Initiation Service
description: Operations for payments.
paths:
/v1/xs2a/v1.0/providers/{provider-id}/payments:
get:
tags:
- Payment Initiation Service
operationId: getPaymentProducts
description: Returns the available payment products for the given provider.
summary: Get Payment Products
parameters:
- name: provider-id
in: path
description: Identifier of an ASPSP, previously returned by the system
required: true
schema:
type: string
- name: X-Request-ID
in: header
required: true
schema:
type: string
format: uuid
- name: X-API-Key
in: header
description: Authorisation key that can be acquired in Sandbox.
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/JsonGetPaymentProductsResponse'
servers:
- url: https://aggregation.api.tieto.com
/v1/xs2a/v1.0/providers/{provider-id}/payments/{payment-product}/{payment-id}:
get:
tags:
- Payment Initiation Service
operationId: getJSONPayment
description: Returns the content of payment object.
summary: Get Payment Details
parameters:
- name: provider-id
in: path
description: Identifier of an ASPSP, previously returned by the system
required: true
schema:
type: string
- name: payment-product
in: path
required: true
schema:
type: string
- name: payment-id
in: path
required: true
schema:
type: string
format: uuid
- name: End-User-ID
in: header
description: The system-generated ID of an anonymous End User.
required: true
schema:
type: string
format: uuid
- name: X-Request-ID
in: header
required: true
schema:
type: string
format: uuid
- name: X-API-Key
in: header
description: Authorisation key that can be acquired in Sandbox.
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/JsonGetPaymentResponse'
delete:
tags:
- Payment Initiation Service
summary: Payment cancellation for the specified product type and identifier
description: Initiates the cancellation of the addressed payment with resource identification payment-id if applicable to the payment-service, payment-product and received in product related timelines.
operationId: cancelPayment
parameters:
- name: provider-id
in: path
description: Identifier of an ASPSP, previously returned by the system
required: true
schema:
type: string
- name: payment-product
in: path
required: true
schema:
type: string
- name: payment-id
in: path
required: true
schema:
type: string
- name: Content-Type
in: header
required: true
schema:
type: string
- name: End-User-ID
in: header
description: The system-generated ID of an anonymous End User.
required: true
schema:
type: string
format: uuid
- name: X-Request-ID
in: header
required: true
schema:
type: string
format: uuid
- name: X-API-Key
in: header
description: Authorisation key that can be acquired in Sandbox.
required: true
schema:
type: string
- name: TPP-Explicit-Authorisation-Preferred
in: header
description: If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket.
schema:
type: boolean
default: false
- name: TPP-Redirect-URI
in: header
description: URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach (including OAuth2 SCA approach).
required: true
schema:
type: string
format: uri
- name: TPP-Nok-Redirect-URI
in: header
description: If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.
schema:
type: string
format: uri
responses:
'202':
description: No errors occurred. Authorisation of the cancellation by the PSU is needed.
content:
application/json:
schema:
$ref: '#/components/schemas/JsonDeletePaymentResponse'
'204':
description: No errors occurred.
'400':
description: One of mandatory parameters (headers) missing or in incorrect format.
content:
application/json:
schema:
$ref: '#/components/schemas/JsonErrorResponse'
'404':
description: invalid payment product
content:
application/json:
schema:
$ref: '#/components/schemas/JsonErrorResponse'
'405':
description: The addressed payment is not cancellable e.g. due to cut off time passed or legal constraints. Or payment cancellation is not supported by the bank.
content:
application/json:
schema:
$ref: '#/components/schemas/JsonErrorResponse'
servers:
- url: https://aggregation.api.tieto.com
/v1/xs2a/v1.0/providers/{provider-id}/payments/{payment-product}/{payment-id}/authorisations:
get:
tags:
- Payment Initiation Service
summary: 'Payment: Get authorisation sub-resources request'
description: Will deliver an array of resource identifications of all generated authorisation sub-resources.
operationId: paymentsGetAuthorizations
parameters:
- name: provider-id
in: path
description: Identifier of an ASPSP, previously returned by the system
required: true
schema:
type: string
- name: payment-product
in: path
required: true
schema:
type: string
- name: payment-id
in: path
description: Identification of the related resource
required: true
schema:
type: string
format: uuid
- name: End-User-ID
in: header
description: The system-generated ID of an anonymous End User.
required: true
schema:
type: string
format: uuid
- name: X-Request-ID
in: header
description: ID of the request, unique to the call, as determined by the initiating party.
required: true
schema:
type: string
format: uuid
- name: X-API-Key
in: header
description: Authorisation key that can be acquired in Sandbox.
required: true
schema:
type: string
responses:
'200':
description: Returns array of authorisation sub-resources.
content:
application/json:
schema:
$ref: '#/components/schemas/JsonGetAuthorisationsResponse'
post:
tags:
- Payment Initiation Service
summary: 'Payment: Start authorisation process'
description: Starts the authorisation process for a payment initiation.
operationId: paymentsStartAuthorization
parameters:
- name: provider-id
in: path
description: Identifier of an ASPSP, previously returned by the system
required: true
schema:
type: string
- name: payment-product
in: path
required: true
schema:
type: string
- name: payment-id
in: path
description: Identification of the related resource
required: true
schema:
type: string
format: uuid
- name: End-User-ID
in: header
description: The system-generated ID of an anonymous End User.
required: true
schema:
type: string
format: uuid
- name: X-Request-ID
in: header
description: ID of the request, unique to the call, as determined by the initiating party.
required: true
schema:
type: string
format: uuid
- name: X-API-Key
in: header
description: Authorisation key that can be acquired in Sandbox.
required: true
schema:
type: string
- name: TPP-Redirect-URI
in: header
description: URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach (including OAuth2 SCA approach).
required: true
schema:
type: string
format: uri
- name: TPP-Nok-Redirect-URI
in: header
description: If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.
schema:
type: string
format: uri
- name: PSU-IP-Address
in: header
description: The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP.
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/JsonPostAuthorisationsResponse'
'201':
description: Created authorisation sub-resource.
servers:
- url: https://aggregation.api.tieto.com
/v1/xs2a/v1.0/providers/{provider-id}/payments/{payment-product}/{payment-id}/authorisations/{authorisation-id}:
get:
tags:
- Payment Initiation Service
summary: 'Payment: Get SCA status request'
description: Checks the SCA status of a authorisation sub-resource.
operationId: paymentsGetAuthorizationStatus
parameters:
- name: provider-id
in: path
description: Identifier of an ASPSP, previously returned by the system
required: true
schema:
type: string
- name: payment-product
in: path
required: true
schema:
type: string
- name: payment-id
in: path
description: Identification of the related resource
required: true
schema:
type: string
format: uuid
- name: End-User-ID
in: header
description: The system-generated ID of an anonymous End User.
required: true
schema:
type: string
format: uuid
- name: X-Request-ID
in: header
description: ID of the request, unique to the call, as determined by the initiating party.
required: true
schema:
type: string
format: uuid
- name: X-API-Key
in: header
description: Authorisation key that can be acquired in Sandbox.
required: true
schema:
type: string
- name: authorisation-id
in: path
description: Identification of the related authorisation sub-resource
required: true
schema:
type: string
responses:
'200':
description: Returns array of authorisation sub-resources.
content:
application/json:
schema:
$ref: '#/components/schemas/JsonGetAuthorisationStatusResponse'
servers:
- url: https://aggregation.api.tieto.com
/v1/xs2a/v1.0/providers/{provider-id}/payments/{payment-product}/{payment-id}/status:
get:
tags:
- Payment Initiation Service
summary: 'Payment: Get Status Request'
description: Can check the status of a payment initiation.
operationId: getJSONPaymentStatus
parameters:
- name: provider-id
in: path
description: Identifier of an ASPSP, previously returned by the system
required: true
schema:
type: string
- name: payment-product
in: path
required: true
schema:
type: string
- name: payment-id
in: path
description: Resource Identification of the related payment.
required: true
schema:
type: string
format: uuid
- name: Accept
in: header
required: true
schema:
type: string
enum:
- application/json
- name: End-User-ID
in: header
description: The system-generated ID of an anonymous End User.
required: true
schema:
type: string
format: uuid
- name: X-Request-ID
in: header
required: true
schema:
type: string
format: uuid
- name: X-API-Key
in: header
description: Authorisation key that can be acquired in Sandbox.
required: true
schema:
type: string
responses:
'200':
description: No errors occurred. Returns payment's transactionStatus
content:
application/json:
schema:
$ref: '#/components/schemas/JsonGetPaymentStatusResponse'
'400':
description: One of mandatory parameters(headers, request body or query parameters) missing or in incorrect format
content:
application/json:
schema:
$ref: '#/components/schemas/JsonErrorResponse'
'404':
description: Payment not found
content:
application/json:
schema:
$ref: '#/components/schemas/JsonErrorResponse'
servers:
- url: https://aggregation.api.tieto.com
/v1/xs2a/v1.0/providers/{provider-id}/payments/{payment-product}:
post:
tags:
- Payment Initiation Service
summary: Payment Initiation with JSON encoding of the Payment Instruction
description: Creates a payment initiation request at the ASPSP.
operationId: initiateJSONPayment
parameters:
- name: provider-id
in: path
description: Identifier of an ASPSP, previously returned by the system
required: true
schema:
type: string
- name: payment-product
in: path
required: true
schema:
type: string
- name: Content-Type
in: header
required: true
schema:
type: string
- name: End-User-ID
in: header
description: The system-generated ID of an anonymous End User.
required: true
schema:
type: string
format: uuid
- name: X-Request-ID
in: header
required: true
schema:
type: string
format: uuid
- name: X-API-Key
in: header
description: Authorisation key that can be acquired in Sandbox.
required: true
schema:
type: string
- name: TPP-Explicit-Authorisation-Preferred
in: header
description: If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket.
schema:
type: boolean
default: false
- name: TPP-Redirect-URI
in: header
description: URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach (including OAuth2 SCA approach).
required: true
schema:
type: string
format: uri
- name: TPP-Nok-Redirect-URI
in: header
description: If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.
schema:
type: string
format: uri
- name: PSU-IP-Address
in: header
description: The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP.
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/JsonPostPaymentResponse'
'201':
description: No errors occurred. In _links section redirect and self links are used.
'400':
description: One of mandatory parameters(headers, request body or query parameters) missing or in incorrect format, creditor address is missing when payment product is cross-border-credit-transfers
content:
application/json:
schema:
$ref: '#/components/schemas/JsonErrorResponse'
'404':
description: invalid payment product
content:
application/json:
schema:
$ref: '#/components/schemas/JsonErrorResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JsonPostPaymentRequest'
servers:
- url: https://aggregation.api.tieto.com
/sandbox/xs2a/v1.3/payments/{payment-product}/{payment-id}:
get:
tags:
- Payment Initiation Service
operationId: getJSONPayment
description: Returns the content of payment object.
summary: Get Payment Details
parameters:
- name: payment-product
in: path
required: true
schema:
type: string
- name: payment-id
in: path
required: true
schema:
type: string
format: uuid
- name: X-Request-ID
in: header
required: true
schema:
type: string
format: uuid
- name: X-API-Key
in: header
description: Authorisation key that can be acquired in Sandbox.
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/JsonGetPaymentResponse_2'
servers:
- url: http://openbanking.api.tieto.com
- url: https://openbanking.api.tieto.com
/sandbox/xs2a/v1.3/payments/{payment-product}/{payment-id}/authorisations:
get:
tags:
- Payment Initiation Service
summary: 'Payment: Get authorisation sub-resources request'
description: Will deliver an array of resource identifications of all generated authorisation sub-resources.
operationId: paymentsGetAuthorizations
parameters:
- name: payment-product
in: path
required: true
schema:
type: string
- name: payment-id
in: path
description: Identification of the related resource
required: true
schema:
type: string
format: uuid
- name: X-Request-ID
in: header
description: ID of the request, unique to the call, as determined by the initiating party.
required: true
schema:
type: string
format: uuid
- name: X-API-Key
in: header
description: Authorisation key that can be acquired in Sandbox.
required: true
schema:
type: string
responses:
'200':
description: Returns array of authorisation sub-resources.
content:
application/json:
schema:
$ref: '#/components/schemas/JsonGetAuthorisationsResponse_2'
post:
tags:
- Payment Initiation Service
summary: 'Payment: Start authorisation process'
description: Starts the authorisation process for a payment initiation.
operationId: paymentsStartAuthorization
parameters:
- name: payment-product
in: path
required: true
schema:
type: string
- name: payment-id
in: path
description: Identification of the related resource
required: true
schema:
type: string
format: uuid
- name: X-Request-ID
in: header
description: ID of the request, unique to the call, as determined by the initiating party.
required: true
schema:
type: string
format: uuid
- name: X-API-Key
in: header
description: Authorisation key that can be acquired in Sandbox.
required: true
schema:
type: string
- name: TPP-Redirect-URI
in: header
description: URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach (including OAuth2 SCA approach).
required: true
schema:
type: string
format: uri
- name: TPP-Nok-Redirect-URI
in: header
description: If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.
schema:
type: string
format: uri
responses:
'201':
description: Created authorisation sub-resource.
content:
application/json:
schema:
$ref: '#/components/schemas/JsonPostAuthorisationsResponse_2'
servers:
- url: http://openbanking.api.tieto.com
- url: https://openbanking.api.tieto.com
/sandbox/xs2a/v1.3/payments/{payment-product}/{payment-id}/authorisations/{authorisation-id}:
get:
tags:
- Payment Initiation Service
summary: 'Payment: Get SCA status request'
description: Checks the SCA status of a authorisation sub-resource.
operationId: paymentsGetAuthorizationStatus
parameters:
- name: payment-id
in: path
description: Identification of the related resource
required: true
schema:
type: string
format: uuid
- name: payment-product
in: path
required: true
schema:
type: string
- name: X-Request-ID
in: header
description: ID of the request, unique to the call, as determined by the initiating party.
required: true
schema:
type: string
format: uuid
- name: X-API-Key
in: header
description: Authorisation key that can be acquired in Sandbox.
required: true
schema:
type: string
- name: authorisation-id
in: path
description: Identification of the related authorisation sub-resource
required: true
schema:
type: string
responses:
'200':
description: Returns array of authorisation sub-resources.
content:
application/json:
schema:
$ref: '#/components/schemas/JsonGetAuthorisationStatusResponse'
servers:
- url: http://openbanking.api.tieto.com
- url: https://openbanking.api.tieto.com
/sandbox/xs2a/v1.3/payments/{payment-product}/{payment-id}/status:
get:
tags:
- Payment Initiation Service
summary: 'Payment: Get Status Request'
description: Can check the status of a payment initiation.
operationId: getJSONPaymentStatus
parameters:
- name: payment-id
in: path
description: Resource Identification of the related payment.
required: true
schema:
type: string
format: uuid
- name: payment-product
in: path
required: true
schema:
type: string
- name: Accept
in: header
required: true
schema:
type: string
enum:
- application/json
- name: X-Request-ID
in: header
required: true
schema:
type: string
format: uuid
- name: X-API-Key
in: header
description: Authorisation key that can be acquired in Sandbox.
required: true
schema:
type: string
responses:
'200':
description: No errors ocurred. Returns payment's transactionStatus
content:
application/json:
schema:
$ref: '#/components/schemas/JsonGetPaymentStatusResponse_2'
'400':
description: One of mandatory parameters(headers, request body or query parameters) missing or in incorrect format
content:
application/json:
schema:
$ref: '#/components/schemas/JsonErrorResponse_2'
'404':
description: Payment not found
content:
application/json:
schema:
$ref: '#/components/schemas/JsonErrorResponse_2'
servers:
- url: http://openbanking.api.tieto.com
- url: https://openbanking.api.tieto.com
/sandbox/xs2a/v1.3/payments/{payment-product}:
post:
tags:
- Payment Initiation Service
summary: Payment Initiation with JSON encoding of the Payment Instruction
description: Creates a payment initiation request at the ASPSP.
operationId: initiateJSONPayment
parameters:
- name: payment-product
in: path
required: true
schema:
type: string
- name: Content-Type
in: header
required: true
schema:
type: string
- name: X-Request-ID
in: header
required: true
schema:
type: string
format: uuid
- name: X-API-Key
in: header
description: Authorisation key that can be acquired in Sandbox.
required: true
schema:
type: string
- name: TPP-Explicit-Authorisation-Preferred
in: header
description: If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket.
schema:
type: boolean
default: false
- name: TPP-Redirect-URI
in: header
description: URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach (including OAuth2 SCA approach).
required: true
schema:
type: string
format: uri
- name: TPP-Nok-Redirect-URI
in: header
description: If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method.
schema:
type: string
format: uri
- name: PSU-IP-Address
in: header
description: The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP.
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/JsonPostPaymentResponse_2'
'201':
description: No errors occurred. In _links section redirect and self links are used.
'400':
description: One of mandatory parameters(headers, request body or query parameters) missing or in incorrect format, creditor address is missing when payment product is cross-border-credit-transfers
content:
application/json:
schema:
$ref: '#/components/schemas/JsonErrorResponse_2'
'404':
description: invalid payment product
content:
application/json:
schema:
$ref: '#/components/schemas/JsonErrorResponse_2'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JsonPostPaymentRequest_2'
servers:
- url: http://openbanking.api.tieto.com
- url: https://openbanking.api.tieto.com
/{sandbox|live}/xs2a-premium/v1.3/future-dated-payments/{payment-product}/{payment-id}:
get:
tags:
- Payment Initiation Service
operationId: getJSONPayment
description: Returns the content of payment object.
summary: 'Payment: Get Payment Details'
parameters:
- $ref: '#/components/parameters/envParam'
- name: payment-product
in: path
required: true
schema:
type: string
enum:
- sepa-credit-transfers
- instant-sepa-credit-transfers
- target-2-payments
- cross-border-credit-transfers
- name: payment-id
in: path
required: true
description: Resource Identification of the related payment.
schema:
type: string
format: uuid
- name: X-Request-ID
in: header
required: true
schema:
type: string
format: uuid
- name: X-API-Key
in: header
description: Authorisation key that can be acquired in TPP developer portal.
required: true
schema:
type: string
- name: Authorization
in: header
description: Is contained only, if an OAuth2 based SCA was performed in the related consent authorisation.
required: false
schema:
type: string
- name: PSU-ID
in: header
description: Client ID of the PSU in the bank.
required: false
schema:
type: string
- name: PSU-Corporate-ID
in: header
description: Corporate client ID of the PSU in the bank.
required: false
schema:
type: string
responses:
200:
description: No errors occurred. Returns consent. link is used.
content:
application/json:
schema:
$ref: '#/components/schemas/JsonGetPaymentResponse_3'
400:
description: One of mandatory parameters(headers, request body or query parameters) missing or in incorrect format
content:
application/json:
schema:
$ref: '#/components/schemas/JsonErrorResponse_3'
404:
description: Consent not found
content:
application/json:
schema:
$ref: '#/components/schemas/JsonErrorResponse_3'
delete
# --- truncated at 32 KB (113 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tietoevry/refs/heads/main/openapi/tietoevry-payment-initiation-service-api-openapi.yml