production
https://sandbox-apis.bankofcyprus.com/df-boc-org-sb/sb
Paths
/v1/payments/groupPayments
post /v1/payments/groupPayments
Create Group Payments
Application - Oauth
Application - Oauth
(oauth2 application)
Token URL
https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/psd2/oauth2/token
Scopes
TPPOAuth2Security
client_id
Optional in query
string
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
Optional in header
string
Third party Provide ( TPP ) ID
requestBody
Required in body
object
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
201
Created
202
Accepted
302
Found
400
Bad Request
401
Unauthorized
403
Forbidden
404
API URL Not Found
405
Method not Found
406
Not Acceptable
429
Too many Requests
500
Internal Server Error
503
Service Unavailable
Example Request
Example Response
POST https://sandbox-apis.bankofcyprus.com/df-boc-org-sb/sb/psd2/v1/payments/groupPayments
Try this operation
/v1/massPayments
get /v1/massPayments
Get Mass Payment Status
Application - Oauth
Application - Oauth
(oauth2 application)
Token URL
https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/psd2/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
filename
Optional in query
string
endToEndId
Optional in query
string
transactionDate
Optional in query
string
qualityOfCode
Optional in query
string
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
subscriptionId of TPP
timeStamp
Required in header
string
The time stamp when the request was sent to system
tppId
Optional in header
string
Third party Provide ( TPP ) ID
Accept
Optional in header
string
application/json
200
302
Found
400
Bad Request
401
Unauthorized
403
Forbidden
404
API URL Not Found
405
Method not Found
406
Not Acceptable
429
Too many Requests
500
Internal Server Error
503
Service Unavailable
Example Request
Example Response
GET https://sandbox-apis.bankofcyprus.com/df-boc-org-sb/sb/psd2/v1/massPayments
Try this operation
post /v1/massPayments
Create mass payments
Application - Oauth
Application - Oauth
(oauth2 application)
Token URL
https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/psd2/oauth2/token
Scopes
TPPOAuth2Security
client_id
Optional in query
string
Third party Provide ( TPP ) Application Id
client_secret
Optional in query
string
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 User
timeStamp
Required in header
string
The time stamp when the request was sent to system
tppId
Optional in header
string
Third party Provide ( TPP ) ID
requestBody
Required in body
object
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
OK
201
Created
202
Accepted
302
Found
400
Bad Request
401
Unauthorized
403
Forbidden
404
API URL Not Found
405
Method not Found
406
Not Acceptable
429
Too many Requests
500
Internal Server Error
503
Service Unavailable
Example Request
Example Response
POST https://sandbox-apis.bankofcyprus.com/df-boc-org-sb/sb/psd2/v1/massPayments
Try this operation
/v1/utilityBillCompanies
get /v1/utilityBillCompanies
Retrieve Utility Bill Companies
Application - Oauth
Application - Oauth
(oauth2 application)
Token URL
https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/psd2/oauth2/token
Scopes
TPPOAuth2Security
client_id
Optional in query
string
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
Optional in header
string
Subscription Id of TPP
timeStamp
Required in header
string
The time stamp when the request was sent to system
tppId
Optional in header
string
Third party Provide ( TPP ) ID
Accept
Optional in header
string
application/json
200
302
400
Bad Request
401
Unauthorized
403
Forbidden
404
API URL Not Found
405
Method not Found
406
Not Acceptable
429
Too many Requests
500
Internal Server Error
503
Service Unavailable
Example Request
Example Response
GET https://sandbox-apis.bankofcyprus.com/df-boc-org-sb/sb/psd2/v1/utilityBillCompanies
Try this operation
/v1/groupAndMassPayments/healthCheck
get /v1/groupAndMassPayments/healthCheck
healthCheck
Accept
Optional in header
string
200
200 OK
Example Request
Example Response
GET https://sandbox-apis.bankofcyprus.com/df-boc-org-sb/sb/psd2/v1/groupAndMassPayments/healthCheck
Try this operation
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": {
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"line3": {
"type": "string"
},
"line4": {
"type": "string"
}
}
}
{
"type": "object",
"required": [
"utilityCompanies"
],
"properties": {
"utilityCompanies": {
"type": "array",
"items": {
"$ref": "#\/definitions\/UtilityBillCompany"
}
}
}
}
{
"type": "object",
"required": [
"email",
"statusCode"
],
"properties": {
"statusCode": {
"type": "string",
"example": "200"
},
"email": {
"type": "string",
"example": "xyz@gmail.com"
}
}
}
{
"type": "object",
"properties": {
"debtor": {
"$ref": "#\/definitions\/Debtor",
"example": "Mike"
},
"massPaymentCreditor": {
"$ref": "#\/definitions\/MassPaymentCreditor",
"example": "Wayne enterprises"
},
"contactPhoneNumber": {
"type": "string",
"description": "Contact telephone number of debitor",
"example": "344590900"
},
"adviceNotificationOption": {
"$ref": "#\/definitions\/NotificationOption",
"example": "on"
},
"statusNotificationOption": {
"$ref": "#\/definitions\/StatusNotificationOption",
"example": "off"
},
"chargesPaidBy": {
"type": "string",
"enum": [
"debtor",
"creditor",
"split"
],
"example": "company"
},
"chargesAccount": {
"$ref": "#\/definitions\/ChargesAccount",
"example": "20"
},
"amount": {
"$ref": "#\/definitions\/Amount",
"example": "2000"
},
"description": {
"$ref": "#\/definitions\/Description",
"example": "salary"
},
"endToEndId": {
"type": "string",
"example": "123"
},
"RUB": {
"$ref": "#\/definitions\/RUB",
"example": "11"
},
"executionDate": {
"type": "string",
"example": "11\/10\/2018"
},
"valueDate": {
"type": "string",
"example": "11\/10\/2018"
}
}
}
{
"type": "object",
"properties": {
"status": {
"$ref": "#\/definitions\/Status",
"example": "success"
},
"totalDebitAmount": {
"$ref": "#\/definitions\/Amount",
"example": "2000"
}
}
}
{
"type": "object",
"required": [
"fileData",
"fileName"
],
"properties": {
"fileData": {
"type": "string",
"example": "xsl"
},
"fileName": {
"type": "string",
"example": "salary.xsl"
}
}
}
{
"type": "object",
"properties": {
"transactionTime": {
"type": "string",
"description": "Needed only in case of two factor authentication. Time as received in the create payment message",
"example": "12:00"
},
"authCode": {
"type": "string",
"description": "Subscriber has to provide Auth code in case of two factor authentication. For example OTP entered by Subscriber on the TPP screen.",
"example": "123"
}
}
}
{
"type": "object",
"required": [
"accountId",
"transaction"
],
"properties": {
"bankId": {
"type": "string",
"example": "101"
},
"accountId": {
"type": "string",
"example": "12345"
},
"transaction": {
"$ref": "#\/definitions\/Amount",
"example": "2000"
}
}
}
{
"type": "object",
"required": [
"companyInfo",
"debtor",
"groupPayments",
"numberOfTransactions",
"totalAmount",
"type"
],
"properties": {
"endToEndId": {
"type": "string"
},
"filename": {
"type": "string",
"maxLength": 35,
"example": "salary.xsl"
},
"numberOfTransactions": {
"type": "number",
"example": 12
},
"totalAmount": {
"type": "string",
"example": "200000"
},
"type": {
"type": "string",
"enum": [
"PAYROLL",
"GROUP_PAYMENT"
],
"example": "company"
},
"executionDate": {
"type": "string",
"example": "11\/12\/2018"
},
"debtor": {
"$ref": "#\/definitions\/Debtor",
"example": "Mike"
},
"companyInfo": {
"$ref": "#\/definitions\/CompanyInfo",
"example": "Wayne enterprises"
},
"groupPayments": {
"type": "array",
"items": {
"$ref": "#\/definitions\/GroupPayment"
}
}
}
}
{
"type": "object",
"required": [
"accountId",
"bankId"
],
"properties": {
"bankId": {
"type": "string",
"example": "101"
},
"accountId": {
"type": "string",
"description": "IBAN or Account",
"example": "123"
},
"beneficiaryName": {
"type": "string",
"example": "John"
},
"beneficiaryAddress": {
"$ref": "#\/definitions\/ShortAddress",
"example": "Nicosia, Cyprus"
}
}
}
{
"type": "object",
"properties": {
"authCodeNeeded": {
"type": "boolean",
"example": "10101"
},
"payment": {
"$ref": "#\/definitions\/Payment",
"example": "salary"
}
}
}
{
"type": "object",
"required": [
"accountId"
],
"properties": {
"bankId": {
"type": "string",
"example": "101"
},
"accountId": {
"type": "string",
"maxLength": 35,
"example": "123"
}
}
}
{
"type": "object",
"required": [
"massPayment",
"status"
],
"properties": {
"massPayment": {
"$ref": "#\/definitions\/MassPayment",
"example": "yes"
},
"status": {
"$ref": "#\/definitions\/Status",
"example": "success"
},
"errorDescription": {
"type": "string",
"example": "none"
}
}
}
{
"type": "object",
"properties": {
"line1": {
"type": "string",
"maxLength": 35,
"example": "#33"
},
"line2": {
"type": "string",
"maxLength": 35,
"example": "3rd cross"
},
"line3": {
"type": "string",
"maxLength": 35,
"example": "Nicosia"
},
"line4": {
"type": "string",
"maxLength": 35,
"example": "Cyprus"
}
}
}
{
"type": "object",
"required": [
"paymentId",
"status"
],
"properties": {
"paymentId": {
"type": "string",
"example": "101"
},
"status": {
"$ref": "#\/definitions\/Status",
"example": "success"
}
}
}
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "service"
},
"value": {
"type": "string",
"example": "20"
}
}
}
{
"type": "object",
"required": [
"accountId"
],
"properties": {
"bankId": {
"type": "string",
"description": "SWIFT code",
"example": "101"
},
"accountId": {
"type": "string",
"description": "IBAN or Account",
"example": "DY4747"
},
"companyCode": {
"type": "string",
"example": "123"
},
"checkDigit": {
"type": "string",
"example": "123"
},
"amountCheckDigit": {
"type": "string",
"example": "123"
},
"beneficiaryName": {
"type": "string",
"example": "John"
},
"beneficiaryAddress": {
"$ref": "#\/definitions\/ShortAddress",
"example": "Nicosia, Cyprus"
},
"bankName": {
"type": "string",
"example": "BOC"
},
"nationalId": {
"type": "string",
"example": "CYP"
},
"bankCountryCode": {
"type": "string",
"example": "28229"
},
"branchName": {
"type": "string",
"example": "xyz"
}
}
}
{
"type": "object",
"properties": {
"voCode": {
"type": "string",
"maxLength": 35,
"example": "33"
},
"BIK": {
"type": "string",
"maxLength": 35,
"example": "rr4"
},
"INN": {
"type": "string",
"maxLength": 35,
"example": "223"
},
"correspondentAccount": {
"type": "string",
"maxLength": 35,
"example": "2134324"
}
}
}
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Allowed values CPLT | RJCT | PDNG | AUTH |",
"example": "CPLT"
},
"description": {
"type": "array",
"items": {
"type": "string",
"description": "It will be set to one of the following depending on the status:\n\nCOMPLETED: The transaction has passed all validations and was successfully posted in bank systems.\n\nREJECTED: The transaction was rejected when attempting to post it on the banks systems.Please check error code\n\nPENDING: Processing Pending. Please, check your Transaction Status Page on Bank portal for more information.\n\nAUTHORISATION: The transaction has been accepted by the bank but needs to be authorized by another user(s) ."
}
},
"refNumber": {
"type": "string",
"description": "A 9 digit number which the customer uses as a reference for support or for his records",
"maxLength": 9,
"example": "123567098"
}
}
}
{
"type": "object",
"properties": {
"faxNumber": {
"type": "string",
"example": "9328479328"
},
"email": {
"type": "string",
"example": "XYZ@gmail.com"
}
}
}
{
"type": "object",
"required": [
"accountId",
"bankId"
],
"properties": {
"bankId": {
"type": "string",
"example": "101"
},
"accountId": {
"type": "string",
"example": "123"
}
}
}
{
"type": "object",
"required": [
"accountCheckDigit",
"amountCheckDigit",
"companyCode",
"companyName"
],
"properties": {
"companyName": {
"type": "string"
},
"companyCode": {
"type": "string"
},
"amountCheckDigit": {
"type": "boolean",
"default": false
},
"accountCheckDigit": {
"type": "boolean",
"default": false
}
}
}
{
"type": "object",
"required": [
"amount"
],
"properties": {
"amount": {
"type": "number",
"description": "Amount is in EUR",
"example": 2131
},
"currency": {
"type": "string",
"description": "3 Character ISO code",
"maxLength": 3,
"example": "111"
},
"currencyRate": {
"type": "string",
"example": "2.0"
}
}
}
{
"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"
}
}
}
}
{
"type": "object",
"required": [
"creditor",
"debtor",
"paymentDetails",
"transactionAmount"
],
"properties": {
"debtor": {
"$ref": "#\/definitions\/Debtor",
"example": "Mike"
},
"creditor": {
"$ref": "#\/definitions\/Creditor",
"example": "John"
},
"transactionAmount": {
"$ref": "#\/definitions\/Amount",
"example": "2000"
},
"endToEndId": {
"type": "string",
"maxLength": 35,
"example": "11\/12\/2018"
},
"paymentDetails": {
"type": "string",
"maxLength": 120,
"example": "salary"
},
"terminalId": {
"type": "string",
"maxLength": 35,
"example": "3432"
},
"branch": {
"type": "string",
"maxLength": 35,
"example": "CYP"
},
"RUB": {
"$ref": "#\/definitions\/RUB",
"example": "22"
},
"executionDate": {
"type": "string",
"example": "11\/12\/2018"
},
"valueDate": {
"type": "string",
"example": "11\/12\/2018"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Attachment"
}
}
}
}
{
"type": "object",
"required": [
"massPaymentStatus",
"numberOfInvalidPayments",
"numberOfTransactions",
"numberOfValidPayments",
"totalAmountOfValidPayments"
],
"properties": {
"numberOfTransactions": {
"type": "number",
"example": 400
},
"numberOfValidPayments": {
"type": "number",
"example": 380
},
"numberOfInvalidPayments": {
"type": "number",
"example": 20
},
"totalAmountOfValidPayments": {
"type": "string",
"example": "20000"
},
"massPaymentStatus": {
"type": "array",
"items": {
"$ref": "#\/definitions\/MassPaymentStatus"
}
}
}
}
{
"type": "object",
"properties": {
"fatalError": {
"type": "boolean",
"example": "10101"
},
"error": {
"$ref": "#\/definitions\/Error"
}
}
}
{
"type": "object",
"required": [
"massPayments",
"numberOfTransactions"
],
"properties": {
"filename": {
"type": "string",
"example": "salary.xsl"
},
"numberOfTransactions": {
"type": "number",
"example": 400
},
"massPayments": {
"type": "array",
"items": {
"$ref": "#\/definitions\/MassPayment"
},
"example": "400"
}
}
}
{
"type": "object",
"properties": {
"paymentId": {
"type": "string",
"example": "1213"
},
"transactionTime": {
"type": "string",
"example": "12:00"
},
"status": {
"$ref": "#\/definitions\/Status",
"example": ""
},
"debtor": {
"$ref": "#\/definitions\/Debtor"
},
"creditor": {
"$ref": "#\/definitions\/Creditor"
},
"transactionAmount": {
"$ref": "#\/definitions\/Amount"
},
"charges": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Charges"
}
},
"totalCharges": {
"type": "string",
"example": "20"
},
"endToEndId": {
"type": "string",
"maxLength": 35,
"example": "123"
},
"paymentDetails": {
"type": "string",
"maxLength": 140,
"example": "salary"
},
"terminalId": {
"type": "string",
"maxLength": 35,
"example": "123"
},
"branch": {
"type": "string",
"maxLength": 35,
"example": "CYP"
},
"RUB": {
"$ref": "#\/definitions\/RUB",
"example": ""
},
"executionDate": {
"type": "string",
"example": "11\/12\/2018"
},
"valueDate": {
"type": "string",
"example": "11\/12\/2018"
},
"totalDebitAmount": {
"$ref": "#\/definitions\/Amount"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Attachment"
}
}
}
}
{
"type": "object",
"required": [
"amount"
],
"properties": {
"groupPaymentCreditor": {
"$ref": "#\/definitions\/GroupPaymentCreditor"
},
"amount": {
"type": "number",
"example": 23234
},
"description": {
"$ref": "#\/definitions\/Description"
},
"code": {
"type": "string",
"example": "111"
}
}
}
{
"type": "object",
"required": [
"identification"
],
"properties": {
"identification": {
"type": "string",
"example": "CYP"
},
"name": {
"type": "string",
"example": "Mike"
}
}
}
{
"type": "object",
"required": [
"accountId"
],
"properties": {
"bankId": {
"type": "string",
"example": "101"
},
"accountId": {
"type": "string",
"maxLength": 35,
"example": "123"
},
"name": {
"type": "string",
"maxLength": 35,
"example": "Mike"
},
"address": {
"type": "string",
"maxLength": 105,
"example": "Cyprus"
}
}
}
Comments
RE:
Submitted by graceallen070@gmail.com on
Numbers show an image of the B2B payment ecosystem that embraces APIs to become faster, more agile and more global Online Class Help. The Tracker is a deep-dive into several of the industry's key players, and an up-to - date guide to the latest market events.
RE:
Submitted by graceallen070@gmail.com on
Numbers show an image of the B2B payment ecosystem that embraces APIs to become faster, more agile and more global Online Class Help. The Tracker is a deep-dive into several of the industry's key players, and an up-to - date guide to the latest market events.