PSD2-Funds-Confirmation-API

PSD2-Funds-Confirmation-API V1.1

0
No votes yet
forum Discuss this API in the forum
production
https://apis.bankofcyprus.com/df-boc-org-prd/prod

APIC Gateway Server

Paths

/v2/funds-confirmation/fundAvailability

post /v2/funds-confirmation/fundAvailability

Check availability of funds in a Account

Application - Oauth
Application - Oauth
(oauth2 application)
Token URL
https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/v2/oauth2/token
Scopes
TPPOAuth2Security
client_id
Optional in query
string

Third party Provide ( TPP ) Application Id

client_secret
Optional in query
string

Unique ID for TPP

Authorization
Required in header
string

Encrypted access token

correlationId
Optional in header
string

Correlation ID passed by the requesting system

journeyId
Required in header
string

Global transaction Id

lang
Optional in header
string

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

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

subscriptionId
Required in header
string

Subscription Id of TPP

timeStamp
Required in header
string

The time stamp when the request was sent to system

tppId
Required in header
string

Third party Provide ( TPP ) ID

requestBody
Required in body
object
FundAvailabilityRequest
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

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

OK

202

Accepted

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
POST https://apis.bankofcyprus.com/df-boc-org-prd/prod/psd2/v2/funds-confirmation/fundAvailability
Try this operation
https://apis.bankofcyprus.com/df-boc-org-prd/prod/psd2/v2/funds-confirmation/fundAvailability
content-type
accept
Authorization
correlationId
journeyId
lang
originSourceId
originChannelId
originDeptId
originUserId
originEmployeeId
originTerminalId
subscriptionId
timeStamp
tppId
customerIP
customerSessionId
customerDevice
loginTimeStamp
client_id
client_secret

/v2/funds-confirmation/healthCheck

get /v2/funds-confirmation/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/v2/funds-confirmation/healthCheck
Try this operation
https://apis.bankofcyprus.com/df-boc-org-prd/prod/psd2/v2/funds-confirmation/healthCheck
accept

Definitions 

{
    "type": "object",
    "properties": {
        "errorCode": {
            "type": "string"
        },
        "severity": {
            "type": "string"
        },
        "status": {
            "type": "string"
        },
        "description": {
            "type": "string"
        }
    }
}
              
{
    "type": "object",
    "required": [
        "accountId",
        "transaction"
    ],
    "properties": {
        "bankId": {
            "type": "string"
        },
        "accountId": {
            "type": "string"
        },
        "transaction": {
            "$ref": "#\/definitions\/Amount"
        }
    }
}
              
{
    "type": "object",
    "required": [
        "amount"
    ],
    "properties": {
        "amount": {
            "type": "number",
            "description": "Amount is in EUR"
        },
        "currency": {
            "type": "string",
            "description": "3 Character ISO code",
            "maxLength": 3
        },
        "currencyRate": {
            "type": "string"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "code": {
            "type": "string"
        },
        "severity": {
            "type": "string",
            "enum": [
                "error",
                "warning",
                "Info"
            ]
        },
        "description": {
            "type": "string"
        },
        "additionalDetails": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/AdditionalDetails"
            }
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "fatalError": {
            "type": "boolean"
        },
        "error": {
            "$ref": "#\/definitions\/Error"
        }
    }
}