Security/Approvals

Security/Approvals 1.2.3

API safeguarding monetrary Transactions, implementing a 2FA mechanism using sms and/or token devices

expand_moreexpand_lessContact information
Rapidlink Support Team
expand_moreexpand_lessLicense
Privacy Policy
forum Discuss this API in the forum
production
development
https://api.rapidlink.piraeusbank.gr/piraeusbank/production

Base Gateway API Endpoint

Paths

/

get /
Security Approvals

Get pending transactions for approval

Get pending transactions for approval

To use this operation you must use one of the following sets of security requirements.
clientIdHeader
X-IBM-Client-Id
(apiKey located in 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)
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)

Resource Owner Implicit Grant Type

Authorization URL
https://dev.api.piraeusbank.gr/innovationcenter/development/oauth/oauth2/authorize
Token URL
https://dev.api.piraeusbank.gr/innovationcenter/development/oauth/oauth2/token
Scopes
/sandboxapi
Access to all security 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

GetApprovals_Output
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/approvals/
Try this operation
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/approvals/
accept
Authorization

/list

get /list
Security Approvals

Get the pending transactions currently listed for approval

Get the pending transactions currently listed for approval

To use this operation you must use one of the following sets of security requirements.
clientIdHeader
X-IBM-Client-Id
(apiKey located in 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)
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)

Resource Owner Implicit Grant Type

Authorization URL
https://dev.api.piraeusbank.gr/innovationcenter/development/oauth/oauth2/authorize
Token URL
https://dev.api.piraeusbank.gr/innovationcenter/development/oauth/oauth2/token
Scopes
/sandboxapi
Access to all security 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

GetAprrovalsList_Output
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/approvals/list
Try this operation
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/approvals/list
accept
Authorization
delete /list
Approvals Security

Clear the list of pending transactions for approval

Clear the list of pending transactions for approval

To use this operation you must use one of the following sets of security requirements.
clientIdHeader
X-IBM-Client-Id
(apiKey located in 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)
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)

Resource Owner Implicit Grant Type

Authorization URL
https://dev.api.piraeusbank.gr/innovationcenter/development/oauth/oauth2/authorize
Token URL
https://dev.api.piraeusbank.gr/innovationcenter/development/oauth/oauth2/token
Scopes
/sandboxapi
Access to all security 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

ClearApprovalsList_Output
Example Request
Example Response
DELETE https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/approvals/list
Try this operation
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/approvals/list
accept
Authorization

/list/{approvalKey}

delete /list/{approvalKey}
Security Approvals

Remove a pending transaction from the list for approval

Remove a pending transaction from the list for approval

To use this operation you must use one of the following sets of security requirements.
clientIdHeader
X-IBM-Client-Id
(apiKey located in 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)
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)

Resource Owner Implicit Grant Type

Authorization URL
https://dev.api.piraeusbank.gr/innovationcenter/development/oauth/oauth2/authorize
Token URL
https://dev.api.piraeusbank.gr/innovationcenter/development/oauth/oauth2/token
Scopes
/sandboxapi
Access to all security 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

approvalKey
Required in path
integer / int64

Unique key of the approval that needs to be added to or deleted from the approvals' list

Accept
Optional in header
string
application/json
200

200 OK

DeleteFromList_Output
Example Request
Example Response
DELETE https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/approvals/list/{approvalKey}
Try this operation
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/approvals/list/{approvalKey}
accept
Authorization
approvalKey
post /list/{approvalKey}
Security Approvals

Add a pending transaction into the list for approval

Add a pending transaction into the list for approval

To use this operation you must use one of the following sets of security requirements.
clientIdHeader
X-IBM-Client-Id
(apiKey located in 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)
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)

Resource Owner Implicit Grant Type

Authorization URL
https://dev.api.piraeusbank.gr/innovationcenter/development/oauth/oauth2/authorize
Token URL
https://dev.api.piraeusbank.gr/innovationcenter/development/oauth/oauth2/token
Scopes
/sandboxapi
Access to all security 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

approvalKey
Required in path
integer / int64

