---
swagger: "2.0"
info:
x-ibm-name: customer
title: Customer
version: 1.2.6
description: Customer API returns customer's information and Logout function hat
logs a user out from the API.
contact:
name: rapidlink support
email: rapidlink@piraeusbank.gr
url: https://rapidlink.piraeusbank.gr
license:
url: https://rapidlink.piraeusbank.gr/terms
name: Terms and Conditions of Use
termsOfService: Privacy Policy
schemes:
- https
basePath: /v1.2/customer
consumes:
- application/json
produces:
- application/json
- lisa.pavlidi@gr.ey.com
securityDefinitions:
MSIS OAuth:
type: oauth2
description: OAuth URLs to use in the dev, uat and production environment using
the access code OAuth 2.0 flow.
flow: accessCode
scopes:
winbankAccess winbankAccess.info: ""
authorizationUrl: https://openbank.piraeusbank.gr/identityserver/connect/authorize
tokenUrl: https://openbank.piraeusbank.gr/identityserver/connect/token
x-tokenIntrospect:
url: https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/v1.2/oauth/external/introspect
Sandbox OAuth:
type: oauth2
description: OAuth URLs to use in the sandbox environment using the access
code OAuth 2.0 flow
flow: accessCode
authorizationUrl: https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/oauth/oauth2/authorize
scopes:
/sandboxapi: Scope to access to the APIs in the sandbox environment
tokenUrl: https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2/oauth/oauth2/token
x-tokenIntrospect:
url: https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/v1.2/oauth/internal/introspect
clientIdHeader:
type: apiKey
description: The client id of the application as obtained by registering
the client application in the developers portal.
in: header
name: X-IBM-Client-Id
x-ibm-configuration:
testable: true
enforced: true
phase: realized
categories:
- Core Banking / Customer
paths:
/info:
get:
responses:
200:
description: 200 OK
schema:
$ref: '#/definitions/Customer_Info_Output'
400:
description: Bad Request
schema:
$ref: '#/definitions/Error_Output'
401:
description: Unauthorized
schema:
$ref: '#/definitions/Error_Output'
404:
description: Not Found
schema:
$ref: '#/definitions/Error_Output'
440:
description: Login Time-out
schema:
$ref: '#/definitions/Error_Output'
501:
description: Not Implemented
schema:
$ref: '#/definitions/Error_Output'
description: This service contains demographic information corresponding to
the customer associated with OAuth bearer token supplied. The information
returned includes information such as name, address, telephone numbers, email
address etc.
summary: This operation returns information related to the customer
tags:
- customer
- demographics
- core banking
deprecated: false
parameters:
- $ref: '#/parameters/Authorization'
definitions:
Error_Output:
description: ""
type: object
properties:
httpCode:
type: string
httpMessage:
type: string
errorCode:
type: string
errorMessage:
type: string
example: "{\n\t\"httpCode\": \"412\",\n\t\"httpMessage\": \"Precondition Failed\",\n\t\"errorCode\":
\"API-987\",\n\t\"errorMessage\": \"sample error message\"\n}"
Customer_Info_Output:
description: The response to the customer info operation
type: object
properties:
Quarantine:
type: boolean
description: A boolean property
Body:
type: object
properties:
SiteCode:
type: string
description: The country where the customer is based e.g. GR
ChannelCode:
type: string
description: The channel that is used currently e.g. EB - electronic banking
CultureName:
type: string
description: The locale of the user. Messages are returned in this locale
e.g. el-GR
UserId:
type: number
description: The user id of the customer e.g. 483450 - this is an internal
bank number
UserAlias:
type: string
description: The user alias of the customer - it is essentially the user
name that was used for authentication
DisplayName:
type: string
description: The display name - e.g. Shatoshi Nakamoto
Firstname:
type: string
description: The given name of the customer e.g. Shatoshi
Surname:
type: string
description: The last name of the customer e.g. Nakamoto
Fathername:
type: string
description: The name of the father of the customer e.g. Yanis
AddressOfCustomer:
type: string
description: The postal address of the customer e.g. ΧΕΙΜΑΡΑΣ 8B, 15125,
ΜΑΡΟΥΣΙ ΑΤΤΙΚΗΣ, GR-ΕΛΛΑΔΑ
Email:
type: string
description: The email address of the customer e.g. sNakamoto@bitcoin.gr
IsCorporate:
type: boolean
description: Whether the customer is a corporate customer true/false
ExtraPinMobile:
type: string
description: The mobile number to receive the extra pin information e.g.
+306946666666
NativeSalutation:
type: string
description: A salutation string in the language (culture name) of the
customer e.g Welcome Mr. Shatoshi Nakamoto
TaxCode:
type: string
description: The tax code (AFM) of the customer e.g. 012345678
IDCardOrPassport:
type: string
description: The id card number or passport number of the customer eg.
X123456
LastLogin:
type: string
description: The date of last login of the customer eg. 2017-03-08T16:11:00
HasExtraPin:
type: boolean
description: Whether the customer has an extra pin capability true/false
HasOtp:
type: boolean
description: Whether the customer has one time password token capability
true/false
BirthDate:
type: string
description: The birthdate of the customer e.g. 1971-12-07T00:00:00
description: The body of the response to the customer info operation
example: "{\n\t\"Quarantine\": false,\n\t\"Body\": {\n\t\t\"SiteCode\": \"GR\",\n\t\t\"ChannelCode\":
\"EB\",\n\t\t\"CultureName\": \"el-GR\",\n\t\t\"UserId\": 123456,\n\t\t\"UserAlias\":
\"UserAAA\",\n\t\t\"DisplayName\": \"ΗΛΙΑΣ ΓΕΩΡΓΙΟΥ\",\n\t\t\"Firstname\": \"ΗΛΙΑΣ\",\n\t\t\"Surname\":
\"ΓΕΩΡΓΙΟΥ\",\n\t\t\"Fathername\": \"ΑΘΑΝΑΣΙΟΣ\",\n\t\t\"AddressOfCustomer\":
\"ΜΕΓ.ΑΛΕΞΑΝΔΡΟΥ 15, ΠΕΡΙΣΤΕΡΙ ΑΤΤΙΚΗΣ, GR-ΕΛΛΑΔΑ\",\n\t\t\"Email\": \"i.georgiou@myemail.com\",\n\t\t\"IsCorporate\":
false,\n\t\t\"ExtraPinMobile\": \"+306946666666\",\n\t\t\"NativeSalutation\":
\"Welcome Ilias Georgiou\",\n\t\t\"TaxCode\": \"012345678\",\n\t\t\"IDCardOrPassport\":
\"ΑΔ123145\",\n\t\t\"LastLogin\": \"2017-03-08T16:11:00\",\n\t\t\"HasExtraPin\":
true,\n\t\t\"HasOtp\": false,\n\t\t\"BirthDate\": \"1971-12-07T00:00:00\"\n\t}\n}"
security:
- MSIS OAuth:
- winbankAccess winbankAccess.info
clientIdHeader: []
- clientIdHeader: []
Sandbox OAuth:
- /sandboxapi
parameters:
Authorization:
name: Authorization
type: string
required: true
in: header
description: This header should be in the form "Bearer Token", where Token is
the OAuth2 token
externalDocs:
url: https://rapidlink.piraeusbank.gr/start
description: Getting Started
x-ibm-endpoints:
- endpointUrl: https://api.rapidlink.piraeusbank.gr/piraeusbank/production
description: Base Gateway API Endpoint
type:
- production
- development
...