Premium Payments API

Download Premium API Payments - 1.0 specification (swagger)

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

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

API Key

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

/v1/{payment-service}

Show/Hide
List Operations
Expand Operations

POST /v1/{payment-service}/{payment-product}

initiatePayment

Implementation Notes

This method is used to initiate sepa credit transfer payment.

Parameters

Parameter	Value	Description
payment-service		*payment-service Payment service: Possible value is: payments * bulk-payments**
payment-product		payment-product The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: - sepa-credit-transfers - pain.001-sepa-credit-transfers - instant-sepa-credit-transfers - pain.001-instant-sepa-credit-transfers
PSU-ID		PSU-ID Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session. In this case the ASPSP might check whether PSU-ID and token match, according to ASPSP documentation.
PSU-Corporate-ID		PSU-Corporate-ID Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type		PSU-Corporate-ID-Type Might be mandated in the ASPSP's documentation. Only used in a corporate context.
X-Request-ID		X-Request-ID ID of the request, unique to the call, as determined by the initiating party.
PSU-IP-Address		PSU-IP-Address 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.
PSU-Application		PSU-Application The Application name, if available.
Instant-Payment-Flow		Instant-Payment-Flow This attribute is valid only if payment-product is set to instant-sepa-credit-transfers, otherwise ignored. Value 'OPTIONAL' means that if its NOT possible to process payment set with payment-product as instant (Technical reasons), the payment will be automatically switched to standard sepa-credit-transfer ,otherwise If the value is set to 'MANDATORY', the payment will be rejected.
Content-Type		Content-Type

Response Messages

HTTP Status Code	Reason	Response Model
201	CREATED
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not found
405	Method Not Allowed
408	Request Timeout
409	Conflict
415	Unsupported Media Type
500	Internal Server Error
503	Service Unavailable

PUT /v1/{payment-service}/{payment-product}/{paymentId}/authorizations/{authorizationId}

submit

Implementation Notes

Initialized payment is submitted after calling this method.

Parameters

Parameter	Value	Description
payment-service		*payment-service Payment service: Possible value is: payments * bulk-payments**
payment-product		payment-product The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: - sepa-credit-transfers - pain.001-sepa-credit-transfers - instant-sepa-credit-transfers - pain.001-instant-sepa-credit-transfers
authorizationId		authorizationId
paymentId		paymentId Resource identification of the generated payment initiation resource.
PSU-ID		PSU-ID Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session. In this case the ASPSP might check whether PSU-ID and token match, according to ASPSP documentation.
PSU-Corporate-ID		PSU-Corporate-ID Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type		PSU-Corporate-ID-Type Might be mandated in the ASPSP's documentation. Only used in a corporate context.
X-Request-ID		X-Request-ID ID of the request, unique to the call, as determined by the initiating party.
PSU-IP-Address		PSU-IP-Address 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.
PSU-Application		PSU-Application The Application name, if available.

Response Messages

HTTP Status Code	Reason	Response Model
201	Payment has been submitted
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not found
405	Method Not Allowed
408	Request Timeout
409	Conflict
415	Unsupported Media Type
500	Internal Server Error
503	Service Unavailable

GET /v1/{payment-service}/{payment-product}/{paymentId}/authorizations/{authorizationId}

getPaymentInitiationScaStatus

Implementation Notes

Read the SCA status of the payment authorisation

Parameters

Parameter	Value	Description
payment-service		*payment-service Payment service: Possible value is: payments * bulk-payments**
payment-product		payment-product The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: - sepa-credit-transfers - pain.001-sepa-credit-transfers - instant-sepa-credit-transfers - pain.001-instant-sepa-credit-transfers
authorizationId		authorizationId
paymentId		paymentId Resource identification of the generated payment initiation resource.
PSU-ID		PSU-ID Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session. In this case the ASPSP might check whether PSU-ID and token match, according to ASPSP documentation.
PSU-Corporate-ID		PSU-Corporate-ID Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type		PSU-Corporate-ID-Type Might be mandated in the ASPSP's documentation. Only used in a corporate context.
X-Request-ID		X-Request-ID ID of the request, unique to the call, as determined by the initiating party.
PSU-IP-Address		PSU-IP-Address 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.
PSU-Application		PSU-Application The Application name, if available.

