{"info":{"_postman_id":"3ebaa839-5643-4f3d-bd0b-43cca7048839","name":"DTB API Documentation","description":"

Data definition

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Field NameData TypeMax LengthState
originatorConversationIdstring100Mandatory
paymentNotesstring255Mandatory
remitternamestring128Mandatory
remitteraddressstring128Mandatory
remitterPhoneNumberstring13Mandatory
remitterIdTypestring13Mandatory
remitterIdNumberstring13Mandatory
remitterCountrystring50Mandatory
remitterCCYstring3Mandatory
remitternationalitystring64Mandatory
remitteridIssuePlacestring64Optional
remitteridIssueDatestring64Optional
remitteridExpiryDatestring64Optional
recipientNamestring64Mandatory
remitterFinancialInstitutionstring64Mandatory
remitterSourceOfFundsstring64Mandatory
remitterPrincipalActivitystring64Mandatory
remitterDateOfBirthstring64Mandatory
recipientAddressstring64Optional
recipientEmailAddressstring64Optional
recipientPhoneNumberstring13Mandatory
recipientMCCMNCinteger6Required Mobile only
recipientInstitutionIdentifierstring6Only optional for Mobile
recipientPrimaryAccountNumberstring50Mandatory
recipientPurposestring3Mandatory
recipientCCYinteger6Mandatory
recipientCountrystring3Mandatory
transactionrouteIdguid6Mandatory
transactionamountdecimal6Mandatory
transactionchannelTypeinteger6Mandatory
transactionreferencestring100Mandatory
transactionsystemTraceAudiNumberstring50Mandatory
\n

Note: The recipient and remitter names should adhere to the following specifications:

\n
    \n

  1. Should contain at least two names.

    \n
    2. \n

  2. No capturing of initials in any of the fields.

    \n
    3. \n

  3. No input of numbers.

    \n
    4. \n

  4. A single space should be used between the names.

    \n
    5. \n
\n

Transaction Status Types

\n

This is a reference to the transactionStatus field found on the Transfers callback payload

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
0Pending
1Queued
2Submitted
3SubmitAcknowledged
4Completed
6Failed
7Rejected
8TimedOut
9DeliveredToThirdParty
\n

Category Types

\n

This 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
0Mobile Wallet Transfer
1Bank Transfer
\n

Channel Types

\n

This 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
182Mpesa
180Pesalink
181IFT
\n

Currencies

\n

The API supports the following currencies:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameCodeDescription
KES404Kenyan Shillings
TZS834Tanzanian Shilling
UGX800Ugandan Shilling
BIF108Burundi Franc
RWF646Rwanda Franc
SSP728South Sudanese Pound
\n

MCCMNC Codes

\n

This 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDescription
63902Safaricom Kenya
64101Airtel Uganda
64110MTN Uganda
64111Telcom Uganda
64114Africell Uganda
64002Tigo Tanzania
64003ZANTEL Tanzania
64004Vodacom Tanzania
64005Airtel Tanzania
\n

Error Codes

\n

What errors and status codes can a user expect?

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
DTB API Response CodesDescription
200The request was processed successfully
202The request has been accepted for processing
401Unauthorized request. Happens when the credentials used, for this case,the bearer token, has expired.
400, BadRequestBad request. For example, this happens when there is a validation error(missing fields) or when there is a duplicate entry(originatorConversationId)
404Request url not found
500Internal server error
\n

Sample callback response for Transfers

\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
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Data definition","slug":"data-definition"},{"content":"Transaction Status Types","slug":"transaction-status-types"},{"content":"Category Types","slug":"category-types"},{"content":"Channel Types","slug":"channel-types"},{"content":"Currencies","slug":"currencies"},{"content":"MCCMNC Codes","slug":"mccmnc-codes"},{"content":"Error Codes","slug":"error-codes"}],"owner":"16548268","collectionId":"3ebaa839-5643-4f3d-bd0b-43cca7048839","publishedId":"2sA3sAioLv","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-08-21T11:26:18.000Z"},"item":[{"name":"Token Request","id":"c3cf749f-a946-4fe6-91e4-76b150977160","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"clientid","type":"text"},{"key":"client_secret","value":"clientsecret","type":"text"},{"key":"grant_type","value":"client_credentials","type":"text"}]},"url":"https://xborder-uat.diamondtrustbank.co.ke/connect/token","description":"

The DTB API uses OAuth2.0 authentication and this requires client_id, client_secret, grant_type, scope. Token Request is a POST request responsible for returning the bearer token that is required for all the requests that are to be made. For this the required details are: client_id, client_secret, grant_type, scope

\n

Sample success response:

\n
{\n    \"access_token\":\"eyJhdddsGciOiJSUzI1NiIsImtpZCI6IkJEQTFFRURDNjNDQkVDNDY4N0Q5MzdDNThCM0ZBQjYxIiwidHlwIjoiYXQrand0In0.eyJuYmYiOjE2MjQ1NDIzMTgsImV4cCI6MTYyNDU0NTkxOCwiaXNzIjoiaHR0cHM6Ly9sb2NhbGhvc3Q6NDQzMTAiLCJhdWQiOiJQeVBheV9hcGkiLCJjbGllbnRfaWQiOiJQeVBheV9hcGkiLCJjbGllbnRfY3VzdeqvG9tZXJfaWQiOiJmYmViMzc4NS03MmEyLWViMTEtYTgxMy1kYzQxYTlmODczOWMiLCJjbGllbwwwfnRfY3VzdG9tZXJfdHlwZSI6IkNvcnBvcmF0ZSIsImNsaWVudF93ZWJzaXRlIjoiaHR0cDovL3d3dygw2445weWNzLmNvLmtlIiwianRpIjoiODcxMzlGOTZEMzJCNTRGNTA4OERCRTI4OTBCMkEyM0UiLCJpYXQiOjE2MjQ1NDIzMTgsInNjb3BlIjpbIlB5UGF5X2FwaSJdfQ.BifQbO6n9P_928WRN40qDJgvvdujFygWpbTmPIiOwPgG2uGlZzDeeVRguU6KseS4HuTZrZg2oWEnyTFG5gcH06m8Yd0sPdN5m441425IscbvcXE3sAn7Nbvs VHSMITl1rZdS1KNzbTWKzGV4l8AFTNLa4j63Z7aG73E6e1BrIHsP6dV0JUKTjXzBOyX6dmV0E4MuSHv9qyFk0YdlQkPw1NHtDYwOh___r88mNavaeKlsX1JMevq17MLXz3pfx2upH89KdoATdALBMjY7r8MSLslZCr1d-VmVeQaLq7heHvgtLIHsZlyqeeqeqkznKE6piL9wHScVtIgVmdNSVJVJAOIQgjHxn0oVnOOw\",\n    \"expires_in\": 3600,\n    \"token_type\": \"Bearer\",\n    \"scope\": \"scope\"\n}\n\n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"3ebaa839-5643-4f3d-bd0b-43cca7048839","id":"3ebaa839-5643-4f3d-bd0b-43cca7048839","name":"DTB API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["connect","token"],"host":["xborder-uat","diamondtrustbank","co","ke"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3cf749f-a946-4fe6-91e4-76b150977160"},{"name":"Bank Payment Order Request","id":"d18fd15d-8635-4d7b-a1c4-c8843fb73396","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"originatorConversationId\": \"12211t21412vr434345545x\",\r\n \"paymentNotes\": \"Transactions\",\r\n \"paymentOrderLines\": [\r\n {\r\n \"remitter\": {\r\n \"name\": \"John Doe\",\r\n \"address\": \"USA\",\r\n \"phoneNumber\": \"USA\",\r\n \"idType\": \"USA\",\r\n \"idNumber\": \"200000\",\r\n \"country\": \"USA\",\r\n \"ccy\": \"840\",\r\n \"financialInstitution\": \"Bank\",\r\n \"sourceOfFunds\": \"Business\",\r\n \"principalActivity\": \"Business\",\r\n \"dateOfBirth\":\"yyyy/mm/dd\",\r\n \"idIssueDate\":\"yyyy/mm/dd\",\r\n \"idIssuePlace\": \"Texas\",\r\n \"idExpiryDate\":\"yyyy/mm/dd\",\r\n \"nationality\" : \"American\"\r\n },\r\n \"recipient\": {\r\n \"name\": \"John Doe\",\r\n \"address\": \"Nyati\",\r\n \"emailAddress\": \"kkhaliboy@gmail.com\",\r\n \"phoneNumber\": \"\",\r\n \"idType\": \"National ID\",\r\n \"idNumber\": \"100000000\",\r\n \"financialInstitution\": \"Bank\",\r\n \"institutionIdentifier\": \"EQBLKENA\",\r\n \"primaryAccountNumber\": \"0122000000\",\r\n \"ccy\": 404,\r\n \"country\": \"KE\",\r\n \"purpose\": \"TEST\"\r\n },\r\n \"transaction\": {\r\n \"routeId\": \"90d7e7a0-2a12-ec11-aaa1-c7e0fb8016f8\",\r\n \"ChannelType\": 180,\r\n \"amount\": 1111,\r\n \"reference\": \"s1199111s5cdd12r32rwwewsuyitt\",\r\n \"systemTraceAuditNumber\": \"22f323f3241s14sswwwin9uihjf\"\r\n },\r\n \"metaDataList\":[\r\n {\r\n \"key\": \"remitterPrimaryAccountNumber\",\r\n \"value\":\"5643212450\" \r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://xborder-uat.diamondtrustbank.co.ke/v1/payment-order/new-order","description":"

Note: A valid token is required for authentication as it expires after every hour. Refer to Token Request to generate a new token.

\n

originatorConversationId This a unique identifier of the request from the client

\n

paymentNotes This a brief summary of the request

\n

remitter: This information is only required for a Payment Remittance Company

\n
\n

name: Name of the remitter

\n

contact: Remitter's contact

\n

address: Address of the remitter

\n

idType: remitter Id type e.g. National ID, Passport

\n

idNumber: remitter Id type number

\n

country:This is the remitter's ALPHA 2 code. Follow ALPHA to learn more.

\n

ccy: Remitter's currency code

\n

financialInstitution: Remitter's financial institution

\n

sourceOfFunds: Remitter's source of funds

\n

principalActivity: Remitter's principal activity

\n

dateOfBirth:The birth date of the sender in the format yyyy/mm/dd

\n

idIssueDate:National identification card issue date of the sender in the format yyyy/mm/dd(This field is optional)

\n

idIssuePlace: Location where the national ID was issued (This field is optional)

\n

idExpiryDate: The expiration date of the national ID of the sender in the format yyyy/mm/dd(This field is optional)

\n

nationality: The country where the sender is from e.g. American

\n
\n

recipient: These are the recipient's details

\n
\n

name: Name of recipient

\n

address: Address of the recipient

\n

emailAddress: Email address of the recipient

\n

contact: Contact of the recipient

\n

idType: Id type of the recipient

\n

idNumber: Id number of the recipient

\n

financialInstitution: Recipient financial institution

\n

institutionIdentifier: An identifier of the recipient institution. This is mandatory for Bank payment order requests (IFT, RTGS and Pesalink). Bank uses BIC_Codes e.g. EQBLKENA.

\n

primaryAccountNumber:This is the account number being credited

\n

ccy:This is the currency code of the recipient country

\n

country:This is the recipient's ALPHA 2 code. Follow ALPHA to learn more.

\n

purpose:This is the purpose of the transfer.

\n
\n

transaction: The following are the transaction details:

\n
\n

routeId: Id of the route transaction to be used for the transaction.This id is generated from the FindTransactionRoutes request.

\n

channelType: This is the channel transaction type. It is received after querying the Find Transaction Routes request

\n

amount: Amount to be transferred

\n

reference: A reference for the transaction

\n

systemTraceAuditNumber: Unique identifier of the transaction from the client

\n
\n

metaDataList: The following are the metadata list details:

\n
\n

key: The key is remitterPrimaryAccountNumber. This is a mandatory field that holds the key for the account that is to be debited for the transaction.

\n

value: This holds the value of the account to be debited e.g. 231452360.

\n

NOTE: For duplicate requests, the transaction will be accepted but instead expect a callback to be sent. Refer to the Sample Duplicate Callback Response for an example.

\n
\n

Sample Bank request

\n
{\n  \"originatorConversationId\": \"fb60297a-c26f-4669-ab7a-c6598e4a595d\",\n  \"paymentNotes\": \"Transactions\",\n  \"paymentOrderLines\": [\n    {\n      \"remitter\": {\n        \"name\": \"Dean Muhando\",\n        \"address\": \"Kampala\",\n        \"phoneNumber\": \"+254743543212\",\n        \"idType\": \"National ID\",\n        \"idNumber\": \"25662882\",\n        \"country\": \"UG\",\n        \"ccy\": 800,\n        \"financialInstitution\": \"68000\",\n        \"sourceOfFunds\": \"Loan\",\n        \"principalActivity\": \"Business\",\n        \"institutionIdentifier\":\"404\",\n        \"nationality\":\"KENYAN\",\n        \"dateOfBirth\":\"24-02-1998\"\n      },\n      \"recipient\": {\n        \"name\": \"Gigi Buffon\",\n        \"address\": \"Westlands\",\n        \"emailAddress\": \"dboysss@gmail.com\",\n        \"phoneNumber\": \"+254743354635\",\n        \"idType\": \"National ID\",\n        \"idNumber\": \"28475979\",\n        \"financialInstitution\": \"68000\",\n        \"primaryAccountNumber\": \"0170197176640\",\n        \"mccmnc\": \"63902\",\n        \"ccy\": 404,\n        \"country\" : \"KE\",\n        \"purpose\": \"Salary\",\n         \"institutionIdentifier\":\"EQBLKENA\"\n      },\n      \"transaction\": {\n        \"routeId\": \"b44baada-a9ea-ef11-a051-0afb36a7659f\",\n        \"ChannelType\": 180,\n        \"amount\": 100,\n        \"reference\": \"testing\",\n        \"systemTraceAuditNumber\": \"a561069d-28b6-4c41-899e-228b942be476\"\n      },\n       \"metaDataList\":[\n        {\n       \"key\": \"remitterPrimaryAccountNumber\",\n       \"value\":\"5643212450\" \n       }\n    ]      \n    }\n  ]\n}\n\n
\n

Sample success response

\n
{\n  \"message\": {\n    \"appDomainName\": \"LIVE\",\n    \"systemConversationId\": \"16780000-a97d-3024-8e07-08d93713929d\",\n    \"originatorConversationId\": \"origiqjwwqwqnnmqeqersationId\",\n    \"remarks\": \"order submission accepted\",\n    \"timestamp\": \"2021-06-24T13:25:49.5292326Z\"\n  }\n}\n\n
\n

Sample failed response

\n
{\n    \"appDomainName\": \"LIVE\",\n    \"timestamp\": \"2022-02-11T10:13:11.2483928Z\",\n    \"systemConversationId\": \"16780000-a97d-3024-98a9-08d9ed471bab\",\n    \"originatorConversationId\": \"W93323321ei4455t40093334xxiuigggtey\",\n    \"errors\": [\n        {\n            \"field\": \"OriginatorConversationId\",\n            \"message\": \"duplicate originator conversation id 'W93323321ei4455t40093334xxiuigggtey'\"\n        }\n    ]\n}\n\n
\n

Sample validation errors response

\n
{\n    \"appDomainName\": \"LIVE\",\n    \"status\": \"BadRequest\",\n    \"timestamp\": \"2022-02-11T10:13:11.2483928Z\",\n    \"systemConversationId\": \"16780000-a97d-3024-98a9-08d9ed471bab\",\n    \"originatorConversationId\": \"W93323321ei4455t40093334xxiuigggtey\",\n    \"errors\": [\n          {\n             \"field\": \"PaymentOrderLines[0].Recipient\",\n             \"message\": \"The Recipient field is required.\"\n          }\n      ]\n}\n\n
\n

Sample Duplicate callback response

\n

Kindly note the following will be the response in case a duplicate request is sent. The details will be seen under the transcationOutcome part of the callback.

\n
{\n    \"id\": \"00000000-0000-0000-0000-000000000000\",\n    \"customerId\": \"f45eca19-d0df-eb11-aa67-8d094e8aa279\",\n    \"isEnabled\": false,\n    \"remarks\": null,\n    \"conversationId\": null,\n    \"originatorConversationId\": \"UA5L3LSL53W5P07KWG54\",\n    \"dueDate\": \"0001-01-01T00:00:00\",\n    \"dateApproved\": null,\n    \"dateRejected\": null,\n    \"isProcessed\": false,\n    \"dateProcessed\": null,\n    \"recordStatus\": 0,\n    \"createdBy\": null,\n    \"createdDate\": \"2022-04-28T14:52:57.1131933+03:00\",\n    \"orderLines\": [\n        {\n            \"remitter\": {\n                \"name\": null,\n                \"address\": null,\n                \"phoneNumber\": null,\n                \"idType\": null,\n                \"idNumber\": null,\n                \"idIssuePlace\": null,\n                \"idIssueDate\": null,\n                \"idExpireDate\": null,\n                \"country\": null,\n                \"nationality\": null,\n                \"ccy\": null,\n                \"financialInstitution\": null,\n                \"sourceOfFunds\": null,\n                \"principalActivity\": null,\n                \"dateOfBirth\": null\n            },\n            \"recipient\": {\n                \"name\": \"John Doe\",\n                \"address\": \"28 Nii sackey street\",\n                \"emailAddress\": \"test@gmail.com\",\n                \"phoneNumber\": \"+254700000000\",\n                \"mccmnc\": \"63902\",\n                \"idType\": \"National Id\",\n                \"idNumber\": \"10000000\",\n                \"primaryAccountNumber\": \"+254713771963\",\n                \"financialInstitution\": \"Business\",\n                \"institutionIdentifier\": null,\n                \"ccy\": \"404\",\n                \"purpose\": \"Withdraw Amount from wallet\",\n                \"country\": null\n            },\n            \"transaction\": {\n                \"routeId\": \"dadcb601-7089-ec11-ab85-0ee00e897f52\",\n                \"amount\": 200,\n                \"reference\": \"16000000000\",\n                \"systemTraceAuditNumber\": \"UA5L3LSL53W5P07KWG54\",\n                \"type\": 0,\n                \"channelType\": 0,\n                \"customerAccountNo\": null,\n                \"routeTransactionTypeId\": \"00000000-0000-0000-0000-000000000000\"\n            },\n            \"transactionOutcome\": {\n                \"id\": \"00000000-0000-0000-0000-000000000000\",\n                \"paymentAmount\": 0,\n                \"feeAmount\": 0,\n                \"trackingNumber\": null,\n                \"transactionStatus\": 6,\n                \"transactionStatusDescription\": \"Failed\",\n                \"workingAccountAvailableFunds\": 0,\n                \"utilityAccountAvailableFunds\": 0,\n                \"transactionDate\": null,\n                \"transactionCreditParty\": null,\n                \"resultCode\": \"9\",\n                \"resultCodeDescription\": \"Duplicate transaction\",\n                \"thirdPartyPayload\": null,\n                \"createdDate\": \"2022-04-28T14:52:57.1131933+03:00\"\n            }\n        }\n    ]\n}\n\n
\n

Sample callback response

\n

NOTE: There are particular fields to note in the callback response incase there is a failed status in the transactionStatus field:

\n

resultCode:This is the code shown as defined under the Error Codes section

\n

resultDescription:This is the description of the resultCode

\n

thirdPartyPayload:This body contains fields that gives the exact resultCode and resultDescription from the third party e.g M-Pesa as shown above. The fields are thirdPartyResultCode and thirdPartyResultDescription

\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-99300000\",\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\": \"Bank\",\n        \"primaryAccountNumber\": \"102000000\",\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
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"3ebaa839-5643-4f3d-bd0b-43cca7048839","id":"3ebaa839-5643-4f3d-bd0b-43cca7048839","name":"DTB API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","payment-order","new-order"],"host":["xborder-uat","diamondtrustbank","co","ke"],"query":[],"variable":[]}},"response":[],"_postman_id":"d18fd15d-8635-4d7b-a1c4-c8843fb73396"},{"name":"Mobile Payment Order Request","id":"7718181a-c004-43a6-b420-b0e2be2f1dfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"originatorConversationId\": \"12211t21412vr434345545x\",\r\n \"paymentNotes\": \"Transactions\",\r\n \"paymentOrderLines\": [\r\n {\r\n \"remitter\": {\r\n \"name\": \"John Doe\",\r\n \"address\": \"USA\",\r\n \"phoneNumber\": \"USA\",\r\n \"idType\": \"USA\",\r\n \"idNumber\": \"200000\",\r\n \"country\": \"USA\",\r\n \"ccy\": \"840\",\r\n \"financialInstitution\": \"Bank\",\r\n \"sourceOfFunds\": \"Business\",\r\n \"principalActivity\": \"Business\",\r\n \"dateOfBirth\":\"yyyy/mm/dd\",\r\n \"idIssueDate\":\"yyyy/mm/dd\",\r\n \"idIssuePlace\": \"Texas\",\r\n \"idExpiryDate\":\"yyyy/mm/dd\",\r\n \"nationality\" : \"American\"\r\n },\r\n \"recipient\": {\r\n \"name\": \"John Doe\",\r\n \"address\": \"Nyati\",\r\n \"emailAddress\": \"kkhaliboy@gmail.com\",\r\n \"phoneNumber\": \"\",\r\n \"idType\": \"National ID\",\r\n \"idNumber\": \"28475979\",\r\n \"financialInstitution\": \"Mpesa\",\r\n \"primaryAccountNumber\": \"+254714789009\",\r\n \"mccmnc\": \"63902\",\r\n \"ccy\": 404,\r\n \"country\": \"KE\",\r\n \"purpose\": \"TEST\"\r\n },\r\n \"transaction\": {\r\n \"routeId\": \"90d7e7a0-2a12-ec11-aaa1-c7e0fb8016f8\",\r\n \"channelType\": 182,\r\n \"amount\": 1111,\r\n \"reference\": \"s1199111s5cdd12r32rwwewsuyitt\",\r\n \"systemTraceAuditNumber\": \"22f323f3241s14sswwwin9uihjf\"\r\n },\r\n \"metaDataList\":[\r\n {\r\n \"key\": \"remitterPrimaryAccountNumber\",\r\n \"value\":\"5643212450\" \r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://xborder-uat.diamondtrustbank.co.ke/v1/payment-order/new-order","description":"

Note: A valid token is required for authentication as it expires after every hour. Refer to Token Request to generate a new token.

\n

originatorConversationId This a unique identifier of the request from the client

\n

paymentNotes This a brief summary of the request

\n

remitter: This information is only required for a Payment Remittance Company

\n
\n

name: Name of the remitter

\n

contact: Remitter's contact

\n

address: Address of the remitter

\n

idType: remitter Id type e.g. National ID, Passport

\n

idNumber: remitter Id type number

\n

country:This is the remitter's ALPHA 2 code. Follow ALPHA to learn more.

\n

ccy: Remitter's currency code

\n

financialInstitution: Remitter's financial institution

\n

sourceOfFunds: Remitter's source of funds

\n

principalActivity: Remitter's principal activity

\n

dateOfBirth:The birth date of the sender in the format yyyy/mm/dd

\n

idIssueDate:National identification card issue date of the sender in the format yyyy/mm/dd(This field is optional)

\n

idIssuePlace: Location where the national ID was issued (This field is optional)

\n

idExpiryDate: The expiration date of the national ID of the sender in the format yyyy/mm/dd(This field is optional)

\n

nationality: The country where the sender is from e.g. American

\n
\n

recipient: These are the recipient's details

\n
\n

name: Name of recipient

\n

address: Address of the recipient

\n

emailAddress: Email address of the recipient

\n

contact: Contact of the recipient

\n

idType: Id type of the recipient

\n

idNumber: Id number of the recipient

\n

mccmnc:Mobile country code. Follow this link, MCCMNC, to find out more about the codes. Only mandatory for Mobile payment order requests.

\n

financialInstitution: Recipient financial institution

\n

institutionIdentifier: An identifier of the recipient institution.

\n

primaryAccountNumber:This is the account number (phone number) being credited

\n

ccy:This is the currency code of the recipient

\n

country:This is the recipient's ALPHA 2 code. Follow ALPHA to learn more.

\n

purpose:This is the purpose of the transfer.

\n
\n

transaction: The following are the transaction details:

\n
\n

routeId: Id of the route transaction to be used for the transaction.This id is generated from the FindTransactionRoutes request.

\n

channelType: This is the channel transaction type. It is received after querying the Find Transaction Routes request

\n

amount: Amount to be transferred

\n

reference: A reference for the transaction

\n

systemTraceAuditNumber: Unique identifier of the transaction from the client

\n
\n

metaDataList: The following are the metadata list details:

\n
\n

key: The key is remitterPrimaryAccountNumber. This is a mandatory field that holds the key for the account that is to be debited for the transaction.

\n

value: This holds the value of the account to be debited e.g. 231452360.

\n

NOTE: For duplicate requests, the transaction will be accepted but instead expect a callback to be sent. Refer to the Sample Duplicate Callback Response for an example.

\n
\n

Sample mobile request

\n
{\n  \"originatorConversationId\": \"12211t21412vr434345545x\",\n  \"paymentNotes\": \"Transactions\",\n  \"paymentOrderLines\": [\n    {\n        \"remitter\": {\n            \"name\": \"John Doe\",\n            \"address\": \"USA\",\n            \"phoneNumber\": \"USA\",\n            \"idType\": \"USA\",\n            \"idNumber\": \"200000\",\n            \"country\": \"USA\",\n            \"ccy\": \"840\",\n            \"financialInstitution\": \"Bank\",\n            \"sourceOfFunds\": \"Business\",\n            \"principalActivity\": \"Business\",\n            \"dateOfBirth\":\"yyyy/mm/dd\",\n            \"idIssueDate\":\"yyyy/mm/dd\",\n            \"idIssuePlace\": \"Texas\",\n            \"idExpiryDate\":\"yyyy/mm/dd\",\n            \"nationality\" : \"American\"\n        },\n      \"recipient\": {\n        \"name\": \"John Doe\",\n        \"address\": \"Nyati\",\n        \"emailAddress\": \"kkhaliboy@gmail.com\",\n        \"phoneNumber\": \"\",\n        \"idType\": \"National ID\",\n        \"idNumber\": \"28475979\",\n        \"financialInstitution\": \"Mpesa\",\n        \"primaryAccountNumber\": \"+254714789009\",\n        \"mccmnc\": \"63902\",\n        \"ccy\": 404,\n        \"country\": \"KE\",\n        \"purpose\": \"TEST\"\n      },\n      \"transaction\": {\n        \"routeId\": \"90d7e7a0-2a12-ec11-aaa1-c7e0fb8016f8\",\n        \"channelType\": 1,\n        \"customerAccountNo\":\"12323242433\",\n        \"amount\": 1111,\n        \"reference\": \"s1199111s5cdd12r32rwwewsuyitt\",\n        \"systemTraceAuditNumber\": \"22f323f3241s14sswwwin9uihjf\"\n      },     \n       \"metaDataList\":[\n        {\n       \"key\": \"remitterPrimaryAccountNumber\",\n       \"value\":\"5643212450\" \n       }\n    }\n  ]\n}\n\n
\n

Sample success response

\n
{\n  \"message\": {\n    \"appDomainName\": \"LIVE\",\n    \"systemConversationId\": \"16780000-a97d-3024-8e07-08d93713929d\",\n    \"originatorConversationId\": \"origiqjwwqwqnnmqeqersationId\",\n    \"remarks\": \"order submission accepted\",\n    \"timestamp\": \"2021-06-24T13:25:49.5292326Z\"\n  }\n}\n\n
\n

Sample failed response

\n
{\n    \"appDomainName\": \"LIVE\",\n    \"timestamp\": \"2022-02-11T10:13:11.2483928Z\",\n    \"systemConversationId\": \"16780000-a97d-3024-98a9-08d9ed471bab\",\n    \"originatorConversationId\": \"W93323321ei4455t40093334xxiuigggtey\",\n    \"errors\": [\n        {\n            \"field\": \"OriginatorConversationId\",\n            \"message\": \"duplicate originator conversation id 'W93323321ei4455t40093334xxiuigggtey'\"\n        }\n    ]\n}\n\n
\n

Sample validation errors response

\n
{\n    \"appDomainName\": \"LIVE\",\n    \"status\": \"BadRequest\",\n    \"timestamp\": \"2022-02-11T10:13:11.2483928Z\",\n    \"systemConversationId\": \"16780000-a97d-3024-98a9-08d9ed471bab\",\n    \"originatorConversationId\": \"W93323321ei4455t40093334xxiuigggtey\",\n    \"errors\": [\n          {\n             \"field\": \"PaymentOrderLines[0].Recipient\",\n             \"message\": \"The Recipient field is required.\"\n          }\n      ]\n}\n\n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"3ebaa839-5643-4f3d-bd0b-43cca7048839","id":"3ebaa839-5643-4f3d-bd0b-43cca7048839","name":"DTB API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","payment-order","new-order"],"host":["xborder-uat","diamondtrustbank","co","ke"],"query":[],"variable":[]}},"response":[],"_postman_id":"7718181a-c004-43a6-b420-b0e2be2f1dfd"},{"name":"Reject Order By OriginatorConversationId","id":"c3780a3e-6ff6-4419-a44c-021340004ae2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://xborder-uat.diamondtrustbank.co.ke/v1/payment-order/reject-order?OriginatorConversationId=61d8824a-0053-4286-8993-23c45ae1646e","description":"

This request is used to reject an order already posted using a specified originatorConversationId

\n

NOTE: This can only be done for transactions in Pending or Queued state (refer to the Transaction Status Types table). For bulk transactions, we can only reject the ones that fit the given criteria.

\n

Sample response

\n

originatorConversationId This a unique identifier of the request from the client

\n

transactionStatus: This is the value representing the state of the transaction (refer to the Transaction Status Types table)

\n

transactionDescription: This describes the transactionStatus value.

\n

resultCode: It is the code representing the result of the reject process.

\n

resultCodeDescription: It describes the resultCode value

\n
{\n    \"paymentOrderlines\": [\n        {\n            \"originatorConversationId\": \"61d8824a-0053-4286-8993-23c45ae1646e\",\n            \"transactionStatus\": 7,\n            \"transactionStatusDescription\": \"Rejected\",\n            \"resultCode\": \"1\",\n            \"resultCodeDescription\": \"Transaction cannot be rejected on current status\"\n        }\n    ]\n}\n\n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"3ebaa839-5643-4f3d-bd0b-43cca7048839","id":"3ebaa839-5643-4f3d-bd0b-43cca7048839","name":"DTB API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","payment-order","reject-order"],"host":["xborder-uat","diamondtrustbank","co","ke"],"query":[{"key":"OriginatorConversationId","value":"61d8824a-0053-4286-8993-23c45ae1646e"}],"variable":[]}},"response":[],"_postman_id":"c3780a3e-6ff6-4419-a44c-021340004ae2"},{"name":"Find Payment Order By OriginatorConversationId","id":"9c3e683c-884d-49d4-941e-32dd848ec326","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://xborder-uat.diamondtrustbank.co.ke/v1/payment-order/check-status?Id=61d8824a-0053-4286-8993-23c45ae1646e&IdType=OriginatorConversationId","description":"

This request returns an order based on the Id which is the unique identifier that you provide with every PostPaymentOrder request together with the IdType which specifies the type of the Id to be passed. For this case IdType will be the OriginatorConversationId.

\n

Sample error response

\n
{\n    \"appDomainName\": \"LIVE\",\n    \"status\": 400,\n    \"timestamp\": \"2022-02-11T10:13:11.2483928Z\",\n    \"systemConversationId\": \"16780000-a97d-3024-98a9-08d9ed471bab\",\n    \"originatorConversationId\": \"61d8824a-0053-4286-8993-23c45ae1646e\",\n    \"errors\": [\n        {\n            \"field\": \"Id\",\n            \"message\": \"The Id field is required.\"\n        }\n    ]\n}\n\n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"3ebaa839-5643-4f3d-bd0b-43cca7048839","id":"3ebaa839-5643-4f3d-bd0b-43cca7048839","name":"DTB API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","payment-order","check-status"],"host":["xborder-uat","diamondtrustbank","co","ke"],"query":[{"key":"Id","value":"61d8824a-0053-4286-8993-23c45ae1646e"},{"key":"IdType","value":"OriginatorConversationId"}],"variable":[]}},"response":[],"_postman_id":"9c3e683c-884d-49d4-941e-32dd848ec326"},{"name":"Callback","id":"425d544a-8778-4b66-9c49-312a25adc7c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","description":"

This is the response that is sent to the partner for a transaction in its final status.

\n

NOTE: There are particular fields to note in the callback response incase there is a failed status in the transactionStatus field:

\n

resultCode:This is the code shown as defined under the Error Codes section

\n

resultDescription:This is the description of the resultCode

\n

thirdPartyPayload:This body contains fields that gives the exact resultCode and resultDescription from the third party e.g M-Pesa as shown above. The fields are thirdPartyResultCode and thirdPartyResultDescription

\n

Sample callback response

\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-99300000\",\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
\n

Sample Duplicate callback response

\n

Kindly note the following will be the response in case a duplicate request is sent. The details will be seen under the transcationOutcome part of the callback.

\n
{\n    \"id\": \"00000000-0000-0000-0000-000000000000\",\n    \"customerId\": \"f45eca19-d0df-eb11-aa67-8d094e8aa279\",\n    \"isEnabled\": false,\n    \"remarks\": null,\n    \"conversationId\": null,\n    \"originatorConversationId\": \"UA5L3LSL53W5P07KWG54\",\n    \"dueDate\": \"0001-01-01T00:00:00\",\n    \"dateApproved\": null,\n    \"dateRejected\": null,\n    \"isProcessed\": false,\n    \"dateProcessed\": null,\n    \"recordStatus\": 0,\n    \"createdBy\": null,\n    \"createdDate\": \"2022-04-28T14:52:57.1131933+03:00\",\n    \"orderLines\": [\n        {\n            \"remitter\": {\n                \"name\": null,\n                \"address\": null,\n                \"phoneNumber\": null,\n                \"idType\": null,\n                \"idNumber\": null,\n                \"idIssuePlace\": null,\n                \"idIssueDate\": null,\n                \"idExpireDate\": null,\n                \"country\": null,\n                \"nationality\": null,\n                \"ccy\": null,\n                \"financialInstitution\": null,\n                \"sourceOfFunds\": null,\n                \"principalActivity\": null,\n                \"dateOfBirth\": null\n            },\n            \"recipient\": {\n                \"name\": \"John Doe\",\n                \"address\": \"28 Nii sackey street\",\n                \"emailAddress\": \"test@gmail.com\",\n                \"phoneNumber\": \"+254700000000\",\n                \"mccmnc\": \"63902\",\n                \"idType\": \"National Id\",\n                \"idNumber\": \"10000000\",\n                \"primaryAccountNumber\": \"+254713771963\",\n                \"financialInstitution\": \"Business\",\n                \"institutionIdentifier\": null,\n                \"ccy\": \"404\",\n                \"purpose\": \"Withdraw Amount from wallet\",\n                \"country\": null\n            },\n            \"transaction\": {\n                \"routeId\": \"dadcb601-7089-ec11-ab85-0ee00e897f52\",\n                \"amount\": 200,\n                \"reference\": \"16000000000\",\n                \"systemTraceAuditNumber\": \"UA5L3LSL53W5P07KWG54\",\n                \"type\": 0,\n                \"channelType\": 0,\n                \"customerAccountNo\": null,\n                \"routeTransactionTypeId\": \"00000000-0000-0000-0000-000000000000\"\n            },\n            \"transactionOutcome\": {\n                \"id\": \"00000000-0000-0000-0000-000000000000\",\n                \"paymentAmount\": 0,\n                \"feeAmount\": 0,\n                \"trackingNumber\": null,\n                \"transactionStatus\": 6,\n                \"transactionStatusDescription\": \"Failed\",\n                \"workingAccountAvailableFunds\": 0,\n                \"utilityAccountAvailableFunds\": 0,\n                \"transactionDate\": null,\n                \"transactionCreditParty\": null,\n                \"resultCode\": \"9\",\n                \"resultCodeDescription\": \"Duplicate transaction\",\n                \"thirdPartyPayload\": null,\n                \"createdDate\": \"2022-04-28T14:52:57.1131933+03:00\"\n            }\n        }\n    ]\n}\n\n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"3ebaa839-5643-4f3d-bd0b-43cca7048839","id":"3ebaa839-5643-4f3d-bd0b-43cca7048839","name":"DTB API Documentation","type":"collection"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"425d544a-8778-4b66-9c49-312a25adc7c8"},{"name":"Find Transaction Routes","id":"863d4394-ee57-4556-8bd6-d0d00466896e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://xborder-uat.diamondtrustbank.co.ke/v1/transaction-routes/assigned-routes","description":"

\n

\n

This is a GET request that returns a list of transaction routes that you currently have setup

\n

Sample success response:

\n
{\n    \"routes\": [\n        {\n            \"id\": \"b44baada-a9ea-ef11-a051-0afb36a7659f\",\n            \"category\": \"1\",\n            \"categoryDescription\": \"Bank Transfer\",\n            \"transactionTypeId\": \"8399bb51-2de9-ef11-a051-0afb36a7659f\",\n            \"categoryIsEnabled\": true,\n            \"routeIntergration\": \"DTB\",\n            \"country\": \"KENYA\",\n            \"routeIsActive\": true,\n            \"channelTypes\": [\n                {\n                    \"channelType\": 180,\n                    \"channelDescription\": \"DTB-Pesalink\"\n                },\n                {\n                    \"channelType\": 181,\n                    \"channelDescription\": \"DTB-IFT\"\n                },\n                {\n                    \"channelType\": 182,\n                    \"channelDescription\": \"DTB-Mpesa-B2C\"\n                }\n            ]\n        }\n    ]\n}\n\n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"3ebaa839-5643-4f3d-bd0b-43cca7048839","id":"3ebaa839-5643-4f3d-bd0b-43cca7048839","name":"DTB API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","transaction-routes","assigned-routes"],"host":["xborder-uat","diamondtrustbank","co","ke"],"query":[],"variable":[]}},"response":[],"_postman_id":"863d4394-ee57-4556-8bd6-d0d00466896e"},{"name":"Health Check","id":"bd6fcd5a-e38f-4e1e-9665-38e5d1900932","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://xborder-uat.diamondtrustbank.co.ke/api_health_check","description":"

Ensures the functionality of all the API endpoints

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"3ebaa839-5643-4f3d-bd0b-43cca7048839","id":"3ebaa839-5643-4f3d-bd0b-43cca7048839","name":"DTB API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["api_health_check"],"host":["xborder-uat","diamondtrustbank","co","ke"],"query":[],"variable":[]}},"response":[],"_postman_id":"bd6fcd5a-e38f-4e1e-9665-38e5d1900932"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"9bc79168-e611-426a-b92c-51f4c7c75cae","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a399b313-4b79-4d66-9715-a9b8471e0275","type":"text/javascript","exec":[""]}}],"variable":[{"key":"test_url","value":"https://sandboxapi.zamupay.com","type":"string"},{"key":"test_token_url","value":"http://54.224.92.175:10001","type":"string"}]}