Unique key of the approval that needs to be added to or deleted from the approvals' list

Accept
Optional in header
string
application/json
200

200 OK

InsertToList_Output
Example Request
Example Response
POST https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/approvals/list/{approvalKey}
Try this operation
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/approvals/list/{approvalKey}
accept
Authorization
approvalKey

/validate

post /validate
Security Approvals

Validates and stages the transactions for approval

Validates and stages the transactions for approval

To use this operation you must use one of the following sets of security requirements.
clientIdHeader
X-IBM-Client-Id
(apiKey located in 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)
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)

Resource Owner Implicit Grant Type

Authorization URL
https://dev.api.piraeusbank.gr/innovationcenter/development/oauth/oauth2/authorize
Token URL
https://dev.api.piraeusbank.gr/innovationcenter/development/oauth/oauth2/token
Scopes
/sandboxapi
Access to all security 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

ApproveValidate_Output
Example Request
Example Response
POST https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/approvals/validate
Try this operation
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/approvals/validate
accept
Authorization
delete /validate
Security Approvals

Validates and stages the transactions for rejection

Validates and stages the transactions for rejection

To use this operation you must use one of the following sets of security requirements.
clientIdHeader
X-IBM-Client-Id
(apiKey located in 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)
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)

Resource Owner Implicit Grant Type

Authorization URL
https://dev.api.piraeusbank.gr/innovationcenter/development/oauth/oauth2/authorize
Token URL
https://dev.api.piraeusbank.gr/innovationcenter/development/oauth/oauth2/token
Scopes
/sandboxapi
Access to all security 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

RejectValidate_Output
Example Request
Example Response
DELETE https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/approvals/validate
Try this operation
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/approvals/validate
accept
Authorization

/execute

post /execute
Security Approvals

Executes the approval/rejection of pending transactions

Executes the approval/rejection of pending transactions

To use this operation you must use one of the following sets of security requirements.
clientIdHeader
X-IBM-Client-Id
(apiKey located in 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)
Sandbox OAuth
Sandbox OAuth
(oauth2 accessCode)

Resource Owner Implicit Grant Type

Authorization URL
https://dev.api.piraeusbank.gr/innovationcenter/development/oauth/oauth2/authorize
Token URL
https://dev.api.piraeusbank.gr/innovationcenter/development/oauth/oauth2/token
Scopes
/sandboxapi
Access to all security 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

body
Required in body
object

Input required to execute approval/rejection of pending transactions

Execute_Input
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Execute_Output
Example Request
Example Response
POST https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/approvals/execute
Try this operation
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/approvals/execute
content-type
accept
Authorization

Definitions

Standard error object

{
    "type": "object",
    "properties": {
        "httpCode": {
            "type": "string",
            "description": "Http code of error"
        },
        "httpMessage": {
            "type": "string",
            "description": "Http message of error"
        },
        "errorCode": {
            "type": "string",
            "description": "Error code"
        },
        "errorMessage": {
            "type": "string",
            "description": "Error message"
        }
    },
    "example": "{\n\t\"httpCode\": \"412\",\n\t\"httpMessage\": \"Precondition Failed\",\n\t\"errorCode\": \"API-987\",\n\t\"errorMessage\": \"sample error message\"\n}"
}

Array of pending approvals

{
    "type": "array",
    "items": {
        "$ref": "#\/definitions\/ApprovalDetails_Definition"
    }
}

Object containing information about the details of a specific approval

