TB Payments

Download OpenAPI 2.0 specification (swagger)

To play with our API you should setup Authentication to Sandbox URI.

API URL : https://api.tatrabanka.sk/sandbox/api

API Key

API Key: No API key is available.
- Toggle All

/v1/payments

Show/Hide
List Operations
Expand Operations

The confirmation (signing) of a payment instruction that has been initiated. The identifier of a corresponding payment instruction is identified by a beared toke in the authorization HTTP header field.

Parameters

Parameter	Value	Description
Request-ID		Request-ID An unique identifier of a particular request message. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
Correlation-ID		Correlation-ID An unique correlation identifier correlates the request and the response messages as a pair especially useful for audit logs. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
Process-ID		Process-ID Identifier of a business or technical process to what the set of requests and response pairs are organized. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
PSU-IP-Address		PSU-IP-Address Identifier of a customer's IP address from which he/she is connected to the TPP infrastructure. It might be in the format of IPv4 o IPv6 address.
PSU-Device-OS		PSU-Device-OS A customer's device and/or operating system identification from which he/she is connected to the TPP infrastructure.
PSU-User-Agent		PSU-User-Agent A customer's web browser of other client device identification from which he/she is connected to the TPP infrastructure.
PSU-Geo-Location		PSU-Geo-Location The GPS coordinates of the current customer's location in the moment of connection to the TPP infrastructure.
PSU-Presence		PSU-Presence The presence status of user (PSU) during an API call. The value of the parameter could be 'true' (PSU is present) or 'false' (PSU is not present).

Response Messages

HTTP Status Code	Reason	Response Model
201	Payment instruction signed successfully.
400	The request could not be understood by the bank server due to malformed syntax. Your application should not repeat the request without modifications.
401	The request requires user authentication.
403	The bank server understood the request, but is refusing to fulfill it. Authorization will not help and the request should not be repeated.
500	The bank server encountered an unexpected condition which prevented it from fulfilling the request.
503	The bank server is currently unable to handle the request due to maintenance of the server.

POST /v1/payments/standard/iso

Payment instruction initiation

Implementation Notes

The PISP sends a ISO20022 pain.01 based structure that specifies the payment activation request that i related to a commercial transaction between a PSU and the merchant.

Parameters

Parameter	Value	Description
Request-ID		Request-ID An unique identifier of a particular request message. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
Correlation-ID		Correlation-ID An unique correlation identifier correlates the request and the response messages as a pair especially useful for audit logs. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
Process-ID		Process-ID Identifier of a business or technical process to what the set of requests and response pairs are organized. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
PSU-IP-Address		PSU-IP-Address Identifier of a customer's IP address from which he/she is connected to the TPP infrastructure. It might be in the format of IPv4 o IPv6 address.
PSU-Device-OS		PSU-Device-OS A customer's device and/or operating system identification from which he/she is connected to the TPP infrastructure.
PSU-User-Agent		PSU-User-Agent A customer's web browser of other client device identification from which he/she is connected to the TPP infrastructure.
PSU-Geo-Location		PSU-Geo-Location The GPS coordinates of the current customer's location in the moment of connection to the TPP infrastructure.
PSU-Presence		PSU-Presence The presence status of user (PSU) during an API call. The value of the parameter could be 'true' (PSU is present) or 'false' (PSU is not present).

Response Messages

HTTP Status Code	Reason	Response Model
201	Payment instruction initiated successfully.
400	The request could not be understood by the bank server due to malformed syntax. Your application should not repeat the request without modifications.
401	The request requires user authentication.
403	The bank server understood the request, but is refusing to fulfill it. Authorization will not help and the request should not be repeated.
500	The bank server encountered an unexpected condition which prevented it from fulfilling the request.
503	The bank server is currently unable to handle the request due to maintenance of the server.

POST /v1/payments/ecomm/iso

postPaymentStandardEcomm

Implementation Notes

The PISP sends a ISO20022 pain.001 based structure that specifies the payment activation request. This is the recommended payment type for performing e-commerce transactions.

Parameters

