Security/TrustedBeneficiaries

Security/TrustedBeneficiaries 1.2.0

API implementing processes related with trusted beneficiaries (i.e. whitelisting of accounts or payments), in order to exclude particular monetary transactions or payments from any second factor authentication requirements.

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 TrustedBeneficiaries

Get list of trusted beneficiaries

Get list of trusted beneficiaries

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://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)
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 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

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

/list

get /list
Security TrustedBeneficiaries

Get list of beneficiaries staged for whitelisting

Get list of beneficiaries staged for whitelisting

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://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)
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 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

GetStagedBeneficiaries_Output
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/trustedBeneficiaries/list
Try this operation
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/trustedBeneficiaries/list
accept
Authorization
post /list
Security TrustedBeneficiaries

Add beneficiary to staging list for whitelisting

Add beneficiary to staging list for whitelisting

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://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)
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 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
PostStageBeneficiary_Input
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

PostStageBeneficiary_Output
Example Request
Example Response
POST https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/trustedBeneficiaries/list
Try this operation
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/trustedBeneficiaries/list
content-type
accept
Authorization
delete /list
Security TrustedBeneficiaries

Remove all staged beneficiaries from list for whitelisting

Remove all staged beneficiaries from list for whitelisting

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://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)
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 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

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

/list/{stagedId}

delete /list/{stagedId}
Security TrustedBeneficiaries

Remove a staged beneficiary from list for whitelisting based on its stageId

Remove a staged beneficiary from list for whitelisting based on its stageId

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://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)
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 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

stagedId
Required in path
string
Accept
Optional in header
string
application/json
200

200 OK

DeleteStagedBeneficiary_Output
Example Request
Example Response
DELETE https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/trustedBeneficiaries/list/{stagedId}
Try this operation
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/trustedBeneficiaries/list/{stagedId}
accept
Authorization
stagedId

/validate

post /validate
Security TrustedBeneficiaries

Validate insertion of trusted beneficiaries

Validate insertion of trusted beneficiaries

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://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)
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 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

AddTrustedBeneficiariesValidate_Output
Example Request
Example Response
POST https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/trustedBeneficiaries/validate
Try this operation
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/trustedBeneficiaries/validate
accept
Authorization

/execute

post /execute
Security TrustedBeneficiaries

Execute insertion of trusted beneficiaries

Execute insertion of trusted beneficiaries

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://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)
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 security resources in sandbox
body
Optional in body
object
AddTrustedBeneficiariesExecute_Input
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

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

/{trustedBeneficiaryID}

delete /{trustedBeneficiaryID}
Security TrustedBeneficiaries

Remove a trusted beneficiary

Remove a trusted beneficiary

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://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)
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 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

trustedBeneficiaryID
Required in path
string
Accept
Optional in header
string
application/json
200

200 OK

RemoveTrustedBeneficiary_Output
Example Request
Example Response
DELETE https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/trustedBeneficiaries/{trustedBeneficiaryID}
Try this operation
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/security/trustedBeneficiaries/{trustedBeneficiaryID}
accept
Authorization
trustedBeneficiaryID

Definitions

Object containing information about the beneficiary's bank

{
    "properties": {
        "Name": {
            "type": "string",
            "description": "Bank name of beneficiary's account",
            "example": "EFG EUROBANK ERGASIAS"
        },
        "Bic": {
            "type": "string",
            "description": "Bic of beneficiary's account",
            "example": "ERBKGRAAXXX"
        },
        "Address": {
            "type": "string",
            "description": "Main bank address of beneficiary's account",
            "example": "OTHONOS STREET 8"
        },
        "CountryIsoCode": {
            "type": "string",
            "description": "Country ISO code of beneficiary's account",
            "example": "GR"
        },
        "City": {
            "type": "string",
            "description": "City of beneficiary's bank main address",
            "example": "ATHENS"
        },
        "DomesticBankCode": {
            "type": "string",
            "description": "Domestic bank code of beneficiary's account",
            "example": "026"
        }
    },
    "additionalProperties": false
}

Object containing information about the beneficiary to be staged for whitelisting

{
    "properties": {
        "ProductValue": {
            "type": "string",
            "description": "Account number or payment code for whitelisting"
        },
        "BeneficiaryBank": {
            "$ref": "#\/definitions\/BeneficiaryBank",
            "description": "(Optional. Used in remittances) Object containing information about the beneficiary bank"
        },
        "BeneficiaryName": {
            "type": "string",
            "description": "(Optional. Used in remittances) Name of beneficiary"
        }
    },
    "additionalProperties": false
}