{
    "properties": {
        "ApprovalKey": {
            "type": "string",
            "example": "MF80ODM0NTNfOTI4N183NTQ2MzMxNw",
            "description": "Generated key for each record"
        },
        "KeyType": {
            "type": "integer",
            "example": "1",
            "format": "int64",
            "description": "0 = Other, 1 = Own"
        },
        "PendingOperationiD": {
            "type": "integer",
            "format": "int64",
            "example": "9287",
            "description": "Unique identifier of the pending operation."
        },
        "PaymentOrderId": {
            "type": "integer",
            "format": "int64",
            "example": "75463317",
            "description": "Unique identifier of the payment order waiting for approval"
        },
        "UserName": {
            "type": "string",
            "example": "ΟΝΟΜΑ ΕΠΩΝΥΜΟ",
            "description": "Name of the user that has requested the operation"
        },
        "UserAlias": {
            "type": "string",
            "example": "UserE",
            "description": "User alias that has requested the operation"
        },
        "TransactionDescription": {
            "type": "string",
            "example": "BILL PAYMENT",
            "description": "Localized description of the requested operation"
        },
        "PostDate": {
            "type": "string",
            "example": "2023-01-04T00:00:00",
            "description": "Date of request creation"
        },
        "Amount": {
            "type": "number",
            "format": "double",
            "example": 40,
            "description": "Amount  of the pending operation, if it is a monetary transaction"
        },
        "Currency": {
            "type": "string",
            "example": "EUR",
            "description": "Currency  of the pending operation, if it is a monetary transaction"
        },
        "AssetNumber": {
            "type": "string",
            "example": "GR28 0171 8220 0070 6113 3122 113",
            "description": "Source asset of the operation under approval"
        },
        "Destination": {
            "type": "string",
            "example": "1234567",
            "description": "Destination asset of the operation under approval"
        },
        "ApprovalStarted": {
            "type": "boolean",
            "example": "false",
            "description": "Flag indicating whether the approval process has started"
        }
    },
    "additionalProperties": false
}

Object containing information about a specific entry of the approval list

{
    "properties": {
        "TimeStamp": {
            "type": "string",
            "example": "2023-02-08T11:29:23.5533333",
            "description": "Timestamp of the entry in the approvals list"
        },
        "UserID": {
            "type": "string",
            "example": "483453",
            "description": "Unique identifier of the user requesting the entry into the approvals list"
        },
        "ClientID": {
            "type": "string",
            "description": "Client Id of the application used to make the entry into the approvals list"
        },
        "ApprovalKey": {
            "type": "string",
            "example": "MV80ODM0NTNfOTI4NF83NTQ2MzMxNA",
            "description": "Generated key for each approval entrly"
        },
        "KeyType": {
            "type": "integer",
            "format": "int64",
            "example": "1",
            "description": "0 = Other, 1 = Own"
        },
        "savedUserId": {
            "type": "string",
            "example": "483453",
            "description": "Unique identifier of the user requesting the entry into the approvals list"
        },
        "PendingOperationiD": {
            "type": "integer",
            "format": "int64",
            "example": "9284",
            "description": "Unique identifier of the pending operation."
        },
        "PaymentOrderId": {
            "type": "integer",
            "format": "int64",
            "example": "75463314",
            "description": "Unique identifier of the payment order waiting for approval"
        },
        "errorCode": {
            "type": "integer",
            "format": "int32",
            "description": "Code of possible error returned during the insertion into the approvals' list"
        },
        "errorMessage": {
            "type": "string",
            "description": "Message of possible error returned during the insertion into the approvals' list"
        }
    },
    "additionalProperties": false
}

Array of multiple ApprovalResults objects

{
    "type": "array",
    "items": {
        "$ref": "#\/definitions\/ApprovalResults_Definition"
    }
}

Object containing information about a specific approval result

{
    "type": "object",
    "properties": {
        "approvalKey": {
            "type": "string",
            "description": "Generated key for each approvals list element",
            "example": "MF80ODM0NTBfMzAyOF83NTQ2NDExMg"
        },
        "status": {
            "type": "integer",
            "format": "int32",
            "example": "1",
            "description": "0 = NA, 1 = Success, 2 = Warning, 3 = Failure"
        },
        "statusDescription": {
            "type": "string",
            "example": "Completed",
            "description": "Description of status"
        },
        "comment": {
            "type": "string",
            "example": "EB17061900626009"
        }
    },
    "additionalProperties": false
}
              
