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
/codes
get /codes
Transactions
Payments
Retrieve all payment codes
Retrieve all payment codes
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://openbank.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://openbank.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://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/authorize
Token URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/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
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/transactions/payments/codes
Try this operation
/codes/{paymentCode}
get /codes/{paymentCode}
Transactions
Payments
Retrieve information about a specific payment code
Retrieve information about a specific payment code
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://openbank.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://openbank.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://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/authorize
Token URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/token
Scopes
/sandboxapi
Access to all payments resources in sandbox
paymentCode
Required in path
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/transactions/payments/codes/{paymentCode}
Try this operation
/single/{RFCode}/validate
post /single/{RFCode}/validate
Transactions
Payments
Validate a single (RF) payment
Validate a single (RF) payment
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://openbank.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://openbank.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://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/authorize
Token URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/token
Scopes
/sandboxapi
Access to all payments resources in sandbox
RFCode
Required in path
string
payment code in RF999..999 format
payments_single_validate_input
Optional in body
object
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
Example Request
Example Response
POST https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/transactions/payments/single/{RFCode}/validate
Try this operation
/single/{RFCode}/execute/{SessionKey}
post /single/{RFCode}/execute/{SessionKey}
Transactions
Payments
Execute a single (RF) payment
Execute a single (RF) payment
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://openbank.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://openbank.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://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/authorize
Token URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/token
Scopes
/sandboxapi
Access to all payments resources in sandbox
SessionKey
Required in path
string
Session key retrieved from payment validation step
payments_single_execute_input
Optional in body
object
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
Example Request
Example Response
POST https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/transactions/payments/single/{RFCode}/execute/{SessionKey}
Try this operation
/{paymentCode}/validate
post /{paymentCode}/validate
Transactions
Payments
Validate a (non-RF) bill payment
Validate a (non-RF) bill payment
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://openbank.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://openbank.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://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/authorize
Token URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/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
Optional in
object
paymentDetails
Optional 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/transactions/payments/{paymentCode}/validate
Try this operation
/{paymentCode}/execute/{SessionKey}
post /{paymentCode}/execute/{SessionKey}
Transactions
Payments
Execute a (non-RF) bill payment
Execute a (non-RF) bill payment
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://openbank.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://openbank.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://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/authorize
Token URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/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
Optional in
object
SessionKey
Required in path
string
Session key retrieved from payment validation step
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
POST https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/transactions/payments/{paymentCode}/execute/{SessionKey}
Try this operation
/{paymentOrderID}/history
get /{paymentOrderID}/history
Transactions
Payments
Retrieve recurring history of a specific payment order
Retrieve recurring history of a specific payment order
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://openbank.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://openbank.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://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/authorize
Token URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/token
Scopes
/sandboxapi
Access to all payments resources in sandbox
paymentOrderID
Required in path
integer / int64
the id of the payment order to retrieve its execution history (list of payments)
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/transactions/payments/{paymentOrderID}/history
Try this operation
/{paymentOrderID}/{paymentID}
get /{paymentOrderID}/{paymentID}
Transactions
Payments
Retrieve details about a specific transaction/payment
Retrieve details about a specific transaction/payment
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://openbank.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://openbank.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://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/authorize
Token URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/token
Scopes
/sandboxapi
Access to all payments resources in sandbox
paymentOrderID
Required in path
integer / int64
paymentID
Required in path
integer / int64
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/transactions/payments/{paymentOrderID}/{paymentID}
Try this operation
/{paymentOrderID}/action/{action}
put /{paymentOrderID}/action/{action}
Transactions
Payments
Update execution of a specific payment order
Update execution of a specific payment order
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://openbank.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://openbank.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://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/authorize
Token URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/token
Scopes
/sandboxapi
Access to all payments resources in sandbox
paymentOrderID
Required in path
integer / int64
Payment Order ID to act upon
action
Required in path
string
Action to perform on Payment Order (possible values: 0 = Suspend, 1 = Resume, 2 = Cancel, 3 = Complete, 4 = Reversal )
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
PUT https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/transactions/payments/{paymentOrderID}/action/{action}
Try this operation
/history/type/{type}
get /history/type/{type}
Transactions
Payments
Retrieve transaction history per transaction type
Retrieve transaction history per transaction type
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://openbank.piraeusbank.gr/identityserver/connect/authorize
Token URL
https://openbank.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://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/authorize
Token URL
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.1/oauth/oauth2/token
Scopes
/sandboxapi
Access to all payments resources in sandbox
type
Required in path
string
Possible values: done, active, canceled
pageSize
Optional in query
string
Number of rows to return
pagingId
Optional in query
string
Fetch entries after this Payment Order ID
dateFrom
Optional in query
string
Earlier date of the entries to fetch
dateTo
Optional in query
string
Latest date of the entries to fetch
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/transactions/payments/history/type/{type}
Try this operation
Definitions
Standard error object
{
"type": "object",
"properties": {
"httpCode": {
"type": "string",
"description": "Http code of returned error"
},
"httpMessage": {
"type": "string",
"description": "Http message of returned error"
},
"errorCode": {
"type": "string",
"description": "Code of returned error"
},
"errorMessage": {
"type": "string",
"description": "Message of returned error"
}
},
"example": "{\n\t\"httpCode\": \"412\",\n\t\"httpMessage\": \"Precondition Failed\",\n\t\"errorCode\": \"API-987\",\n\t\"errorMessage\": \"sample error message\"\n}"
}
Object containing the input data to be provided for a single (RF) payment to be validated
{
"properties": {
"assetId": {
"type": "string",
"description": "Id of asset from which the payment will be done"
},
"assetType": {
"properties": [],
"type": "string",
"description": "Type of asset from which the payment will done (values 'account', 'creditCard')",
"example": "account"
},
"amount": {
"properties": [],
"type": "number",
"format": "double",
"description": "Amount of the particular payment",
"example": 10.35
},
"currency": {
"properties": [],
"type": "string",
"description": "Currency of the particular payment",
"example": "EUR"
},
"installments": {
"properties": [],
"type": "integer",
"format": "int32",
"description": "number of installments (for specific asset types, e.g. credit card)",
"example": "5"
},
"scheduling": {
"properties": [],
"$ref": "#\/definitions\/Scheduling",
"description": "Scheduling parameters for future payment"
}
},
"additionalProperties": false,
"required": [
"assetId",
"assetType",
"amount",
"currency"
]
}
Object containing the output data to be returned upon validation of a single (RF) payment
{
"properties": {
"Installments": {
"type": "integer",
"format": "int32",
"description": "Number of installments (for specific asset types, e.g. credit card)",
"example": "0"
},
"RFCode": {
"properties": [],
"type": "string",
"description": "The organization's (RF) code of the particular payment",
"example": "RF84907738000300001234567"
},
"PaymentCode": {
"properties": [],
"type": "string",
"description": "Payment code (internal notation)"
},
"PaymentDescription": {
"properties": [],
"type": "string",
"description": "Description of internal payment code",
"example": "DEH"
},
"SessionKey": {
"properties": [],
"type": "string",
"example": "2112c28e9d2342a0b7b2bb94ef523736",
"description": "Session key required along with the OTP for payment execution"
},
"Status": {
"properties": [],
"type": "string",
"example": "Success",
"description": "Status of validation of the particular payment"
},
"Amount": {
"properties": [],
"type": "number",
"format": "double",
"description": "Amount of payment",
"example": 25.3
},
"Currency": {
"properties": [],
"type": "string",
"description": "Currency of payment",
"example": "EUR"
},
"RequiresApproval": {
"properties": [],
"type": "boolean",
"description": "Flag indicating whether the payment requires approval",
"example": "false"
},
"RequiresTransactionalPin": {
"properties": [],
"type": "boolean",
"description": "Flag indicating whether the payment requires OTP"
},
"Execute": {
"properties": [],
"type": "string",
"description": "Date of single payment execution"
},
"Commission": {
"properties": [],
"type": "number",
"format": "double",
"description": "Amount of commissions charged for payment execution"
},
"CommissionCurrency": {
"properties": [],
"type": "string",
"description": "Currency of commissions"
}
},
"additionalProperties": false
}
Object containing the input data to be provided for single (RF) payment execution
{
"properties": {
"ExtraPin": {
"type": "string",
"description": "One Time Pin (OTP) to be provided for payment execution"
}
},
"additionalProperties": false
}
Object containing the output data to be returned upon execution of a single (RF) payment
{
"properties": {
"Succeded": {
"type": "boolean",
"description": "Flag indicating whether the single (RF) payment execution was successful",
"example": ""
},
"TransactionReference": {
"properties": [],
"type": "string",
"description": "Transaction reference number generated upon successful execution of single (RF) payment"
},
"Status": {
"properties": [],
"type": "string",
"description": "Status of payment execution"
},
"Message": {
"properties": [],
"type": "string",
"description": "System message returned"
},
"RequiresApproval": {
"properties": [],
"type": "boolean",
"description": "Flag indicating whether the payment requires approval"
},
"RequiresTransactionalPin": {
"properties": [],
"type": "boolean",
"description": "Flag indicating whether the payment requires OTP"
},
"AssetType": {
"properties": [],
"type": "string",
"description": "Type of asset from which the payment was done"
},
"AssetNumber": {
"properties": [],
"type": "string",
"description": "Id number of asset from which the payment was done"
},
"RFCode": {
"properties": [],
"type": "string",
"description": "The organization's (RF) code of the particular payment"
},
"Amount": {
"properties": [],
"type": "string",
"description": "Amount of the particular payment"
},
"Currency": {
"properties": [],
"type": "string",
"description": "Currency of the particular payment"
},
"Commission": {
"properties": [],
"type": "string",
"description": "Amount of commissions charged for payment execution"
},
"CommissionCurrency": {
"properties": [],
"type": "string",
"description": "Currency of commissions"
},
"Execute": {
"properties": [],
"type": "string",
"description": "Date of single payment execution"
}
},
"additionalProperties": false
}
Object containing the data to be provided for future payment scheduling
{
"properties": {
"ExecuteDate": {
"type": "string",
"format": "date",
"description": "Scheduled date of payment execution",
"example": "'2022-12-31'"
},
"Recurrence": {
"properties": [],
"type": "integer",
"format": "int32",
"description": "Recurrence options ( 0 = None, 1 = First Day of Month, 2 = Last Day of Month, 3 = Specific Day of Month)",
"example": "2"
},
"RecurrenceDay": {
"properties": [],
"type": "integer",
"format": "int32",
"description": "Specific day of month when the payment execution should recur (required when Recurrence value is 3)",
"example": "3"
}
},
"additionalProperties": false
}
Array of objects of type Code_Output
{
"type": "array",
"xml": {
"namespace": ""
},
"items": {
"$ref": "#\/definitions\/Code_Output"
}
}
Object containing the basic information about a specific payment code
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of payment code",
"example": "6303",
"format": "int32"
},
"name": {
"type": "string",
"description": "Name of payment",
"example": "Vodafone Mobile\/Fixed"
},
"definition": {
"properties": {
"categoryID": {
"type": "number"
},
"categoryDescription": {
"type": "string"
},
"subCategoryID": {
"type": "number"
},
"subCategoryDescription": {
"type": "string"
},
"paymentCode": {
"type": "string"
},
"paymentDescription": {
"type": "string"
},
"paymentLogo": {
"type": "string"
},
"isPopularPayment": {
"type": "boolean"
},
"sample": {
"type": "object",
"properties": []
},
"requires2FA": {
"type": "boolean"
},
"ib_action": {
"type": "string"
},
"hostTxCode": {
"type": "string"
},
"useCreditCard": {
"type": "boolean"
},
"numberOfInstallments": {
"type": "number"
},
"useDebitCard": {
"type": "boolean"
},
"usePrepaidCard": {
"type": "boolean"
},
"useAccount": {
"type": "boolean"
},
"onlyPiraeusCards": {
"type": "boolean"
},
"fields": {
"type": "array",
"items": {
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
},
"showOnResult": {
"type": "boolean"
},
"partOfPayment": {
"type": "boolean"
},
"size": {
"type": "number"
},
"length": {
"type": "number"
},
"assetType": {
"type": "array",
"items": {
"properties": {
"name": {
"type": "string"
},
"title": {
"type": "object",
"properties": {
"gr": {
"type": "string"
},
"en": {
"type": "string"
}
}
}
},
"type": "object"
}
}
},
"type": "object"
}
}
},
"$ref": "#\/definitions\/Code_Definition",
"description": "Object containing the definition of a specific payment code"
}
},
"example": " {\r\n \"id\": \"6201\",\r\n \"name\": \"EFKA Employers Contributions\",\r\n \"definition\": {\r\n \"categoryID\": 5,\r\n \"categoryDescription\": \"Public Sector\",\r\n \"subCategoryID\": 504,\r\n \"subCategoryDescription\": \"Social Security Funds\",\r\n \"paymentCode\": \"6201\",\r\n \"paymentDescription\": \"EFKA Employers Contributions\",\r\n \"paymentLogo\": \"images\/BillPayments\/Logo\/6201.png\",\r\n \"isPopularPayment\": true,\r\n \"sample\": {},\r\n \"requires2FA\": false,\r\n \"ib_action\": \"PiraeusBank.InternationalBanking.Services.GenericPayment.6201\",\r\n \"hostTxCode\": \"1000115\",\r\n \"useCreditCard\": true,\r\n \"numberOfInstallments\": 1,\r\n \"useDebitCard\": true,\r\n \"usePrepaidCard\": true,\r\n \"useAccount\": true,\r\n \"onlyPiraeusCards\": false,\r\n \"fields\": [\r\n {\r\n \"name\": \"AssetFrom\",\r\n \"type\": \"text\",\r\n \"mandatory\": true,\r\n \"showOnResult\": false,\r\n \"partOfPayment\": true,\r\n \"size\": 50,\r\n \"length\": 50,\r\n \"assetType\": [\r\n {\r\n \"name\": \"creditCard\",\r\n \"title\": {\r\n \"gr\": \"CreditCard\",\r\n \"en\": \"CreditCard\"\r\n }\r\n },\r\n {\r\n \"name\": \"debitCard\",\r\n \"title\": {\r\n \"gr\": \"DebitCard\",\r\n \"en\": \"DebitCard\"\r\n }\r\n },\r\n {\r\n \"name\": \"prepaidCard\",\r\n \"title\": {\r\n \"gr\": \"PrepaidCard\",\r\n \"en\": \"PrepaidCard\"\r\n }\r\n },\r\n {\r\n \"name\": \"account\",\r\n \"title\": {\r\n \"gr\": \"Account\",\r\n \"en\": \"Account\"\r\n }\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"SubscriberCode\",\r\n \"type\": \"text\",\r\n \"mandatory\": true,\r\n \"showOnResult\": true,\r\n \"partOfPayment\": true,\r\n \"size\": 0,\r\n \"length\": 30,\r\n \"title\": {\r\n \"gr\": \"IKAPaymentCode\",\r\n \"en\": \"IKAPaymentCode\"\r\n }\r\n },\r\n {\r\n \"name\": \"AmountValue\",\r\n \"type\": \"money\",\r\n \"mandatory\": true,\r\n \"showOnResult\": false,\r\n \"partOfPayment\": true,\r\n \"size\": 0,\r\n \"length\": 13,\r\n \"title\": {\r\n \"gr\": \"amount\",\r\n \"en\": \"amount\"\r\n }\r\n }\r\n ]\r\n }\r\n }"
}
Object containing the definition of a specific payment code
{
"type": "object",
"properties": {
"categoryID": {
"type": "integer",
"description": "Unique Identifier of the category in which the payment code belongs",
"format": "int32",
"example": "7"
},
"categoryDescription": {
"type": "string",
"description": "Description of the category in which the payment code belongs",
"example": "Telecommunications"
},
"subCategoryID": {
"type": "integer",
"description": "Unique Identifier of the subcategory in which the payment code belongs",
"format": "int32",
"example": "702"
},
"subCategoryDescription": {
"type": "string",
"description": "Description of the subcategory in which the payment code belongs",
"example": "Telecommunications"
},
"paymentCode": {
"type": "string",
"description": "Payment code",
"example": "6303"
},
"paymentDescription": {
"type": "string",
"description": "Description of payment code",
"example": "Vodafone Mobile\/Fixed"
},
"paymentLogo": {
"type": "string",
"example": "\/images\/BillPayments\/Logo\/6303.png",
"description": "Path of specific payment's logo image"
},
"isPopularPayment": {
"type": "boolean",
"description": "Flag indicating whether the specific payment is popular",
"example": "true"
},
"sample": {
"type": "object",
"properties": [],
"example": "{}",
"description": "Object providing a sample of the payment"
},
"requires2FA": {
"type": "boolean",
"description": "Flag indicating whether the specific payment requires second-factor authentication (OTP)",
"example": "false"
},
"ib_action": {
"type": "integer",
"description": "Internally defined action for specific payment code",
"format": "int32",
"example": "Piraeusbank.InternationalBanking.Services.GenericPayment.6303"
},
"hostTxCode": {
"type": "string",
"description": "Internally generated host transaction code for specific payment",
"example": "1000427"
},
"useCreditCard": {
"type": "boolean",
"description": "Flag indicating whether the specific payment can be executed via credit card",
"example": "true"
},
"numberOfInstallments": {
"type": "integer",
"format": "int32",
"description": "Maximum number of instalments in case of credit card use",
"example": "1"
},
"useDebitCard": {
"type": "boolean",
"description": "Flag indicating whether the specific payment can be executed via debit card",
"example": "true"
},
"usePrepaidCard": {
"type": "boolean",
"description": "Flag indicating whether the specific payment can be executed via prepaid card",
"example": "true"
},
"useAccount": {
"type": "boolean",
"description": "Flag indicating whether the specific payment can be executed via account",
"example": "true"
},
"onlyPiraeusCards": {
"type": "boolean",
"description": "Flag indicating whether the specific payment can be executed via Piraeusbank cards only",
"example": "true"
},
"fields": {
"items": {
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"mandatory": {
"type": "boolean"
},
"showOnResult": {
"type": "boolean"
},
"partOfPayment": {
"type": "boolean"
},
"size": {
"type": "number"
},
"length": {
"type": "number"
},
"assetType": {
"type": "array",
"items": {
"properties": {
"name": {
"type": "string"
},
"title": {
"type": "object",
"properties": {
"gr": {
"type": "string"
},
"en": {
"type": "string"
}
}
}
},
"type": "object"
}
}
},
"type": "object"
},
"$ref": "#\/definitions\/Code_Definition_Fields",
"description": "Object containing additional fields related to the definition of the specific payment code"
}
},
"example": "{\r\n \"categoryID\": 3,\r\n \"categoryDescription\": \"Energy\",\r\n \"subCategoryID\": 302,\r\n \"subCategoryDescription\": \"Gas\",\r\n \"paymentCode\": \"6426\",\r\n \"paymentDescription\": \"Zeni� Gas Utility\",\r\n \"paymentLogo\": \"images\/BillPayments\/Logo\/6426.png\",\r\n \"isPopularPayment\": false,\r\n \"sample\": {},\r\n \"requires2FA\": false,\r\n \"ib_action\": \"PiraeusBank.InternationalBanking.Services.GenericPayment.6426\",\r\n \"hostTxCode\": \"1000140\",\r\n \"useCreditCard\": true,\r\n \"numberOfInstallments\": 9,\r\n \"useDebitCard\": true,\r\n \"usePrepaidCard\": true,\r\n \"useAccount\": true,\r\n \"onlyPiraeusCards\": false,\r\n \"fields\": [\r\n {\r\n \"name\": \"AssetFrom\",\r\n \"type\": \"text\",\r\n \"mandatory\": true,\r\n \"showOnResult\": false,\r\n \"partOfPayment\": true,\r\n \"size\": 50,\r\n \"length\": 50,\r\n \"assetType\": [\r\n {\r\n \"name\": \"creditCard\",\r\n \"title\": {\r\n \"gr\": \"CreditCard\",\r\n \"en\": \"CreditCard\"\r\n }\r\n },\r\n {\r\n \"name\": \"debitCard\",\r\n \"title\": {\r\n \"gr\": \"DebitCard\",\r\n \"en\": \"DebitCard\"\r\n }\r\n },\r\n {\r\n \"name\": \"prepaidCard\",\r\n \"title\": {\r\n \"gr\": \"PrepaidCard\",\r\n \"en\": \"PrepaidCard\"\r\n }\r\n },\r\n {\r\n \"name\": \"account\",\r\n \"title\": {\r\n \"gr\": \"Account\",\r\n \"en\": \"Account\"\r\n }\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"PayeeName\",\r\n \"type\": \"text\",\r\n \"mandatory\": true,\r\n \"showOnResult\": true,\r\n \"partOfPayment\": false,\r\n \"size\": 0,\r\n \"length\": 50,\r\n \"title\": {\r\n \"gr\": \"fullName\",\r\n \"en\": \"fullName\"\r\n }\r\n },\r\n {\r\n \"name\": \"SubscriberCode\",\r\n \"type\": \"text\",\r\n \"mandatory\": true,\r\n \"showOnResult\": true,\r\n \"partOfPayment\": true,\r\n \"size\": 0,\r\n \"length\": 20,\r\n \"title\": {\r\n \"gr\": \"paymentCode\",\r\n \"en\": \"paymentCode\"\r\n }\r\n },\r\n {\r\n \"name\": \"AmountValue\",\r\n \"type\": \"money\",\r\n \"mandatory\": true,\r\n \"showOnResult\": false,\r\n \"partOfPayment\": true,\r\n \"size\": 0,\r\n \"length\": 13,\r\n \"title\": {\r\n \"gr\": \"amount\",\r\n \"en\": \"amount\"\r\n }\r\n }\r\n ]\r\n }"
}
Array of objects of type Code_Definition_Field
{
"type": "array",
"items": {
"$ref": "#\/definitions\/Code_Definition_Field"
}
}
Object containing additional fields related to the definition of the specific payment code
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of field",
"example": "AssetFrom"
},
"type": {
"type": "string",
"description": "Type of field",
"example": "Text"
},
"mandatory": {
"type": "boolean",
"description": "Flag indicating whether the field is mandatory",
"example": "true"
},
"showOnResult": {
"type": "boolean",
"description": "Flag indicating whether the field will be shown in the result of payment execution",
"example": "false"
},
"partOfPayment": {
"type": "boolean",
"description": "Flag indicating whether the field is part of the payment",
"example": "true"
},
"size": {
"type": "integer",
"format": "int32",
"description": "Maximum character size of the particular field",
"example": "50"
},
"length": {
"type": "integer",
"format": "int32",
"description": "Maximum length of the particular field",
"example": "50"
},
"assetType": {
"items": {
"properties": {
"name": {
"type": "string"
},
"title": {
"type": "object",
"properties": {
"gr": {
"type": "string"
},
"en": {
"type": "string"
}
}
}
},
"type": "object"
},
"$ref": "#\/definitions\/Code_Definition_Field_AssetTypeArray",
"description": "Array of objects containing information about each of the asset types available for the specific payment definition"
}
},
"example": "{\r\n \"name\": \"AssetFrom\",\r\n \"type\": \"text\",\r\n \"mandatory\": true,\r\n \"showOnResult\": false,\r\n \"partOfPayment\": true,\r\n \"size\": 50,\r\n \"length\": 50,\r\n \"assetType\": [\r\n {\r\n \"name\": \"creditCard\",\r\n \"title\": {\r\n \"gr\": \"CreditCard\",\r\n \"en\": \"CreditCard\"\r\n }\r\n },\r\n {\r\n \"name\": \"debitCard\",\r\n \"title\": {\r\n \"gr\": \"DebitCard\",\r\n \"en\": \"DebitCard\"\r\n }\r\n },\r\n {\r\n \"name\": \"prepaidCard\",\r\n \"title\": {\r\n \"gr\": \"PrepaidCard\",\r\n \"en\": \"PrepaidCard\"\r\n }\r\n },\r\n {\r\n \"name\": \"account\",\r\n \"title\": {\r\n \"gr\": \"Account\",\r\n \"en\": \"Account\"\r\n }\r\n }\r\n ]\r\n }"
}
Array of objects of type Code_Definition_Field_AssetType
{
"type": "array",
"items": {
"$ref": "#\/definitions\/Code_Definition_Field_AssetType"
}
}
Object containing information about each of the asset types available for the specific payment definition
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of asset type supported for the specific payment code",
"example": "creditCard"
},
"title": {
"properties": {
"gr": {
"type": "string"
},
"en": {
"type": "string"
}
},
"$ref": "#\/definitions\/Code_Definition_Field_AssetType_Title",
"description": "Array of titles of the asset type supported for the specific payment code per language",
"example": ""
}
},
"example": " {\r\n \"name\": \"creditCard\",\r\n \"title\": {\r\n \"gr\": \"CreditCard\",\r\n \"en\": \"CreditCard\"\r\n }\r\n }"
}
Array of titles of the asset type supported for the specific payment code per language (en, gr)
{
"type": "object",
"properties": {
"gr": {
"type": "string",
"description": "Title of asset type in greek locale",
"example": "CreditCard"
},
"en": {
"type": "string",
"description": "Title of asset type in english locale",
"example": "CreditCard"
}
},
"example": "{\r\n \"gr\": \"CreditCard\",\r\n \"en\": \"CreditCard\"\r\n}"
}
Object containing information about the input required by a specific payment code before validation
{
"properties": {
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of the fields that each payment expects as input as provided in the"
},
"scheduling": {
"$ref": "#\/definitions\/Scheduling",
"description": "Object containing information about scheduling payment execution in a future date"
}
},
"additionalProperties": false
}
Object containing information about the output generated upon validation of a specific payment code
{
"type": "object",
"properties": {
"requiredTokenType": {
"type": "integer",
"example": 0,
"format": "int32"
},
"succeeded": {
"type": "boolean",
"example": "true",
"description": "Boolean showing if the validation was successfull"
},
"sessionKey": {
"type": "string",
"example": "286e97192aa141e7a4fe215b60821fc3",
"description": "Session key required along with the OTP for payment execution"
},
"status": {
"type": "string",
"example": "success",
"description": "Status of the validation"
},
"requiresApproval": {
"type": "boolean",
"example": "false",
"description": "True if second signature is needed to complete the execution"
},
"requiresTransactionalPin": {
"type": "boolean",
"example": "true",
"description": "True if second factor authentication (extrapin) is needed"
},
"account": {
"type": "string",
"example": "GR34 0172 1234 1234 1234 1234 123 (Πληρωμών)",
"description": "Iban account that will be charged"
},
"amount": {
"type": "number",
"example": 12.54,
"description": "Amount that will be paid",
"format": "double"
},
"currency": {
"type": "string",
"example": "EUR",
"description": "Currency of the amount to be paid"
},
"commission": {
"type": "number",
"example": 0.6,
"description": "Commission that will be charged",
"format": "double"
},
"commissionCurrency": {
"type": "string",
"example": "EUR",
"description": "Currency of the commission"
},
"execute": {
"type": "string",
"example": "immediately",
"description": "Date of payment execution"
}
},
"example": "{\r\n \"requiredTokenType\": 0,\r\n \"succeeded\": true,\r\n \"sessionKey\": \"286e97192aa141e7a4fe215b60821fc3\",\r\n \"status\": \"Success\",\r\n \"requiresApproval\": false,\r\n \"requiresTransactionalPin\": true,\r\n \"account\": \"GR34 0172 9760 0059 7600 8074 131 (Πληρωμών)\",\r\n \"amount\": 7.1,\r\n \"currency\": \"EUR\",\r\n \"commission\": 0.6,\r\n \"commissionCurrency\": \"EUR\",\r\n \"execute\": \"Immediately\"\r\n}"
}
Object containing information about the input required by a specific payment code before execution
{
"properties": {
"ExtraPin": {
"type": "string",
"description": "One Time Pin (OTP) to be provided for payment execution"
}
},
"additionalProperties": false
}
Object containing information about the output generated upon execution of a specific payment code
{
"properties": {
"Succeeded": {
"type": "boolean",
"description": "Succeeded"
},
"TransactionReference": {
"type": "string",
"description": "Transaction Reference"
},
"Status": {
"type": "string",
"description": "Status"
},
"RequiresApproval": {
"type": "boolean",
"description": "Requires Approval"
},
"BankAccount": {
"type": "string",
"description": "Bank Account"
},
"Account": {
"type": "string",
"description": "Account"
},
"paymentCode": {
"type": "string",
"description": "Payment Code"
},
"Amount": {
"type": "number",
"example": 12.5,
"format": "double",
"description": "Amount that was paid"
},
"Currency": {
"type": "string",
"example": "EUR",
"description": "Currency of the paid amount"
},
"Commission": {
"type": "number",
"format": "double",
"example": 0.5,
"description": "Commission that was charged to execute the payment"
},
"CommissionCurrency": {
"type": "string",
"description": "Currency of charged commission"
},
"Execute": {
"type": "string",
"description": "Date of payment execution"
},
"Message": {
"type": "string",
"description": "Message returned upon execution"
}
},
"additionalProperties": false
}
Array of objects of type PaymentOrder_Payment_Output
{
"type": "array",
"items": {
"$ref": "#\/definitions\/PaymentOrder_Payment_Output"
}
}
Object containing information about a particular payment order
{
"properties": {
"nextPaymentId": {
"type": "integer",
"format": "int32",
"description": "Next Payment Id"
},
"scheduledDate": {
"type": "string",
"format": "date-time",
"description": "Scheduled Date"
},
"amount": {
"$ref": "#\/definitions\/Amount",
"description": "Amount"
},
"status": {
"type": "integer",
"format": "int32",
"description": "Status"
},
"statusDescription": {
"type": "string",
"description": "Status Description"
},
"paymentStatus": {
"type": "integer",
"format": "int32",
"description": "Payment Status"
},
"isRecurring": {
"type": "boolean",
"description": "Is Recurring"
},
"paymentType": {
"type": "string",
"description": "Payment Type"
},
"recipient": {
"type": "string",
"description": "Recipient"
}
},
"additionalProperties": false
}
Object containing information about a particular payment order action
{
"properties": {
"message": {
"type": "string",
"description": "Message"
}
},
"additionalProperties": false
}
Object containing information about an amount
{
"properties": {
"Amount": {
"type": "number",
"format": "double",
"description": "Amount"
},
"Currency": {
"type": "string",
"description": "Currency"
}
},
"additionalProperties": false
}
Object containing detailed information about a specific transaction
{
"properties": {
"paymentTypeDescription": {
"type": "string",
"description": "Payment Type Description"
},
"transactionSearchType": {
"type": "integer",
"description": "Transaction Search Type",
"format": "int32"
},
"executionDate": {
"type": "string",
"description": "Execution Date",
"format": "date-time"
},
"paymentOrderId": {
"type": "integer",
"description": "Payment Order Id",
"format": "int32"
},
"status": {
"type": "integer",
"description": "Status",
"format": "int32"
},
"statusDescription": {
"type": "string",
"description": "Status Description"
},
"reason": {
"type": "string",
"description": "Reason"
},
"posted_date": {
"type": "string",
"description": "Posted Date"
},
"channel": {
"type": "string",
"description": "Channel"
},
"card": {
"type": "string",
"description": "Card"
},
"installments": {
"type": "string",
"description": "Installments"
},
"payment_Code": {
"type": "string",
"description": "Payment Code"
},
"amount": {
"type": "number",
"description": "Amount",
"format": "double"
},
"currency": {
"type": "string",
"description": "Currency"
},
"commission": {
"type": "number",
"description": "Commission",
"format": "double"
},
"executeOn": {
"type": "string",
"description": "Execute On"
}
},
"additionalProperties": false
}
Object containing information about the transaction history of a specific transaction type
{
"properties": {
"LastPaymentId": {
"type": "integer",
"format": "int32",
"description": "Last Payment Id"
},
"PagingPaymentId": {
"type": "string",
"description": "Paging Payment Id"
},
"Transactions": {
"$ref": "#\/definitions\/Transaction_History_Transactions",
"description": "List of Transaction History objects"
}
},
"additionalProperties": false
}
Array of objects of type Transaction_History_TransactionDefinition
{
"type": "array",
"items": {
"$ref": "#\/definitions\/Transaction_History_TransactionDefinition"
}
}
Object containing information about a specific Transaction History element
{
"properties": {
"PaymentOrderId": {
"type": "integer",
"format": "int32",
"description": "Payment Order Id"
},
"PaymentId": {
"properties": [],
"type": "integer",
"format": "int32",
"description": "Payment Id"
},
"PaymentAction": {
"type": "string",
"description": "Payment Action"
},
"CustomerName": {
"type": "integer",
"format": "int32",
"description": "Customer Name"
},
"ExternalApp": {
"type": "string",
"description": "External App"
},
"Description": {
"type": "string",
"description": "Description"
},
"ExecutionDate": {
"type": "string",
"format": "date-time",
"description": "Execution Date"
},
"PostedDate": {
"type": "string",
"format": "date-time",
"description": "Posted Date"
},
"LastExecutionStatus": {
"type": "integer",
"format": "int32",
"description": "Last Execution Status"
},
"LastExecutionStatusDescription": {
"type": "string",
"description": "Last Execution Status Description"
},
"Status": {
"type": "integer",
"format": "int32",
"description": "Status of validation of the particular payment"
},
"StatusDescription": {
"type": "string",
"description": "Status Description"
},
"AccountNumber": {
"type": "string",
"description": "Account Number"
},
"SourceType": {
"type": "integer",
"format": "int32",
"description": "Source Type"
},
"Amount": {
"$ref": "#\/definitions\/Amount",
"description": "Amount of payment"
},
"Recipient": {
"type": "string",
"description": "Recipient"
},
"SearchTransactionType": {
"type": "integer",
"format": "int32",
"description": "Search Transaction Type"
},
"PaymentTransactionType": {
"type": "integer",
"format": "int32",
"description": "Payment Transaction Type"
}
},
"additionalProperties": false
}