Paths
/v1/payments/groupPayments
Create Group Payments
Unique ID for TPP
Encrypted access token
Correlation ID passed by the requesting system
Global transaction Id
2-character iso code for preferred language. If empty the default will be English
ID of the source system invoking
ID of the channel from which the invocation occurred
ID of the department from which the invocation occurred
User ID of the requester (as per LDAP)
Employee ID of the requester (as per employee HR record)
Terminal ID of the requester
Subscription Id of TPP
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
The PSU's IP address if the PSU is currently logged in with the TPP
The PSU’s Session Identifier with the TPP
The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App
The time of PSU’s last login with the TPP related to the Session Id provided above
Created
Accepted
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
The PSU's IP address if the PSU is currently logged in with the TPP
The PSU’s Session Identifier with the TPP
The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App
The time of PSU’s last login with the TPP related to the Session Id provided above
200 OK
/v1/massPayments
Get Mass Payment Status
Third party Provide ( TPP ) Application Id
Unique ID for TPP
Encrypted access token
Correlation ID passed by the requesting system
Global transaction Id
2-character iso code for preferred language. If empty the default will be English
ID of the source system invoking
ID of the channel from which the invocation occurred
ID of the department from which the invocation occurred
User ID of the requester (as per LDAP)
Employee ID of the requester (as per employee HR record)
Terminal ID of the requester
subscriptionId of TPP
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
The PSU's IP address if the PSU is currently logged in with the TPP
The PSU’s Session Identifier with the TPP
The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App
The time of PSU’s last login with the TPP related to the Session Id provided above
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
Create mass payments
Third party Provide ( TPP ) Application Id
Encrypted access token
Correlation ID passed by the requesting system
Global transaction Id
2-character iso code for preferred language. If empty the default will be English
ID of the source system invoking
ID of the channel from which the invocation occurred
ID of the department from which the invocation occurred
User ID of the requester (as per LDAP)
Employee ID of the requester (as per employee HR record)
Terminal ID of the requester
Subscription Id of User
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
The PSU's IP address if the PSU is currently logged in with the TPP
The PSU’s Session Identifier with the TPP
The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App
The time of PSU’s last login with the TPP related to the Session Id provided above
OK
Created
Accepted
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/utilityBillCompanies
Retrieve Utility Bill Companies
Unique ID for TPP
Encrypted access token
Correlation ID passed by the requesting system
Global transaction Id
2-character iso code for preferred language. If empty the default will be English
ID of the source system invoking
ID of the channel from which the invocation occurred
ID of the department from which the invocation occurred
User ID of the requester (as per LDAP)
Employee ID of the requester (as per employee HR record)
Terminal ID of the requester
Subscription Id of TPP
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
The PSU's IP address if the PSU is currently logged in with the TPP
The PSU’s Session Identifier with the TPP
The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App
The time of PSU’s last login with the TPP related to the Session Id provided above
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/groupAndMassPayments/healthCheck
200 OK
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"
}
}
}
{
"properties": {
"filename": {
"type": "string"
},
"numberOfTransactions": {
"type": "integer",
"format": "int32"
},
"totalAmount": {
"type": "integer",
"format": "int32"
},
"endToEndId": {
"type": "string"
},
"status": {
"$ref": "#\/definitions\/Status"
},
"type": {
"type": "string"
},
"executionDate": {
"type": "string"
},
"debtor": {
"$ref": "#\/definitions\/Debtor"
},
"companyInfo": {
"$ref": "#\/definitions\/CompanyInfo"
},
"groupPayments": {
"$ref": "#\/definitions\/GroupPayment"
}
},
"additionalProperties": false
}
{
"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"
}
}
}