{ "info": { "_postman_id": "9ffe9a8c-3d05-47d1-b714-eeb6378a29db", "name": "Banks Contract", "description": "\n### This API is used by financial sectors (Bank, Fintech…etc.) to inquire certain details about vendors’ contracts with governmental agencies.\n\n\n#### To see the error messages and the valid response :\n | Response Status Code | Contract Number | Id Type | Id Value |\n | ---------------------| ----------------| --------|---------------|\n | **200** | 123456789123 | 01 |2000000002 |\n | **404** | 123456789113 | 01 |1000000001 |\n | **500** | 123456789000 | 01 |4000000004 |\n\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": "47100298", "_collection_link": "https://rehamalmutiri-4180031.postman.co/workspace/15944b1e-b16d-4441-8b30-4304c956348c/collection/47100298-9ffe9a8c-3d05-47d1-b714-eeb6378a29db?action=share&source=collection_link&creator=47100298" }, "item": [ { "name": "sandbox", "item": [ { "name": "banks", "item": [ { "name": "v2", "item": [ { "name": "contracts", "item": [ { "name": "{contractNumber}", "item": [ { "name": "/sandbox/banks/v2/contracts/:contractNumber", "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "clientSecret", "value": "{{clientSecret}}", "type": "string" }, { "key": "clientId", "value": "{{clientID}}", "type": "string" }, { "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" } ] }, "method": "GET", "header": [ { "key": "X_MOF_RqUID", "value": "{{$guid}}", "description": "(Required) Request UID, it is unique reference, GUID format" }, { "key": "X_MOF_ClientID", "value": "{{clientID}}", "description": "(Required) client Id of Banks or fintech companies" }, { "key": "X_EXT_UserName", "value": "%D8%AE%D8%A7%D9%84%D8%AF", "description": "(Required) Representative of user who made a query" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sandbox/banks/v2/contracts/:contractNumber?idType=01&idValue=2000000002", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "banks", "v2", "contracts", ":contractNumber" ], "query": [ { "key": "idType", "value": "01", "description": "(Required) Vendor Identification Type and allowed values are: \"01\" means the value of idValue parameter is CR of vendor" }, { "key": "idValue", "value": "2000000002", "description": "(Required) Vendor Identification Value of selected Id type" } ], "variable": [ { "key": "contractNumber", "value": "123456789123", "description": "(Required) contract Number, it is unique" } ] } }, "response": [ { "name": "Ok", "originalRequest": { "method": "GET", "header": [ { "key": "X_MOF_RqUID", "value": "{{$guid}}", "description": "(Required) Request UID, it is unique reference, GUID format" }, { "key": "X_MOF_ClientID", "value": "{{clientID}}", "description": "(Required) client Id of Banks or fintech companies" }, { "key": "X_EXT_UserName", "value": "%D8%AE%D8%A7%D9%84%D8%AF", "description": "(Required) Representative of user who made a query" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "", "description": "Added as a part of security scheme: oauth2" } ], "url": { "raw": "{{baseUrl}}/sandbox/banks/v2/contracts/:contractNumber?idType=01&idValue=2000000002", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "banks", "v2", "contracts", ":contractNumber" ], "query": [ { "key": "idType", "value": "01", "description": "(Required) Vendor Identification Type and allowed values are: \"01\" means the value of idValue parameter is CR of vendor" }, { "key": "idValue", "value": "2000000002", "description": "(Required) Vendor Identification Value of selected Id type" } ], "variable": [ { "key": "contractNumber" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"BankContractData\": {\n \"name\": \"Test for Bank\",\n \"referenceNumber\": \"123456789123\",\n \"govAgency\": {\n \"agencyName\": \" مدينة الملك فهد الطبية\",\n \"agencyCode\": \"022001000003\"\n },\n \"amount\": 5992.82270033886,\n \"vendors\": [\n {\n \"name\": \"شركة اعتماد الاختبارية المحدودة\",\n \"CRNumber\": \"2000000002\",\n \"isMainVendor\": true\n },\n {\n \"name\": \"شركة اعتماد الاختبارية المحدودة\",\n \"CRNumber\": \"2000000002\",\n \"isMainVendor\": true\n }\n ],\n \"duration\": {\n \"startDate\": \"2021-07-14\",\n \"endDate\": \"2022-07-14\"\n },\n \"totalReleasedAmount\": 4453.012175514073,\n \"financialClaims\": [\n {\n \"referenceNumber\": \"111111111111\",\n \"amount\": 1047.3443874363375,\n \"status\": \"FC_2\",\n \"bankName\": \"مصرف الراجحى\",\n \"accountNumber\": \"SA8484020900988883999504\"\n },\n {\n \"referenceNumber\": \"111111111111\",\n \"amount\": 7892.65157224676,\n \"status\": \"FC_2\",\n \"bankName\": \"مصرف الراجحى\",\n \"accountNumber\": \"SA8484020900988883999504\"\n }\n ]\n }\n}" }, { "name": "A001400", "originalRequest": { "method": "GET", "header": [ { "key": "X_MOF_RqUID", "value": "{{$guid}}", "description": "(Required) Request UID, it is unique reference, GUID format" }, { "key": "X_MOF_ClientID", "value": "{{clientID}}", "description": "(Required) client Id of Banks or fintech companies" }, { "key": "X_EXT_UserName", "value": "%D8%AE%D8%A7%D9%84%D8%AF", "description": "(Required) Representative of user who made a query" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "", "description": "Added as a part of security scheme: oauth2" } ], "url": { "raw": "{{baseUrl}}/sandbox/banks/v2/contracts/:contractNumber?idType=01&idValue=2000000002", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "banks", "v2", "contracts", ":contractNumber" ], "query": [ { "key": "idType", "value": "01", "description": "(Required) Vendor Identification Type and allowed values are: \"01\" means the value of idValue parameter is CR of vendor" }, { "key": "idValue", "value": "2000000002", "description": "(Required) Vendor Identification Value of selected Id type" } ], "variable": [ { "key": "contractNumber" } ] } }, "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": "A002400", "originalRequest": { "method": "GET", "header": [ { "key": "X_MOF_RqUID", "value": "{{$guid}}", "description": "(Required) Request UID, it is unique reference, GUID format" }, { "key": "X_MOF_ClientID", "value": "{{clientID}}", "description": "(Required) client Id of Banks or fintech companies" }, { "key": "X_EXT_UserName", "value": "%D8%AE%D8%A7%D9%84%D8%AF", "description": "(Required) Representative of user who made a query" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "", "description": "Added as a part of security scheme: oauth2" } ], "url": { "raw": "{{baseUrl}}/sandbox/banks/v2/contracts/:contractNumber?idType=01&idValue=2000000002", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "banks", "v2", "contracts", ":contractNumber" ], "query": [ { "key": "idType", "value": "01", "description": "(Required) Vendor Identification Type and allowed values are: \"01\" means the value of idValue parameter is CR of vendor" }, { "key": "idValue", "value": "2000000002", "description": "(Required) Vendor Identification Value of selected Id type" } ], "variable": [ { "key": "contractNumber" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"A002400,\",\n \"details\": \"Validation format failed. Please return to documentations.,\",\n \"type\": \"BusinessError,\",\n \"link\": null,\n \"in\": [\n {\n \"name\": \"idValue\",\n \"type\": \"query\",\n \"reason\": \"Invalid white space character\"\n }\n ]\n}" }, { "name": "A001400+A002400", "originalRequest": { "method": "GET", "header": [ { "key": "X_MOF_RqUID", "value": "{{$guid}}", "description": "(Required) Request UID, it is unique reference, GUID format" }, { "key": "X_MOF_ClientID", "value": "{{clientID}}", "description": "(Required) client Id of Banks or fintech companies" }, { "key": "X_EXT_UserName", "value": "%D8%AE%D8%A7%D9%84%D8%AF", "description": "(Required) Representative of user who made a query" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "", "description": "Added as a part of security scheme: oauth2" } ], "url": { "raw": "{{baseUrl}}/sandbox/banks/v2/contracts/:contractNumber?idType=01&idValue=2000000002", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "banks", "v2", "contracts", ":contractNumber" ], "query": [ { "key": "idType", "value": "01", "description": "(Required) Vendor Identification Type and allowed values are: \"01\" means the value of idValue parameter is CR of vendor" }, { "key": "idValue", "value": "2000000002", "description": "(Required) Vendor Identification Value of selected Id type" } ], "variable": [ { "key": "contractNumber" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\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 },\n {\n \"code\": \"A002400\",\n \"details\": \"Validation format failed. Please return to documentations.\",\n \"type\": \"BusinessError\",\n \"link\": \"\",\n \"in\": [\n {\n \"name\": \"contractNumber\",\n \"type\": \"path\",\n \"reason\": \"Invalid white space character\"\n }\n ]\n }\n]" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "X_MOF_RqUID", "value": "{{$guid}}", "description": "(Required) Request UID, it is unique reference, GUID format" }, { "key": "X_MOF_ClientID", "value": "{{clientID}}", "description": "(Required) client Id of Banks or fintech companies" }, { "key": "X_EXT_UserName", "value": "%D8%AE%D8%A7%D9%84%D8%AF", "description": "(Required) Representative of user who made a query" }, { "key": "Authorization", "value": "", "description": "Added as a part of security scheme: oauth2" } ], "url": { "raw": "{{baseUrl}}/sandbox/banks/v2/contracts/:contractNumber?idType=01&idValue=2000000002", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "banks", "v2", "contracts", ":contractNumber" ], "query": [ { "key": "idType", "value": "01", "description": "(Required) Vendor Identification Type and allowed values are: \"01\" means the value of idValue parameter is CR of vendor" }, { "key": "idValue", "value": "2000000002", "description": "(Required) Vendor Identification Value of selected Id type" } ], "variable": [ { "key": "contractNumber" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "X_MOF_RqUID", "value": "{{$guid}}", "description": "(Required) Request UID, it is unique reference, GUID format" }, { "key": "X_MOF_ClientID", "value": "{{clientID}}", "description": "(Required) client Id of Banks or fintech companies" }, { "key": "X_EXT_UserName", "value": "%D8%AE%D8%A7%D9%84%D8%AF", "description": "(Required) Representative of user who made a query" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "", "description": "Added as a part of security scheme: oauth2" } ], "url": { "raw": "{{baseUrl}}/sandbox/banks/v2/contracts/:contractNumber?idType=01&idValue=2000000002", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "banks", "v2", "contracts", ":contractNumber" ], "query": [ { "key": "idType", "value": "01", "description": "(Required) Vendor Identification Type and allowed values are: \"01\" means the value of idValue parameter is CR of vendor" }, { "key": "idValue", "value": "2000000002", "description": "(Required) Vendor Identification Value of selected Id type" } ], "variable": [ { "key": "contractNumber" } ] } }, "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\": \"jXAalozJFwCNwN.knd\"\n },\n {\n \"code\": \"A001403\",\n \"details\": \"Error Message Detail\",\n \"type\": \"BusinessError\",\n \"link\": \"O.yp\"\n }\n ]\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "X_MOF_RqUID", "value": "{{$guid}}", "description": "(Required) Request UID, it is unique reference, GUID format" }, { "key": "X_MOF_ClientID", "value": "{{clientID}}", "description": "(Required) client Id of Banks or fintech companies" }, { "key": "X_EXT_UserName", "value": "%D8%AE%D8%A7%D9%84%D8%AF", "description": "(Required) Representative of user who made a query" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "", "description": "Added as a part of security scheme: oauth2" } ], "url": { "raw": "{{baseUrl}}/sandbox/banks/v2/contracts/:contractNumber?idType=01&idValue=2000000002", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "banks", "v2", "contracts", ":contractNumber" ], "query": [ { "key": "idType", "value": "01", "description": "(Required) Vendor Identification Type and allowed values are: \"01\" means the value of idValue parameter is CR of vendor" }, { "key": "idValue", "value": "2000000002", "description": "(Required) Vendor Identification Value of selected Id type" } ], "variable": [ { "key": "contractNumber" } ] } }, "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\": \"ACnV.cki\"\n },\n {\n \"code\": \"A001404\",\n \"details\": \"contract not found\",\n \"type\": \"BusinessError\",\n \"link\": \"kKzzmxnhlFDXqtRIyVkaBDBfQsUDjJ.qh\"\n }\n ]\n}" }, { "name": "Backend Timeout", "originalRequest": { "method": "GET", "header": [ { "key": "X_MOF_RqUID", "value": "{{$guid}}", "description": "(Required) Request UID, it is unique reference, GUID format" }, { "key": "X_MOF_ClientID", "value": "{{clientID}}", "description": "(Required) client Id of Banks or fintech companies" }, { "key": "X_EXT_UserName", "value": "%D8%AE%D8%A7%D9%84%D8%AF", "description": "(Required) Representative of user who made a query" }, { "key": "Authorization", "value": "", "description": "Added as a part of security scheme: oauth2" } ], "url": { "raw": "{{baseUrl}}/sandbox/banks/v2/contracts/:contractNumber?idType=01&idValue=2000000002", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "banks", "v2", "contracts", ":contractNumber" ], "query": [ { "key": "idType", "value": "01", "description": "(Required) Vendor Identification Type and allowed values are: \"01\" means the value of idValue parameter is CR of vendor" }, { "key": "idValue", "value": "2000000002", "description": "(Required) Vendor Identification Value of selected Id type" } ], "variable": [ { "key": "contractNumber" } ] } }, "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": "(Required) Request UID, it is unique reference, GUID format" }, { "key": "X_MOF_ClientID", "value": "{{clientID}}", "description": "(Required) client Id of Banks or fintech companies" }, { "key": "X_EXT_UserName", "value": "%D8%AE%D8%A7%D9%84%D8%AF", "description": "(Required) Representative of user who made a query" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "", "description": "Added as a part of security scheme: oauth2" } ], "url": { "raw": "{{baseUrl}}/sandbox/banks/v2/contracts/:contractNumber?idType=01&idValue=2000000002", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "banks", "v2", "contracts", ":contractNumber" ], "query": [ { "key": "idType", "value": "01", "description": "(Required) Vendor Identification Type and allowed values are: \"01\" means the value of idValue parameter is CR of vendor" }, { "key": "idValue", "value": "2000000002", "description": "(Required) Vendor Identification Value of selected Id type" } ], "variable": [ { "key": "contractNumber" } ] } }, "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\": \"laxgdZCQUrPnTIQdA.jdn\"\n },\n {\n \"code\": \"A001500\",\n \"details\": \"Internal Server Error\",\n \"type\": \"BusinessError\",\n \"link\": \"TZPRRKGQrWVKNMI.jjk\"\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://sandboxapi.etimad.sa" }, { "key": "clientID", "value": "JRZgTE5h1zRxpiYMFpv85VgdvMoEGGcN" }, { "key": "clientSecret", "value": "2nDfAXilPMrfW70v" } ] }