Paths
/v1/payments/initiate
Initiate Payment Request
Third party Provide ( TPP ) Application Id
Unique ID for TPP
Subscription Id of 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
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
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/payments
Create Payment
Third party Provide ( TPP ) Application Id
Unique ID for TPP
Subscription Id of 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
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
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/payments/{paymentId}/execute
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
Payment Id
Subscription Id of TPP
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
OK
Accepted
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/payments/accounts/{accountId}
Get Account Payments
Account Id for which payments need to be retrieved
Third party Provide ( TPP ) Application Id
Unique ID for TPP
End date
Maximum Number of records to be retrieved
Start date
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
OK
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/payments/{paymentId}/funds-confirmation
Check availability of funds in a Account
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
Subscription Id of TPP
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
Payment Id for which details need to be retrieved
OK
Accepted
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/payments/fundAvailability
Check availability of funds in a Account
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
Subscription Id of TPP
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
OK
Accepted
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/payments/{paymentId}
Retrieve the details of payment by payment ID
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
Payment Id for which details need to be retrieved
subscriptionId of TPP
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
OK
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
Cancel a payment which is authorized
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
Payment Id
Subscription Id of TPP
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
OK
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/payments/{paymentId}/authorize
/v1/payments/{paymentId}/status
Get the Status of a Payment by payment ID
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
Payment Id to retrieve payment status
subscriptionId of TPP
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/payment/healthCheck
200 OK
Definitions
{
"type": "object",
"properties": {
"errorCode": {
"type": "string"
},
"severity": {
"type": "string"
},
"status": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
{
"type": "object",
"properties": {
"status": {
"$ref": "#\/definitions\/Status"
},
"totalDebitAmount": {
"$ref": "#\/definitions\/Amount"
}
}
}
{
"type": "object",
"required": [
"fileData",
"fileName"
],
"properties": {
"fileData": {
"type": "string"
},
"fileName": {
"type": "string"
}
}
}
{
"type": "object",
"properties": {
"transactionTime": {
"type": "string",
"description": "Needed only in case of two factor authentication. Time as received in the create payment message"
},
"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."
}
}
}
{
"type": "object",
"required": [
"accountId",
"transaction"
],
"properties": {
"bankId": {
"type": "string"
},
"accountId": {
"type": "string"
},
"transaction": {
"$ref": "#\/definitions\/Amount"
}
}
}
{
"type": "object",
"properties": {
"authCodeNeeded": {
"type": "boolean"
},
"payment": {
"$ref": "#\/definitions\/Payment"
}
}
}
{
"type": "object",
"required": [
"accountId"
],
"properties": {
"bankId": {
"type": "string"
},
"accountId": {
"type": "string",
"maxLength": 35
}
}
}
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
{
"type": "object",
"properties": {
"voCode": {
"type": "string",
"maxLength": 35
},
"BIK": {
"type": "string",
"maxLength": 35
},
"INN": {
"type": "string",
"maxLength": 35
},
"correspondentAccount": {
"type": "string",
"maxLength": 35
}
}
}
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Allowed values CPLT | RJCT | PDNG | AUTH |"
},
"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
}
}
}
{
"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",
"required": [
"creditor",
"debtor",
"paymentDetails",
"transactionAmount"
],
"properties": {
"debtor": {
"$ref": "#\/definitions\/Debtor"
},
"creditor": {
"$ref": "#\/definitions\/Creditor"
},
"transactionAmount": {
"$ref": "#\/definitions\/Amount"
},
"endToEndId": {
"type": "string",
"maxLength": 35
},
"paymentDetails": {
"type": "string",
"maxLength": 120
},
"terminalId": {
"type": "string",
"maxLength": 35
},
"branch": {
"type": "string",
"maxLength": 35
},
"RUB": {
"$ref": "#\/definitions\/RUB"
},
"executionDate": {
"type": "string"
},
"valueDate": {
"type": "string"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Attachment"
}
}
}
}
{
"type": "object",
"properties": {
"fatalError": {
"type": "boolean"
},
"error": {
"$ref": "#\/definitions\/Error"
}
}
}
{
"type": "object",
"properties": {
"paymentId": {
"type": "string"
},
"transactionTime": {
"type": "string"
},
"status": {
"$ref": "#\/definitions\/Status"
},
"debtor": {
"$ref": "#\/definitions\/Debtor"
},
"creditor": {
"$ref": "#\/definitions\/Creditor"
},
"transactionAmount": {
"$ref": "#\/definitions\/Amount"
},
"charges": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Charges"
}
},
"totalCharges": {
"type": "string"
},
"endToEndId": {
"type": "string",
"maxLength": 35
},
"paymentDetails": {
"type": "string",
"maxLength": 140
},
"terminalId": {
"type": "string",
"maxLength": 35
},
"branch": {
"type": "string",
"maxLength": 35
},
"RUB": {
"$ref": "#\/definitions\/RUB"
},
"executionDate": {
"type": "string"
},
"valueDate": {
"type": "string"
},
"totalDebitAmount": {
"$ref": "#\/definitions\/Amount"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Attachment"
}
}
}
}
{
"type": "object",
"required": [
"accountId"
],
"properties": {
"bankId": {
"type": "string"
},
"accountId": {
"type": "string",
"maxLength": 35
},
"name": {
"type": "string",
"maxLength": 35
},
"address": {
"type": "string",
"maxLength": 105
}
}
}
{
"type": "object",
"required": [
"creditor",
"paymentDetails",
"transactionAmount"
],
"properties": {
"debtor": {
"$ref": "#\/definitions\/Debtor"
},
"creditor": {
"$ref": "#\/definitions\/Creditor"
},
"transactionAmount": {
"$ref": "#\/definitions\/Amount"
},
"endToEndId": {
"type": "string",
"maxLength": 35
},
"paymentDetails": {
"type": "string",
"maxLength": 120
},
"terminalId": {
"type": "string",
"maxLength": 35
},
"branch": {
"type": "string",
"maxLength": 35
},
"RUB": {
"$ref": "#\/definitions\/RUB"
},
"executionDate": {
"type": "string"
},
"valueDate": {
"type": "string"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Attachment"
}
}
}
}
{
"type": "object",
"properties": {
"authCodeNeeded": {
"type": "boolean"
},
"payment": {
"$ref": "#\/definitions\/Payment"
}
}
}
Comments
risoulaser
Submitted by fukuyamamidori@outlook.jp on
This article is really well written, and it made me realize a lot of new knowledge, which I believe will help me.レーザーポインター強力