Bulk Payment

Parameters

fileName (Mandatory)

Specifies the name of the file that must be uploaded.

description (Mandatory)

Specifies the description of the file.

content (Mandatory)

Specifies the content in the file.

uploadDate

Specifies the file uploaded date.

fileSize

Specifies the size of file in MB.

systemGeneratedFileName

Specifies the unique file name generated by system.

batchMode (Mandatory)

Specifies the type of batch mode.

{
    "fileName": "SampleCSV.csv",
    "uploadDate": "10/21/2021",
    "fileSize": "0.0009 MB",
    "systemGeneratedFileName": "SampleCSV.csv",
    "description": "test",
    "batchMode": "SINGLE",
    "content": "PERFU0NSSVBUSU9OPiw8QlVMSy5UWVBFPiw8REVCSVQuQ1JFRElUPiw8U0lOR0xFLk1VTFRJPiw8Q1VTVE9NRVI+LDxERUJJVC5BQ0NPVU5UPiw8Q1VSUkVOQ1k+LDxXQVNILkFDQ09VTlQ+LDxFUlJPUi5BQ0NPVU5UPiw8TU9ERS5PRi5UUkFOU0ZFUj4sPFBST0NFU1NJTkcuREFURT4sPFBBWU1FTlQuVkFMVUUuREFURT4sPENMRUFSSU5HLkRBVEU+LDxVUExPQUQuUkVGRVJFTkNFPiw8REVCSVQuUkVGRVJFTkNFPiw8Q1JFRElULlJFRkVSRU5DRT4sLCwsLCw8QU1ULlRPLkJFLlVQTE9BREVEPiwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsCjxQQVlNRU5ULk9SREVSLlBST0RVQ1Q+LCw8T1JERVJJTkcuQ1VTVE9NRVI+LDxPUkRFUklORy5DVVNUT01FUi5CSUM+LDxPUkRFUklORy5DVVNULk5BTUU+LCwsLCwsPERFQklULkNDWT4sPERFQklULkFDQ09VTlQuSUJBTj4sLCwsLCwsLCwsPEJFTkVGSUNJQVJZLkFDQ09VTlQuTk8+LDxCRU5FRklDSUFSWS5JQkFOPiwsLDxCRU5FRklDSUFSWS5OQU1FPiwsLDxCRU4uUE9TVC5BRERSLkxJTkUtMT4sLCwsLCwsLCwsPEFDQ1QuV0lUSC5CQU5LLkJJQz4sLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLDxQQVlNRU5ULkNVUlJFTkNZPiw8UEFZTUVOVC5BTU9VTlQ+LCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLDxCVUxLLlBST0NFU1NJTkcuTU9ERT4sLCwsLA=="
}

Parameters

confirmationNumber (Mandatory)

Specifies the confirmation number that gets generated after uploading the file.

systemGeneratedFileName (Mandatory)

Specifies the unique file name generated by system.