Response Messages

HTTP Status Code	Reason	Response Model
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not found
405	Method Not Allowed
408	Request Timeout
409	Conflict
415	Unsupported Media Type
500	Internal Server Error
503	Service Unavailable

DELETE /v1/{payment-service}/{payment-product}/{paymentId}

deletePaymentRequest

Implementation Notes

Payment cancellation request

Parameters

Parameter	Value	Description
payment-service		*payment-service Payment service: Possible value is: payments * bulk-payments**
payment-product		payment-product The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: - sepa-credit-transfers - pain.001-sepa-credit-transfers - instant-sepa-credit-transfers - pain.001-instant-sepa-credit-transfers
paymentId		paymentId Resource identification of the generated payment initiation resource.
PSU-ID		PSU-ID Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session. In this case the ASPSP might check whether PSU-ID and token match, according to ASPSP documentation.
PSU-Corporate-ID		PSU-Corporate-ID Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type		PSU-Corporate-ID-Type Might be mandated in the ASPSP's documentation. Only used in a corporate context.
X-Request-ID		X-Request-ID ID of the request, unique to the call, as determined by the initiating party.
PSU-IP-Address		PSU-IP-Address 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.
PSU-Application		PSU-Application The Application name, if available.

Response Messages

HTTP Status Code	Reason	Response Model
202	Received
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not found
405	Method Not Allowed
408	Request Timeout
409	Conflict
415	Unsupported Media Type
500	Internal Server Error
503	Service Unavailable

GET /v1/{payment-service}/{payment-product}/{paymentId}/status

getPaymentStatus

Implementation Notes

Get payment status

Parameters

Parameter	Value	Description
payment-service		*payment-service Payment service: Possible value is: payments * bulk-payments**
payment-product		payment-product The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: - sepa-credit-transfers - pain.001-sepa-credit-transfers - instant-sepa-credit-transfers - pain.001-instant-sepa-credit-transfers
paymentId		paymentId Resource identification of the generated payment initiation resource.
PSU-ID		PSU-ID Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session. In this case the ASPSP might check whether PSU-ID and token match, according to ASPSP documentation.
PSU-Corporate-ID		PSU-Corporate-ID Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type		PSU-Corporate-ID-Type Might be mandated in the ASPSP's documentation. Only used in a corporate context.
X-Request-ID		X-Request-ID ID of the request, unique to the call, as determined by the initiating party.
PSU-IP-Address		PSU-IP-Address 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.
PSU-Application		PSU-Application The Application name, if available.

Response Messages

HTTP Status Code	Reason	Response Model
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not found
405	Method Not Allowed
408	Request Timeout
409	Conflict
415	Unsupported Media Type
500	Internal Server Error
503	Service Unavailable

Tatra banka a.s.Developer Portal

Premium Payments API

/v1/{payment-service}

POST /v1/{payment-service}/{payment-product}

Implementation Notes

Parameters

Response Messages

PUT /v1/{payment-service}/{payment-product}/{paymentId}/authorizations/{authorizationId}

Implementation Notes

Parameters

Response Messages

GET /v1/{payment-service}/{payment-product}/{paymentId}/authorizations/{authorizationId}

Implementation Notes

Parameters

Response Messages

DELETE /v1/{payment-service}/{payment-product}/{paymentId}

Implementation Notes

Parameters

Response Messages

GET /v1/{payment-service}/{payment-product}/{paymentId}/status

Implementation Notes

Parameters

Response Messages

Tatra banka APIs

Raiffeisen bank APIs

Other Links

Contacts