{
    "type": "object",
    "properties": {
        "Own": {
            "description": "User's own pending transactions",
            "$ref": "#\/definitions\/Approvals_ApprovalDetails",
            "type": "object"
        },
        "Other": {
            "description": "Other users' pending transactions",
            "$ref": "#\/definitions\/Approvals_ApprovalDetails",
            "type": "array",
            "items": {
                "type": "string"
            }
        }
    }
}

Array of ApprovalListEntry elements

{
    "type": "array",
    "example": "{\n\t\"OwnPending\": [\n\t\t{\n\t\t\t\"PendingOperationId\": 1,\n\t\t\t\"PaymentOrderId\": 1,\n\t\t\t\"UserName\": \"sample string 2\",\n\t\t\t\"UserAlias\": \"sample string 3\",\n\t\t\t\"TransactionDescription\": \"sample string 9\",\n\t\t\t\"PostDate\": \"2017-10-05T15:14:36.1784204+03:00\",\n\t\t\t\"Amount\": 1.0,\n\t\t\t\"Currency\": \"sample string 2\",\n\t\t\t\"AssetNumber\": \"sample string 6\",\n\t\t\t\"Destination\": \"sample string 7\",\n\t\t\t\"PendingType\": 0,\n\t\t\t\"HasApprovals\": true\n\t\t}\n\t],\n\t\"OtherPending\": [\n\t\t{\n\t\t\t\"PendingOperationId\": 1,\n\t\t\t\"PaymentOrderId\": 1,\n\t\t\t\"UserName\": \"sample string 2\",\n\t\t\t\"UserAlias\": \"sample string 3\",\n\t\t\t\"TransactionDescription\": \"sample string 9\",\n\t\t\t\"PostDate\": \"2017-10-05T15:14:36.1784204+03:00\",\n\t\t\t\"Amount\": 1.0,\n\t\t\t\"Currency\": \"sample string 2\",\n\t\t\t\"AssetNumber\": \"sample string 6\",\n\t\t\t\"Destination\": \"sample string 7\",\n\t\t\t\"PendingType\": 0,\n\t\t\t\"HasApprovals\": true\n\t\t}\n\t]\n}\n",
    "items": {
        "$ref": "#\/definitions\/Approvals_GetList_ApprovalListEntry"
    }
}

Object containing the output of the request to clear the approvals list

{
    "properties": {
        "message": {
            "type": "string",
            "example": "List successfully cleared",
            "description": "Generic success message"
        }
    },
    "additionalProperties": false
}

Object containing the output of the request to insert a record into the approvals list

{
    "properties": {
        "message": {
            "type": "string",
            "description": "Generic success message",
            "example": "Successfully added"
        }
    },
    "additionalProperties": false
}

Object containing the output of the request to delete a record from the approvals list

{
    "properties": {
        "message": {
            "type": "string",
            "description": "Generic success message",
            "example": "Entry {approvalKey} successfully deleted from list"
        }
    },
    "additionalProperties": false
}

Object containing the response of the request to validate one or more approvals

{
    "properties": {
        "SessionKey": {
            "type": "string"
        },
        "approvalKeys": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "Array of approval keys (strings)"
        }
    },
    "additionalProperties": false
}

Object containing the response of the request to validate one or more rejections

{
    "properties": {
        "SessionKey": {
            "type": "string"
        },
        "approvalKeys": {
            "type": "array",
            "description": "Array of approval keys (strings)",
            "items": {
                "type": "string"
            }
        }
    },
    "additionalProperties": false
}

Request object for execution of one or more approvals/rejections based on the session key of the respective validation

{
    "properties": {
        "SessionKey": {
            "type": "string"
        },
        "ExtraPin": {
            "type": "string",
            "example": "3288000"
        }
    },
    "additionalProperties": false,
    "required": [
        "SessionKey"
    ]
}

Object containing the response of the request to execute one or more approvals/rejections based on the session key of the respective validation

{
    "properties": {
        "SessionKey": {
            "type": "string"
        },
        "ApprovalResults": {
            "description": "Array of approval keys (strings)",
            "items": {
                "type": "string"
            },
            "$ref": "#\/definitions\/Approvals_ApprovalResults"
        }
    },
    "additionalProperties": false
}