Transactions/Payments API supports various kinds of payments (single/RF and bill/non-RF payments)
production
development
https://api.rapidlink.piraeusbank.gr/piraeusbank/production
Base Gateway API Endpoint
Paths
/massPayments/validate
post /massPayments/validate
To use this operation you must use one of the following sets of security requirements.
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Client ID Header
MSIS OAuth
MSIS OAuth
(oauth2 accessCode)
Authorization URL
https://identityserver.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://identityserver.piraeusbank.gr/identityserver/connect/token
Scopes
winbankAccess winbankAccess.info winbankAccess.monetaryTransactions
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Client ID Header
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)
Resource Owner Implicit Grant Type
Authorization URL
https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/authorize
Token URL
https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/token
Scopes
/sandboxapi
Access to all payments resources in sandbox
Authorization
Required in header
string
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2
file
Optional in formData
string
Encrypted file (.pgp) located in form data.
vopId
Optional in formData
string
After the VOP check is finished (if used), this field is required to use the /validate request, and the file is not needed.
withVop
Optional in query
boolean
Set to true if opting into VOP check, default value is false.
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
POST https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/piraeus4all/massPayments/validate
Try this operation
/massPayments/execute
post /massPayments/execute
To use this operation you must use one of the following sets of security requirements.
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Client ID Header
MSIS OAuth
MSIS OAuth
(oauth2 accessCode)
Authorization URL
https://identityserver.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://identityserver.piraeusbank.gr/identityserver/connect/token
Scopes
winbankAccess winbankAccess.info winbankAccess.monetaryTransactions
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Client ID Header
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)
Resource Owner Implicit Grant Type
Authorization URL
https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/authorize
Token URL
https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/token
Scopes
/sandboxapi
Access to all payments resources in sandbox
Authorization
Required in header
string
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2
requestBody
Required in body
object
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
POST https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/piraeus4all/massPayments/execute
Try this operation
/massPayments/vopCheck/{vopId}
get /massPayments/vopCheck/{vopId}
To use this operation you must use one of the following sets of security requirements.
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Client ID Header
MSIS OAuth
MSIS OAuth
(oauth2 accessCode)
Authorization URL
https://identityserver.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://identityserver.piraeusbank.gr/identityserver/connect/token
Scopes
winbankAccess winbankAccess.info winbankAccess.monetaryTransactions
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Client ID Header
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)
Resource Owner Implicit Grant Type
Authorization URL
https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/authorize
Token URL
https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/token
Scopes
/sandboxapi
Access to all payments resources in sandbox
Authorization
Required in header
string
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2
vopId
Required in path
string
Returned in /validate when opting into VOP check.
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/piraeus4all/massPayments/vopCheck/{vopId}
Try this operation
/payrolls/validate
post /payrolls/validate
To use this operation you must use one of the following sets of security requirements.
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Client ID Header
MSIS OAuth
MSIS OAuth
(oauth2 accessCode)
Authorization URL
https://identityserver.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://identityserver.piraeusbank.gr/identityserver/connect/token
Scopes
winbankAccess winbankAccess.info winbankAccess.monetaryTransactions
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Client ID Header
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)
Resource Owner Implicit Grant Type
Authorization URL
https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/authorize
Token URL
https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/token
Scopes
/sandboxapi
Access to all payments resources in sandbox
Authorization
Required in header
string
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2
file
Optional in formData
string
Encrypted file (.pgp) located in form data.
vopId
Optional in formData
string
After the VOP check is finished (if used), this field is required to use the /validate request, and the file is not needed.
withVop
Optional in query
boolean
Set to true if opting into VOP check, default value is false.
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
POST https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/piraeus4all/payrolls/validate
Try this operation
/payrolls/execute
post /payrolls/execute
To use this operation you must use one of the following sets of security requirements.
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Client ID Header
MSIS OAuth
MSIS OAuth
(oauth2 accessCode)
Authorization URL
https://identityserver.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://identityserver.piraeusbank.gr/identityserver/connect/token
Scopes
winbankAccess winbankAccess.info winbankAccess.monetaryTransactions
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Client ID Header
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)
Resource Owner Implicit Grant Type
Authorization URL
https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/authorize
Token URL
https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/token
Scopes
/sandboxapi
Access to all payments resources in sandbox
Authorization
Required in header
string
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2
requestBody
Required in body
object
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
POST https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/piraeus4all/payrolls/execute
Try this operation
/payrolls/vopCheck/{vopId}
get /payrolls/vopCheck/{vopId}
To use this operation you must use one of the following sets of security requirements.
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Client ID Header
MSIS OAuth
MSIS OAuth
(oauth2 accessCode)
Authorization URL
https://identityserver.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://identityserver.piraeusbank.gr/identityserver/connect/token
Scopes
winbankAccess winbankAccess.info winbankAccess.monetaryTransactions
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Client ID Header
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)
Resource Owner Implicit Grant Type
Authorization URL
https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/authorize
Token URL
https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/token
Scopes
/sandboxapi
Access to all payments resources in sandbox
Authorization
Required in header
string
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2
vopId
Required in path
string
Returned in /validate when opting into VOP check.
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/piraeus4all/payrolls/vopCheck/{vopId}
Try this operation
/massPayments/list
get /massPayments/list
To use this operation you must use one of the following sets of security requirements.
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Client ID Header
MSIS OAuth
MSIS OAuth
(oauth2 accessCode)
Authorization URL
https://identityserver.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://identityserver.piraeusbank.gr/identityserver/connect/token
Scopes
winbankAccess winbankAccess.info winbankAccess.monetaryTransactions
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Client ID Header
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)
Resource Owner Implicit Grant Type
Authorization URL
https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/authorize
Token URL
https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/token
Scopes
/sandboxapi
Access to all payments resources in sandbox
Authorization
Required in header
string
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2
dateFrom
Optional in query
string / date-time
dateTo
Optional in query
string / date-time
pageSize
Optional in query
integer / int32
nextPagePositionId
Optional in query
string
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/piraeus4all/massPayments/list
Try this operation
/payrolls/list
get /payrolls/list
To use this operation you must use one of the following sets of security requirements.
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Client ID Header
MSIS OAuth
MSIS OAuth
(oauth2 accessCode)
Authorization URL
https://identityserver.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://identityserver.piraeusbank.gr/identityserver/connect/token
Scopes
winbankAccess winbankAccess.info winbankAccess.monetaryTransactions
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Client ID Header
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)
Resource Owner Implicit Grant Type
Authorization URL
https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/authorize
Token URL
https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/token
Scopes
/sandboxapi
Access to all payments resources in sandbox
Authorization
Required in header
string
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2
dateFrom
Optional in query
string / date-time
dateTo
Optional in query
string / date-time
pageSize
Optional in query
integer / int32
nextPagePositionId
Optional in query
string
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/piraeus4all/payrolls/list
Try this operation
/massPayments/paymentResults/{transactionReference}
get /massPayments/paymentResults/{transactionReference}
To use this operation you must use one of the following sets of security requirements.
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Client ID Header
MSIS OAuth
MSIS OAuth
(oauth2 accessCode)
Authorization URL
https://identityserver.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://identityserver.piraeusbank.gr/identityserver/connect/token
Scopes
winbankAccess winbankAccess.info winbankAccess.monetaryTransactions
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Client ID Header
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)
Resource Owner Implicit Grant Type
Authorization URL
https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/authorize
Token URL
https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/token
Scopes
/sandboxapi
Access to all payments resources in sandbox
Authorization
Required in header
string
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2
transactionReference
Required in path
string
Transaction reference, returned by /list apis. In that API, the transactionReference will be visible once processing of the file is finished in the bank's systems.
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/piraeus4all/massPayments/paymentResults/{transactionReference}
Try this operation
/payrolls/paymentResults/{transactionReference}
get /payrolls/paymentResults/{transactionReference}
To use this operation you must use one of the following sets of security requirements.
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Client ID Header
MSIS OAuth
MSIS OAuth
(oauth2 accessCode)
Authorization URL
https://identityserver.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://identityserver.piraeusbank.gr/identityserver/connect/token
Scopes
winbankAccess winbankAccess.info winbankAccess.monetaryTransactions
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
Client ID Header
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)
Resource Owner Implicit Grant Type
Authorization URL
https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/authorize
Token URL
https://dev.api.piraeusbank.gr/innovationcenter/development/v1.2/oauth/oauth2/token
Scopes
/sandboxapi
Access to all payments resources in sandbox
Authorization
Required in header
string
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2
transactionReference
Required in path
string
Transaction reference, returned by /list apis. In that API, the transactionReference will be visible once processing of the file is finished in the bank's systems.
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/piraeus4all/payrolls/paymentResults/{transactionReference}
Try this operation
Definitions
{
"properties": {
"SessionKey": {
"type": "string",
"example": "4QYCjB0Zas8osivYQxr8XRmdxNGUHj5bLD",
"description": "Returned from the \/validate request."
},
"ExtraPin": {
"type": "string",
"example": "3288000"
}
},
"additionalProperties": false,
"required": [
"SessionKey"
]
}
{
"properties": {
"SessionKey": {
"type": "string",
"description": "Returned from the \/validate request.",
"example": "4QYCjB0Zas8osivYQxr8XRmdxNGUHj5bLD"
},
"ExtraPin": {
"type": "string",
"example": "3288000"
}
},
"additionalProperties": false,
"required": [
"SessionKey"
]
}