B2B Customer API

B2B Customer API 1.0

0
No votes yet
Customer

Swagger Specifications for the B2B Customer APIs

production
https://apis.bankofcyprus.com/df-boc-org-prd/prod

APIC Gateway Server

Paths

/v1/customers

get /v1/customers
Customer

Get list of connected cif's for a subscriber based of User_Id

Application_oauth
Application_oauth
(oauth2 application)
Token URL
https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/v1/oauth2/token
Scopes
TPPOAuth2Security
maxCount
Optional in query
string
journeyId
Required in header
string

Global transaction Id

originSourceId
Optional in header
string

ID of the source system invoking

originChannelId
Optional in header
string

ID of the channel from which the invocation occurred

originDeptId
Optional in header
string

ID of the department from which the invocation occurred

originUserId
Required in header
string

User ID of the requester (as per LDAP)

originEmployeeId
Optional in header
string

Employee ID of the requester (as per employee HR record)

originTerminalId
Optional in header
string

Terminal ID of the requester

timeStamp
Required in header
string

The time stamp when the request was sent to system

correlationId
Optional in header
string

Correlation ID passed by the requesting system

tppId
Optional in header
string

Third party Provide ( TPP ) ID

client_id
Optional in query
string

Third party Provide ( TPP ) Application Id

subscriptionId
Required in header
string

Subscription ID of a subscriber

Authorization
Required in header
string

Encrypted access token

lang
Optional in header
string

2-character iso code for preferred language. If empty the default will be English

client_secret
Optional in query
string
customerIP
Optional in header
string

The PSU's IP address if the PSU is currently logged in with the TPP

customerSessionId
Optional in header
string

The PSU’s Session Identifier with the TPP

customerDevice
Optional in header
string

The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App

loginTimeStamp
Optional in header
string

The time of PSU’s last login with the TPP related to the Session Id provided above

Accept
Optional in header
string
application/json
200

OK

RetrieveConnectedCustomers
302

Found

400

Bad Request

ErrorResponse
401

Unauthorized

ErrorResponse
403

Forbidden

ErrorResponse
404

API URL Not Found

ErrorResponse
405

Method not Found

ErrorResponse
406

Not Acceptable

ErrorResponse
429

Too many Requests

ErrorResponse
500

Internal Server Error

ErrorResponse
503

Service Unavailable

ErrorResponse
Example Request
Example Response
GET https://apis.bankofcyprus.com/df-boc-org-prd/prod/psd2/v1/customers
Try this operation
https://apis.bankofcyprus.com/df-boc-org-prd/prod/psd2/v1/customers
accept
journeyId
originSourceId
originChannelId
originDeptId
originUserId
originEmployeeId
originTerminalId
timeStamp
correlationId
tppId
subscriptionId
Authorization
lang
customerIP
customerSessionId
customerDevice
loginTimeStamp
maxCount
client_id
client_secret

/v1/customers/healthCheck

get /v1/customers/healthCheck
healthCheck
Accept
Optional in header
string
200

200 OK

Example Request
Example Response
GET https://apis.bankofcyprus.com/df-boc-org-prd/prod/psd2/v1/customers/healthCheck
Try this operation
https://apis.bankofcyprus.com/df-boc-org-prd/prod/psd2/v1/customers/healthCheck
accept

Definitions 

{
    "type": "object",
    "properties": {
        "errorCode": {
            "type": "string",
            "example": "404"
        },
        "severity": {
            "type": "string",
            "example": "High"
        },
        "status": {
            "type": "string",
            "example": "failure"
        },
        "description": {
            "type": "string",
            "example": "more information"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "customers": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/Customer"
            }
        }
    }
}
              
{
    "type": "object",
    "required": [
        "clientBusinessId",
        "customerName"
    ],
    "properties": {
        "clientBusinessId": {
            "type": "string",
            "example": "123"
        },
        "customerName": {
            "type": "string",
            "example": "Mike"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "code": {
            "type": "string",
            "example": "404"
        },
        "severity": {
            "type": "string",
            "enum": [
                "error",
                "warning",
                "Info"
            ],
            "example": "High"
        },
        "description": {
            "type": "string",
            "example": "Not found"
        },
        "additionalDetails": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/AdditionalDetails"
            },
            "example": "Not found"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "fatalError": {
            "type": "boolean",
            "example": "10101"
        },
        "error": {
            "$ref": "#\/definitions\/Error",
            "example": "404"
        }
    }
}