{
"info": {
"_postman_id": "7b6cddce-fe4c-4009-b718-fd830835db24",
"name": "Contracts Plus For Banks",
"description": "### Contracts Plus Data Inquiry Service is an API that enables you to integrate and obtain existing and historical contract data related to Government Tenders and Procurements. The API service allows the beneficiaries to inquire via Commercial Registry No. (CR) without the contract number. The API includes basic contract and beneficiary data. \n\n#### To see the error messages and the valid response :\n | Response Status Code | Contract Number | Id Type | Id Value | Sort By |\n | ---------------------| ----------------| --------|---------------|---------------|\n | **200** | 191201000575 | 01 |2251037375 |\n | **200** | 451103007412 | 01 |2251037375 |\n | **200** | 191201000575 | 01 |1010574839 |\n | **200** | 191201000575 | 03 |7033322222 |\n | **200** | 191201000575 | 01 |1010574839 | amount\n \n
More information about authorization can be found in the Token API integration guide:'\n",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "25675706"
},
"item": [
{
"name": "sandbox",
"item": [
{
"name": "banking",
"item": [
{
"name": "v1",
"item": [
{
"name": "contracts",
"item": [
{
"name": "/sandbox/banking/v1/contracts",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "accessTokenUrl",
"value": "{{baseUrl}}/sandbox/oauth/v2/accesstoken",
"type": "string"
},
{
"key": "scope",
"value": "ReadBanksContracts",
"type": "string"
},
{
"key": "grant_type",
"value": "client_credentials",
"type": "string"
},
{
"key": "clientId",
"value": "{{clientID}}",
"type": "string"
},
{
"key": "clientSecret",
"value": "{{clientSecret}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "X_MOF_RqUID",
"value": "{{$guid}}",
"description": "Request UID, it is unique reference, GUID format"
},
{
"key": "X_MOF_ClientID",
"value": "{{clientID}}",
"description": "Client Id of Banks or fintech companies"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/sandbox/banking/v1/contracts?contractNumber=191201000575&idType=01&idValue=2251037375&sortBy=contractStartDate&sortOrder=DESC&limit=10&offset=2",
"host": [
"{{baseUrl}}"
],
"path": [
"sandbox",
"banking",
"v1",
"contracts"
],
"query": [
{
"key": "contractNumber",
"value": "191201000575",
"description": "Contract Number"
},
{
"key": "idType",
"value": "01",
"description": "Vendor identification type and allowed values are: 01 means the value of idValue parameter is *CR* of vendor, 02 means *beneficiaryId*, and 03 means *700Id*\n"
},
{
"key": "idValue",
"value": "2251037375",
"description": "Vendor identification value of selected Id type"
},
{
"key": "sortBy",
"value": "contractStartDate",
"description": "Sort by amount or contractStartDate or contractEndDate
\n"
},
{
"key": "sortOrder",
"value": "DESC",
"description": "Sorting order"
},
{
"key": "limit",
"value": "10",
"description": "Total number of contracts for each page"
},
{
"key": "offset",
"value": "2",
"description": "Page number"
}
]
}
},
"response": [
{
"name": "Ok",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "X_MOF_RqUID",
"value": "{{$guid}}",
"description": "Request UID, it is unique reference, GUID format"
},
{
"key": "X_MOF_ClientID",
"value": "{{clientID}}",
"description": "Client Id of Banks or fintech companies"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "",
"description": "Added as a part of security scheme: oauth2"
}
],
"url": {
"raw": "{{baseUrl}}/sandbox/banking/v1/contracts?contractNumber=191201000575&idType=01&idValue=2251037375&sortBy=contractStartDate&sortOrder=DESC&limit=10&offset=2",
"host": [
"{{baseUrl}}"
],
"path": [
"sandbox",
"banking",
"v1",
"contracts"
],
"query": [
{
"key": "contractNumber",
"value": "191201000575",
"description": "Contract Number"
},
{
"key": "idType",
"value": "01",
"description": "Vendor identification type and allowed values are: 01 means the value of idValue parameter is *CR* of vendor, 02 means *beneficiaryId*, and 03 means *700Id*\n"
},
{
"key": "idValue",
"value": "2251037375",
"description": "Vendor identification value of selected Id type"
},
{
"key": "sortBy",
"value": "contractStartDate",
"description": "Sort by amount or contractStartDate or contractEndDate
\n"
},
{
"key": "sortOrder",
"value": "DESC",
"description": "Sorting order"
},
{
"key": "limit",
"value": "10",
"description": "Total number of contracts for each page"
},
{
"key": "offset",
"value": "2",
"description": "Page number"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"meta\": {\n \"totalRecords\": 12,\n \"limit\": 1,\n \"offset\": 2,\n \"next\": \"/banking/v1/contracts?offset=3&limit=1\",\n \"previous\": \"/banking/v1/contracts?offset=1&limit=1\"\n },\n \"data\": [\n {\n \"name\": \"Test for Bank\",\n \"referenceNumber\": \"123456789123\",\n \"govAgency\": {\n \"agencyName\": \" مدينة الملك فهد الطبية\",\n \"agencyCode\": \"022001000003\"\n },\n \"amount\": 3029.6201391288923,\n \"vendors\": [\n {\n \"name\": \"Test for company\",\n \"CRNumber\": \"1213213213\",\n \"isMainVendor\": false\n },\n {\n \"name\": \"Test for company\",\n \"CRNumber\": \"1213213213\",\n \"isMainVendor\": false\n }\n ],\n \"totalReleasedAmount\": 5113.634446386661,\n \"duration\": {\n \"startDate\": \"2021-07-14\",\n \"endDate\": \"2022-07-14\"\n },\n \"financialClaims\": [\n {\n \"referenceNumber\": \"111111111111\",\n \"amount\": 193.6308626036909,\n \"status\": \"تحت الاجراء\"\n },\n {\n \"referenceNumber\": \"111111111111\",\n \"amount\": 4977.987540831372,\n \"status\": \"معتمد\"\n }\n ],\n \"paymentOrders\": {\n \"bankName\": \"مصرف الراجحى\",\n \"accountNumber\": \"SA9080000621608010080389\",\n \"paymentOrderDate\": \"2022-12-01\"\n }\n },\n {\n \"name\": \"Test for Bank\",\n \"referenceNumber\": \"123456789123\",\n \"govAgency\": {\n \"agencyName\": \" مدينة الملك فهد الطبية\",\n \"agencyCode\": \"022001000003\"\n },\n \"amount\": 8655.630835801614,\n \"vendors\": [\n {\n \"name\": \"Test for company\",\n \"CRNumber\": \"1213213213\",\n \"isMainVendor\": true\n },\n {\n \"name\": \"Test for company\",\n \"CRNumber\": \"1213213213\",\n \"isMainVendor\": true\n }\n ],\n \"totalReleasedAmount\": 804.8322159537136,\n \"duration\": {\n \"startDate\": \"2021-07-14\",\n \"endDate\": \"2022-07-14\"\n },\n \"financialClaims\": [\n {\n \"referenceNumber\": \"111111111111\",\n \"amount\": 4263.377792331969,\n \"status\": \"ملغي\"\n },\n {\n \"referenceNumber\": \"111111111111\",\n \"amount\": 3888.062093670095,\n \"status\": \"معتمد\"\n }\n ],\n \"paymentOrders\": {\n \"bankName\": \"مصرف الراجحى\",\n \"accountNumber\": \"SA9080000621608010080389\",\n \"paymentOrderDate\": \"2022-12-01\"\n }\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "X_MOF_RqUID",
"value": "{{$guid}}",
"description": "Request UID, it is unique reference, GUID format"
},
{
"key": "X_MOF_ClientID",
"value": "{{clientID}}",
"description": "Client Id of Banks or fintech companies"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "",
"description": "Added as a part of security scheme: oauth2"
}
],
"url": {
"raw": "{{baseUrl}}/sandbox/banking/v1/contracts?contractNumber=191201000575&idType=01&idValue=2251037375&sortBy=contractStartDate&sortOrder=DESC&limit=10&offset=2",
"host": [
"{{baseUrl}}"
],
"path": [
"sandbox",
"banking",
"v1",
"contracts"
],
"query": [
{
"key": "contractNumber",
"value": "191201000575",
"description": "Contract Number"
},
{
"key": "idType",
"value": "01",
"description": "Vendor identification type and allowed values are: 01 means the value of idValue parameter is *CR* of vendor, 02 means *beneficiaryId*, and 03 means *700Id*\n"
},
{
"key": "idValue",
"value": "2251037375",
"description": "Vendor identification value of selected Id type"
},
{
"key": "sortBy",
"value": "contractStartDate",
"description": "Sort by amount or contractStartDate or contractEndDate
\n"
},
{
"key": "sortOrder",
"value": "DESC",
"description": "Sorting order"
},
{
"key": "limit",
"value": "10",
"description": "Total number of contracts for each page"
},
{
"key": "offset",
"value": "2",
"description": "Page number"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"code\": \"A001400,\",\n \"details\": \"Some Required Fields are not founded in your request, Please return to documentation,\",\n \"type\": \"BusinessError,\",\n \"link\": null,\n \"in\": [\n {\n \"name\": \"idValue\",\n \"type\": \"query\"\n }\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "X_MOF_RqUID",
"value": "{{$guid}}",
"description": "Request UID, it is unique reference, GUID format"
},
{
"key": "X_MOF_ClientID",
"value": "{{clientID}}",
"description": "Client Id of Banks or fintech companies"
},
{
"key": "Authorization",
"value": "",
"description": "Added as a part of security scheme: oauth2"
}
],
"url": {
"raw": "{{baseUrl}}/sandbox/banking/v1/contracts?contractNumber=191201000575&idType=01&idValue=2251037375&sortBy=contractStartDate&sortOrder=DESC&limit=10&offset=2",
"host": [
"{{baseUrl}}"
],
"path": [
"sandbox",
"banking",
"v1",
"contracts"
],
"query": [
{
"key": "contractNumber",
"value": "191201000575",
"description": "Contract Number"
},
{
"key": "idType",
"value": "01",
"description": "Vendor identification type and allowed values are: 01 means the value of idValue parameter is *CR* of vendor, 02 means *beneficiaryId*, and 03 means *700Id*\n"
},
{
"key": "idValue",
"value": "2251037375",
"description": "Vendor identification value of selected Id type"
},
{
"key": "sortBy",
"value": "contractStartDate",
"description": "Sort by amount or contractStartDate or contractEndDate
\n"
},
{
"key": "sortOrder",
"value": "DESC",
"description": "Sorting order"
},
{
"key": "limit",
"value": "10",
"description": "Total number of contracts for each page"
},
{
"key": "offset",
"value": "2",
"description": "Page number"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "X_MOF_RqUID",
"value": "{{$guid}}",
"description": "Request UID, it is unique reference, GUID format"
},
{
"key": "X_MOF_ClientID",
"value": "{{clientID}}",
"description": "Client Id of Banks or fintech companies"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "",
"description": "Added as a part of security scheme: oauth2"
}
],
"url": {
"raw": "{{baseUrl}}/sandbox/banking/v1/contracts?contractNumber=191201000575&idType=01&idValue=2251037375&sortBy=contractStartDate&sortOrder=DESC&limit=10&offset=2",
"host": [
"{{baseUrl}}"
],
"path": [
"sandbox",
"banking",
"v1",
"contracts"
],
"query": [
{
"key": "contractNumber",
"value": "191201000575",
"description": "Contract Number"
},
{
"key": "idType",
"value": "01",
"description": "Vendor identification type and allowed values are: 01 means the value of idValue parameter is *CR* of vendor, 02 means *beneficiaryId*, and 03 means *700Id*\n"
},
{
"key": "idValue",
"value": "2251037375",
"description": "Vendor identification value of selected Id type"
},
{
"key": "sortBy",
"value": "contractStartDate",
"description": "Sort by amount or contractStartDate or contractEndDate
\n"
},
{
"key": "sortOrder",
"value": "DESC",
"description": "Sorting order"
},
{
"key": "limit",
"value": "10",
"description": "Total number of contracts for each page"
},
{
"key": "offset",
"value": "2",
"description": "Page number"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"code\": \"A001403\",\n \"details\": \"Error Message Detail\",\n \"type\": \"BusinessError\",\n \"link\": \"cNfdnoNrd.yng\"\n },\n {\n \"code\": \"A001403\",\n \"details\": \"Error Message Detail\",\n \"type\": \"BusinessError\",\n \"link\": \"sAUERq.xbv\"\n }\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "X_MOF_RqUID",
"value": "{{$guid}}",
"description": "Request UID, it is unique reference, GUID format"
},
{
"key": "X_MOF_ClientID",
"value": "{{clientID}}",
"description": "Client Id of Banks or fintech companies"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "",
"description": "Added as a part of security scheme: oauth2"
}
],
"url": {
"raw": "{{baseUrl}}/sandbox/banking/v1/contracts?contractNumber=191201000575&idType=01&idValue=2251037375&sortBy=contractStartDate&sortOrder=DESC&limit=10&offset=2",
"host": [
"{{baseUrl}}"
],
"path": [
"sandbox",
"banking",
"v1",
"contracts"
],
"query": [
{
"key": "contractNumber",
"value": "191201000575",
"description": "Contract Number"
},
{
"key": "idType",
"value": "01",
"description": "Vendor identification type and allowed values are: 01 means the value of idValue parameter is *CR* of vendor, 02 means *beneficiaryId*, and 03 means *700Id*\n"
},
{
"key": "idValue",
"value": "2251037375",
"description": "Vendor identification value of selected Id type"
},
{
"key": "sortBy",
"value": "contractStartDate",
"description": "Sort by amount or contractStartDate or contractEndDate
\n"
},
{
"key": "sortOrder",
"value": "DESC",
"description": "Sorting order"
},
{
"key": "limit",
"value": "10",
"description": "Total number of contracts for each page"
},
{
"key": "offset",
"value": "2",
"description": "Page number"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"code\": \"A001404\",\n \"details\": \"contract not found\",\n \"type\": \"BusinessError\",\n \"link\": \"UzFVn.bgzv\"\n },\n {\n \"code\": \"A001404\",\n \"details\": \"contract not found\",\n \"type\": \"BusinessError\",\n \"link\": \"gXXazNIDLFeV.mv\"\n }\n ]\n}"
},
{
"name": "Backend Timeout",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "X_MOF_RqUID",
"value": "{{$guid}}",
"description": "Request UID, it is unique reference, GUID format"
},
{
"key": "X_MOF_ClientID",
"value": "{{clientID}}",
"description": "Client Id of Banks or fintech companies"
},
{
"key": "Authorization",
"value": "",
"description": "Added as a part of security scheme: oauth2"
}
],
"url": {
"raw": "{{baseUrl}}/sandbox/banking/v1/contracts?contractNumber=191201000575&idType=01&idValue=2251037375&sortBy=contractStartDate&sortOrder=DESC&limit=10&offset=2",
"host": [
"{{baseUrl}}"
],
"path": [
"sandbox",
"banking",
"v1",
"contracts"
],
"query": [
{
"key": "contractNumber",
"value": "191201000575",
"description": "Contract Number"
},
{
"key": "idType",
"value": "01",
"description": "Vendor identification type and allowed values are: 01 means the value of idValue parameter is *CR* of vendor, 02 means *beneficiaryId*, and 03 means *700Id*\n"
},
{
"key": "idValue",
"value": "2251037375",
"description": "Vendor identification value of selected Id type"
},
{
"key": "sortBy",
"value": "contractStartDate",
"description": "Sort by amount or contractStartDate or contractEndDate
\n"
},
{
"key": "sortOrder",
"value": "DESC",
"description": "Sorting order"
},
{
"key": "limit",
"value": "10",
"description": "Total number of contracts for each page"
},
{
"key": "offset",
"value": "2",
"description": "Page number"
}
]
}
},
"status": "Request Timeout",
"code": 408,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Internal Server Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "X_MOF_RqUID",
"value": "{{$guid}}",
"description": "Request UID, it is unique reference, GUID format"
},
{
"key": "X_MOF_ClientID",
"value": "{{clientID}}",
"description": "Client Id of Banks or fintech companies"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "",
"description": "Added as a part of security scheme: oauth2"
}
],
"url": {
"raw": "{{baseUrl}}/sandbox/banking/v1/contracts?contractNumber=191201000575&idType=01&idValue=2251037375&sortBy=contractStartDate&sortOrder=DESC&limit=10&offset=2",
"host": [
"{{baseUrl}}"
],
"path": [
"sandbox",
"banking",
"v1",
"contracts"
],
"query": [
{
"key": "contractNumber",
"value": "191201000575",
"description": "Contract Number"
},
{
"key": "idType",
"value": "01",
"description": "Vendor identification type and allowed values are: 01 means the value of idValue parameter is *CR* of vendor, 02 means *beneficiaryId*, and 03 means *700Id*\n"
},
{
"key": "idValue",
"value": "2251037375",
"description": "Vendor identification value of selected Id type"
},
{
"key": "sortBy",
"value": "contractStartDate",
"description": "Sort by amount or contractStartDate or contractEndDate
\n"
},
{
"key": "sortOrder",
"value": "DESC",
"description": "Sorting order"
},
{
"key": "limit",
"value": "10",
"description": "Total number of contracts for each page"
},
{
"key": "offset",
"value": "2",
"description": "Page number"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"code\": \"A001500\",\n \"details\": \"Internal Server Error\",\n \"type\": \"BusinessError\",\n \"link\": \"Iy.fz\"\n },\n {\n \"code\": \"A001500\",\n \"details\": \"Internal Server Error\",\n \"type\": \"BusinessError\",\n \"link\": \"rOAJDLv.wy\"\n }\n ]\n}"
}
]
}
]
}
]
}
]
}
]
}
],
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "scope",
"value": "ReadBanksContracts",
"type": "string"
},
{
"key": "accessTokenUrl",
"value": "{{baseUrl}}/sandbox/oauth/v2/accesstoken",
"type": "string"
},
{
"key": "X_MOF_ClientID",
"value": "{{clientID}}",
"type": "string"
},
{
"key": "grant_type",
"value": "client_credentials",
"type": "string"
}
]
},
"variable": [
{
"key": "baseUrl",
"value": "https://10.13.85.56:9443"
},
{
"key": "clientID",
"value": "Mh259dl9GnVbdLkxecmXVKLjyNTz5Gpi"
},
{
"key": "clientSecret",
"value": "8oTkQv6nqoc9bt3B"
}
]
}