This API returns the token and token expiration period. This token should be added to all request
\n","_postman_id":"8719d9f5-f323-45e7-b0f0-1a382123b5b3","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"The grant type needed for authorization
\n","type":"text"}]},"url":"https://gateway.dotbank.africa/oauth2/token","urlObject":{"path":["oauth2","token"],"host":["https://gateway.dotbank.africa"],"query":[],"variable":[]}},"response":[{"id":"341b0607-3292-49c1-8713-e6be0db53372","name":"Success","originalRequest":{"method":"POST","header":[{"key":"client_id","value":"cleva","type":"text","disabled":true},{"key":"client_secret","value":"0ZBlO7OSMnaU2eV1cPxG9zehN5BmynV3","type":"text","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","description":"The grant type needed for authorization","type":"text"}]},"url":"https://gateway.dotbank.africa/oauth2/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Thu, 08 Feb 2024 09:05:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1165"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"KC_RESTART=; Version=1; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Max-Age=0; Path=/realms/dot/; Secure; HttpOnly"},{"key":"Set-Cookie","value":"KC_AUTH_STATE=; Version=1; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Max-Age=0; Path=/realms/dot/; Secure"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJhbGciOiJFUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIzY0RFUHA5MkFBXzVqbkZOTWpkMkNKQW9CY3JnUzI4N3NjUHhRblNNbkhBIn0.eyJleHAiOjE3MDczODQwMzIsImlhdCI6MTcwNzM4MzEzMiwianRpIjoiNWQ4YjYwZTYtYjM4Ni00OTFlLWIzNDMtNzVkNWY1MjEyYTdhIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay5zYW5kYm94LmRvdGJhbmsuYWZyaWNhL3JlYWxtcy9kb3QiLCJhdWQiOlsib3JuaXMiLCJhY2NvdW50Il0sInN1YiI6ImNhNzQ0ODIyLTJmYzgtNDRiMy04NTI0LTZkNjU2MzA0MTIxOCIsInR5cCI6IkJlYXJlciIsImF6cCI6ImNsZXZhIiwiYWNyIjoiMSIsInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJkZWZhdWx0LXJvbGVzLWRvdCIsIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iXX0sInJlc291cmNlX2FjY2VzcyI6eyJvcm5pcyI6eyJyb2xlcyI6WyJ2YWMiXX0sImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoiZW1haWwgcHJvZmlsZSIsImNsaWVudEhvc3QiOiIxOTIuMTY4LjE5Mi4xIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJzZXJ2aWNlLWFjY291bnQtY2xldmEiLCJjbGllbnRBZGRyZXNzIjoiMTkyLjE2OC4xOTIuMSIsImNsaWVudF9pZCI6ImNsZXZhIn0.0_7HYXaEXi2RL2Eb1igM_rDms9xZytw3ZGG2vi_Ik_-bMwLzhWtecozcHz0ESV8Hp7-B8MQ8qEGd4i5RA2rYyQ\",\n \"expires_in\": 900,\n \"refresh_expires_in\": 0,\n \"token_type\": \"Bearer\",\n \"not-before-policy\": 0,\n \"scope\": \"email profile\"\n}"}],"_postman_id":"d0011bd4-e0c0-4444-8619-71cde0d20d28"}],"id":"d5031aaf-d6f8-47ad-afeb-50cfbeb5f051","description":"Following the completion of the onboarding process, you will be required to authenticate your API calls by using your ClientID and ClientSecret obtained from your credential request to generate an Access Token required for you to successfully call the API.
\nThe Access Token is generated using the /oauth2/token endpoint
\n","_postman_id":"d5031aaf-d6f8-47ad-afeb-50cfbeb5f051","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"This resource allows you to retrievea credit transaction by the reference on the transaction.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"(Required) A unique reference for transaction status query
\n","type":"text/plain"},"type":"any","value":"This resource allows you to retrieve details of a single account number by passing in the externalId of the specific account.
(Required) A unique identifier of a user in the client's system or database
\n","type":"text/plain"},"type":"any","value":"This resource allows you to retrieve the pool/primary account.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"This resource allows you to retrieve all the accounts attached to your account. Pagination is required when using these resources.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"Business email address for correspondence
\n","type":"text/plain"},"key":"email","value":"Callback Url to which a transaction notice payload is pushed for every inward virtual account transaction
\n","type":"text/plain"},"key":"notificationUrl","value":"DOTMFB Virtual Account feature allows you to generate virtual bank accounts for your customers using the DOT API. These accounts facilitate seamless receipt of payments via bank transfers. You can create multiple virtual accounts tailored to your business needs, specifying bank name and account number.
\nIn this section, you'll find resources covering the creation and retrieval of accounts using the API. The virtual accounts type issued to your customers for payment is the;
\n- \n
- Fixed Virtual Account: This type remains operational at all times, enabling continuous payment collection for your business. \n
Transactions made through these accounts are settled in the primary or pool (merchant) account. It's important to note that these accounts do not maintain balances; they solely store transaction details. Balances are automatically transferred to your merchant account. Hence, settlements do not occur within these virtual accounts. All transactions (collections and transfers) are settled in your merchant account.
\nOwners cannot initiate transfers from these accounts; instead, a job sweeps the accounts to maintain a zero balance continuously.
\nThis API endpoint is used to submit a transfer request with the provided payload using a POST request.
\nResponse
\nThe response of this request can be documented as a JSON schema.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"This API endpoint makes an HTTP GET request to retrieve information about a transfer with the specified ID and reference. The response for this request is documented below as a JSON schema.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"transferId\": {\n \"type\": \"string\",\n \"description\": \"The ID of the transfer\"\n },\n \"reference\": {\n \"type\": \"string\",\n \"description\": \"The reference of the transfer\"\n },\n \"amount\": {\n \"type\": \"number\",\n \"description\": \"The amount of the transfer\"\n },\n \"status\": {\n \"type\": \"string\",\n \"description\": \"The status of the transfer\"\n },\n \"timestamp\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"description\": \"The timestamp of the transfer\"\n }\n }\n}\nInternally generated identifier (requestId) for the transaction that is returned during the transfer initiation
\n","type":"text/plain"},"key":"id","value":""},{"description":{"content":"Service provided transaction reference, the same used during the transfer initiation.
\n","type":"text/plain"},"key":"reference","value":""}],"variable":[]}},"response":[{"id":"b45bca89-5565-40c7-8048-9cf6dd539b8d","name":"success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://gateway.dotbank.africa/api/v1/ransfers/tsq?id=1&reference=test","host":["https://gateway.dotbank.africa"],"path":["api","v1","ransfers","tsq"],"query":[{"key":"id","value":"1"},{"key":"reference","value":"test"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": 0,\n \"receiptNumber\": \"string\",\n \"transactionRef\": \"string\",\n \"state\": \"RUNNING\", // [ RUNNING, SUCCEEDED, FAILED ]\n \"internalState\": \"INITIATED\", // [ \"INITIATED\", \"RUNNING\", \"APPROVED\", \"REJECTED\", \"SUCCEEDED\", \"FAILED\", \"RETRIED\", \"SUBMITTED\", \"PAUSED\", \"ERRORED\", \"CONFIRMING\", \"DEBITED\", \"CHARGED\" ],\n \"status\": \"APPROVED\", // [ APPROVED, UNKNOWN_STATUS, INVALID_SENDER, DO_NOT_HONOR, DORMANT_ACCOUNT, INVALID_ACCOUNT, ACCOUNT_NAME_MISMATCH, IN_PROGRESS, INVALID_TRANSACTION, INVALID_AMOUNT, INVALID_BATCH_NUMBER, INVALID_REFERENCE, UNKNOWN_BANK_CODE, INVALID_CHANNEL, WRONG_METHOD_CALL, NO_ACTION, RECORD_NOT_FOUND, DUPLICATE_RECORD, FORMAT_ERROR, UNSUCCESSFUL, SUSPECTED_FRAUD, CONTACT_BANK, INSUFFICIENT_FUNDS, SENDER_NOT_PERMITTED, CHANNEL_NOT_PERMITTED, LIMIT_EXCEEDED, SECURITY_VIOLATION, WITHDRAWAL_FREQUENCY_EXCEEDED, LATE_RESPONSE, FAILED_UNBLOCK, FAILED_BLOCK, EMPTY_MANDATE, BANK_NOT_AVAILABLE, ROUTING_ERROR, DUPLICATE_TXN, MALFUNCTION, TIMEOUT, CLIENT_DISABLED, NOT_FOUND, EXPIRED, EMPTY_VALUE, INVALID_VALUE, INVALID_DATA, NOT_PERMITTED, UNAUTHORIZED, PROCESSING_ERROR, MANDATE_MISMATCH, MANDATE_ACCOUNT_MISMATCH, NO_STATUS, INTERNAL_ERROR, RUNNING, INVALID_SESSION_ID, TOO_MANY_CONCURRENT_TRANSACTIONS ]\n \"statusMessage\": \"string\",\n \"lastUpdated\": \"2024-03-23T14:18:30.041Z\",\n \"transferFees\": 0,\n \"transactionAmount\": 0\n}"},{"id":"873d5b19-17cb-4de6-b3ea-5d1a9c3f5df9","name":"failed","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://gateway.dotbank.africa/api/v1/ransfers/tsq?id=1&reference=test","host":["https://gateway.dotbank.africa"],"path":["api","v1","ransfers","tsq"],"query":[{"key":"id","value":"1"},{"key":"reference","value":"test"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"400\",\n \"description\": \"string\",\n \"errors\": [\n {\n \"message\": \"string\",\n \"propertyName\": \"string\"\n }\n ]\n}"}],"_postman_id":"2a4188da-08ee-4156-a09a-b2a1ff4b629b"},{"name":"Retry a previously failed fund transfer","id":"3ae78534-0bd4-4aee-bfdd-6028ef77229d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://gateway.dotbank.africa/transfers/retry/{id}?id=","description":"This endpoint allows the user to retry a failed transfer by sending an HTTP PUT request to the specified URL. The {id} path parameter should be replaced with the ID of the transfer to be retried.
Response
\nThe response of this request is a JSON schema describing the structure of the response data. The schema will outline the properties and their data types that can be expected in the response from the API.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"Transaction request id
\n","type":"text/plain"},"key":"id","value":""}],"variable":[]}},"response":[{"id":"658c2d90-3879-46d5-90e7-0756f5d3fe76","name":"success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://gateway.dotbank.africa/api/v1/transfers/retry/{id}?id","host":["https://gateway.dotbank.africa"],"path":["api","v1","transfers","retry","{id}"],"query":[{"key":"id","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": 0,\n \"receiptNumber\": \"string\",\n \"transactionRef\": \"string\",\n \"state\": \"RUNNING\", // [ RUNNING, SUCCEEDED, FAILED ]\n \"internalState\": \"INITIATED\", // [ \"INITIATED\", \"RUNNING\", \"APPROVED\", \"REJECTED\", \"SUCCEEDED\", \"FAILED\", \"RETRIED\", \"SUBMITTED\", \"PAUSED\", \"ERRORED\", \"CONFIRMING\", \"DEBITED\", \"CHARGED\" ],\n \"status\": \"APPROVED\", // [ APPROVED, UNKNOWN_STATUS, INVALID_SENDER, DO_NOT_HONOR, DORMANT_ACCOUNT, INVALID_ACCOUNT, ACCOUNT_NAME_MISMATCH, IN_PROGRESS, INVALID_TRANSACTION, INVALID_AMOUNT, INVALID_BATCH_NUMBER, INVALID_REFERENCE, UNKNOWN_BANK_CODE, INVALID_CHANNEL, WRONG_METHOD_CALL, NO_ACTION, RECORD_NOT_FOUND, DUPLICATE_RECORD, FORMAT_ERROR, UNSUCCESSFUL, SUSPECTED_FRAUD, CONTACT_BANK, INSUFFICIENT_FUNDS, SENDER_NOT_PERMITTED, CHANNEL_NOT_PERMITTED, LIMIT_EXCEEDED, SECURITY_VIOLATION, WITHDRAWAL_FREQUENCY_EXCEEDED, LATE_RESPONSE, FAILED_UNBLOCK, FAILED_BLOCK, EMPTY_MANDATE, BANK_NOT_AVAILABLE, ROUTING_ERROR, DUPLICATE_TXN, MALFUNCTION, TIMEOUT, CLIENT_DISABLED, NOT_FOUND, EXPIRED, EMPTY_VALUE, INVALID_VALUE, INVALID_DATA, NOT_PERMITTED, UNAUTHORIZED, PROCESSING_ERROR, MANDATE_MISMATCH, MANDATE_ACCOUNT_MISMATCH, NO_STATUS, INTERNAL_ERROR, RUNNING, INVALID_SESSION_ID, TOO_MANY_CONCURRENT_TRANSACTIONS ]\n \"statusMessage\": \"string\",\n \"lastUpdated\": \"2024-03-23T19:05:27.795Z\",\n \"transferFees\": 0,\n \"transactionAmount\": 0\n}"}],"_postman_id":"3ae78534-0bd4-4aee-bfdd-6028ef77229d"}],"id":"339b1140-5208-46f3-a3de-ffda0c7b4fa2","description":"The DOT Transfer API provides a seamless and secure way for you or your users to initiate transfers from a DOT Account or any external account to any bank account in Nigeria. Whether you're sending funds to vendors, suppliers, or employees, this API simplifies the process, ensuring that transfers are executed efficiently and accurately.
\n","_postman_id":"339b1140-5208-46f3-a3de-ffda0c7b4fa2","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"This endpoint allows you to send an SMS.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"This endpoint returns the delivery status of the SMS
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"This endpoint retrieves the details of the integrator for the authenticated user.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"This endpoint retrieves all accounts of the integrator for the authenticated user.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"This endpoint makes an HTTP GET request to retrieve a list of banks from the API. The response will be a JSON array containing bank objects, where each object includes the following properties:
\n- \n
code(string): The code of the bank. \nname(string): The name of the bank. \ncategory(string): The category of the bank. \ncbnCode(string): The CBN code of the bank. \nlogo(string): The URL or path to the logo of the bank. \n
Here is an example of the response:
\n[\n {\n \"code\": \"\",\n \"name\": \"\",\n \"category\": \"\",\n \"cbnCode\": \"\",\n \"logo\": \"\"\n }\n]\nCustomer's banking account number
\n","type":"text/plain"},"key":"accountNo","value":"REQUIRED"},{"description":{"content":"NIP 6 digit banking code (required)
\n","type":"text/plain"},"key":"bankCode","value":"REQUIRED"},{"description":{"content":"Available values : TELLER, INTERNET_BANKING, MOBILE, POS, ATM, WEB, USSD, CORPORATE, SOCIAL_MEDIA, AGENCY_BANKING, VIRTUAL_ACCOUNT, THIRD_PARTY, OTHERS, NQR
\n","type":"text/plain"},"key":"channel","value":"OPTIONAL"}],"variable":[]}},"response":[{"id":"a6581e3f-9924-4beb-ba4f-c4662eececc5","name":"success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://gateway.dotbank.africa/api/v1/banking/account-info?accountNo=&bankCode=&channel","host":["https://gateway.dotbank.africa"],"path":["api","v1","banking","account-info"],"query":[{"key":"accountNo","value":"","description":"Customer's banking account number"},{"key":"bankCode","value":"","description":"NIP 6 digit banking code (required)"},{"key":"channel","value":null,"description":"Available values : TELLER, INTERNET_BANKING, MOBILE, POS, ATM, WEB, USSD, CORPORATE, SOCIAL_MEDIA, AGENCY_BANKING, VIRTUAL_ACCOUNT, THIRD_PARTY, OTHERS, NQR"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"accountName\": \"string\",\n \"accountNumber\": \"string\",\n \"bankCode\": \"string\",\n \"kycLevel\": \"1\",\n \"channel\": \"TELLER\",\n \"bankVerificationNumber\": \"string\"\n}"},{"id":"6e45247e-60e5-4d04-b14f-ad8bcf2e38b7","name":"failed (400)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://gateway.dotbank.africa/api/v1/banking/account-info?accountNo=&bankCode=&channel","host":["https://gateway.dotbank.africa"],"path":["api","v1","banking","account-info"],"query":[{"key":"accountNo","value":"","description":"Customer's banking account number"},{"key":"bankCode","value":"","description":"NIP 6 digit banking code (required)"},{"key":"channel","value":null,"description":"Available values : TELLER, INTERNET_BANKING, MOBILE, POS, ATM, WEB, USSD, CORPORATE, SOCIAL_MEDIA, AGENCY_BANKING, VIRTUAL_ACCOUNT, THIRD_PARTY, OTHERS, NQR"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"400\",\n \"description\": \"string\",\n \"errors\": [\n {\n \"message\": \"string\",\n \"propertyName\": \"string\"\n }\n ]\n}"},{"id":"07616a0a-dd36-42c1-a85e-2e1293dcb206","name":"failed (403)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://gateway.dotbank.africa/api/v1/banking/account-info?accountNo=&bankCode=&channel","host":["https://gateway.dotbank.africa"],"path":["api","v1","banking","account-info"],"query":[{"key":"accountNo","value":"","description":"Customer's banking account number"},{"key":"bankCode","value":"","description":"NIP 6 digit banking code (required)"},{"key":"channel","value":null,"description":"Available values : TELLER, INTERNET_BANKING, MOBILE, POS, ATM, WEB, USSD, CORPORATE, SOCIAL_MEDIA, AGENCY_BANKING, VIRTUAL_ACCOUNT, THIRD_PARTY, OTHERS, NQR"}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2024-03-23T19:19:04.125Z\",\n \"status\": 403,\n \"error\": \"Forbidden\",\n \"path\": \"/api/v1/banking/account-info\"\n}"}],"_postman_id":"81754710-40b4-433e-a8fb-4bc45b0f2c90"}],"id":"e7ed8cf0-5748-4ec7-9c4c-10928ced0a34","_postman_id":"e7ed8cf0-5748-4ec7-9c4c-10928ced0a34","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"Account id*
\n","type":"text/plain"},"key":"accountId","value":"DOT030269058"},{"disabled":true,"key":"merchantId","value":"OMNI1234_01"},{"disabled":true,"key":"transactionType","value":"DOT_SAVE"},{"disabled":true,"key":"transactionMode","value":"CREDIT"},{"disabled":true,"description":{"content":"dd/mm/yyyy format*
\n","type":"text/plain"},"key":"endDate","value":"01/09/2024"},{"disabled":true,"description":{"content":"dd/mm/yyyy format*
\n","type":"text/plain"},"key":"toDate","value":"17/09/2024"},{"key":"pageStart","value":"0"},{"key":"pageLength","value":"5"}],"variable":[]}},"response":[{"id":"2507efb9-e3b3-4fbc-8837-1d4c0aa7b248","name":"Paginated Response Data","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://localhost:8090/all?accountId=OMNI1234&merchantId=OMNI1234_01&transactionType=DOT_SAVE&transactionMode=CREDIT&endDate=01/09/2024&toDate=17/09/2024&pageStart=0&pageLength=5","protocol":"http","host":["localhost"],"port":"8090","path":["all"],"query":[{"key":"accountId","value":"OMNI1234","description":"Account id*"},{"key":"merchantId","value":"OMNI1234_01"},{"key":"transactionType","value":"DOT_SAVE"},{"key":"transactionMode","value":"CREDIT"},{"key":"endDate","value":"01/09/2024","description":"dd/mm/yyyy format*"},{"key":"toDate","value":"17/09/2024","description":"dd/mm/yyyy format*"},{"key":"pageStart","value":"0"},{"key":"pageLength","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Trace-Id","value":"5f23a6f3-f97a-4c8e-9184-dbbfdd6977ea"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 18 Sep 2024 13:45:48 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"transactionReference\": \"OMNI1234_011726576598005\",\n \"amount\": 100,\n \"accountId\": \"OMNI1234\",\n \"transactionType\": \"DOT_SAVE\",\n \"description\": \"test 2019\",\n \"createdBy\": \"OMNI1234_01\",\n \"createdAt\": \"2024-09-17T12:36:38.130180Z\",\n \"statusMessage\": \"SUCCESSFUL\",\n \"transactionMode\": \"CREDIT\",\n \"externalReference\": \"SAVTRF20240917920927280\"\n }\n ],\n \"pageable\": {\n \"sort\": {\n \"unsorted\": true,\n \"sorted\": false,\n \"empty\": true\n },\n \"offset\": 0,\n \"pageNumber\": 0,\n \"pageSize\": 5,\n \"paged\": true,\n \"unpaged\": false\n },\n \"last\": true,\n \"totalElements\": 1,\n \"totalPages\": 1,\n \"first\": true,\n \"size\": 5,\n \"number\": 0,\n \"sort\": {\n \"unsorted\": true,\n \"sorted\": false,\n \"empty\": true\n },\n \"numberOfElements\": 1,\n \"empty\": false\n}"}],"_postman_id":"bc28fd4c-c6cc-4df2-a7fb-ba45278062d2"},{"name":"User login","id":"928e5d48-906c-4293-80a0-6f88134f77d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\": \"DOT030269058\", //userId or email\n \"password\": \"Default1\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/v1/partner/dotsave/user/login","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"DOT SAVE API SERVICE
\nDot Save is a feature that allows users to have the flexibility to save money into their dot savings wallet and get interest accrual, daily, monthly or yearly.
\nThis service allows third parties to have seamless interaction with DotSave features through a tailored solution that includes an authentication layer for third-party integration.
\nYou can make use of this Dot Save API by easily clicking the Run in Postman button above. Postman is a free tool that helps developers run and debug API requests. Every endpoint documented here is readily available by running our Postman collection.
\nONBOARDING
\nTo get started with Dot Save, you need to be profiled as a PARTNER on the DOT payment platform for Authentication purposes. You will receive an account opening email.
\nYour Token would be used to login and access the dot save.
\nSUPPORT
\nOur DOT engineers are here to support you with any questions or technical needs you may have. Feel free to contact us at engineering@dot.ai for prompt assistance.
\nThe available stable endpoints for the latest version apis:
\n- \n
User login for Authentication
\n \nPerform a Savings on Dot Save
\n \nPerform a Withdrawal on Dot Save
\n \nFetch Single Dot Save Transaction
\n \nFetch Dot Save Transaction History
\n \n
This API endpoint is used to submit a transfer request with the provided payload using a POST request.
\nResponse
\nThe response of this request can be documented as a JSON schema.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"