This is the documentation for the 'v1' version of the Branch API. It includes the endpoints for login with card, get the accounts with permissions to deposit or withdraw, and the respective endpoints to deposit and withdraw.
To use any of these requests, you need the following variables
proxyDomain: This is the URL of the API.
\nbranchId: This is the ID of the ATM.
\nEach request provides you a requestId in the response. This ID can be used to track any issue related to the specified request.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"37852977","collectionId":"8d8cabf9-2f21-45f4-81fa-2b92b321377b","publishedId":"2sB34fnMCW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"242580"},"publishDate":"2025-07-11T18:13:34.000Z"},"item":[{"name":"Login","item":[{"name":"card","item":[{"name":"/login/card ☑️","event":[{"listen":"prerequest","script":{"id":"c15b77f1-ba68-4c96-89c6-64eeb78cdba6","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"5c689886-c3a0-4fd2-aeae-cf6faad9c2b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"card\": \"4811460000192093\",\n \"bin\": \"481146\",\n \"pin\": \"1234\",\n \"last4Digits\": \"2093\"\n}","options":{"raw":{"language":"json"}}},"url":"{{proxyDomain}}/login/card?branchId={{branchId}}","description":"Purpose:
This endpoint authenticates a user by verifying their card credentials and returns a session ID upon successful login. It is typically used for card-based login flows in branch or ATM systems.
Usage:
Send a POST request to {{proxyDomain}}/login/card with the required query parameter and headers. The request body must contain the card details in JSON format.
Required Header:
\nbranch-api-key: API key for the branch. Use the value from your environment variableQuery Parameter:
\nbranchId (required): The unique identifier for the branch. Use the value from your environment variable {{branchId}}.Request Body (JSON):
\n{\n \"card\": \"<string>\", // Card UUID or number\n \"bin\": \"<string>\", // Bank Identification Number\n \"pin\": \"<string>\", // Card PIN\n \"last4Digits\": \"<string>\" // Last 4 digits of the card\n}\n\nSuccessful Response:
\n{ \n \"requestId\": \"<string>\", \n \"data\": { \n \"sessionId\": \"<string>\" \n } \n}\n\nPurpose:
This endpoint generates a QR code for initiating a secure login flow. It is typically used by an ATM or kiosk to display a QR code that a user can scan with their mobile device to authenticate and log in without entering credentials on the ATM.
Request:
\nMethod: GET
\nURL: {{proxyDomain}}/login/qr?branchId={{branchId}}
Required Query Parameters:
\nbranchId (string): The unique identifier for the branch where the login is being initiated. This value is required.Required Headers:
\nbranch-api-key (string): API key for authenticating the request. This must be provided in the request headers.Response Overview:
\n200 OK), the response contains a sessionId and a qr field. The qr field is a base64-encoded image representing the QR code. The user scans this QR code to start the login process on their mobile device.QR Code Login Flow:
\nThe ATM requests a QR code by calling this endpoint.
\nThe server responds with a login URL encoded as a QR code.
\nThe user scans the QR code with their mobile device and submits their credentials.
\nThe ATM periodically checks if the user has logged in by polling a status endpoint.
\nOnce authenticated, the ATM receives an access token and grants access.
\nPurpose:
Retrieves the current authentication status for a QR-based login session at a branch. This endpoint is typically used by client applications to poll and determine if a user has completed authentication via QR code.
Request URL:GET {{proxyDomain}}/login/qr/status/{{branchSessionId}}
Required Headers:
\nbranch-api-key: API key required for authentication and authorization.URL Variables:
\nproxyDomain: The base domain for the API
branchSessionId: Unique identifier for the QR login session whose status is being checked.
Expected Response:
\nStatus Code: 200 OK (on success)
\nBody Example:
\n {\n \"requestId\": \"41caacc3-203b-4931-bb92-f926167bc8a3\",\n \"data\": {\n \"status\": \"authenticated\",\n \"token\": \"<session_token>\"\n }\n }\n\nstatus can indicate states such as accessDenied, authenticated, or failed.
If authenticated, a token is provided for subsequent authenticated requests.
Use this endpoint to check if a user has successfully authenticated via QR code at a branch location.
\n","urlObject":{"path":["login","qr","status","{{branchSessionId}}"],"host":["{{proxyDomain}}"],"query":[],"variable":[]}},"response":[{"id":"64d5321e-40ea-435b-82df-5ca022823c6e","name":"/login/qr/status","originalRequest":{"method":"GET","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"url":"{{proxyDomain}}/login/qr/status/{{branchSessionId}}"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"requestId\": \"Purpose:
This endpoint generates a QR code for continuing a secure dual login flow.
Dual Auth Login Flow:
\nThe ATM requests a QR code by calling /login/qr.
\nThe server responds with a login URL encoded as a QR code.
\nThe user scans the QR code with their mobile device and submits their credentials.
\nThe ATM periodically checks if the user has logged in by polling a status endpoint.
\nOnce authenticated, the ATM receives a session token and grants access.
\nThe ATM reuqests a QR code by calling /atm/dualAuth
\nThe server responds with a login URL encoded as a QR code.
\nThe user scans the QR code with their mobile device and submits their credentials.
\nThe ATM periodically checks if the user has logged in by polling a status endpoint.
\nOnce authenticated, the ATM receives a session token and grants access.
\nThe dual flow can be complete with the session token of the step 5.
\nThis endpoint generates a QR code that enables members to authenticate via their mobile devices in a QR code-based login flow. The QR code contains a login URL that, when scanned, allows users to complete authentication on their phone while the ATM or client application polls for login status.
\nGET {{proxyDomain}}/login/qr/member
{\n \"requestId\": \"9972b228-b6cb-4179-af71-238221a482f5\",\n \"data\": {\n \"sessionId\": \"8cd11535-f765-4596-852c-336a764b8e0a\",\n \"qr\": \"data:image/png;base64,iVBORw0KGgoAAAANSU...\"\n }\n}\n\nResponse Fields:
\nrequestId (string): Unique identifier for this API request, useful for tracking and debugging
data.sessionId (string): Unique session identifier that should be used when polling the login status endpoint to check if the user has completed authentication
data.qr (string): Base64-encoded PNG image data of the QR code. This can be directly displayed in an tag or rendered on a device screen. The QR code contains the login URL that users will scan with their mobile device.
Generate QR Code: Call this endpoint to generate a new QR code and receive a sessionId
Display QR Code: Render the base64-encoded QR image on the ATM screen or client application
\nUser Scans: The user scans the QR code with their mobile device, which opens the login URL
\nUser Authenticates: The user enters their credentials on their mobile device and submits
\nPoll for Status: The ATM/client continuously polls the /login/qr/status endpoint using the sessionId to check if authentication is complete
Receive Token: Once authenticated, the polling endpoint returns an access token
\nThe QR code image is returned as a data URI with base64 encoding, making it ready for immediate display
\nStore the sessionId from the response to use in subsequent status polling requests
The QR code typically contains a URL that directs users to a mobile-friendly login page
\nConsider implementing a timeout mechanism for QR codes (e.g., 5 minutes) after which a new QR code should be generated
\nThis endpoint checks the current status of a QR code login session for a member. It is designed to be polled by the ATM after displaying a QR code to determine whether the user has completed authentication on their mobile device.
\nMethod: GET
Path: {{proxyDomain}}/login/qr/member/status/{{branchSessionId}}
branch-api-key - API key for authentication with the Branch servicebranchSessionId - The unique session identifier returned from the initial QR code generation endpoint. This ID links the ATM's polling request to the specific QR code authentication session.The endpoint returns a JSON object with the following structure:
\n{\n \"requestId\": \"string\",\n \"data\": {\n \"status\": \"string\"\n }\n}\n\nThe status field in the response can have the following values:
expired - The QR code session has timed out and is no longer valid
authenticated - The user has successfully authenticated on their phone
\nDisplay QR Code: The ATM first generates a QR code using the QR code generation endpoint
\nStart Polling: The ATM begins polling this status endpoint at regular intervals
\nCheck Status: Continue polling until the status changes from pending to one of the terminal states (authenticated or expired)
Handle Response:
\nIf authenticated: Proceed with the authenticated session (access token should be available)
If expired: Display appropriate error message and allow user to retry
This API endpoint retrieves a list of accounts that have permissions to deposit funds based on the provided authentication token.
\nThe purpose of this request is to allow users to access account information relevant to deposit permissions, filtered by a specific branch ID.
\nMethod: GET
\nEndpoint: {{proxyDomain}}/deposit/accounts
Query Parameters:
\nbranchId (required): The identifier for the branch from which to retrieve the accounts.The response will contain a JSON object with the following structure:
\nrequestId: A unique identifier for the request (string).
data (array): A list of account objects that have deposit permissions.
Each account object may include details such as:
\naccountId: The unique identifier for the account (integer).
accountName: The name associated with the account (string).
accountNumber: The account number (string).
type: The type of account (string).
balance: The current balance of the account (integer).
{\n \"requestId\": \"\",\n \"data\": [\n {\n \"accountId\": 110000,\n \"accountName\": \"John Doe Savings\",\n \"accountNumber\": \" 1230326 00\",\n \"type\": \"1\",\n \"balance\": 1500.33\n },\n {\n \"accountId\": 110001,\n \"accountName\": \"Jane Doe Checking\",\n \"accountNumber\": \" 1230326 06\",\n \"type\": \"2\",\n \"balance\": 2500.01\n }\n ]\n}\n\nEnsure that the request includes a valid authentication token to access the account data.
\nReturns the list of accounts that have permissions to deposit based on the provided branch ID.
\n","urlObject":{"path":["deposit","accounts"],"host":["{{proxyDomain}}"],"query":[{"key":"branchId","value":"{{branchId}}"}],"variable":[]}},"response":[{"id":"0a644575-cb3e-49a7-a62d-a162ac1b004f","name":"/deposit/accounts ☑️","originalRequest":{"method":"GET","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"url":{"raw":"{{proxyDomain}}/deposit/accounts?branchId={{branchId}}","host":["{{proxyDomain}}"],"path":["deposit","accounts"],"query":[{"key":"branchId","value":"{{branchId}}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"requestId\": \"c5c97a9a-322b-4baf-81c2-cdb513516da8\",\n \"data\": [\n {\n \"accountId\": 89791,\n \"accountName\": \"SAVINGS\",\n \"accountNumber\": \" 1230321 00\",\n \"type\": \"1\",\n \"balance\": 4286.33\n },\n {\n \"accountId\": 101987,\n \"accountName\": \"FREE CHECK\",\n \"accountNumber\": \" 1230326 00\",\n \"type\": \"6\",\n \"balance\": 1887.86\n },\n {\n \"accountId\": 101988,\n \"accountName\": \"HELOC CHEC\",\n \"accountNumber\": \" 1230326 01\",\n \"type\": \"6\",\n \"balance\": 460\n }\n ]\n}"}],"_postman_id":"df5c0365-a2fe-46c1-a6d6-1bd4fcab9829"},{"name":"/deposit ☑️","id":"c61aa14f-b6eb-4b0e-a16a-bcf2c8a4d92e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionId}}"}]},"isInherited":false},"method":"POST","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"account\": {\n \"accountId\": 259631,\n \"accountNumber\": \"999999901 00\"\n },\n \"currentBills\": {\n \"recycler\": {\n \"100\": 920,\n \"50\": 920,\n \"20\": 920,\n \"10\": 920,\n \"5\": 920,\n \"1\": 920,\n \"totalAmount\": 171120,\n \"totalQuantity\": 5520\n },\n \"deposit\": {\n \"100\": 20,\n \"50\": 20,\n \"20\": 20,\n \"10\": 20,\n \"5\": 20,\n \"1\": 20,\n \"totalAmount\": 3500,\n \"totalQuantity\": 120\n },\n \"rejected\": {\n \"totalQuantity\": 30\n }\n },\n \"bills\": {\n \"10\": {\n \"quantity\": 1,\n \"serialNumbers\": [\n \"L02001932A\"\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{proxyDomain}}/deposit?branchId={{branchId}}","description":"This HTTP POST request is used to initiate a deposit transaction for a specific account at a designated branch. The request is sent to the endpoint {{proxyDomain}}/deposit?branchId={{branchId}}, where branchId identifies the branch where the transaction is being processed.
The primary purpose of this request is to deposit a specified amount into a designated account. It ensures that only authorized users can perform this operation based on their authentication token.
\nThe request body must be in JSON format and should include the following parameters:
\namount (number): The amount of money to be deposited.
\naccount (object): An object containing account details.
\naccountId (number): The unique identifier for the account.
\naccountNumber (string): The number associated with the account, which may include leading or trailing spaces.
\n{\n \"amount\": 100,\n \"account\": {\n \"accountId\": 101987,\n \"accountNumber\": \" 1230326 00\"\n }\n}\n\nThe response will typically include confirmation of the transaction, along with any relevant details about the deposit, such as:
\nTransaction ID
\nUpdated account balance
\nStatus of the transaction
\nExample Response:
\n{\n \"requestId\": \"\",\n \"data\": {\n \"cashIn\": \"20.0\",\n \"newBalance\": \"440.0\"\n }\n}\n\nEnsure that the request is properly authenticated and that the account has sufficient funds to complete the transaction.
\nEnsure that the request is properly authenticated to receive a valid response.
\nReturns the list of accounts who has permissions to deposit based on the auth token
\n","urlObject":{"path":["deposit"],"host":["{{proxyDomain}}"],"query":[{"key":"branchId","value":"{{branchId}}"}],"variable":[]}},"response":[{"id":"e10a1660-235e-421b-b252-af8b8e45fc83","name":"/deposit ☑️","originalRequest":{"method":"POST","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 100,\n \"account\": {\n \"accountId\": 101987,\n \"accountNumber\": \" 1230326 00\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{proxyDomain}}/deposit?branchId={{branchId}}","host":["{{proxyDomain}}"],"path":["deposit"],"query":[{"key":"branchId","value":"{{branchId}}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"requestId\": \"3c6dd9f4-ea2d-4b52-b75c-b4de593d3de3\",\n \"data\": {\n \"cashIn\": \"100.0\",\n \"newBalance\": \"1987.86\"\n }\n}"},{"id":"7ac43e05-2bf5-4863-89cd-917380f7be4d","name":"/deposit with bills tracking","originalRequest":{"method":"POST","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"account\": {\n \"accountId\": 259631,\n \"accountNumber\": \"999999901 00\"\n },\n \"currentBills\": {\n \"recycler\": {\n \"100\": 920,\n \"50\": 920,\n \"20\": 920,\n \"10\": 920,\n \"5\": 920,\n \"1\": 920,\n \"totalAmount\": 171120,\n \"totalQuantity\": 5520\n },\n \"deposit\": {\n \"100\": 20,\n \"50\": 20,\n \"20\": 20,\n \"10\": 20,\n \"5\": 20,\n \"1\": 20,\n \"totalAmount\": 3500,\n \"totalQuantity\": 120\n },\n \"rejected\": {\n \"totalQuantity\": 30\n }\n },\n \"bills\": {\n \"10\": {\n \"quantity\": 1,\n \"serialNumbers\": [\n \"L02001932A\"\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{proxyDomain}}/deposit?branchId={{branchId}}","host":["{{proxyDomain}}"],"path":["deposit"],"query":[{"key":"branchId","value":"{{branchId}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":null,"header":[{"key":":status","value":201},{"key":"date","value":"Thu, 09 Apr 2026 13:37:57 GMT"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"128"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"cross-origin-resource-policy","value":"same-origin"},{"key":"origin-agent-cluster","value":"?1"},{"key":"referrer-policy","value":"no-referrer"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"x-download-options","value":"noopen"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-xss-protection","value":"0"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-allow-credentials","value":"true"},{"key":"x-request-id","value":"9633d404-3435-496b-88e1-0d0bb67d8956"},{"key":"x-powered-by","value":"Express"},{"key":"vary","value":"Origin"},{"key":"etag","value":"W/\"80-Ci+V+gwctoArFGdqbKEQ3t7ZDaE\""}],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"9633d404-3435-496b-88e1-0d0bb67d8956\",\n \"data\": {\n \"cashIn\": \"5.60\",\n \"newBalance\": \"6182.29\",\n \"transactionId\": \"267356865\"\n }\n}"},{"id":"0dfc174e-a0ff-4cb5-aedc-a4897e1bc58b","name":"/deposit with bills tracking only cassettes","originalRequest":{"method":"POST","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"account\": {\n \"accountId\": 259631,\n \"accountNumber\": \"999999901 00\"\n },\n \"currentBills\": {\n \"recycler\": {\n \"100\": 920,\n \"50\": 920,\n \"20\": 920,\n \"10\": 920,\n \"5\": 920,\n \"1\": 920,\n \"totalAmount\": 171120,\n \"totalQuantity\": 5520\n },\n \"deposit\": {\n \"100\": 20,\n \"50\": 20,\n \"20\": 20,\n \"10\": 20,\n \"5\": 20,\n \"1\": 20,\n \"totalAmount\": 3500,\n \"totalQuantity\": 120\n },\n \"rejected\": {\n \"totalQuantity\": 30\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{proxyDomain}}/deposit?branchId={{branchId}}","host":["{{proxyDomain}}"],"path":["deposit"],"query":[{"key":"branchId","value":"{{branchId}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":null,"header":[{"key":":status","value":201},{"key":"date","value":"Thu, 09 Apr 2026 13:37:57 GMT"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"128"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"cross-origin-resource-policy","value":"same-origin"},{"key":"origin-agent-cluster","value":"?1"},{"key":"referrer-policy","value":"no-referrer"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"x-download-options","value":"noopen"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-xss-protection","value":"0"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-allow-credentials","value":"true"},{"key":"x-request-id","value":"9633d404-3435-496b-88e1-0d0bb67d8956"},{"key":"x-powered-by","value":"Express"},{"key":"vary","value":"Origin"},{"key":"etag","value":"W/\"80-Ci+V+gwctoArFGdqbKEQ3t7ZDaE\""}],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"9633d404-3435-496b-88e1-0d0bb67d8956\",\n \"data\": {\n \"cashIn\": \"5.60\",\n \"newBalance\": \"6182.29\",\n \"transactionId\": \"267356865\"\n }\n}"},{"id":"57d26e33-734d-4c42-894c-66a5b7b5c242","name":"/deposit with bills tracking only recycling details","originalRequest":{"method":"POST","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"account\": {\n \"accountId\": 259631,\n \"accountNumber\": \"999999901 00\"\n },\n \"currentBills\": {\n \"recycler\": {\n \"100\": 920,\n \"50\": 920,\n \"20\": 920,\n \"10\": 920,\n \"5\": 920,\n \"1\": 920,\n \"totalAmount\": 171120,\n \"totalQuantity\": 5520\n },\n \"deposit\": {\n \"totalAmount\": 3500,\n \"totalQuantity\": 120\n },\n \"rejected\": {\n \"totalQuantity\": 30\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{proxyDomain}}/deposit?branchId={{branchId}}","host":["{{proxyDomain}}"],"path":["deposit"],"query":[{"key":"branchId","value":"{{branchId}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":null,"header":[{"key":":status","value":201},{"key":"date","value":"Thu, 09 Apr 2026 13:37:57 GMT"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"128"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"cross-origin-resource-policy","value":"same-origin"},{"key":"origin-agent-cluster","value":"?1"},{"key":"referrer-policy","value":"no-referrer"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"x-download-options","value":"noopen"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-xss-protection","value":"0"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-allow-credentials","value":"true"},{"key":"x-request-id","value":"9633d404-3435-496b-88e1-0d0bb67d8956"},{"key":"x-powered-by","value":"Express"},{"key":"vary","value":"Origin"},{"key":"etag","value":"W/\"80-Ci+V+gwctoArFGdqbKEQ3t7ZDaE\""}],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"9633d404-3435-496b-88e1-0d0bb67d8956\",\n \"data\": {\n \"cashIn\": \"5.60\",\n \"newBalance\": \"6182.29\",\n \"transactionId\": \"267356865\"\n }\n}"}],"_postman_id":"c61aa14f-b6eb-4b0e-a16a-bcf2c8a4d92e"},{"name":"/deposit fee","id":"b96487d4-b835-4bbf-b525-70f1ec9d23d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionId}}"}]},"isInherited":false},"method":"POST","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"account\": {\n \"accountId\": 259631,\n \"accountNumber\": \"999999901 00\"\n }\n // ,\n // \"metadata\": { // optional\n // \"mockData\": {\n // \"channel\": \"external\" \n // }\n // } \n}","options":{"raw":{"language":"json"}}},"url":"{{proxyDomain}}/deposit/fee?branchId={{branchId}}","description":"This HTTP POST request is used to retrieve the deposit fee associated with a specific account. The request is made to the endpoint {{proxyDomain}}/deposit/fee, and it requires a query parameter branchId to specify the branch for which the fee is being requested.
The request must include a JSON payload in the following format:
\n{\n \"account\": {\n \"accountId\": <integer>, // The unique identifier for the account\n \"accountNumber\": <string> // The account number associated with the account\n }\n}\n\naccountId: A unique integer identifier for the account.
\naccountNumber: A string representing the account number, which may include leading or trailing spaces.
\nUpon a successful request, the server responds with a 201 Created status code and a JSON object containing the following structure:
{\n \"requestId\": \"\", // A unique identifier for the request \n \"data\": {\n \"fee\": <integer> // The deposit fee amount associated with the account\n }\n}\n\nrequestId: A string that uniquely identifies the request.
\ndata: An object containing the fee information.
\nThis request is essential for users to determine the fees associated with depositing to their accounts based on the specified branch and account details.
\n","urlObject":{"path":["deposit","fee"],"host":["{{proxyDomain}}"],"query":[{"key":"branchId","value":"{{branchId}}"}],"variable":[]}},"response":[{"id":"9ae4f9b0-43c7-47a4-bd4a-b9064ba846c0","name":"/deposit fee","originalRequest":{"method":"POST","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"account\": {\n \"accountId\": 89791,\n \"accountNumber\": \" 1230321 00\"\n }\n \n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{proxyDomain}}/deposit/fee?branchId={{branchId}}","host":["{{proxyDomain}}"],"path":["deposit","fee"],"query":[{"key":"branchId","value":"{{branchId}}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"\",\n \"data\": {\n \"fee\": 0\n }\n}"}],"_postman_id":"b96487d4-b835-4bbf-b525-70f1ec9d23d4"}],"id":"4a33221d-4d4d-463a-9503-86190e55e28d","_postman_id":"4a33221d-4d4d-463a-9503-86190e55e28d","description":""},{"name":"Withdraw","item":[{"name":"/withdraw ☑️","event":[{"listen":"prerequest","script":{"id":"bfa472fd-ca2a-4667-a961-935ecf9c5c71","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"2f086a6f-4bce-4c90-8aa8-482649a016b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionId}}"}]},"isInherited":false},"method":"POST","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 20,\n \"account\": {\n \"accountId\": 259631,\n \"accountNumber\": \"999999901 00\"\n },\n \"currentBills\": {\n \"recycler\": {\n \"100\": 920,\n \"50\": 920,\n \"20\": 920,\n \"10\": 920,\n \"5\": 920,\n \"1\": 920,\n \"totalAmount\": 171120,\n \"totalQuantity\": 5520\n },\n \"deposit\": {\n \"100\": 20,\n \"50\": 20,\n \"20\": 20,\n \"10\": 20,\n \"5\": 20,\n \"1\": 20,\n \"totalAmount\": 3500,\n \"totalQuantity\": 120\n },\n \"rejected\": {\n \"totalQuantity\": 30\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{proxyDomain}}/withdraw?branchId={{branchId}}","description":"This request is used to withdraw a specified amount of funds from a designated account at a particular branch. It is essential for managing account transactions securely.
\nMethod: POST
\nURL: {{proxyDomain}}/withdraw?branchId={{branchId}}
The request body must be in JSON format and should contain the following parameters:
\namount (integer): The amount of money to withdraw.
\naccount (object): An object containing account details.
\naccountId (integer): The unique identifier for the account from which funds will be withdrawn.
\naccountNumber (string): The account number associated with the account.
\nExample Request Body:
\n{\n \"amount\": 20,\n \"account\": {\n \"accountId\": 101988,\n \"accountNumber\": \"1230326 01\"\n }\n}\n\nThe response will typically include confirmation of the withdrawal transaction, along with any relevant details regarding the status of the account after the transaction has been processed. The structure of the response will generally include:
\nrequestId (string): A unique identifier for the withdrawal request.
\ndata (object): An object containing the following properties:
\ncashOut (string): Details about the cash withdrawn, if applicable.
\nnewBalance (string): The new balance of the account after the withdrawal.
\nExample Response:
\n{\n \"requestId\": \"\",\n \"data\": {\n \"cashOut\": \"20.0\",\n \"newBalance\": \"440.0\"\n }\n}\n\nEnsure that the request is properly authenticated and that the account has sufficient funds to complete the transaction.
\n","urlObject":{"path":["withdraw"],"host":["{{proxyDomain}}"],"query":[{"key":"branchId","value":"{{branchId}}"}],"variable":[]}},"response":[{"id":"4334d5f1-9211-469e-82b8-5b9e00eea74e","name":"/withdraw ☑️","originalRequest":{"method":"POST","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 20,\n \"account\": {\n \"accountId\": 101988,\n \"accountNumber\": \" 1230326 01\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{proxyDomain}}/withdraw?branchId={{branchId}}","host":["{{proxyDomain}}"],"path":["withdraw"],"query":[{"key":"branchId","value":"{{branchId}}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"requestId\": \"dfa76ce3-4446-4977-bd82-9441e02579b1\",\n \"data\": {\n \"cashOut\": \"20.0\",\n \"newBalance\": \"440.0\"\n }\n}"},{"id":"0b40dff2-8ebf-46ac-b733-1c0ac35c124a","name":"/withdraw with bills tracking","originalRequest":{"method":"POST","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 20,\n \"account\": {\n \"accountId\": 259631,\n \"accountNumber\": \"999999901 00\"\n },\n \"currentBills\": {\n \"recycler\": {\n \"100\": 920,\n \"50\": 920,\n \"20\": 920,\n \"10\": 920,\n \"5\": 920,\n \"1\": 920,\n \"totalAmount\": 171120,\n \"totalQuantity\": 5520\n },\n \"deposit\": {\n \"100\": 20,\n \"50\": 20,\n \"20\": 20,\n \"10\": 20,\n \"5\": 20,\n \"1\": 20,\n \"totalAmount\": 3500,\n \"totalQuantity\": 120\n },\n \"rejected\": {\n \"totalQuantity\": 30\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{proxyDomain}}/withdraw?branchId={{branchId}}","host":["{{proxyDomain}}"],"path":["withdraw"],"query":[{"key":"branchId","value":"{{branchId}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":null,"header":[{"key":":status","value":201},{"key":"date","value":"Thu, 09 Apr 2026 13:43:33 GMT"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"130"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"cross-origin-resource-policy","value":"same-origin"},{"key":"origin-agent-cluster","value":"?1"},{"key":"referrer-policy","value":"no-referrer"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"x-download-options","value":"noopen"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-xss-protection","value":"0"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-allow-credentials","value":"true"},{"key":"x-request-id","value":"8aff1195-fc11-4d76-8ef0-4c85e191d7c0"},{"key":"x-powered-by","value":"Express"},{"key":"vary","value":"Origin"},{"key":"etag","value":"W/\"82-n0oWXbiJtVtKl7/qji5SW/iOoew\""}],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"8aff1195-fc11-4d76-8ef0-4c85e191d7c0\",\n \"data\": {\n \"cashOut\": \"20.00\",\n \"newBalance\": \"6162.29\",\n \"transactionId\": \"267356869\"\n }\n}"}],"_postman_id":"2f086a6f-4bce-4c90-8aa8-482649a016b9"},{"name":"withdrawal/validate ☑️","event":[{"listen":"prerequest","script":{"id":"e9d2143e-45d5-45e6-9d7b-2c6901ec1dfb","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"ff37fe51-ef07-47aa-b151-9cd319bce314","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionId}}"}]},"isInherited":false},"method":"POST","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 200,\n \"account\": {\n \"accountId\": 101987,\n \"accountNumber\": \" 1230326 00\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{proxyDomain}}/withdraw/validate?branchId={{branchId}}","description":"This endpoint is used to validate a withdrawal request for a specific account at a designated branch. It checks if the withdrawal can be processed based on the provided amount and account details.
\nThe purpose of this request is to determine whether a specified withdrawal can be executed for a given account. This is essential for ensuring that transactions are processed correctly and that accounts have sufficient funds for the requested withdrawal.
\nMethod: POST
\nURL: {{proxyDomain}}/withdraw/validate?branchId={{branchId}}
The request body must be in JSON format and should include the following parameters:
\namount (number): The amount of money to be withdrawn.
\naccount (object): An object containing the account details.
\naccountId (number): The unique identifier for the account.
\naccountNumber (string): The number associated with the account.
\nExample Request Body:
\n{\n \"amount\": 200,\n \"account\": {\n \"accountId\": 101987,\n \"accountNumber\": \"1230326 00\"\n }\n}\n\nThe response will provide information regarding the validation of the withdrawal request. The structure of the response may include:
\nrequestId (string): A unique identifier for the request.
\ndata (object): Contains additional information regarding the validation.
\nmessage (string): A detailed message explaining the result of the validation.
\nbody (object): An object that includes:
\nExample Response:
\n{\n \"requestId\": \"\",\n \"data\": {\n \"message\": \"Can do transaction.\",\n \"body\": {\n \"canDoTransaction\": true\n }\n }\n}\n\nEnsure to handle the response appropriately based on the status returned.
\n","urlObject":{"path":["withdraw","validate"],"host":["{{proxyDomain}}"],"query":[{"key":"branchId","value":"{{branchId}}"}],"variable":[]}},"response":[{"id":"8e21df76-f227-4b22-8ec3-969bbb6658e0","name":"withdrawal/validate ☑️","originalRequest":{"method":"POST","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 200,\n \"account\": {\n \"accountId\": 101987,\n \"accountNumber\": \" 1230326 00\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{proxyDomain}}/withdraw/validate?branchId={{branchId}}","host":["{{proxyDomain}}"],"path":["withdraw","validate"],"query":[{"key":"branchId","value":"{{branchId}}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"requestId\": \"5d619d73-039b-443b-922f-47df4caa1712\",\n \"data\": {\n \"message\": \"Can do transaction.\",\n \"body\": {\n \"canDoTransaction\": true\n }\n }\n}"}],"_postman_id":"ff37fe51-ef07-47aa-b151-9cd319bce314"},{"name":"/withdraw/accounts ☑️","event":[{"listen":"prerequest","script":{"id":"140838da-9e4a-4818-be5c-144b9498576e","exec":["/* ","Criterias of evaluation","","1. Withdrawal brake if idfi no exist on tables [ ✅ log , ✅ error expected ].","2. Withdrawal brake if idfi is null [ ✅ log , ✅ error expected ].","3. Withdrawal brake if wrong route at Car by card endpoint [ ✅ log , ✅ error expected ].",""," */","/* const sessionId = '1d7ccf41-2cd5-4db3-b91e-c06b32f24919'; // DEV */","/* const sessionId = '55d628cc-57f4-4537-a06a-b8e488f55e67'; // ALPHA */","/*const sessionId = 'f0bc02d4-7931-460e-abbc-2eb153801494'; // DEV */","","","",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"c31b6e4b-921c-430d-8cbb-091a0fc7730e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionId}}"}]},"isInherited":false},"method":"GET","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"url":"{{proxyDomain}}/withdraw/accounts?branchId={{branchId}}","description":"This HTTP GET request retrieves a list of accounts that have permissions to withdraw funds based on the provided branch identifier.
\nThe main purpose of this request is to allow authorized users to view accounts associated with a specific branch that are permitted to perform withdrawal operations.
\nURL: {{proxyDomain}}/withdraw/accounts
Query Parameters:
\nbranchId (required): The unique identifier of the branch for which the accounts are being queried.The response will contain a list of accounts with the following structure:
\nrequestId: A unique identifier for the request.
data: An array of account objects, each containing:
accountId: The unique identifier for the account.
accountName: The name associated with the account.
accountNumber: The account number.
type: The type of account.
balance: The current balance of the account.
Make sure to include a valid authentication token in the request headers to authorize access to this endpoint.
\n{\n \"requestId\": \"\",\n \"data\": [\n {\n \"accountId\": 110000,\n \"accountName\": \"John Doe Savings\",\n \"accountNumber\": \" 1230326 00\",\n \"type\": \"1\",\n \"balance\": 1500.33\n },\n {\n \"accountId\": 110001,\n \"accountName\": \"Jane Doe Checking\",\n \"accountNumber\": \" 1230326 06\",\n \"type\": \"2\",\n \"balance\": 2500.01\n }\n ]\n}\n\nThis endpoint allows users to calculate the withdrawal fee associated with a specific account and amount. The fee is determined based on the provided parameters and is returned in the response.
\nMethod: POST
URL: {{proxyDomain}}/withdraw/fee?branchId={{branchId}}
The request body must be in JSON format and should contain the following parameters:
\namount (integer, required): The amount for which the withdrawal fee is being calculated.
\naccount (object, required): An object containing account details.
\naccountId (integer, required): The unique identifier for the account.
\naccountNumber (string, required): The account number associated with the account.
\nExample Request Body:
\n{\n \"account\": {\n \"accountId\": <integer>, // The unique identifier for the account\n \"accountNumber\": <string> // The account number associated with the account\n }\n}\n\nThe response will be returned in JSON format with the following structure:
\nrequestId (string): A unique identifier for the request (may be empty).
\ndata (object): Contains the calculated fee information.
\nExample Response:
\n{\n \"requestId\": \"\", // A unique identifier for the request \n \"data\": {\n \"fee\": <integer> // The deposit fee amount associated with the account\n }\n}\n\nThis API endpoint is used to retrieve the reversal details of a withdrawal transaction. It allows users to check the status of a specific withdrawal reversal based on the provided branch ID.
\nStatus: 200 OK
\nContent-Type: application/json
\nResponse Body:
\nrequestId: A unique identifier for the request.
\ndata: An object containing:
\ncashIn: The amount of cash that was reversed.
\nnewBalance: The updated balance after the reversal.
\ntransactionId: The identifier for the transaction related to the reversal.
\nThis endpoint is essential for tracking the status and details of withdrawal reversals in the system.
\n","urlObject":{"path":["withdraw","reversal"],"host":["{{proxyDomain}}"],"query":[{"key":"branchId","value":"{{branchId}}"}],"variable":[]}},"response":[{"id":"6de6276d-f60e-488f-9109-822861332cf4","name":"/withdraw/reversal ☑️","originalRequest":{"method":"GET","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"url":{"raw":"{{proxyDomain}}/withdraw/reversal?branchId={{branchId}}","host":["{{proxyDomain}}"],"path":["withdraw","reversal"],"query":[{"key":"branchId","value":"{{branchId}}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"requestId\": \"\",\n \"data\": {\n \"cashIn\": \"20.0\",\n \"newBalance\": \"1755.0\",\n \"transactionId\": \"267336801\"\n }\n}"}],"_postman_id":"261ceb56-4ea2-4e62-b45d-93a07be2499b"}],"id":"def33035-eb31-46ab-808c-651c4c76c9bb","_postman_id":"def33035-eb31-46ab-808c-651c4c76c9bb","description":""},{"name":"Balance","item":[{"name":"balance","id":"2246dd2e-8b2e-497b-83cb-4d1aa3babb8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionId}}"}]},"isInherited":false},"method":"GET","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"url":"{{proxyDomain}}/balance?branchId={{branchId}}","description":"This endpoint retrieves account balance information for a specific branch. It returns detailed balance data for all accounts associated with the branch, including savings and checking accounts.
\nMethod: GET
Endpoint: {{proxyDomain}}/balance
branch-api-key: Authentication key for branch API accessbranchId (required): The unique identifier for the branch whose account balances you want to retrieveThe endpoint returns a successful response with status code 200 containing account balance information.
{\n \"requestId\": \"string\",\n \"data\": [\n {\n \"accountId\": number,\n \"accountName\": \"string\",\n \"accountType\": \"string\",\n \"availableBalance\": number,\n \"currentBalance\": number,\n \"accountNumber\": \"string\",\n \"accountNumberMasked\": \"string\"\n }\n ]\n}\n\nrequestId: Unique identifier for the API request
data: Array of account objects containing:
accountId: Unique identifier for the account
accountName: Display name of the account (e.g., \"SAVINGS\", \"CHECKING\")
accountType: Type of account (e.g., \"SAVINGS\", \"CHECKING\")
availableBalance: Available balance that can be withdrawn
currentBalance: Current total balance in the account
accountNumber: Full account number
accountNumberMasked: Masked version of the account number for display purposes
{\n \"requestId\": \"55f4a14a-c992-47a6-a5d5-665bd5d70fe4\",\n \"data\": [\n {\n \"accountId\": 259631,\n \"accountName\": \"SAVINGS\",\n \"accountType\": \"SAVINGS\",\n \"availableBalance\": 2148.5,\n \"currentBalance\": 2153.5,\n \"accountNumber\": \"99999990:1:00\",\n \"accountNumberMasked\": \"SAVINGS ...990:1:00\"\n },\n {\n \"accountId\": 259632,\n \"accountName\": \"CHECKING\",\n \"accountType\": \"CHECKING\",\n \"availableBalance\": 8658.8,\n \"currentBalance\": 8658.8,\n \"accountNumber\": \"99999990:6:00\",\n \"accountNumberMasked\": \"CHECKING ...990:6:00\"\n }\n ]\n}\n\nThe response includes multiple account types (SAVINGS, CHECKING, etc.) with their respective balance information.
\n","urlObject":{"path":["balance"],"host":["{{proxyDomain}}"],"query":[{"key":"branchId","value":"{{branchId}}"}],"variable":[]}},"response":[{"id":"3abff41e-4999-4ab0-ba3e-49b40cf6c905","name":"balance","originalRequest":{"method":"GET","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"url":{"raw":"{{proxyDomain}}/balance?branchId={{branchId}}","host":["{{proxyDomain}}"],"path":["balance"],"query":[{"key":"branchId","value":"{{branchId}}"}]}},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"requestId\": \"Purpose:\nRetrieves the receipt details for a transaction at a specific branch.
\nRequired Query Parameters:
\nbranchId (string): The unique identifier of the branch for which the transaction receipt is requested.Response:\nReturns a JSON object containing transaction details, including:
\nUse this endpoint to obtain a detailed receipt for a transaction performed at the specified branch.
\n","urlObject":{"path":["transaction","receipt"],"host":["{{proxyDomain}}"],"query":[{"key":"branchId","value":"{{branchId}}"}],"variable":[]}},"response":[{"id":"1a1e81ac-4846-4f4e-abfd-b8058b308197","name":"transaction/receipt","originalRequest":{"method":"GET","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"url":{"raw":"{{proxyDomain}}/transaction/receipt?branchId={{branchId}}","host":["{{proxyDomain}}"],"path":["transaction","receipt"],"query":[{"key":"branchId","value":"{{branchId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Oct 2025 03:22:56 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"334"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"x-request-id","value":"f064be50-6220-490b-98ce-22c6dfdd2d9a"},{"key":"ETag","value":"W/\"14e-+ntfDpYwFRPh1QH/6qnLkh2IQxI\""}],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"Retrieves configuration details for a specific ATM branch.
\nPurpose:
Use this endpoint to obtain configuration information for an ATM, such as its name, status, type, timezone, currency, language settings, audit settings, and visual configuration.
Usage:
Send a GET request to this endpoint with the required query parameter and authentication header.
Parameters:
\nbranchId (query, required): The unique identifier of the branch whose ATM configuration is being requested.Authentication:
\nbranch-api-key (header, required): API key required for authentication. Include this header in your request.Example Request:
GET {{proxyDomain}}/atm/config?branchId={{branchId}}
Header: branch-api-key:
A successful response returns the configuration details for the specified ATM branch.
\n","urlObject":{"path":["atm","config"],"host":["{{proxyDomain}}"],"query":[{"key":"branchId","value":"{{branchId}}"}],"variable":[]}},"response":[{"id":"2a7aaa6f-51c8-4e93-b752-ba3e120303f7","name":"/atm/config","originalRequest":{"method":"GET","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"url":{"raw":"{{proxyDomain}}/atm/config?branchId={{branchId}}","host":["{{proxyDomain}}"],"path":["atm","config"],"query":[{"key":"branchId","value":"{{branchId}}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"requestId\": \"This endpoint allows users to create a new alert for a specific ATM branch. By sending a POST request, you can register an alert with a unique identifier for tracking and management purposes.
\nPurpose: Register a new alert for an ATM branch.
\nMethod: POST
URL: {{proxyDomain}}/atm/alerts?branchId={{branchId}}
The request body must be in JSON format and include the following field:
\nExample Request Body:
\n{\n \"alertId\": \"RECY-0010\"\n}\n\nStatus Code: 201 Created
Content-Type: application/json
Response Body:
\nExample Response:
\n{\n \"requestId\": \"5bdadb5b-de38-44a3-9751-e0a1cf789956\",\n \"data\": {\n \"alertId\": \"RECY-0010\",\n \"success\": true\n }\n}\n\nThe branchId query parameter is required and must correspond to a valid branch.
The alertId should be unique within the context of the branch.
A valid branch-api-key header is required for authentication.
On success, the response will include the alertId and a success flag.
If the alert cannot be created, an error response will be returned with details.
\nRequest:
\nPOST {{proxyDomain}}/atm/alerts?branchId=12345\nHeader: branch-api-key: <api-key>\nBody:\n{\n \"alertId\": \"RECY-0010\"\n}\n\nResponse:
\n201 Created\n{\n \"requestId\": \"5bdadb5b-de38-44a3-9751-e0a1cf789956\",\n \"data\": {\n \"alertId\": \"RECY-0010\",\n \"success\": true\n }\n}\n\nThis endpoint is essential for managing ATM alerts, allowing users to create alerts that can be referenced and acted upon in the future.
\n","urlObject":{"path":["atm","alerts"],"host":["{{proxyDomain}}"],"query":[{"key":"branchId","value":"{{branchId}}"}],"variable":[]}},"response":[{"id":"10d20e00-9641-43f8-b01a-eee559577636","name":"/atm/alerts","originalRequest":{"method":"POST","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"alertId\": \"Submit the operational status event for an ATM for a specific branch. As of this version, the endpoint no longer accepts a request body. Clients report status via query parameters and required headers only.
\nHTTP Method: POST
\nEndpoint URL: {{proxyDomain}}/atm/status?branchId={{branchId}}
Status Code: 201 Created
\nDescription: The ATM status was successfully recorded.
\nResponse Body Example:
{
\"requestId\": \"\",
\"data\": {
\"success\": true\n\n }
}
Request:
POST {{proxyDomain}}/atm/status?branchId=12345
Headers:
branch-api-key:
Body: (none)
Response:
201 Created
{
\"requestId\": \"a80b9810-6cb3-48f9-931c-5e3ee57103f2\",
\"data\": {
\"success\": true
}
}
Purpose:\nThis endpoint creates journal logs for ATM actions at a specified branch.
\nUsage:
\nHTTP Method: POST
\nEndpoint: /atm/journalLogs
Required Query Parameter:
\nbranchId (string): The unique identifier of the branch where the ATM action occurred.Request Body (JSON):
\nlogs: An array of log objects, each containing:action (string): The ATM action performed (e.g., CASH_WITHDRAWAL).role (string): The role of the user performing the action (e.g., MEMBER).Example:
\n{\n \"logs\": [\n { \"action\": \"CASH_WITHDRAWAL\", \"role\": \"MEMBER\" }\n ]\n}\nExpected Response:
\n{\n \"requestId\": \"<string>\",\n \"data\": {\n \"success\": true,\n \"message\": \"Journal log created successfully\"\n }\n}\nA successful request will return a 201 status code and a message confirming the journal log was created.
\n","urlObject":{"path":["atm","journalLogs"],"host":["{{proxyDomain}}"],"query":[{"key":"branchId","value":"{{branchId}}"}],"variable":[]}},"response":[{"id":"1975e8f3-3e11-4df4-8a15-494056da4e03","name":"/atm/journalLogs","originalRequest":{"method":"POST","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"logs\": [\n // { \"action\": \"EMPLOYEE_LOGIN\", \"role\": \"SUPERVISOR\" }\n { \"action\": \"CASH_WITHDRAWAL\", \"role\": \"MEMBER\" }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{proxyDomain}}/atm/journalLogs?branchId={{branchId}}","host":["{{proxyDomain}}"],"path":["atm","journalLogs"],"query":[{"key":"branchId","value":"{{branchId}}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"requestId\": \"f5cdda49-8ddb-4ca7-953b-14914c9906d9\",\n \"data\": {\n \"success\": true,\n \"message\": \"Journal log created successfully\"\n }\n}"}],"_postman_id":"99e780db-7efc-4b46-b44d-296fa4a03881"},{"name":"/atm/commonLogs","id":"fca52af9-fe0d-4bfe-9757-91abd86826f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","uuid":"b7d6c123-4d46-4703-a321-62fb3672ea7b","value":null}]},"url":"{{proxyDomain}}/atm/commonLogs?branchId={{branchId}}","description":"Endpoint: POST {{proxyDomain}}/atm/commonLogs?branchId={{branchId}}
Purpose:
Uploads a log file to the ATM system for the specified branch. This endpoint is typically used to submit bulk or individual log files for processing and storage.
Required Headers:
\nbranch-api-key: API key for authenticating the request.Request Body:
\nContent-Type: multipart/form-data
Form field:
\nfile: The log file to upload (e.g., a .zip file containing logs).Query Parameters:
\nbranchId: The unique identifier of the branch. Provided via the {{branchId}} variable.Successful Response:
\nStatus Code: 201 Created
Body (JSON):
\n{\n \"requestId\": \"<string>\",\n \"data\": {\n \"success\": true,\n \"message\": \"File uploaded successfully\"\n }\n}\n\nrequestId: Unique identifier for tracking the upload request.
data.success: Indicates if the upload was successful.
data.message: Confirmation message.
Usage Notes:
\nEnsure the file field is included in the form-data body.
\nThe endpoint requires valid authentication via the branch-api-key header.
The branchId must correspond to an existing branch in the system.
Purpose:
The blossom/visualConfig GET endpoint retrieves the current visual configuration settings for the Blossom application. This allows clients to dynamically obtain branding assets and theming information for consistent UI presentation.
Usage:
\nHTTP Method: GET
\nURL: {{proxyDomain}}/blossom/visualConfig
Authentication: Requires the branch-api-key header.
Request Body: None required.
\nRequired Headers:
\nbranch-api-key: API key for authentication and authorization.Response Details:
\nStatus: 200 OK on success
\nBody: JSON object containing:
\nicons: URLs for icon assets in JPG, PNG, and SVG formats.
logos: URLs for dark and light theme logos in JPG, PNG, and SVG formats.
theme.colors: Accent color, primary color, and a palette of color codes for UI theming.
success: Boolean indicating request success.
requestId: Unique identifier for the request.
Example Response:
\n{\n \"requestId\": \"c0ea7fa4-55a1-4cb9-9463-a586adc84e77\",\n \"data\": {\n \"success\": true,\n \"config\": {\n \"icons\": { \"jpg\": \"...\", \"png\": \"...\", \"svg\": \"...\" },\n \"logos\": {\n \"dark\": { \"jpg\": \"...\", \"png\": \"...\", \"svg\": \"...\" },\n \"light\": { \"jpg\": \"...\", \"png\": \"...\", \"svg\": \"...\" }\n },\n \"theme\": {\n \"colors\": {\n \"accent\": \"#3956E8\",\n \"palette\": { \"50\": \"#F7F9FB\", ... },\n \"primary\": \"#001D3D\"\n }\n }\n }\n }\n}\n\nThis endpoint is essential for clients that need to render the Blossom UI with up-to-date branding and theming information.
\n","urlObject":{"path":["blossom","visualConfig"],"host":["{{proxyDomain}}"],"query":[],"variable":[]}},"response":[{"id":"57f75e44-a37b-45ad-b4ab-2951bfe32312","name":"blossom/visualConfig","originalRequest":{"method":"GET","header":[{"key":"branch-api-key","value":"{{proxyApiKey}}","type":"text"}],"url":"{{proxyDomain}}/blossom/visualConfig"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"requestId\": \"c0ea7fa4-55a1-4cb9-9463-a586adc84e77\",\n \"data\": {\n \"success\": true,\n \"config\": {\n \"icons\": {\n \"jpg\": \"https://devolbassets.static-content.blossomdev.com/dev/blossom/icons/blossom_icon.jpg\",\n \"png\": \"https://devolbassets.static-content.blossomdev.com/dev/blossom/icons/blossom_icon.png\",\n \"svg\": \"https://devolbassets.static-content.blossomdev.com/dev/blossom/icons/blossom_icon.svg\"\n },\n \"logos\": {\n \"dark\": {\n \"jpg\": \"https://devolbassets.static-content.blossomdev.com/dev/blossom/logos/dark/blossom_logo.jpg\",\n \"png\": \"https://devolbassets.static-content.blossomdev.com/dev/blossom/logos/dark/blossom_logo.png\",\n \"svg\": \"https://devolbassets.static-content.blossomdev.com/dev/blossom/logos/dark/blossom_logo.svg\"\n },\n \"light\": {\n \"jpg\": \"https://devolbassets.static-content.blossomdev.com/dev/blossom/logos/light/blossom_logo.jpg\",\n \"png\": \"https://devolbassets.static-content.blossomdev.com/dev/blossom/logos/light/blossom_logo.png\",\n \"svg\": \"https://devolbassets.static-content.blossomdev.com/dev/blossom/logos/light/blossom_logo.svg\"\n }\n },\n \"theme\": {\n \"colors\": {\n \"accent\": \"#3956E8\",\n \"palette\": {\n \"50\": \"#F7F9FB\",\n \"100\": \"#F2F5F7\",\n \"200\": \"#A0BDD8\",\n \"300\": \"#4E80AF\",\n \"400\": \"#BE531C\",\n \"500\": \"#BE531C\",\n \"600\": \"#003B5C\",\n \"700\": \"#00273D\",\n \"800\": \"#001F30\",\n \"900\": \"#04151E\"\n },\n \"primary\": \"#001D3D\"\n }\n }\n }\n }\n}"}],"_postman_id":"17eef699-a823-481d-b39f-afafa4ea9b8b"}],"id":"849c8f5a-6bf1-4559-a6b4-8bdaf8a75568","_postman_id":"849c8f5a-6bf1-4559-a6b4-8bdaf8a75568","description":""},{"name":"/healthCheck","id":"3e526ffb-e773-43c8-820b-8eab5301f510","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{proxyDomain}}/ping","urlObject":{"path":["ping"],"host":["{{proxyDomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3e526ffb-e773-43c8-820b-8eab5301f510"}]}