Parameter	Value	Description
Request-ID		Request-ID An unique identifier of a particular request message. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
Correlation-ID		Correlation-ID An unique correlation identifier correlates the request and the response messages as a pair especially useful for audit logs. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
Process-ID		Process-ID Identifier of a business or technical process to what the set of requests and response pairs are organized. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
PSU-IP-Address		PSU-IP-Address Identifier of a customer's IP address from which he/she is connected to the TPP infrastructure. It might be in the format of IPv4 o IPv6 address.
PSU-Device-OS		PSU-Device-OS A customer's device and/or operating system identification from which he/she is connected to the TPP infrastructure.
PSU-User-Agent		PSU-User-Agent A customer's web browser of other client device identification from which he/she is connected to the TPP infrastructure.
PSU-Geo-Location		PSU-Geo-Location The GPS coordinates of the current customer's location in the moment of connection to the TPP infrastructure.
PSU-Presence		PSU-Presence The presence status of user (PSU) during an API call. The value of the parameter could be 'true' (PSU is present) or 'false' (PSU is not present).

Response Messages

HTTP Status Code	Reason	Response Model
201	Payment instruction initiated successfully.
400	The request could not be understood by the bank server due to malformed syntax. Your application should not repeat the request without modifications.
401	The request requires user authentication.
403	The bank server understood the request, but is refusing to fulfill it. Authorization will not help and the request should not be repeated.
500	The bank server encountered an unexpected condition which prevented it from fulfilling the request.
503	The bank server is currently unable to handle the request due to maintenance of the server.

GET /v1/payments/{orderId}/status

getPaymentStatus

Implementation Notes

The information about processing status of a received payment instruction.

Parameters

Parameter	Value	Description
orderId		orderId Payment instruction identifier.
Request-ID		Request-ID An unique identifier of a particular request message. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
Correlation-ID		Correlation-ID An unique correlation identifier correlates the request and the response messages as a pair especially useful for audit logs. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
Process-ID		Process-ID Identifier of a business or technical process to what the set of requests and response pairs are organized. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
PSU-IP-Address		PSU-IP-Address Identifier of a customer's IP address from which he/she is connected to the TPP infrastructure. It might be in the format of IPv4 o IPv6 address.
PSU-Device-OS		PSU-Device-OS A customer's device and/or operating system identification from which he/she is connected to the TPP infrastructure.
PSU-User-Agent		PSU-User-Agent A customer's web browser of other client device identification from which he/she is connected to the TPP infrastructure.
PSU-Geo-Location		PSU-Geo-Location The GPS coordinates of the current customer's location in the moment of connection to the TPP infrastructure.
PSU-Presence		PSU-Presence The presence status of user (PSU) during an API call. The value of the parameter could be 'true' (PSU is present) or 'false' (PSU is not present).

Response Messages

HTTP Status Code	Reason	Response Model
201	Payment status information set.
400	The request could not be understood by the bank server due to malformed syntax. Your application should not repeat the request without modifications.
401	The request requires user authentication.
403	The bank server understood the request, but is refusing to fulfill it. Authorization will not help and the request should not be repeated.
500	The bank server encountered an unexpected condition which prevented it from fulfilling the request.
503	The bank server is currently unable to handle the request due to maintenance of the server.

DELETE /v1/payments/{orderId}/rcp

cancelPayment

Implementation Notes

The operation allows to cancel payment, that were initiated through the same PISP by services Standard Payment Initializaton (XML) or Standard Payment Initializaton (JSON).

Parameters

Parameter	Value	Description
orderId		orderId Payment instruction identifier.
Request-ID		Request-ID An unique identifier of a particular request message. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
Correlation-ID		Correlation-ID An unique correlation identifier correlates the request and the response messages as a pair especially useful for audit logs. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
Process-ID		Process-ID Identifier of a business or technical process to what the set of requests and response pairs are organized. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
PSU-IP-Address		PSU-IP-Address Identifier of a customer's IP address from which he/she is connected to the TPP infrastructure. It might be in the format of IPv4 o IPv6 address.
PSU-Device-OS		PSU-Device-OS A customer's device and/or operating system identification from which he/she is connected to the TPP infrastructure.
PSU-User-Agent		PSU-User-Agent A customer's web browser of other client device identification from which he/she is connected to the TPP infrastructure.
PSU-Geo-Location		PSU-Geo-Location The GPS coordinates of the current customer's location in the moment of connection to the TPP infrastructure.
PSU-Presence		PSU-Presence The presence status of user (PSU) during an API call. The value of the parameter could be 'true' (PSU is present) or 'false' (PSU is not present).

Response Messages

HTTP Status Code	Reason	Response Model
201	Payment order identifier to be canceled.
400	The request could not be understood by the bank server due to malformed syntax. Your application should not repeat the request without modifications.
401	The request requires user authentication.
403	The bank server understood the request, but is refusing to fulfill it. Authorization will not help and the request should not be repeated.
500	The bank server encountered an unexpected condition which prevented it from fulfilling the request.
503	The bank server is currently unable to handle the request due to maintenance of the server.

