{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"3ebaa839-5643-4f3d-bd0b-43cca7048839","name":"DTB API Documentation","description":"# Data definition\n\n| Field Name | Data Type | Max Length | State |\n| --- | --- | --- | --- |\n| originatorConversationId | string | 100 | **Mandatory** |\n| paymentNotes | string | 255 | **Mandatory** |\n| remittername | string | 128 | **Mandatory** |\n| remitteraddress | string | 128 | **Mandatory** |\n| remitterPhoneNumber | string | 13 | **Mandatory** |\n| remitterIdType | string | 13 | **Mandatory** |\n| remitterIdNumber | string | 13 | **Mandatory** |\n| remitterCountry | string | 50 | **Mandatory** |\n| remitterCCY | string | 3 | **Mandatory** |\n| remitternationality | string | 64 | **Mandatory** |\n| remitteridIssuePlace | string | 64 | **Optional** |\n| remitteridIssueDate | string | 64 | **Optional** |\n| remitteridExpiryDate | string | 64 | **Optional** |\n| recipientName | string | 64 | **Mandatory** |\n| remitterFinancialInstitution | string | 64 | **Mandatory** |\n| remitterSourceOfFunds | string | 64 | **Mandatory** |\n| remitterPrincipalActivity | string | 64 | **Mandatory** |\n| remitterDateOfBirth | string | 64 | **Mandatory** |\n| recipientAddress | string | 64 | **Optional** |\n| recipientEmailAddress | string | 64 | **Optional** |\n| recipientPhoneNumber | string | 13 | **Mandatory** |\n| recipientMCCMNC | integer | 6 | **Required Mobile only** |\n| recipientInstitutionIdentifier | string | 6 | **Only optional for Mobile** |\n| recipientPrimaryAccountNumber | string | 50 | **Mandatory** |\n| recipientPurpose | string | 3 | **Mandatory** |\n| recipientCCY | integer | 6 | **Mandatory** |\n| recipientCountry | string | 3 | **Mandatory** |\n| transactionrouteId | guid | 6 | **Mandatory** |\n| transactionamount | decimal | 6 | **Mandatory** |\n| transactionchannelType | integer | 6 | **Mandatory** |\n| transactionreference | string | 100 | **Mandatory** |\n| transactionsystemTraceAudiNumber | string | 50 | **Mandatory** |\n\n**Note:** **The recipient and remitter names should adhere to the following specifications:**\n\n1. Should contain at least two names.\n    \n2. No capturing of initials in any of the fields.\n    \n3. No input of numbers.\n    \n4. A single space should be used between the names.\n    \n\n# Transaction Status Types\n\nThis is a reference to the `transactionStatus` field found on the **Transfers callback payload**\n\n| Type | Description |\n| --- | --- |\n| 0 | Pending |\n| 1 | Queued |\n| 2 | Submitted |\n| 3 | SubmitAcknowledged |\n| 4 | Completed |\n| 6 | Failed |\n| 7 | Rejected |\n| 8 | TimedOut |\n| 9 | DeliveredToThirdParty |\n\n# Category Types\n\nThis is a reference to the `category` field found as a result of the **Find Transaction Routes** request. It describes the transaction type for a particular route.\n\n| Type | Description |\n| --- | --- |\n| 0 | Mobile Wallet Transfer |\n| 1 | Bank Transfer |\n\n# Channel Types\n\nThis is a reference to the `channel` field found as a result of the **Find Transaction Routes** request. It describes the available transaction routes.\n\n| **Type** | **Description** |\n| --- | --- |\n| 182 | Mpesa |\n| 180 | Pesalink |\n| 181 | IFT |\n\n# Currencies\n\nThe API supports the following currencies:\n\n| Name | Code | Description |\n| --- | --- | --- |\n| KES | 404 | Kenyan Shillings |\n| TZS | 834 | Tanzanian Shilling |\n| UGX | 800 | Ugandan Shilling |\n| BIF | 108 | Burundi Franc |\n| RWF | 646 | Rwanda Franc |\n| SSP | 728 | South Sudanese Pound |\n\n# MCCMNC Codes\n\nThis is a reference to the `mccmnc` field found on the **Payment Order Request** when doing specifically a mobile request. Below are the codes that the API currently supports.\n\n| Code | Description |\n| --- | --- |\n| 63902 | Safaricom Kenya |\n| 64101 | Airtel Uganda |\n| 64110 | MTN Uganda |\n| 64111 | Telcom Uganda |\n| 64114 | Africell Uganda |\n| 64002 | Tigo Tanzania |\n| 64003 | ZANTEL Tanzania |\n| 64004 | Vodacom Tanzania |\n| 64005 | Airtel Tanzania |\n\n# Error Codes\n\nWhat errors and status codes can a user expect?\n\n| **DTB API Response Codes** | **Description** |\n| --- | --- |\n| 200 | The request was processed successfully |\n| 202 | The request has been accepted for processing |\n| 401 | Unauthorized request. **Happens when the credentials used, for this case,the bearer token, has expired.** |\n| 400, BadRequest | Bad request. **For example, this happens when there is a validation error(missing fields) or when there is a duplicate entry(originatorConversationId)** |\n| 404 | Request url not found |\n| 500 | Internal server error |\n\n#### Sample callback response for Transfers\n\n``` json\n{\n  \"id\": \"0c16c3a6-56a7-ec11-ab96-0ee00e897f52\",\n  \"customerId\": \"a393c67c-158b-ec11-ab86-0ee00e897f52\",\n  \"isEnabled\": true,\n  \"remarks\": \"ERTU67897RQQEQ\",\n  \"conversationId\": \"908cb9a6-56a7-ec11-ab96-0ee00e897f52\",\n  \"originatorConversationId\": \"8f8cb9a6-56a7-ec11-ab96-0ee00e897f52\",\n  \"dueDate\": \"2022-03-21T00:00:00\",\n  \"dateApproved\": null,\n  \"dateRejected\": null,\n  \"isProcessed\": true,\n  \"dateProcessed\": \"2022-03-19T07:32:04.3\",\n  \"recordStatus\": 2,\n  \"createdBy\": \"Flavian\",\n  \"createdDate\": \"2022-03-19T07:31:55.85\",\n  \"orderLines\": [\n    {\n      \"remitter\": {\n        \"name\": \"John Gram\",\n        \"address\": \"USA\",\n        \"phoneNumber\": \"1-900-99398333\",\n        \"idType\": \"National ID\",\n        \"idNumber\": \"2000000\",\n        \"country\": \"USA\",\n        \"ccy\": 404,\n        \"financialInstitution\": \"Bank\",\n        \"sourceOfFunds\": \"Business\",\n        \"principalActivity\": \"Business\"\n      },\n      {\n      \"recipient\": {\n        \"name\": \"John Doe\",\n        \"address\": \"Nyati\",\n        \"emailAddress\": \"jjdoe@gmail.com\",\n        \"phoneNumber\": \"\",\n        \"idType\": \"National ID\",\n        \"idNumber\": \"2000000\",\n        \"financialInstitution\": \"Mpesa\",\n        \"primaryAccountNumber\": \"+254714000000\",\n        \"mccmnc\": \"63902\",\n        \"ccy\": 404,\n        \"country\": \"KE\",\n        \"purpose\": \"TEST\"\n      },\n      \"transaction\": {\n        \"routeId\": \"b1b67c98-84a6-ec11-ab96-0ee00e897f52\",\n        \"amount\": 10,\n        \"reference\": \"ERTU67897RQQEQ\",\n        \"systemTraceAuditNumber\": \"0d4b10f3-e679-4a75-b737-11d7d8600fac\",\n        \"type\": 0,\n        \"channelType\": 0,\n        \"customerAccountNo\": null,\n        \"routeTransactionTypeId\": \"00000000-0000-0000-0000-000000000000\"\n      },\n      \"transactionOutcome\": {\n        \"id\": \"0e16c3a6-56a7-ec11-ab96-0ee00e897f52\",\n        \"paymentAmount\": 10,\n        \"feeAmount\": 2,\n        \"trackingNumber\": \"5O18CE9I\",\n        \"transactionStatus\": 4,\n        \"transactionStatusDescription\": \"Completed\",\n        \"workingAccountAvailableFunds\": 0,\n        \"utilityAccountAvailableFunds\": 0,\n        \"transactionDate\": \"20220319073158\",\n        \"transactionCreditParty\": null,\n        \"resultCode\": \"0\",\n        \"resultCodeDescription\": \"Success\",\n        \"thirdPartyPayload\": {\n          \"thirdPartyResultCode\": \"0\",\n          \"thirdPartyResultCodeDescription\": \"Transaction processed successfully.\",\n          \"thirdPartyReceiptNumber\": null\n        },\n        \"createdDate\": \"2022-03-19T07:31:55.85\"\n      }\n    }\n  ]\n}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"16548268","team":2169076,"collectionId":"3ebaa839-5643-4f3d-bd0b-43cca7048839","publishedId":"2sA3sAioLv","public":true,"publicUrl":"https://documenter-api.postman.tech/view/16548268/2sA3sAioLv","privateUrl":"https://go.postman.co/documentation/16548268-3ebaa839-5643-4f3d-bd0b-43cca7048839","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.0","publishDate":"2024-08-21T11:26:18.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/1eef7ac3ea540d0e821ade2ee8b7a64ba140cc734a30c008af3e473071841aa7","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sA3sAioLv"}