Array of objects of type GetTrustedBeneficiaries_Definition

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

Object containing information about TrustedBeneficiaries

{
    "properties": {
        "WhitelistId": {
            "type": "string",
            "example": "VDA6RPYZ2Mp",
            "description": "Unique identifier of whitelist entry"
        },
        "OperationDescription": {
            "type": "string",
            "example": "Vodafone Mobile\/Fixed",
            "description": "Description of whitelisted operation"
        },
        "WhitelistType": {
            "type": "integer",
            "format": "int32",
            "example": "4",
            "description": "1 = Active, 2 = Destination, 4 = Operation, otherwise = N\/A"
        },
        "WhitelistTypeDescription": {
            "type": "string",
            "example": "Operation",
            "description": "Description of the WhitelistType"
        },
        "DisplayName": {
            "type": "string",
            "example": "Vodafone Mobile\/Fixed",
            "description": "Displayed name of whitelisted beneficiary\/payment operation"
        },
        "UpdateDate": {
            "type": "string",
            "example": "2023-01-16T16:33:38.917",
            "description": "Date of last update"
        }
    },
    "additionalProperties": false
}

Array of objects of type GetStagedBeneficiaries_Definition

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

Object containing information about the beneficiary staged for whitelisting

{
    "properties": {
        "StagedId": {
            "type": "string",
            "description": "Unique identifier of the staged list element"
        },
        "Timestamp": {
            "type": "string",
            "description": "Time of beneficiary staging"
        },
        "DisplayName": {
            "type": "string",
            "description": "Displayed name of beneficiary\/payment operation staged for whitelisting"
        },
        "ProductValue": {
            "type": "string",
            "description": "Account number or payment code staged for whitelisting"
        },
        "Name": {
            "type": "string",
            "description": "Bank name of beneficiary's account"
        },
        "Bic": {
            "type": "string",
            "description": "Bic of beneficiary's account"
        },
        "Address": {
            "type": "string",
            "description": "Main bank address of beneficiary's account"
        },
        "CountryIsoCode": {
            "type": "string",
            "description": "Country ISO code of beneficiary's account"
        },
        "City": {
            "type": "string",
            "description": "City of beneficiary's bank main address"
        },
        "DomesticBankCode": {
            "type": "string",
            "description": "Domestic bank code of beneficiary's account"
        },
        "BeneficiaryName": {
            "type": "string",
            "description": "Name of beneficiary staged for whitelisting"
        }
    },
    "additionalProperties": false
}

Input object required for staging the beneficiary for whitelisting

{
    "properties": {
        "DisplayName": {
            "type": "string",
            "description": "Displayed name of beneficiary\/payment operation staged for whitelisting"
        },
        "ProductValue": {
            "type": "string",
            "description": "Account number or payment code staged for whitelisting"
        },
        "BeneficiaryBank": {
            "$ref": "#\/definitions\/BeneficiaryBank",
            "description": "(Optional. Used in remittances) Object containing information about the beneficiary bank"
        }
    },
    "additionalProperties": false
}

Object containing the response of the request to stage a beneficiary for whitelisting

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

Object containing the response of the request to delete all staged beneficiaries for whitelisting

{
    "properties": {
        "message": {
            "type": "string",
            "description": "Generic success\/failure message",
            "example": "list successfully cleared"
        }
    },
    "additionalProperties": false
}

Object containing the response of the request to delete a staged beneficiary for whitelisting

{
    "properties": {
        "message": {
            "type": "string",
            "description": "Generic success message",
            "example": "staged entry {stagedId} successfully deleted"
        }
    },
    "additionalProperties": false
}

Object containing the output of the request for validating the addition of new trusted beneficiaries

{
    "properties": {
        "SessionKey": {
            "type": "string",
            "description": "Session key used in \/execute"
        }
    },
    "additionalProperties": false
}

Input object required for executing the addition of new trusted beneficiaries

{
    "properties": {
        "SessionKey": {
            "type": "string",
            "description": "Session key fetched from \/validate"
        },
        "ExtraPin": {
            "type": "string",
            "example": "3288000"
        }
    },
    "additionalProperties": false
}

Object containing the output of the request for executing the addition of new trusted beneficiaries

{
    "properties": {
        "message": {
            "type": "string",
            "description": "Generic success\/failure message"
        }
    },
    "additionalProperties": false
}

Object containing the response of the request to delete a trusted beneficiary

{
    "properties": {
        "message": {
            "type": "string",
            "description": "Generic success\/failure message",
            "example": "{whitelistId} successfully deleted"
        }
    },
    "additionalProperties": false
}