POST /v2/payments/standard/sba

postPaymentSba

Implementation Notes

The initiation of a simplified payments in the standard format defined by SBA.

Parameters

Parameter	Value	Description
Request-ID		Request-ID An unique identifier of a particular request message. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
Correlation-ID		Correlation-ID An unique correlation identifier correlates the request and the response messages as a pair especially useful for audit logs. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
Process-ID		Process-ID Identifier of a business or technical process to what the set of requests and response pairs are organized. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
PSU-IP-Address		PSU-IP-Address Identifier of a customer's IP address from which he/she is connected to the TPP infrastructure. It might be in the format of IPv4 o IPv6 address.
PSU-Device-OS		PSU-Device-OS A customer's device and/or operating system identification from which he/she is connected to the TPP infrastructure.
PSU-User-Agent		PSU-User-Agent A customer's web browser of other client device identification from which he/she is connected to the TPP infrastructure.
PSU-Geo-Location		PSU-Geo-Location The GPS coordinates of the current customer's location in the moment of connection to the TPP infrastructure.
PSU-Presence		PSU-Presence The presence status of user (PSU) during an API call. The value of the parameter could be 'true' (PSU is present) or 'false' (PSU is not present).

Response Messages

HTTP Status Code	Reason	Response Model
201	Payment instruction initiated successfully.
400	The request could not be understood by the bank server due to malformed syntax. Your application should not repeat the request without modifications.
401	The request requires user authentication.
403	The bank server understood the request, but is refusing to fulfill it. Authorization will not help and the request should not be repeated.
500	The bank server encountered an unexpected condition which prevented it from fulfilling the request.
503	The bank server is currently unable to handle the request due to maintenance of the server.

POST /v2/payments/ecomm/sba

postPaymentSbaEcomm

Implementation Notes

The initiation of a simplified payments in the eCommerce format defined by SBA.

Parameters

Parameter	Value	Description
Request-ID		Request-ID An unique identifier of a particular request message. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
Correlation-ID		Correlation-ID An unique correlation identifier correlates the request and the response messages as a pair especially useful for audit logs. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
Process-ID		Process-ID Identifier of a business or technical process to what the set of requests and response pairs are organized. Although it may be arbitrary string, it is strongly recommended to use a Universally Unique Ifentifier (UUID) version 4 form (RFC4122 https://tools.ietf.org/html/rfc4122).
PSU-IP-Address		PSU-IP-Address Identifier of a customer's IP address from which he/she is connected to the TPP infrastructure. It might be in the format of IPv4 o IPv6 address.
PSU-Device-OS		PSU-Device-OS A customer's device and/or operating system identification from which he/she is connected to the TPP infrastructure.
PSU-User-Agent		PSU-User-Agent A customer's web browser of other client device identification from which he/she is connected to the TPP infrastructure.
PSU-Geo-Location		PSU-Geo-Location The GPS coordinates of the current customer's location in the moment of connection to the TPP infrastructure.
PSU-Presence		PSU-Presence The presence status of user (PSU) during an API call. The value of the parameter could be 'true' (PSU is present) or 'false' (PSU is not present).

Response Messages

HTTP Status Code	Reason	Response Model
201	Payment instruction initiated successfully.
400	The request could not be understood by the bank server due to malformed syntax. Your application should not repeat the request without modifications.
401	The request requires user authentication.
403	The bank server understood the request, but is refusing to fulfill it. Authorization will not help and the request should not be repeated.
500	The bank server encountered an unexpected condition which prevented it from fulfilling the request.
503	The bank server is currently unable to handle the request due to maintenance of the server.

Tatra banka a.s.Developer Portal

TB Payments

/v1/payments

POST /v1/payments/submission

Implementation Notes

Parameters

Response Messages

POST /v1/payments/standard/iso

Implementation Notes

Parameters

Response Messages

POST /v1/payments/ecomm/iso

Implementation Notes

Parameters

Response Messages

GET /v1/payments/{orderId}/status

Implementation Notes

Parameters

Response Messages

DELETE /v1/payments/{orderId}/rcp

Implementation Notes

Parameters

Response Messages

/v2/payments

POST /v2/payments/standard/sba

Implementation Notes

Parameters

Response Messages

POST /v2/payments/ecomm/sba

Implementation Notes

Parameters

Response Messages

Tatra banka APIs

Raiffeisen bank APIs

Other Links

Contacts