{
    "confirmationNumber": "UPLD2110579993",
    "sysGeneratedFileName": "EurMULTINewformatRT0510211041056.csv",
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 12000
  Error Message: "Internal service error."
• Error Code: 12001
  Error Message: "Logged in user is not authorized to perform this action."
• Error Code: 21225
  Error Message: "Error occurred while invoking uploadBulkPaymentFile."
• Error Code: 21262
  Error Message: "Invalid Account number."
• Error Code: 21228
  Error Message:

  • "Permission denied for the debit card uploaded."

  • "User don't have permission to upload .csv file. They need to re-upload the file with correct file format."

  • "User don't have permission to upload .xml file. They need to re-upload the file with correct file format."

  • "User don't have permission to perform Bulk Payments with processing mode as SINGLE."

  • "User don't have permission to perform Bulk Payments with processing mode as MULTI."

  • "Error occurred while parsing date."

  • "The execution date defined in the file is in Past, please correct the date in the file and re-upload."

• Error Code: 21224
  Error Message: "Unable to store the file info at backend."
• Error Code: 00000
  Error Message: "Error occurred at backend."
• Error Code: 12601
  Error Message: "Transaction creation is failed at backend."
• Error Code: 21204
  Error Message: "Empty file."
• Error Code: 21200
  Error Message: "Failed to parse the uploaded file."

{base_url}/api/v2.0.0/order/bulkPayments/uploads/files

Parameters

sortByParam(Mandatory)

Specifies the field in the response based on which the list of records must be sorted. By default, the list of records would be sorted based on the date on which the request was sent (sentDate).

sortOrder

Specifies the order in which the list of fetched records must be sorted, such as in ascending or descending (ASC/DESC) order. By default, the value is set to DESC for the date on which the request was sent (sentDate).

searchString

Specifies the free text that can be entered to search for a set of records that matches the text that is entered.

pageSize

Specifies the number of rows that must be returned in the result.

pageOffset

Specifies the row from which the data must be retrieved. The offset value is often used together with the limit.

timeParam

Specifies the uploaded date.

timeValue

Specifies the last number of periods (Days, Weeks, Months, Year).

batchMode

Specifies the type of batch mode.

filterByValue

Specifies the value that to filter.

filterByParam

Specifies the parameter value to filter.

{
    "searchString": "",
    "sortByParam": "",
    "sortOrder": "DESC",
    "pageSize": "",
    "pageOffset": "",
    "filterByParam": "",
    "filterByValue": "",
    "batchMode": "",
    "timeParam": "uploadedDate",
    "timeValue": "6,MONTH"
}

Parameters

fileId (Mandatory)

Specifies the unique ID of the Bulk Payment file.

fileName (Mandatory)

Specifies the name of the Bulk Payment file.

description (Mandatory)

Specifies the description of the Bulk Payment file.

confirmationNumber (Mandatory)

Specifies the confirmation number that is generated after uploading the file.

roleId (Mandatory)

Specifies the role ID.

uploadedBy (Mandatory)

Specifies the unique uploaded ID.

companyId (Mandatory)

Specifies the unique role ID.

featureActionId (Mandatory)

Specifies the action ID of feature.

uploadedDate (Mandatory)

Specifies the date of uploading of the file.

status (Mandatory)

Specifies the status of the operation.

fromAccount (Mandatory)

Specifies the account from which the files are uploaded.

totalAmount (Mandatory)

Specifies the total amount.

totalTransactions (Mandatory)

Specifies the total number of transactions.

companyId (Mandatory)

Specifies the unique ID of the company.

content (Mandatory)

Specifies the content

fileSize (Mandatory)

Specifies the size of file.

createdby (Mandatory)

Specifies created user ID.

createdts (Mandatory)

Specifies the created date with time stamp.

lastmodifiedts (Mandatory)

Specifies the last updated date with time stamp.

synctimestamp (Mandatory)

Specifies the synchronized date with time stamp.

sysGeneratedFileName (Mandatory)

Specifies the system generated file name.

batchMode (Mandatory)

Specifies the if it is a Single or Multiple files.

requestStatus (Mandatory)

Specifies the type of request.

{
    "uploadedFiles": [{
        "fileId": "UPLD2110513400",
        "confirmationNumber": "BKM2110500220",
        "fileName": "T122629211020210338014634.csv",
        "description": "test",
        "featureActionId": "BULK_PAYMENT_FILES_SINGLE_UPLOAD_CSV",
        "uploadedBy": "9642944137",
        "companyId": "4718904850_800574",
        "roleId": "GROUP_ADMINISTRATOR",
        "uploadedDate": "2021-10-21T03:38:17Z",
        "status": "PROCESSED",
        "fromAccount": "122629",
        "totalAmount": "0",
        "totalTransactions": "0",
        "content": "dGVzdCxTSU5HTEUtUE8sQ1JFRElULFNJTkdMRSw4MDA1NzQsMTIyNjI5LFVTRCwxMjI2MjksMTIyNjI5LCwyMDIxMDQxNSwyMDIxMDQxNSwyMDIxMDQxNSx0ZXN0LHRlc3QsdGVzdCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLA0KRlRCTUJMSyw4MDA1NzQsLCwsLCxVU0QsLCwsLCwsLDEyMzYyNSwsLCxURVNUSU5HLCwsLCwsLCwsLCwsLCwsLCwsLCwsVVNELDUuMCwsLCwsLCw1LCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsU0lOR0xFDQo=",
        "fileSize": "15784177664",
        "createdby": "7989142796",
        "createdts": "2021-10-21 14:38:17.0",
        "lastmodifiedts": "2021-10-21 03:38:17.0",
        "synctimestamp": "2021-10-21 03:38:17.0",
        "sysGeneratedFileName": "T1226292110202103380146342110210338015.csv",
        "batchMode": "SINGLE",
        "requestStatus": "CREATED"
    }, {
        "fileId": "UPLD2110557406",
        "confirmationNumber": "BKM2110500219",
        "fileName": "T122629211020210322010770.csv",
        "description": "TestT22",
        "featureActionId": "BULK_PAYMENT_FILES_MULTI_UPLOAD_CSV",
        "uploadedBy": "9642944137",
        "companyId": "4718904850_800574",
        "roleId": "GROUP_ADMINISTRATOR",
        "uploadedDate": "2021-10-21T03:22:14Z",
        "status": "PROCESSED",
        "fromAccount": "122629",
        "totalAmount": "0",
        "totalTransactions": "0",
        "content": "VGVzdFQyMixNVUxUSS1QTyxDUkVESVQsTVVMVEksODAwNTc0LDEyMjYyOSxVU0QsLDEyMjYyOSwsMjAyMTA0MTUsMjAyMTA0MTUsMjAyMTA0MTUsVGVzdFQyMixUZXN0VDIyLFRlc3RUMjIsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCkRPTUVTVElDLDgwMDU3NCwsLCwsLFVTRCwsLCwsLCwsMTIyNjI5LCwsLFRFU1RJTkcsLCwsLCwsLCwsLCwsLCwsLCwsLCxVU0QsMi4wLCwsLCwsLFRlc3QsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCxNVUxUSQ0KRE9NRVNUSUMsODAwNTc0LCwsLCwsVVNELCwsLCwsLCxHQjkxREVNTzYwMTYxMzAwMTAwMzc0LCwsLFNyZWVydXBhREQsLCwsLCwsLCwsLCxERU1PR0JQWCwsLCwsLCwsLFVTRCwxLjAsLCwsLCwsVGVzdCwsU0hBLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLE1VTFRJDQpJTkFUSU9OQUwsODAwNTc0LCwsLCwsVVNELCwsLCwsLCxHQjQ3REVNTzYwMTYxMzAwMTAwMDk5LCwsLFNyZWVydXBhSUksLCwsLCwsLCwsLCxERU1PR0JQWCwsLCwsLCwsLFVTRCwzLjAsLCwsLCwsVGVzdEksLFNIQSwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCxNVUxUSQ0K",
        "fileSize": "15784177664",
        "createdby": "7989142796",
        "createdts": "2021-10-21 14:22:14.0",
        "lastmodifiedts": "2021-10-21 03:22:14.0",
        "synctimestamp": "2021-10-21 03:22:14.0",
        "sysGeneratedFileName": "T1226292110202103220107702110210322011.csv",
        "batchMode": "MULTI",
        "requestStatus": "CREATED"
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 12000
  Error Message: "Internal service error."
• Error Code: 12001
  Error Message: "Logged in user is not authorized to perform this action."
• Error Code: 212200
  Error Message: "Failed to fetch bulk payment uploaded files."
• Error Code: 00000
  Error Message: "Error occurred at backend."

{base_url}/api/v2.0.0/order/bulkPayments/uploads/files

Parameters

sortByParam

Specifies the field in the response based on which the list of records must be sorted. By default, the list of records would be sorted based on the date on which the request was sent (sentDate).

sortOrder

Specifies the order in which the list of fetched records must be sorted, such as in ascending or descending (ASC/DESC) order. By default, the value is set to DESC for the date on which the request was sent (sentDate).

searchString

Specifies the free text that can be entered to search for a set of records that matches the text that is entered.

pageSize

Specifies the number of rows that must be returned in the result.

pageOffset

Specifies the row from which the data must be retrieved. The offset value is often used together with the limit.

filterByParam

Specifies the parameter based on which the fetched files must be filtered.

filterByValue

Specifies the value based on which the fetched files must be filtered.

batchMode

Specifies the if it is a Single or Multiple files.

timeParam

Specifies the uploaded date.

timeValue

Specifies the last number of periods (Days, Weeks, Months, Year).

{
    "searchString": "",
    "sortByParam": "",
    "sortOrder": "DESC",
    "pageSize": "",
    "pageOffset": "",
    "filterByParam": "status",
    "filterByValue": "CREATED",
    "batchMode": "SINGLE-PO MULTI-PO",
    "timeParam": "paymentDate",
    "timeValue": ""
}

Parameters

recordId (Mandatory)

Specifies the unique ID of the record.

description (Mandatory)

Specifies the description of the ongoing payment.

paymentDate (Mandatory)

Specifies the date for payment.

scheduledDate (Mandatory)

Specifies the date on when the scheduled transfer payment must occur.

status (Mandatory)

Specifies the status of payment.

fromAccount (Mandatory)

Specifies the account from which the files are uploaded.

totalAmount (Mandatory)

Specifies the total amount.

totalTransactions (Mandatory)

Specifies the total number of transactions.

companyId (Mandatory)

Specifies the unique ID of the company.

fileId (Mandatory)

Specifies the ID of file.

currency (Mandatory)

Specifies the currency in which transaction should happen.

batchMode (Mandatory)

Specifies the type fo batch Single or Multiple files.

paymentOrderProduct (Mandatory)

Specifies the type of order domestic or international.

bulkErrorDetails (Mandatory)

Specifies the error details.

{
    "onGoingPayments": [{
        "recordId": "BKM2110500140",
        "description": "Test",
        "paymentDate": "2021-10-04T00:00:00Z",
        "scheduledDate": "2021-10-04T00:00:00Z",
        "status": "CREATED",
        "fromAccount": "122629",
        "totalAmount": "5",
        "initiatedBy": "3841020824",
        "totalTransactions": "2",
        "companyId": "0924520779_800574",
        "fileId": "UPLD2110519211",
        "currency": "USD",
        "batchMode": "SINGLE",
        "paymentOrderProduct": "FTBMBLK",
        "bulkErrorDetails": []
    }, {
        "recordId": "BKM2110500143",
        "description": "NewCSVupldSing",
        "paymentDate": "2021-10-05T00:00:00Z",
        "scheduledDate": "2021-10-05T00:00:00Z",
        "status": "CREATED",
        "fromAccount": "122629",
        "totalAmount": "9",
        "initiatedBy": "3841020824",
        "totalTransactions": "1",
        "companyId": "0924520779_800574",
        "fileId": "UPLD2110587103",
        "currency": "USD",
        "batchMode": "MULTI",
        "paymentOrderProduct": "DOMESTIC",
        "bulkErrorDetails": []
    }, {
        "recordId": "BKM2110500144",
        "description": "NewCSVupldSing",
        "paymentDate": "2021-10-05T00:00:00Z",
        "scheduledDate": "2021-10-05T00:00:00Z",
        "status": "CREATED",
        "fromAccount": "122629",
        "totalAmount": "2",
        "initiatedBy": "3841020824",
        "totalTransactions": "0",
        "companyId": "0924520779_800574",
        "fileId": "UPLD2110516277",
        "currency": "USD",
        "batchMode": "MULTI",
        "paymentOrderProduct": "DOMESTIC",
        "bulkErrorDetails": []
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}
   

• Error Code: 12001
  Error Message: "Logged in user is not authorized to perform this action."
• Error Code: 21223
  Error Message: "Failed to fetch ongoing payments."
• Error Code: 00000
  Error Message: "Error occurred at backend."
• Error Code: 21228
  Error Message: "Error occurred while parsing date."

{base_url}/api/v2.0.0/order/bulkPayments/status

Parameters

sortByParam

Specifies the field in the response based on which the list of records must be sorted. By default, the list of records would be sorted based on the date on which the request was sent (sentDate).

sortOrder

Specifies the order in which the list of fetched records must be sorted, such as in ascending or descending (ASC/DESC) order. By default, the value is set to DESC for the date on which the request was sent (sentDate).

searchString

Specifies the free text that can be entered to search for a set of records that matches the text that is entered.

pageSize

Specifies the number of rows that must be returned in the result.

pageOffset

Specifies the row from which the data must be retrieved. The offset value is often used together with the limit.

filterByParam

Specifies the parameter based on which the fetched files must be filtered.

filterByValue

Specifies the value based on which the fetched files must be filtered.

batchMode

Specifies the if it is a Single or Multiple files.

timeParam

Specifies the uploaded date.

timeValue

Specifies the last number of periods (Days, Weeks, Months, Year).

{
    "searchString": "",
    "sortByParam": "",
    "sortOrder": "DESC",
    "pageSize": "",
    "pageOffset": "",
    "filterByParam": "",
    "filterByValue": "",
    "batchMode": "",
    "timeParam": "paymentDate",
    "timeValue": ""
}

Parameters

history(Mandatory)

Specifies the history for the unique recordId.

recordId(Mandatory)

Specifies the unique ID of the record.

paymentId(Mandatory)

Specifies the unique ID of the payment.

description(Mandatory)

Specifies the description of the Bulk Payment file.

paymentDate(Mandatory)

Specifies the date on which the payment occurred.

scheduledDate(Mandatory)

Specifies the date on when the scheduled transfer payment must occur.

status(Mandatory)

Specifies the status of the operation.

fromAccount(Mandatory)

Specifies the account from which the files are uploaded.

totalAmount(Mandatory)

Specifies the total amount.

initiatedBy

Specifies the name of the user who initiated the transaction.

totalTransactions

Specifies the total number of transactions.

companyId(Mandatory)

Specifies the unique ID of the company.

requestId(Mandatory)

Specifies the request ID.

actedByMeAlready(Mandatory)

Specifies whether the user has created the request. The value is Boolean.

amIAprover(Mandatory)

Specifies whether the user is the approver. The value is Boolean.

amICreator(Mandatory)

Specifies whether the user is the creator. The value is Boolean.

recievedApprovals(Mandatory)

Specifies the number of requests that are received for approval.

requiredApprovals(Mandatory)

Specifies the number of requests that require approvals.

fileId

Specifies the unique file ID.

currency

Specifies the currency name.

batchMode

Specifies the if it is a Single or Multiple files.

{
    "history": [{
        "recordId": "BKM2110500197",
        "paymentId": "BKM2110500197",
        "description": "TestTemplate1",
        "paymentDate": "2021-04-15T00:00:00Z",
        "scheduledDate": "2021-04-15T00:00:00Z",
        "status": "COMPLETED",
        "fromAccount": "122629",
        "totalAmount": "13",
        "totalTransactions": "2",
        "companyId": "4718904850_800574",
        "requestId": "44",
        "actedByMeAlready": "false",
        "amIApprover": "false",
        "amICreator": "false",
        "receivedApprovals": "1",
        "requiredApprovals": "1",
        "fileId": "UPLD2110546782",
        "currency": "USD",
        "batchMode": "MULTI"
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 12000
  Error Message: "Internal service error."
• Error Code: 00000
  Error Message: "Error occurred at backend."
• Error Code: 21220
  Error Message: "Failed to fetch bulk payment uploaded files."
• Error Code: 21214
  Error Message: "Failed to fetch Bulk Payment Records."

{base_url}/api/v2.0.0/order/bulkPayments/status

Parameters

recordId

Specifies the unique ID of the record.

{
"recordId":""
}

Parameters

paymentId(Mandatory)

Specifies the unique paymentId.

status(Mandatory)

Specifies the status of the review process.

messageDetails(Mandatory)

Specifies the message for the payment.

{
    "paymentId": "BKM2110500185",
    "status": "Sent",
    "messageDetails": "[{"
    id ":"
    DUP.CONTRACT ","
    message ":"
    POSSIBLE DUPLICATE CONTRACT & {
        BKM2110500170 "}]", "opstatus": 0,
        "httpStatusCode": 0
    }

• Error Code: 12001
  Error Message: "Logged in user is not authorized to perform this action."
• Error Code: 00000
  Error Message: "Error occurred at backend."
• Error Code: 21227
  Error Message: "Invalid bulk payments record id."
• Error Code: 21231
  Error Message: "Failed to review bulk payment record."
• Error Code: 21230
  Error Message: "Failed to fetch bulk payment record details backend."
• Error Code: 21222
  Error Message: "Unauthorised user bulk payment review."
• Error Code: 21232
  Error Message: "Invalid total amount."
• Error Code: 28034
  Error Message: "Error in PO status."
• Error Code: 29018
  Error Message: "Failed validation for approvals"
• Error Code: 10624
  Error Message: "Invalid request payload."
• Error Code: 29016
  Error Message: "Failed creating dbx entry."
• Error Code: 12600
  Error Message: "Backend invocation failed."
• Error Code: 12611
  Error Message: "Transactions rdc create error"
• Error Code: 12601
  Error Message: "Backend pending transaction invocation failed."
• Error Code: 29019
  Error Message: "Error updating backend id."

{base_url}/api/v2.0.0/order/bulkPayments/{bulkTransferId}

Parameters

sortByParam

Specifies the field in the response based on which the list of records must be sorted. By default, the list of records would be sorted based on the date on which the request was sent (sentDate).

sortOrder

Specifies the order in which the list of fetched records must be sorted, such as in ascending or descending (ASC/DESC) order. By default, the value is set to DESC for the date on which the request was sent (sentDate).

searchString

Specifies the free text that can be entered to search for a set of records that matches the text that is entered.

pageSize

Specifies the number of rows that must be returned in the result.

pageOffset

Specifies the row from which the data must be retrieved. The offset value is often used together with the limit.

filterByParam

Specifies the parameter based on which the fetched files must be filtered.

filterByValue

Specifies the value based on which the fetched files must be filtered.

{
"sortByParam":"",
"sortOrder": "",
"searchString":"",
"pageSize":"",
"pageOffset":"",
"filterByParam":"",
"filterByValue":""
}

Parameters

records

Specifies an array of JSON object of records and the corresponding details.

recordId

Specifies the unique ID of the record.

paymentId

Specifies the unique ID of the payment.

description

Specifies the description of the Bulk Payment file.

paymentDate

Specifies the date on which the payment has occurred.

scheduledDate

Specifies the date on when the scheduled transfer payment must occur.

status

Specifies the status of the operation.

fromAccount

Specifies the account from which the files are uploaded.

totalAmount

Specifies the total amount.

totalTransactions

Specifies the total number of transactions.

companyId

Specifies the unique ID of the company.

requestId

Specifies the request ID.

actedByMeAlready

Specifies whether the approval has been provided already.

amIAprover

Specifies whether the user is the approver. The value is Boolean.

amICreator

Specifies whether the user is the creator. The value is Boolean.

recievedApprovals

Specifies the number of requests that are received for approval.

requiredApprovals

Specifies the number of requests that require approvals.

{
"records" : [
 { 
  "recordId":"",
  "paymentId":"",
  "description":"",
  "paymentDate":"",
  "scheduledDate":"",
  "status":"",
  "fromAccount":"",
  "totalAmount":"",
  "totalTransactions":"",
  "companyId":"",
  "requestId":"",
  "actedByMeAlready": "",
  "amIApprover":"",
  "amICreator":"",
  "receivedApprovals":"",
  "requiredApprovals":"",
  }
  ],
  "opstatus": 0,
  "httpStatusCode": 0
}

• Error Code: 10227
  Error Message: "Features are empty."
• Error Code: 21220
  Error Message: "Failed to fetch bulkpayment file."
• Error Code: 21246
  Error Message: "Failed to fetch bulkpayment record."
• Error Code: 21230
  Error Message: "Failed to fetch bulkpayment file from backend."
• Error Code: 21200
• Error Message: "Bulkpayment file parse error."

Parameters

sortByParam

Specifies the field in the response based on which the list of records must be sorted. By default, the list of records would be sorted based on the date on which the request was sent (sentDate).

sortOrder

Specifies the order in which the list of fetched records must be sorted, such as in ascending or descending (ASC/DESC) order. By default, the value is set to DESC for the date on which the request was sent (sentDate).

searchString

Specifies the free text that can be entered to search for a set of records that matches the text that is entered.

pageSize

Specifies the number of rows that must be returned in the result.

pageOffset

Specifies the row from which the data must be retrieved. The offset value is often used together with the limit.

filterByParam

Specifies the parameter based on which the fetched files must be filtered.

filterByValue

Specifies the value based on which the fetched files must be filtered.

{
"sortByParam":"",
"sortOrder": "",
"searchString":"",
"pageSize":"",
"pageOffset":"",
"filterByParam":"",
"filterByValue":""
}

Parameters

records

Specifies an array of JSON object of records and the corresponding details.

recordId

Specifies the unique ID of the record.

paymentId

Specifies the unique ID of the payment.

description

Specifies the description of the Bulk Payment file.

paymentDate

Specifies the date on which the payment occurred.

scheduledDate

Specifies the date on when the scheduled transfer payment must occur.

status

Specifies the status of the operation.

fromAccount

Specifies the account from which the files are uploaded.

totalAmount

Specifies the total amount.

totalTransactions

Specifies the total number of transactions.

companyId

Specifies the unique ID of the company.

requestId

Specifies the request ID.

actedByMeAlready

Specifies whether the approval has already been provided.

amIAprover

Specifies whether the user is the approver. The value is Boolean.

amICreator

Specifies whether the user is the creator. The value is Boolean.

recievedApprovals

Specifies the number of requests that are received for approval.

requiredApprovals

Specifies the number of requests that require approvals.

{
"records" : [
 { 
  "recordId":"",
  "paymentId":"",
  "description":"",
  "paymentDate":"",
  "scheduledDate":"",
  "status":"",
  "fromAccount":"",
  "totalAmount":"",
  "totalTransactions":"",
  "companyId":"",
  "requestId":"",
  "actedByMeAlready": "",
  "amIApprover":"",
  "amICreator":"",
  "receivedApprovals":"",
  "requiredApprovals":"",
  }
  ],
  "opstatus": 0,
  "httpStatusCode": 0
}

• Error Code: 10227
  Error Message: "features are empty."
• Error Code: 21220
  Error Message: "failed to fetch bulkpayment file."
• Error Code: 21246
  Error Message: "failed to fetch bulkpayment record."
• Error Code: 21230
  Error Message: "failed to fetch bulkpayment file from backend."
• Error Code: 21200
• Error Message: "bulkpayment file parse error."

Parameters

sortByParam

Specifies the field in the response based on which the list of records must be sorted. By default, the list of records would be sorted based on the date on which the request was sent (sentDate).

sortOrder

Specifies the order in which the list of fetched records must be sorted, such as in ascending or descending (ASC/DESC) order. By default, the value is set to DESC for the date on which the request was sent (sentDate).

searchString

Specifies the free text that can be entered to search for a set of records that matches the text that is entered.

pageSize

Specifies the number of rows that must be returned in the result.

pageOffset

Specifies the row from which the data must be retrieved. The offset value is often used together with the limit.

filterByParam

Specifies the parameter based on which the fetched files must be filtered.

filterByValue

Specifies the value based on which the fetched files must be filtered.

{
"sortByParam":"",
"sortOrder": "",
"searchString":"",
"pageSize":"",
"pageOffset":"",
"filterByParam":"",
"filterByValue":""
}

Parameters

records

Specifies an array of JSON object of records and the corresponding details.

recordId

Specifies the unique ID of the record.

paymentId

Specifies the unique ID of the payment.

description

Specifies the description of the Bulk Payment file.

paymentDate

Specifies the date on which the payment occurred.

scheduledDate

Specifies the date on when the scheduled transfer payment must occur.

status

Specifies the status of the operation.

fromAccount

Specifies the account from which the files are uploaded.

totalAmount

Specifies the total amount.

totalTransactions

Specifies the total number of transactions.

companyId

Specifies the unique ID of the company.

requestId

Specifies the request ID.

actedByMeAlready

Specifies whether the approval has been provided already.

amIAprover

Specifies whether the user is the approver. The value is Boolean.

amICreator

Specifies whether the user is the creator. The value is Boolean.

recievedApprovals

Specifies the number of requests that are received for approval.

requiredApprovals

Specifies the number of requests that require approvals.

{
"records" : [
 { 
  "recordId":"",
  "paymentId":"",
  "description":"",
  "paymentDate":"",
  "scheduledDate":"",
  "status":"",
  "fromAccount":"",
  "totalAmount":"",
  "totalTransactions":"",
  "companyId":"",
  "requestId":"",
  "actedByMeAlready": "",
  "amIApprover":"",
  "amICreator":"",
  "receivedApprovals":"",
  "requiredApprovals":"",
  }
  ],
  "opstatus": 0,
  "httpStatusCode": 0
}

• Error Code: 10227
  Error Message: "features are empty."
• Error Code: 21220
  Error Message: "failed to fetch bulkpayment file."
• Error Code: 21246
  Error Message: "failed to fetch bulkpayment record."
• Error Code: 21230
  Error Message: "failed to fetch bulkpayment file from backend."
• Error Code: 21200
• Error Message: "bulkpayment file parse error."

Parameters

sortByParam

Specifies the field in the response based on which the list of records must be sorted. By default, the list of records would be sorted based on the date on which the request was sent (sentDate).

sortOrder

Specifies the order in which the list of fetched records must be sorted, such as in ascending or descending (ASC/DESC) order. By default, the value is set to DESC for the date on which the request was sent (sentDate).

searchString

Specifies the free text that can be entered to search for a set of records that matches the text that is entered.

pageSize

Specifies the number of rows that must be returned in the result.

pageOffset

Specifies the row from which the data must be retrieved. The offset value is often used together with the limit.

filterByParam

Specifies the parameter based on which the fetched files must be filtered.

filterByValue

Specifies the value based on which the fetched files must be filtered.

{
"sortByParam":"",
"sortOrder": "",
"searchString":"",
"pageSize":"",
"pageOffset":"",
"filterByParam":"",
"filterByValue":""
}

Parameters

records

Specifies an array of JSON object of records and the corresponding details.

recordId

Specifies the unique ID of the record.

paymentId

Specifies the unique ID of the payment.

description

Specifies the description of the Bulk Payment file.

paymentDate

Specifies the date on which the payment occurred.

scheduledDate

Specifies the date on when the scheduled transfer payment must occur.

status

Specifies the status of the operation.

fromAccount

Specifies the account from which the files are uploaded.

totalAmount

Specifies the total amount.

totalTransactions

Specifies the total number of transactions.

companyId

Specifies the unique ID of the company.

requestId

Specifies the request ID.

actedByMeAlready

Specifies whether the approval has been provided already.

amIAprover

Specifies whether the user is the approver. The value is Boolean.

amICreator

Specifies whether the user is the creator. The value is Boolean.

recievedApprovals

Specifies the number of requests that are received for approval.

requiredApprovals

Specifies the number of requests that require approvals.

{
"records" : [
 { 
  "recordId":"",
  "paymentId":"",
  "description":"",
  "paymentDate":"",
  "scheduledDate":"",
  "status":"",
  "fromAccount":"",
  "totalAmount":"",
  "totalTransactions":"",
  "companyId":"",
  "requestId":"",
  "actedByMeAlready": "",
  "amIApprover":"",
  "amICreator":"",
  "receivedApprovals":"",
  "requiredApprovals":"",
  }
  ],
  "opstatus": 0,
  "httpStatusCode": 0
}

• Error Code: 10227
  Error Message: "features are empty."
• Error Code: 21220
  Error Message: "failed to fetch bulkpayment file."
• Error Code: 21246
  Error Message: "failed to fetch bulkpayment record."
• Error Code: 21230
  Error Message: "failed to fetch bulkpayment file from backend."
• Error Code: 21200
• Error Message: "bulkpayment file parse error."

Parameters

requestId

Specifies the unique ID of the request.

comments

Specifies the additional comments

{
    "requestId": "65",
    "comments": "test"
}

Parameters

recordId

Specifies the unique ID of the record.

status

Specifies the status of the operation.

success

Specifies the success message.

actedBy

Specifies the name of the user who acted.

featureActionId

Specifies the unique ID of the feature.

{
    recordId : '',
    status : '',
    featureActionId : '',
    success : '',
    actedBy: '',
}

• Error Code: 12001
  Error Message: "Logged in user is not authorized to perform this action."
• Error Code: 12000
  Error Message: "Internal service error."
• Error Code: Error Code: 12001
  Error Message: "DB fetch error."
• Error Code: 12114
  Error Message: "Failed to fetch application record."
• Error Code: 12113
  Error Message: "Self approvals not allowed."
• Error Code: 21010
  Error Message: "User already approved."

{base_url}/api/v2.0.0/order/bulkMasterApprovals/order/bulkMasterApprovals/{bulkTransferId}

Parameters

requestId

Specifies the unique ID of the request.

comments

Specifies the additional comments.

rejectionreason

Specifies the reasons for rejection.

{
    "requestId": "65",
    "comments": "ƒ",
    "rejectionreason": "For business reasons only"
}

Parameters

recordId

Specifies the unique ID of the record.

status

Specifies the status of the operation.

actedBy

Specifies the name of the user who performed the action.

featureActionId

Specifies the unique ID of the feature.

{
    recordId: '',
    status: '',
    featureActionId: '',
    actedBy: '',
}

• Error Code: 12001
  Error Message: "Logged in User is not authorized to perform this action."
• Error Code: 12000
  Error Message: "Internal service error."
• Error Code: 12610
  Error Message: "Given accounts list contains invalid accounts records."
• Error Code: 21012
  Error Message: "Cannot reject."
• Error Code: 21227
  Error Message: "Invalid bulk payments record id."

{base_url}/api/v2.0.0/order/bulkMasterApprovals/order/bulkMasterApprovals/{bulkTransferId}

Parameters

requestId(Mandatory)

Specifies the unique ID of the request.

comments(Mandatory)

Specifies the additional comments.

cancellationreason(Mandatory)

Specifies the reason for cancellation.

cancellationReasonId(Mandatory)

Specifies the unique cancellationReason ID.

statusCode(Mandatory)

Specifies whether approval is canceled or not canceled.

{
    "recordId": "BKM2110500213",
    "comments": "ramyyaa",
    "cancellationreason": "SELLER'S CBU DOES NOT EXIST",
    "cancellationReasonId": "01",
    "statusCode": "CANCELLED"
}

Parameters

status(Mandatory)

Specifies the status of the operation.

{
    "status": "DISCARDED",
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 12001
  Error Message: "Logged in user is not authorized to perform this action."
• Error Code: 12000
  Error Message: "Internal service error."
• Error Code: 21200
  Error Message: "Bulk payments file parse error."
• Error Code: 21236
  Error Message: "Unauthorized user cancel bulk payments record."
• Error Code: 21227
  Error Message: "Invalid bulk payments record id."
• Error Code: 00000
  Error Message: "Error occurred at backend."
• Error Code: 21230
  Error Message: "Failed to fetch bulk payment record details backend."

{base_url}/api/v2.0.0/order/bulkPayments/{bulkTransferId}

Parameters

recordId

Specifies the unique ID of the record.

description

Specifies the description of the record.

fromAccount

Specifies the account from which the bulk payment transfer must occur.

{
    "recordId": "1176219490",
    "fromAccount": "200911030403585",
    "description": "Test Kalyani"
}

Parameters

confirmationNumber

Specifies the confirmation number that gets generated.

{
    "confirmationNumber": "BKM2110500214",
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 12000
  Error Message: "Internal service error."
• Error Code: 21227
  Error Message: "Invalid bulk payments record id."
• Error Code: 21242
  Error Message: "Mandatory bulk payments from account description."
• Error Code: 21236
  Error Message: "Unauthorized user cancel bulk payments record."
• Error Code: 00000
  Error Message: "Error occurred at backend."
• Error Code: 21216
  Error Message: "Bulk payments record edit error."

{base_url}/api/v2.0.0/order/bulkPayments/{bulkTransferId}

Parameters

recordId (Mandatory)

Specifies the unique ID of the record.

recipientName(Mandatory)

Specifies the name of the recipient.

accountNumber (Mandatory)

Specifies the account number of the user.

bankName

Specifies the name of the bank.

swift

Specifies the swift code for international transactions.

currency (Mandatory)

Specifies the currency code.

amount (Mandatory)

Specifies the amount value for the Payment Order.

feesPaidBy

Specifies the fees paid by the user.

paymentReference

Specifies the reference number for the Payment Order Container.

paymentMethod

Specifies the type of payment method.

addToList

Specifies whether the payment order to be added to list. This a Boolean value.

paymentOrderProduct (Mandatory)

Specifies the paymentOrderProduct name.

fromAccount (Mandatory)

Specifies the account from which the bulk payment transfer must occur.

{
    "recordId": "BKM2110500214",
    "recipientName": "rasmya",
    "accountNumber": "GB79DEMO60161300014648",
    "bankName": "Infinity",
    "swift": "",
    "currency": "USD",
    "amount": "13.00",
    "feesPaidBy": "Shared",
    "paymentReference": "BulkREfAKI",
    "paymentMethod": "Internal",
    "addToList": false,
    "paymentOrderProduct": "FTBMBLK",
    "fromAccount": "125679"
}

Parameters

paymentOrderId

Specifies the unique ID of the Payment Order Container.

{
    "paymentOrderId": "PI21105015P2VJ45",
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 12001
  Error Message: "Logged in User is not authorized to perform this action."
• Error Code: 00000
  Error Message: "Error occurred at backend."
• Error Code: 21209
  Error Message: "Bulk payments PO create error."

{base_url}/api/v2.1.0/order/paymentOrders

Parameters

recordId

Specifies the unique ID of the record.

paymentOrderId

Specifies the unique ID of the Payment Order Container.

currency

Specifies the currency code.

amount

Specifies the amount value for the Payment Order.

feesPaidBy

Specifies the fees paid by the user.

paymentReference

Specifies the reference number for the Payment Order Container.

{
    "recordId": "1066408269",
    "paymentOrderId": "1731229886",
    "currency": "USD",
    "amount": "24",
    "feesPaidBy": "Me",
    "paymentReference": "September salary"
}

Parameters

paymentOrderId

Specifies the unique ID of the Payment Order Container.

{
    "paymentOrderId": "PI211050018YC4SG",
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 12001
  Error Message: "Logged in User is not authorized to perform this action."
• Error Code: 00000
  Error Message: "Error occurred at backend."
• Error Code: 21212
  Error Message: "Bulk payments PO edit error."

{base_url}/api/v2.1.0/order/paymentOrders/{paymentOrderId}

Parameters

recordId

Specifies the unique ID of the record.

paymentOrderId

Specifies the unique ID of the Payment Order Container.

{
    "recordId": "1176219490",
    "paymentOrderId": "1619913373"
}

Parameters

paymentOrderId

Specifies the unique ID of the Payment Order Container.

{
    httpStatusCode: 0
    opstatus: 0
    paymentOrderId: "PI211050KTXPZ4KM"
}

• Error Code: 00000
  Error Message: "Error occurred at backend."
• Error Code: 21227
  Error Message: "Invalid bulk payments record id."
• Error Code: 21238
  Error Message: "Invalid bulk payments payment order id."
• Error Code: 21211
  Error Message: "Bulk payments PO delete error."

None

Parameters

fileName

Specifies the name of the sample file.

description

Specifies the description of the sample file.

fileId

Specifies the unique ID of the sample file.

content

Specifies the content in the sample file.

{
    "sampleFiles": [{
        "fileId": "001",
        "fileName": "SampleCSV",
        "description": "CSV",
        "content": "PERFU0NSSVBUSU9OPiw8QlVMSy5UWVBFPiw8REVCSVQuQ1JFRElUPiw8U0lOR0xFLk1VTFRJPiw8Q1VTVE9NRVI+LDxERUJJVC5BQ0NPVU5UPiw8Q1VSUkVOQ1k+LDxXQVNILkFDQ09VTlQ+LDxFUlJPUi5BQ0NPVU5UPiw8TU9ERS5PRi5UUkFOU0ZFUj4sPFBST0NFU1NJTkcuREFURT4sPFBBWU1FTlQuVkFMVUUuREFURT4sPENMRUFSSU5HLkRBVEU+LDxVUExPQUQuUkVGRVJFTkNFPiw8REVCSVQuUkVGRVJFTkNFPiw8Q1JFRElULlJFRkVSRU5DRT4sLCwsLCw8QU1ULlRPLkJFLlVQTE9BREVEPiwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsCjxQQVlNRU5ULk9SREVSLlBST0RVQ1Q+LCw8T1JERVJJTkcuQ1VTVE9NRVI+LDxPUkRFUklORy5DVVNUT01FUi5CSUM+LDxPUkRFUklORy5DVVNULk5BTUU+LCwsLCwsPERFQklULkNDWT4sPERFQklULkFDQ09VTlQuSUJBTj4sLCwsLCwsLCwsPEJFTkVGSUNJQVJZLkFDQ09VTlQuTk8+LDxCRU5FRklDSUFSWS5JQkFOPiwsLDxCRU5FRklDSUFSWS5OQU1FPiwsLDxCRU4uUE9TVC5BRERSLkxJTkUtMT4sLCwsLCwsLCwsPEFDQ1QuV0lUSC5CQU5LLkJJQz4sLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLDxQQVlNRU5ULkNVUlJFTkNZPiw8UEFZTUVOVC5BTU9VTlQ+LCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLDxCVUxLLlBST0NFU1NJTkcuTU9ERT4sLCwsLA=="
    }, {
        "fileId": "002",
        "fileName": "SampleXML",
        "description": "XML",
        "content": "<?xml version="1.0" encoding="utf-8"?>
<Document xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:iso:std:iso:20022:tech:xsd:pain.001.001.03">
  <CstmrCdtTrfInitn>
    <GrpHdr>
      <MsgId>TPS171020200595005</MsgId> <!--DESCRIPTION-->
      <CreDtTm>2020-04-17T14:07:00</CreDtTm>
      <NbOfTxs>2</NbOfTxs>
	<CtrlSum>3200</CtrlSum>
      <InitgPty>
        <Nm>Nike</Nm>
        <Id>
          <OrgId>
            <BICOrBEI>DEMOGBPX</BICOrBEI>
            <Othr>
              <Id>IDENTIFICATION1</Id>
              <SchmeNm>
                <Cd>CODE</Cd>
              </SchmeNm>
              <Issr>ISSUER</Issr>
            </Othr>
          </OrgId>
        </Id>
      </InitgPty>
    </GrpHdr>
    <PmtInf>
      <PmtInfId>TPS17102020059501</PmtInfId>
      <PmtMtd>TRF</PmtMtd>  
      <BtchBookg>true</BtchBookg>
	 <NbOfTxs>2</NbOfTxs> <!--TOTAL.TRANSACTIONS-->	
	 <CtrlSum>3200</CtrlSum> <!--TOTAL.AMOUNT-->
         <PmtTpInf>
        <InstrPrty>NORM</InstrPrty>
        <SvcLvl>
          <Cd>SEPA</Cd> <!--PAYMENT.METHOD-->
        </SvcLvl>
        <CtgyPurp>
          <Cd>SALA</Cd>
        </CtgyPurp>
      </PmtTpInf>
      <ReqdExctnDt>2020-04-17</ReqdExctnDt> <!--PAYMENT.VALUE.DATE-->
      <Dbtr>
        <Nm>SCT787 EUROPE</Nm>
        <PstlAdr>
          <Ctry>EU</Ctry>
          <AdrLine>Frankfurt</AdrLine>
        </PstlAdr>
        <Id>
          <OrgId>
            <Othr>
              <Id>100230</Id>
			  <SchmeNm>
                <Prtry>GIDP</Prtry>
				</SchmeNm>
              <Issr>DbtrSchIssuer</Issr>           
            </Othr>
          </OrgId>
        </Id>
      </Dbtr>
      <DbtrAcct>
        <Id>
          <IBAN>GB38DEMO60161300013215</IBAN> <!--FROM.ACCOUNT-->
        </Id>
        <Ccy>EUR</Ccy><!--CURRENCY-->
      </DbtrAcct>
      <DbtrAgt>
        <FinInstnId>
          <BIC>DEMOGBPX</BIC>
          <Othr>
            <Id>IDENTIFICATION2</Id>
          </Othr>
        </FinInstnId>
      </DbtrAgt>
      <CdtTrfTxInf>
        <PmtId>
          <InstrId>TPS17102020059511</InstrId>
          <EndToEndId>TPS17102020059511</EndToEndId>
        </PmtId>
        <Amt>
          <InstdAmt Ccy="EUR">1700</InstdAmt> <!-- Ccy = PAYMENT.CURRENCY--> <!--PAYMENT.AMOUNT-->
        </Amt>
        <ChrgBr>SLEV</ChrgBr>
        <UltmtDbtr>
        <Nm>TESTING ULTI DB</Nm>
        <Id>
          <OrgId>
            <BICOrBEI>DEMOGBPX</BICOrBEI>
            <Othr>
              <Id>ULTI-ID</Id>
              <SchmeNm>
                <Cd>TEST</Cd>
              </SchmeNm>
              <Issr>ULTI-ISSUER</Issr>
            </Othr>
          </OrgId>
        </Id>
      </UltmtDbtr>
        <CdtrAgt>
          <FinInstnId>
            <BIC>BARCGB22</BIC> <!--SWIFT.CODE--> 
          </FinInstnId>
        </CdtrAgt>
        <Cdtr>
          <Nm>DEF Electronics</Nm> <!--BENEFICIARY.NAME-->
          <PstlAdr>
            <Ctry>IN</Ctry>
            <AdrLine>BANGALORE</AdrLine>
          </PstlAdr>
          <Id>
            <OrgId>
              <BICOrBEI>BARCGB22</BICOrBEI>
              <Othr>
			  <Id>IDENTIFICATION3</Id>
			    <SchmeNm>
                  <Cd>CODE</Cd>
                </SchmeNm>
              <Issr>ISSUER</Issr>
              </Othr>
            </OrgId>
          </Id>
        </Cdtr>
        <CdtrAcct>
          <Id>
            <IBAN>GB04BARC20474473160944</IBAN> <!--BENEFICIARY.ACCOUNT.NO-->
          </Id>
        </CdtrAcct>
        <UltmtCdtr>
          <Nm>ULTI-CDTR</Nm>
          <Id>
            <OrgId>
              <BICOrBEI>BARCGB22</BICOrBEI>
              <Othr>
                <Id>ID</Id>
                <SchmeNm>
                  <Cd>str1</Cd>
                </SchmeNm>
                <Issr>str1234</Issr>
              </Othr>
            </OrgId>
          </Id>
        </UltmtCdtr>
        <Purp>
          <Cd>GDDS</Cd>
        </Purp>
        <RmtInf>
          <Ustrd>str1233</Ustrd>
          <Strd>
            <CdtrRefInf>
              <Tp>
                <CdOrPrtry>
                  <Cd>SCOR</Cd>
                </CdOrPrtry>
                <Issr>str1234</Issr>
              </Tp>
              <Ref>str1235</Ref>
            </CdtrRefInf>
          </Strd>
        </RmtInf>
      </CdtTrfTxInf>	  
      <CdtTrfTxInf>
        <PmtId>
          <InstrId>TPS17102020059521</InstrId>
          <EndToEndId>TPS17102020059521</EndToEndId>
        </PmtId>
        <Amt>
          <InstdAmt Ccy="EUR">1500</InstdAmt> <!-- Ccy = PAYMENT.CURRENCY--> <!--PAYMENT.AMOUNT-->
        </Amt>
        <ChrgBr>SLEV</ChrgBr>
        <UltmtDbtr>
        <Nm>TESTING ULTI DB</Nm>
        <Id>
          <OrgId>
            <BICOrBEI>DEMOGBPX</BICOrBEI>
            <Othr>
              <Id>ULTI-ID</Id>
              <SchmeNm>
                <Cd>TEST</Cd>
              </SchmeNm>
              <Issr>ULTI-ISSUER</Issr>
            </Othr>
          </OrgId>
        </Id>
      </UltmtDbtr>
        <CdtrAgt>
          <FinInstnId>
            <BIC>BARCGB22</BIC> <!--SWIFT.CODE-->
          </FinInstnId>
        </CdtrAgt>
        <Cdtr>
          <Nm>ROBERT</Nm> <!--BENEFICIARY.NAME-->
          <PstlAdr>
            <Ctry>IN</Ctry>
            <AdrLine>BANGALORE</AdrLine>
          </PstlAdr>
          <Id>
            <OrgId>
              <BICOrBEI>BARCGB22</BICOrBEI>
              <Othr>
			  <Id>IDENTIFICATION3</Id>
			    <SchmeNm>
                  <Cd>CODE</Cd>
                </SchmeNm>
              <Issr>ISSUER</Issr>
              </Othr>
            </OrgId>
          </Id>
        </Cdtr>
        <CdtrAcct>
          <Id>
            <IBAN>GB04BARC20474473160945</IBAN> <!--BENEFICIARY.ACCOUNT.NO-->
          </Id>
        </CdtrAcct>
        <UltmtCdtr>
          <Nm>ULTI-CDTR</Nm>
          <Id>
            <OrgId>
              <BICOrBEI>BARCGB22</BICOrBEI>
              <Othr>
                <Id>ID</Id>
                <SchmeNm>
                  <Cd>str1</Cd>
                </SchmeNm>
                <Issr>str1234</Issr>
              </Othr>
            </OrgId>
          </Id>
        </UltmtCdtr>
        <Purp>
          <Cd>GDDS</Cd>
        </Purp>
        <RmtInf>
          <Ustrd>str1233</Ustrd>
          <Strd>
            <CdtrRefInf>
              <Tp>
                <CdOrPrtry>
                  <Cd>SCOR</Cd>
                </CdOrPrtry>
                <Issr>str1234</Issr>
              </Tp>
              <Ref>str1235</Ref>
            </CdtrRefInf>
          </Strd>
        </RmtInf>
      </CdtTrfTxInf>
     </PmtInf>
  </CstmrCdtTrfInitn>
</Document>"
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 12000
  Error Message: "Internal server error."
• Error Code: 00000
  Error Message: "Error occurred at backend."
• Error Code: 21218
  Error Message: "Fetch sample files failed error."

Parameters

recordId

Specifies the unique ID of the record.

{
    "recordId": "BKM2010800010"
}

Parameters

paymentOrderId

Specifies the unique ID of the Payment Order Container.

recordId

Specifies the unique ID of the record.

recipientName

Specifies the name of the recipient.

accountNumber

Specifies the account number of the user.

bankName

Specifies the name of the bank.

swift

Specifies the swift code for international transactions.

currency

Specifies the currency code.

amount

Specifies the amount value for the Payment Order.

feesPaidBy

Specifies the fees paid by the user.

paymentReference

Specifies the reference number for the Payment Order Container.

status

Specifies the status of the payment order (Added/Modified/Ready for Execution).

paymentMethod

Specifies the method of payment opted by the user such as Single Euro Payments Area (SEPA), Internal or so on.

errorDescription

Specifies the description of the error.

{
    "paymentOrders": [{
        "paymentOrderId": "PI211050018YC4P6",
        "recordId": "BKM2110500143",
        "recipientName": "Rupa14",
        "accountNumber": "GB91DEMO60161300100374",
        "currency": "USD",
        "amount": "2",
        "feesPaidBy": "SHA",
        "paymentReference": "TestRefeeence33",
        "status": "In Error",
        "paymentMethod": "DOMESTIC",
        "errorDescription": "Not Specified Reason Agent Generate"
    }, ],
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 21210
  Error Message: "Bulk payments PO fetch error."
• Error Code: 12001
  Error Message: "Logged in user is not authorized to perform this action."
• Error Code: 21227
  Error Message: "Invalid bulk payments record id."
• Error Code: 00000
  Error Message: "Error occurred at backend."
• Error Code: 21220
  Error Message: "Fetch uploaded files failed error."

{base_url}/api/v2.1.0/order/paymentOrders

Parameters

templateName (Mandatory)

Specifies the name of the template.

description (Mandatory)

Specifies the description of the template.

fromAccount (Mandatory)

Specifies the account number from which bulk payment is to be initiated.

currency (Mandatory)

Specifies the currency medium for performing the bulk payment.

paymentDate (Mandatory)

Specifies the date for the bulk payment.

processingMode (Mandatory)

Specifies whether the processing is Single or Multi.

beneficiaryName(Mandatory)

Specifies the name of the beneficiary.

recipientName(Mandatory)

Specifies the name of the recipient.

paymentMethod(Mandatory)

Specifies the method of payment opted by the user such as Single Euro Payments Area (SEPA), Internal or so on.

amount(Mandatory)

Specifies the amount value for the Payment Order.

feesPaidBy(Mandatory)

Specifies the fees paid by the user.

paymentReference(Mandatory)

Specifies the reference number for the Payment Order Container.

accountNumber(Mandatory)

Specifies the account number of the user.

accType(Mandatory)

Specifies the type of account such as Savings, Checking, and so on.

swift(Mandatory)

Specifies the swift key.

beneficiaryNickName(Mandatory)

Specifies the nick name fpr beneficiary.

beneficiaryAddress(Mandatory)

Specifies the beneficiary Address.

beneficiaryType(Mandatory)

Specifies the type of beneficiary.

addToExistingFlag(Mandatory)

Specifies if the file to be added. This is a Boolean Flag.

bankName(Mandatory)

Specifies the bank name.

{
    "templateName": "BTempNtmeUII",
    "POs": "[{\"amount\":\"10.00\",\"feesPaidBy\":\"-\",\"beneficiaryNickName\":\"Boeing\",\"paymentReference\":\"BulkREfUSH\",\"beneficiaryIBAN\":\"GB09DEMO60161300101753\",\"bankName\":\"Infinity\",\"beneficiaryAddress\":\"-\",\"beneficiaryName\":\"Boeing\",\"beneficiaryType\":\"MANUALLYADDED\",\"recipientName\":\"Boeing\",\"paymentMethod\":\"Boeing\",\"currency\":\"USD\",\"accType\":\"Internal\",\"addToExistingFlag\":\"0\",\"swift\":\"\"}]",
    "fromAccount": "125679",
    "description": "BTempDescGMIHSI",
    "currency": "USD",
    "paymentDate": "2021-10-11",
    "processingMode": "SINGLE"
}

Parameters

templateName

Specifies the name of the template.

fromAccount

Specifies the account number from which bulk payment is to be initiated.

currency

Specifies the currency medium for performing the bulk payment.

paymentDate

Specifies the date for the bulk payment.

templateID

Specifies the unique ID of the template.

processingMode

Specifies whether the processing is Single or Multi.

totalAmount

Specifies the total amount.

totalBeneficiaries

Specifies the total beneficiaries in the file.

description

Specifies the description of the bulk payment template.

{
    "templateName": "BTempNtmeUII",
    "fromAccount": "125679",
    "currency": "USD",
    "processingMode": "SINGLE",
    "paymentDate": "2021-10-11T00:00:00Z",
    "totalAmount": "10",
    "templateId": "211020210719015941",
    "totalBeneficiaries": "1",
    "description": "BTempDescGMIHSI",
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 28000
  Error Message: "Error in invoking create bulk payment template."
• Error Code: 28006
  Error Message: "Unable to store template at backend."
• Error Code: 28005
  Error Message: "Unauthorised user bulk payment template create."
• Error Code: 12000
  Error Message: "Internal server error."

Parameters

templateId (Mandatory)

Specifies the unique ID of the template that is to be deleted.

{
    "templateId": "071020210607047483"
}

Parameters

templateID

Specifies the unique ID of the template that has been deleted.

templateName

Specifies the name of the template that has been deleted.

{
    "templateId": "181020210951036523",
    "templateName": "Srip",
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 28013
  Error Message: "Bulkpayment template deletion failed."
• Error Code: 12025
  Error Message: "Missing template name."
• Error Code: 28012
  Error Message: "Unauthorised user bulkpayment template delete."

Parameters

sortByParam

Specifies the field in the response based on which the list of records must be sorted. By default, the list of records would be sorted based on the date on which the request was sent (sentDate).

sortOrder

Specifies the order in which the list of fetched records must be sorted, such as in ascending or descending (ASC/DESC) order. By default, the value is set to DESC for the date on which the request was sent (sentDate).

searchString

Specifies the free text that can be entered to search for a set of records that matches the text that is entered.

pageSize

Specifies the number of rows that must be returned in the result.

pageOffset

Specifies the row from which the data must be retrieved. The offset value is often used together with the limit.

filterByParam

Specifies the parameter based on which the fetched files must be filtered.

filterByValue

Specifies the value based on which the fetched files must be filtered.

timeParam

Specifies the uploaded date.

timeValue

Specifies the last number of periods (Days, Weeks, Months, Year).

{
    "searchString": "",
    "sortByParam": "",
    "sortOrder": "DESC",
    "pageSize": "",
    "pageOffset": "",
    "filterByParam": "",
    "filterByValue": "",
    "batchMode": "",
    "timeParam": "",
    "timeValue": ""
}

Parameters

bulkPaymentTemplates

Specifies an array of bulk payment templates and the corresponding details.

templateId

Specifies the unique ID of the template.

templateName

Specifies the name of the template.

processingMode

Specifies the processing mode for the template (Single/Multi)

description

Specifies the description of the bulk payment template.

featureActionId

Specifies the unique ID of the feature action.

paymentDate

Specifies the date of payment.

scheduledDate

Specifies the date scheduled for performing the bulk payment.

initiatedBy

Specifies the name of the person who initiated the bulk payment transfer.

companyId

Specifies the unique ID of the company.

roleId

Specifies the unique roleID of the company.

status

Specifies the type of status.

fromAccount

Specifies the account from which the payment is made.

totalAmount

Specifies the total payment amount.

currency

Specifies the currency medium

createdts

Specifies the date of creation of the template.

totalBeneficiaries

Specifies the total number of beneficiaries in the file.

{
    "bulkPaymentTemplates": [{
        "templateId": "041020211133027340",
        "templateName": "Test1",
        "processingMode": "SINGLE",
        "description": "Test1",
        "featureActionId": "BULK_PAYMENT_TEMPLATE_SINGLE_CREATE",
        "paymentDate": "2021-10-04T00:00:00Z",
        "scheduledDate": "2021-10-05T10:14:55Z",
        "initiatedBy": "3841020824",
        "companyId": "0924520779_800574",
        "roleId": "GROUP_ADMINISTRATOR",
        "status": "New",
        "fromAccount": "122629",
        "totalAmount": "2",
        "currency": "USD",
        "createdts": "2021-10-05T10:14:55Z",
        "totalBeneficiaries": "1"
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 28007
  Error Message: "Error in invoking fetch bulkpayment template."
• Error Code: 28008
  Error Message: "Unauthorised user bulkpayment template fetch."
• Error Code: 28009
  Error Message: "Bulk payments templates fetch error."
• Error Code: 00000
  Error Message: "Error occurred at backend."

Parameters

recordId (Mandatory)

Specifies the unique ID of the record.

requestId

Specifies the unique ID of the request.

{
    "recordId": "BKM2110500561",
    "requestId": ""
}

Parameters

fileId

Specifies the unique ID of the file that must be downloaded.

{
    "fileId": "cNjdG3oq-8UutS0dT-c5LbMaHD-5V9zl2mC",
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 21253
  Error Message: "Initiate Bulk payments download failed."
• Error Code: 21255
  Error Message: "Something went wrong while generating report."
• Error Code: 21255
  Error Message: "Bulk payments files generation failed."

Parameters

fileId (Mandatory)

Specifies the unique ID of the file that is to be downloaded.

{
    "fileId" : "IxwCiFzD-tJlbgXuL-Xlo4rvMX-Yd3z1zUf"
}

The response is a byte array that represents a bulk payment PDF file.

• Error Code: 21252
  Error Message:" Error occured while downloading the Bulk payment file."
• Error Code: 14017
  Error Message: "FileId is missing in the input. please provide valid FileId."

Parameters

templateId (Mandatory)

Specifies the unique ID of the template whose details are to be fetched.

{
    "templateId": "051020211022047530"
}

Parameters

paymentOrders

Specifies an array of payment orders associated with the template and the corresponding details.

paymentOrderId

Specifies the unique ID of the payment order.

templateId

Specifies the unique ID of the template.

confirmationNumber

Specifies the confirmation number generated after uploading the file.

recipientName

Specifies the name of the recipient.

accountNumber

Specifies the account number for performing the payment.

bankName

Specifies the name of the bank.

swift

Specifies the swift key.

featureActionId

Specifies the unique ID of the feature action.

companyId

Specifies the unique ID of the company.

roleID

Specifies the unique role ID.

status

Specifies the status of the template.

currency

Specifies the currency medium

amount

Specifies the amount that is to be transferred.

feesPaidBy

Specifies the fees paid by the user.

paymentReference

Specifies the reference number for the Payment Order Container.

beneficiaryName

Specifies the name of the beneficiary.

beneficiaryNickName

Specifies the nick name of the beneficiary.

beneficiaryAddress

Specifies the address of the beneficiary.

paymentMethod

Specifies the method of payment opted by the user such as Single Euro Payments Area (SEPA), Internal or so on.

accType

Specifies the type of account such as Savings, Checking, and so on.

beneficiaryType

Specifies the type of Beneficiary.

addToExistingFlag

Specifies if the file to be added. This is a Boolean Flag.

{
    "paymentOrders": [{
        "paymentOrderId": "1445630911",
        "templateId": "041020211133027340",
        "confirmationNumber": "041020211133027340",
        "recipientName": "SreerupaD",
        "accountNumber": "GB88DEMO60161300100137",
        "bankName": "DEMO BIC FOR MODEL BANK",
        "swift": "DEMOGBPX",
        "featureActionId": "BULK_PAYMENT_TEMPLATE_SINGLE_CREATE",
        "companyId": "0924520779_800574",
        "roleId": "GROUP_ADMINISTRATOR",
        "status": "New",
        "currency": "USD",
        "amount": "2.0",
        "feesPaidBy": "Shared",
        "paymentReference": "Test",
        "beneficiaryIBAN": "null",
        "beneficiaryName": "SreerupaD",
        "beneficiaryNickName": "SreerupaD",
        "beneficiaryAddress": "-",
        "paymentMethod": "SreerupaD",
        "accType": "Domestic",
        "beneficiaryType": "MANUALLYADDED",
        "addToExistingFlag": "0"
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 28016
  Error Message: "Invalid template id."
• Error Code: 28019
  Error Message: "Error in invoking fetch template POs by id."
• Error Code: 12001
  Error Message: "Logged in user is not authorized to perform this action."

Parameters

templateName (Mandatory)

Specifies the name of the template.

templateId (Mandatory)

Specifies the unique ID of the template.

description (Mandatory)

Specifies the description of the template.

fromAccount (Mandatory)

Specifies the account number from which bulk payment is to be initiated.

currency (Mandatory)

Specifies the currency medium for performing the bulk payment.

paymentDate (Mandatory)

Specifies the date for the bulk payment.

processingMode (Mandatory)

Specifies the type of processing used during the payment transaction. <Provide more information>

beneficiaryName(Mandatory)

Specifies the name of the beneficiary.

recipientName(Mandatory)

Specifies the name of the recipient

paymentMethod(Mandatory)

Specifies the method of payment opted by the user such as Single Euro Payments Area (SEPA), Internal or so on.

currency(Mandatory)

Specifies the currency medium for performing the bulk payment.

feesPaidBy(Mandatory)

Specifies the fees paid by the user.

paymentReference(Mandatory)

Specifies the reference number for the Payment Order Container.

accountNumber(Mandatory)

Specifies the account number for performing the payment.

accType(Mandatory)

Specifies the type of account such as Savings, Checking, and so on.

beneficiaryType(Mandatory)

Specifies the type of beneficiary.

beneficiaryNickName(Mandatory)

Specifies the nick name of beneficiary.

addToExistingFlag(Mandatory)

Specifies if the file to be added. This is a Boolean Flag.

bankName(Mandatory)

Specifies the name of Bank.

{
    "templateName": "TestTemplate1",
    "templateId": "111020211050042317",
    "description": "TestTemplate2",
    "fromAccount": "122629",
    "currency": "USD",
    "paymentDate": "4/15/2021",
    "processingMode": "SINGLE",
    "POs": "[{\"beneficiaryName\":\"TESTING\",\"recipientName\":\"TESTING\",\"paymentMethod\":\"TESTING\",\"currency\":\"USD\",\"amount\":\"2.0\",\"feesPaidBy\":\"-\",\"paymentReference\":\"Test\",\"accountNumber\":\"122629\",\"accType\":\"Internal\",\"swift\":\"\",\"beneficiaryType\":\"MANUALLYADDED\",\"beneficiaryNickName\":\"TESTING\",\"beneficiaryAddress\":\"-\",\"addToExistingFlag\":\"0\",\"bankName\":\"Infinity\"}]"
}

Parameters

templateID

Specifies the unique ID of the template.

{

"templateId":"051020211022047530",

"opstatus":0,

"httpStatusCode":0

}

• Error Code: 28013
  Error Message: "Bulk payment template deletion failed."
• Error Code: 12037
  Error Message: "Missing template id."
• Error Code: 28006
  Error Message: "Unable to store template at backend."
• Error Code: 28011
  Error Message: "Bulk payment template edit failed."
• Error Code: 28026
  Error Message: "CIF validation."
• Error Code: 28006
  Error Message: "Unable to store template at backend."
• Error Code: 28011
  Error Message: "BulkPayment Template edit failed."

Parameters

templateId (Mandatory)

Specifies the unique ID of the template.

paymentOrderId (Mandatory)

Specifies an array of Payment Order container and the corresponding details.

currency (Mandatory)

Specifies the unique name of currency.

amount (Mandatory)

Specifies the amount to be transfered.

feesPaidBy (Mandatory)

Specifies the fees paid by the user.

paymentReference (Mandatory)

Specifies the reference number for the Payment Order Container.

executionDate (Mandatory)

Specifies the execution date for bulk payment.

{
    "templateId": "111020211112021650",
    "executionDate": "2022-04-21",
    "POs": "[{"
    paymentOrderId ":"
    1043181207 ","
    currency ":"
    USD ","
    amount ":"
    1.0 ","
    feesPaidBy ":" - ","
    paymentReference ":"
    test "}]"
}

Parameters

confirmationNumber

Specifies the confirmation number generated after uploading the file.

{
    "confirmationNumber": "UPLD2110531264",
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 28000
  Error Message: "Error in invoking create bulk payment template."
• Error Code: 28016
  Error Message: "Invalid templateId."
• Error Code: 12028
  Error Message: "Missing records."
• Error Code: 28021
  Error Message: "Error in parsing input records."
• Error Code: 28020
  Error Message: "Unauthorised user bulk request create."
• Error Code: 21204
  Error Message: "Empty bulk payments file."
• Error Code: 21200
  Error Message: "Bulk payments file parse error."
• Error Code: 28017
  Error Message: "Error in creating records."
• Error Code: 12003
  Error Message: "No matching records found."
• Error Code: 21200
  Error Message: "Bulk payments file parse error."
• Error Code: 12000
  Error Message: "Internal server error."

Parameters

templateId (Mandatory)

Specifies the unique ID of the template whose details are to be fetched.

{
    "templateId": ""
}

Parameters

templateName

Specifies the name of the template.

processingMode

Specifies whether the processing mode is Single or Multi.

description

Specifies the description of payment transaction.

featureActionId

Specifies the unique ID of the feature action.

paymentDate

Specifies the date of payment.

scheduledDate

Specifies the scheduled date for payment.

initiatedBy

Specifies the name of the user who initiated the

companyId

Specifies the unique ID of the company.

roleID

Specifies the unique role ID.

status

Specifies the status of the template.

fromAccount

Specifies the account from which the payment gets initiated.

totalAmount

Specifies the total amount in the Bulk Payment.

currency

Specifies the currency medium.

createdts

Specifies the date and time for the creation of the template.

totalBeneficiaries

Specifies the total beneficiaries in the file.

{
    "templateName": "BTempNtmeUII",
    "processingMode": "SINGLE",
    "description": "BTempDescGMIHSI",
    "featureActionId": "BULK_PAYMENT_TEMPLATE_SINGLE_CREATE",
    "paymentDate": "2021-10-11T00:00:00Z",
    "scheduledDate": "2021-10-20T06:31:37Z",
    "initiatedBy": "1370125039",
    "companyId": "5997524134_801142",
    "roleId": "GROUP_ADMINISTRATOR",
    "status": "New",
    "fromAccount": "125679",
    "totalAmount": "10",
    "currency": "USD",
    "createdts": "2021-10-20T06:31:37Z",
    "totalBeneficiaries": "1",
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 12001
  Error Message: "Logged in user is not authorized to perform this action."
• Error Code: 28016
  Error Message: "Invalid templateId."
• Error Code: 28018
  Error Message: "Error in invoking fetch bulk payment template by id."

None

Parameters

cancellationreasons

Specifies the reasons for cancellation.

{
    "cancellationreasons": [{
        "id": "00",
        "reason": "CREDIT EXECUTED"
    }, {
        "id": "01",
        "reason": "SELLER'S CBU DOES NOT EXIST"
    }, {
        "id": "02",
        "reason": "BUYER'S CBU DOES NOT EXIST"
    }, {
        "id": "03",
        "reason": "AMOUNT EXCEEDS MAX/MIN ALLOWED VAL"
    }, {
        "id": "04",
        "reason": "BUYER NOT ADHERED"
    }, {
        "id": "05",
        "reason": "SELLER NOT ADHERED"
    }, {
        "id": "06",
        "reason": "SELLER'S CURRENCY DIFFERENT FROM RE"
    }, {
        "id": "08",
        "reason": "ERROR TYPE OF ACCOUNT OF THE BUYER"
    }, {
        "id": "09",
        "reason": "SELLER'S CUIT WRONG FORMULATED"
    }, {
        "id": "10",
        "reason": "BUYER'S CUIT WRONG FORMULATED"
    }, {
        "id": "11",
        "reason": "NONEXISTENT CURRENCY"
    }, {
        "id": "1100",
        "reason": "For business reasons only"
    }, {
        "id": "12",
        "reason": "INVALID DESCRIPTION"
    }, {
        "id": "13",
        "reason": "THE BANKS DO NOT COINCIDE"
    }, {
        "id": "14",
        "reason": "IDENTICAL ORIGIN AND DESTINATION"
    }, {
        "id": "15",
        "reason": "CREDIT BANK INACTIVE"
    }, {
        "id": "16",
        "reason": "DEBIT BANK INACTIVE"
    }, {
        "id": "17",
        "reason": "INV CONCEPT(NON-EXIS NOMENCLATURE)"
    }, {
        "id": "18",
        "reason": "VALID GENERAL ERROR"
    }, {
        "id": "19",
        "reason": "PERSISTED"
    }, {
        "id": "20",
        "reason": "Insufficient Funds"
    }, {
        "id": "21",
        "reason": "WRONG FORMULATED DATA SELLER"
    }, {
        "id": "22",
        "reason": "WRONG FORMULATED DATA BUYER"
    }, {
        "id": "23",
        "reason": "SELLER'S CBU WRONG FORMULATED"
    }, {
        "id": "24",
        "reason": "BUYER'S CBU WRONG FORMULATED"
    }, {
        "id": "25",
        "reason": "CUIT doesn't match"
    }, {
        "id": "27",
        "reason": "Invalid Currency"
    }, {
        "id": "30",
        "reason": "Account identifier incorrect"
    }, {
        "id": "31",
        "reason": "Debit bank has not enough guarantee"
    }, {
        "id": "33",
        "reason": "NONEXISTENT ACCOUNT"
    }, {
        "id": "34",
        "reason": "ACCOUNT NOT ENABLED"
    }, {
        "id": "35",
        "reason": "Blocked Account"
    }, {
        "id": "36",
        "reason": "INSUFFICIENT GUARANTEES"
    }, {
        "id": "37",
        "reason": "ERROR CREDIT BANK - INCORRECT DATA"
    }, {
        "id": "38",
        "reason": "ERROR CREDIT BANK-NONEXISTENT ACCT"
    }, {
        "id": "39",
        "reason": "ERROR CREDIT BANK-ACCT NOT ENABLED"
    }, {
        "id": "40",
        "reason": "File received after Cut-off Time"
    }, {
        "id": "41",
        "reason": "CREDIT SHIPPING ERROR"
    }, {
        "id": "45",
        "reason": "Payment breached Risk Filtering"
    }, {
        "id": "46",
        "reason": "Expired DEBIN"
    }, {
        "id": "80",
        "reason": "Bank access token not allowed"
    }, {
        "id": "83",
        "reason": "DEBIN does not exist"
    }, {
        "id": "87",
        "reason": "DEBINstatus modificationnot allowed"
    }, {
        "id": "99",
        "reason": "ERROR TYPE OF ACCOUNT OF THE SELLER"
    }, {
        "id": "AB05",
        "reason": "Transaction stopped due to timeout"
    }, {
        "id": "AC01",
        "reason": "Incorrect Account Number"
    }, {
        "id": "AC03",
        "reason": "Cdtr Account num invalid or missing"
    }, {
        "id": "AC04",
        "reason": "Closed Account Number"
    }, {
        "id": "AC06",
        "reason": "Blocked Account"
    }, {
        "id": "AC09",
        "reason": "Invalid Account Currency"
    }, {
        "id": "AG01",
        "reason": "Transaction Forbidden"
    }, {
        "id": "AG02",
        "reason": "Invalid Bank Operation Code"
    }, {
        "id": "AG04",
        "reason": "Invalid Agent Country"
    }, {
        "id": "AG05",
        "reason": "Invalid Debtor Agent Country"
    }, {
        "id": "AG06",
        "reason": "Invalid Creditor Agent Country"
    }, {
        "id": "AG07",
        "reason": "Unsuccesful Direct Debit"
    }, {
        "id": "AG08",
        "reason": "Invalid Access Rights"
    }, {
        "id": "AG09",
        "reason": "Payment Not Received"
    }, {
        "id": "AG10",
        "reason": "Agent Suspended"
    }, {
        "id": "AM01",
        "reason": "Specified message amount is zero"
    }, {
        "id": "AM02",
        "reason": "Not Allowed Amount"
    }, {
        "id": "AM04",
        "reason": "Insufficient Funds"
    }, {
        "id": "AM05",
        "reason": "Duplication"
    }, {
        "id": "AM12",
        "reason": "Amount is invalid"
    }, {
        "id": "BE01",
        "reason": "Inconsisten With End Customer"
    }, {
        "id": "BE04",
        "reason": "Missing Creditor Address"
    }, {
        "id": "BE05",
        "reason": "Unrecognised Initiating Party"
    }, {
        "id": "BE07",
        "reason": "Debtor Address is missing"
    }, {
        "id": "BE22",
        "reason": "Creditor Name is missing"
    }, {
        "id": "CNOR",
        "reason": "Creditor bank is not registered"
    }, {
        "id": "DNOR",
        "reason": "Debtor bank is not registered"
    }, {
        "id": "DS02",
        "reason": "Order Cancelled"
    }, {
        "id": "DS04",
        "reason": "Order Rejected"
    }, {
        "id": "DU03",
        "reason": "Duplicate Transaction"
    }, {
        "id": "DUPL",
        "reason": "Duplicate Payment"
    }, {
        "id": "FF01",
        "reason": "Invalid File Format"
    }, {
        "id": "MD01",
        "reason": "No Mandate"
    }, {
        "id": "MD02",
        "reason": "Missing Mandatory InformationIn Man"
    }, {
        "id": "MD07",
        "reason": "End Customer Deceased"
    }, {
        "id": "MS03",
        "reason": "Not Specified Reason Agent Generate"
    }, {
        "id": "NARR",
        "reason": "Narrative"
    }, {
        "id": "RC01",
        "reason": "Bank Identifier Incorrect"
    }, {
        "id": "RC02",
        "reason": "Invalid Bank Identifier"
    }, {
        "id": "RC05",
        "reason": "Invalid BIC Identifier"
    }, {
        "id": "RF01",
        "reason": "Not Unique Transaction Reference"
    }, {
        "id": "RR01",
        "reason": "Missing Debtor Account or Identific"
    }, {
        "id": "RR02",
        "reason": "Missing Debtor Name or Address"
    }, {
        "id": "RR03",
        "reason": "Missing Creditor Name or Address"
    }, {
        "id": "RR04",
        "reason": "Regulatory Reason"
    }, {
        "id": "TM01",
        "reason": "Cut Off Time"
    }, {
        "id": "XD19",
        "reason": "Invalid IBAN"
    }, {
        "id": "07",
        "reason": "SELLER'S/BUYER'S CURRENCY DIFFERENT"
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 12000
  Error Message: "Internal server error."
• Error Code: 21218
  Error Message: "Fetch sample files failed error."

{base_url}/api/v1.0.0/reference/lookups

Parameters

recordId(Mandatory)

Specifies the unique record ID.

{
    "recordId": "BKM2110500006"
}

Parameters

recordId

Specifies the unique record ID.

description

Specifies the description of the file.

paymentDate

Specifies the date of payment.

scheduledDate

Specifies the date on when the scheduled transfer payment must occur.

status

Specifies the of the record.

fromAccount

Specifies the account from which the payment gets initiated.

totalAmount

Specifies the total payment amount.

totalTransactions

Specifies the total number of transactions made through the template.

fileName

Specifies the name of the file.

bulkErrorDetails

Specifies the error details.

currency

Specifies the currency medium.

batchMode

{
    "recordId": "BKM2110500143",
    "description": "NewCSVupldSing",
    "paymentDate": "2021-10-05T00:00:00Z",
    "scheduledDate": "2021-10-05T00:00:00Z",
    "status": "CREATED",
    "fromAccount": "122629",
    "totalAmount": "9",
    "totalTransactions": "1",
    "fileName": "EurMULTINewformatRT.csv",
    "bulkErrorDetails": [],
    "currency": "USD",
    "batchMode": "MULTI",
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 12000
  Error Message: "Internal server error."
• Error Code: 12001
  Error Message: "Logged in user is not authorized to perform this action."
• Error Code: 00000
  Error Message: "Error occurred at backend."
• Error Code: 21223
  Error Message: "Failed to fetch ongoing payments."

{base_url}/api/v2.0.0/order/bulkPayments/{bulkTransferId}