Welcome to the AnyDay API!
\nYou can use this API to move money and create users within your account instantly. All of the calls exposed in this API are from the perspective of a manager or customer (cardholder) within the AnyDay program.
\nManagers:
\nManagers are users within the system that are allowed to add customers and load money on to customer cards. There are two levels of managers in the system, admin managers and regular managers. This API encapsulates all of the functionality exposed to an admin manager while allowing you to also create regular managers.
\nCustomers:
\nCustomers are the card holders within the AnyDay Platform. As a manager you are able to invite new customers onto the system as well as load funds to their card.
\nWallets:
\nWallets are where funds are stored in order to initiate payouts. In order for a payout to occur, it must be initiated from a wallet. Wallets can only be created by your XTM representative.
\nStores:
\nStores are a representation of a physical store presense in the real world. Each store has a one to one relationship with a wallet. When a store is created, the accompanying wallet is automatically generated at the same time. Stores can only be created by your XTM representative.
\nExternal Ids:
\nStores, Customers and Managers can all be associated to independent external_ids of your choice. If you chose to use external IDs, it is recomended that you use them throughout your interaction with our APIs. Although this isn't strictly required, it will create a much more consistent experience.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"19440632","collectionId":"73656328-e80d-4892-8403-15ccc678842b","publishedId":"2s9YJhyLq5","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"68C3C4"},"publishDate":"2023-10-19T13:40:05.000Z"},"item":[{"name":"Manager APIs","item":[{"name":"Token Auth","item":[{"name":"Authentication","item":[{"name":"Submit 2FA","id":"0797927a-42bc-42f1-aea4-d5cbc7156be3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"identifier\": \"4165730171\",\n\"passphrase\": \"pass@word1\",\n\"token\": \"323072\"\n\n}","options":{"raw":{"language":"json"}}},"url":"https://stage-apiv2.xtminc.com/v1/manager-login-finish","description":"This endpoint is used to input the token if two factor authentication is used during the login process.
\n","urlObject":{"protocol":"https","path":["v1","manager-login-finish"],"host":["stage-apiv2","xtminc","com"],"query":[],"variable":[]}},"response":[{"id":"233be543-4e6b-494d-965f-a9f8d0f08396","name":"Submit 2FA","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"identifier\": \"4165730171\",\n\"passphrase\": \"pass@word1\",\n\"token\": \"323072\"\n\n}","options":{"raw":{"language":"json"}}},"url":"https://stage-apiv2.xtminc.com/v1/manager-login-finish"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Mon, 01 Feb 2021 03:59:18 GMT"},{"key":"server","value":"istio-envoy"},{"key":"content-length","value":"361"},{"key":"content-type","value":"application/json"},{"key":"x-process-time","value":"0.01049184799194336"},{"key":"x-envoy-upstream-service-time","value":"11"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"manager_id\": 10008,\n \"first_name\": \"Chad\",\n \"last_name\": \"Arthur\",\n \"mobile_number\": \"4165730171\",\n \"session_id\": \"be36720cd35a4feeabc496cbb400c26f\",\n \"barry_allen\": \"89ee68b216f54c00b7f5cb34243ff45f\",\n \"account_level\": \"Admin\",\n \"client_id\": 10000,\n \"daily_limit\": \"0.0\",\n \"single_limit\": \"0.0\",\n \"session_ttl\": 28800,\n \"external_id\": \"M123\",\n \"stores\": []\n },\n \"meta\": {}\n}"}],"_postman_id":"0797927a-42bc-42f1-aea4-d5cbc7156be3"},{"name":"Reset Password Start","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"reset_token\", jsonData.data.token);",""],"type":"text/javascript","id":"8533f5ef-b652-4cc6-bc14-4cc66c4d86d2"}}],"id":"bb60088e-1958-4ff4-a1ab-fd6fc520d138","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"identifier\":\"4165730171\"}","options":{"raw":{"language":"json"}}},"url":"https://stage-apiv2.xtminc.com/v1/managers/This endpoint starts the process for resetting the manager password. A SMS is sent with a reset code to the Manager's phone.
\n","urlObject":{"protocol":"https","path":["v1","managers","This endpoint is used to submit the token generated when starting the resent password process.
\n","urlObject":{"protocol":"https","path":["v1","managers","This endpoint creates a new manager
\n","urlObject":{"protocol":"https","path":["v1","managers"],"host":["stage-apiv2","xtminc","com"],"query":[],"variable":[]}},"response":[{"id":"9d11cca3-495d-4b2e-98fe-e8a3339a7a70","name":"Create Manager","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"mobile_number\": \"4165680086\",\n\"passphrase\": \"pass@word1\",\n\"twofa_required\": false,\n\"first_name\": \"Test\",\n\"last_name\": \"Person\",\n\"external_id\" : \"\",\n\"email\":\"arthurchad@gmail.com\",\n\"client_id\": 10000,\n\"account_level\": \"Admin\",\n\"timezone\": \"GMT -4:00\",\n\"stores\": [ 10000],\n\"limitations\": \"0\"\n}","options":{"raw":{"language":"json"}}},"url":"https://stage-apiv2.xtminc.com/v1/managers"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Mon, 01 Feb 2021 03:20:21 GMT"},{"key":"server","value":"istio-envoy"},{"key":"content-length","value":"313"},{"key":"content-type","value":"application/json"},{"key":"x-process-time","value":"2.0509941577911377"},{"key":"x-envoy-upstream-service-time","value":"2052"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"manager_id\": 10025,\n \"client_id\": 10000,\n \"first_name\": \"Test\",\n \"last_name\": \"Person\",\n \"mobile_number\": \"4165680086\",\n \"account_level\": \"Admin\",\n \"timezone\": \"GMT -4:00\",\n \"stores\": [\n \"10000\"\n ],\n \"limitations\": \"0\",\n \"limit_days\": [],\n \"limit_hours\": [],\n \"daily_limit\": 0,\n \"single_limit\": 0,\n \"active\": \"1\"\n },\n \"meta\": {}\n}"}],"_postman_id":"b749c717-e23c-4c65-99bf-538f0dc6e672"},{"name":"Edit Manager Password","id":"819ed86a-b051-49c0-ab86-cf3033fb817a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"This endpoint allows an Admin manager to set the password for any other manager. The manager having their password changed must be from the same client.
\n","urlObject":{"protocol":"https","path":["v1","managers","10008","set-password"],"host":["stage-apiv2","xtminc","com"],"query":[],"variable":[]}},"response":[{"id":"515142fd-1a52-4a86-9288-b5fd16343b23","name":"Edit Manager Password","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"This endpoint creates a new manager with an external_id. Please Note: if you pass in an external_id here, the store_id passed in will be an assumed external store ID.
\n","urlObject":{"protocol":"https","path":["v1","managers"],"host":["stage-apiv2","xtminc","com"],"query":[],"variable":[]}},"response":[{"id":"a3656ddf-e6ed-4624-a53c-2c6ff829a9bc","name":"Create Manager","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"mobile_number\": \"4165680086\",\n\"passphrase\": \"pass@word1\",\n\"twofa_required\": false,\n\"first_name\": \"Test\",\n\"last_name\": \"Person\",\n\"external_id\" : \"\",\n\"email\":\"arthurchad@gmail.com\",\n\"client_id\": 10000,\n\"account_level\": \"Admin\",\n\"timezone\": \"GMT -4:00\",\n\"stores\": [ 10000],\n\"limitations\": \"0\"\n}","options":{"raw":{"language":"json"}}},"url":"https://stage-apiv2.xtminc.com/v1/managers"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Mon, 01 Feb 2021 03:20:21 GMT"},{"key":"server","value":"istio-envoy"},{"key":"content-length","value":"313"},{"key":"content-type","value":"application/json"},{"key":"x-process-time","value":"2.0509941577911377"},{"key":"x-envoy-upstream-service-time","value":"2052"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"manager_id\": 10025,\n \"client_id\": 10000,\n \"first_name\": \"Test\",\n \"last_name\": \"Person\",\n \"mobile_number\": \"4165680086\",\n \"account_level\": \"Admin\",\n \"timezone\": \"GMT -4:00\",\n \"stores\": [\n \"10000\"\n ],\n \"limitations\": \"0\",\n \"limit_days\": [],\n \"limit_hours\": [],\n \"daily_limit\": 0,\n \"single_limit\": 0,\n \"active\": \"1\"\n },\n \"meta\": {}\n}"}],"_postman_id":"0f099f0c-11a0-4671-b993-5ac8fc69ee72"}],"id":"d8962002-ae0c-4bbe-8834-0cb2c6af31ad","_postman_id":"d8962002-ae0c-4bbe-8834-0cb2c6af31ad","description":""},{"name":"Stores","item":[{"name":"Get Stores","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"store_id\", jsonData.data[0].store_id);"],"type":"text/javascript","id":"eeba9cfe-7acd-48cb-9c4c-621e6c2a58b0"}}],"id":"9dac27c5-041c-430a-b5b9-7f64d8b9851b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"This endpoint retrieves all stores and all associated wallets for a specific client.
\n","urlObject":{"protocol":"https","path":["v1","stores"],"host":["stage-apiv2","xtminc","com"],"query":[{"key":"client_id","value":"This endpoint retrieves the details of a single store.
\n","urlObject":{"protocol":"https","path":["v1","stores","This endpoint retrieves the details of a single store.
\n","urlObject":{"protocol":"https","path":["v1","wallets","This endpoint retrieves the details of a single store.
\n","urlObject":{"protocol":"https","path":["v1","wallets","This endpoint retrieves the details of a single store.
\n","urlObject":{"protocol":"https","path":["v1","wallets","This endpoint retrieves the details of a single store.
\n","urlObject":{"protocol":"https","path":["v1","wallets","Grab all store details using your external store id
\n","urlObject":{"protocol":"https","path":["v1","stores","Grab the ledger of a wallet. This endpoint only supports internal wallet ids. Please use the Get Store Details (External) endpoint to get the associated internal id
\n","urlObject":{"protocol":"https","path":["v1","stores","This endpoint creates a new customer (card holder) in the system. Once this endpoint is called, the customer receives a text message with instructions for downloading the AnyDay mobile app. When they are in the app, they are able to setup their authentication and activate a card.
\n","urlObject":{"protocol":"https","path":["v1","customers"],"host":["stage-apiv2","xtminc","com"],"query":[],"variable":[]}},"response":[{"id":"ead1ffd4-c27b-4a09-9bf2-d2a031a50dee","name":"Create Customer","originalRequest":{"method":"POST","header":[{"key":"","type":"text","value":"","disabled":true}],"body":{"mode":"raw","raw":"{\n\"identifier\": \"4165680085\",\n\"first_name\": \"John\",\n\"email\": \"john@doe.com\",\n\"last_name\": \"Doe\",\n\"client_id\": 10001,\n\"staff_id\": \"EF123\",\n\"external_id\": \"\",\n\"stores\": [This endpoint creates a new customer (card holder) in the system using an external store_id. This will only work if you have a store that already exists in the system with an external_id set. Once this endpoint is called, the customer receives a text message with instructions for downloading the AnyDay mobile app. When they are in the app, they are able to setup their authentication and activate a card. Please Note: if you pass in an external_id here, the store_id passed in will be an assumed external store ID.
\n","urlObject":{"protocol":"https","path":["v1","customers"],"host":["stage-apiv2","xtminc","com"],"query":[],"variable":[]}},"response":[{"id":"2a4fe031-3e9a-429c-96b5-f183f75e10a8","name":"Create Customer With External ID","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"This endpoint returns an array of customers that are associated with the store that was passed in.
\n","urlObject":{"protocol":"https","path":["v1","managers","(Optional) Store ID to filter on.
\n","type":"text/plain"},"key":"store_id","value":"(Optional) Customer status to filter on. 'active', 'pending', 'regisitered' are possible values.
\n","type":"text/plain"},"key":"status","value":"active"}],"variable":[]}},"response":[{"id":"42094bd6-82f9-4c2b-955c-366f5e24033d","name":"Get Client Members","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"This endpoint returns the member information providing the `customer_id`
\n","urlObject":{"protocol":"https","path":["v1","customers","This endpoint returns an array of customers that are associated with the store that was passed in.
\n","urlObject":{"protocol":"https","path":["v1","managers","search-customers","(Optional) Store ID to filter on.
\n","type":"text/plain"},"key":"store_id","value":"(Optional) Customer status to filter on. 'active', 'pending', 'regisitered' are possible values.
\n","type":"text/plain"},"key":"status","value":"active"},{"key":"search_param","value":"Doe"}],"variable":[]}},"response":[{"id":"0f6e178c-6bba-42ad-877d-eb28121fdebc","name":"Search Members","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"This endpoint returns an array of customers that are associated with the store that was passed in.
\n","urlObject":{"protocol":"https","path":["v1","stores","(Optional) External Reference Type - all (default), staff_id, payroll_id, ta_id
\n","type":"text/plain"},"key":"type","value":"staff_id"}],"variable":[]}},"response":[{"id":"ef046e3e-55d4-4020-8ff3-21cb108d8190","name":"Get Client / Store Members - Set Type","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"This endpoint returns an array of customers that are associated with the store that was passed in.
\n","urlObject":{"protocol":"https","path":["v1","stores","This endpoint returns an array of customers that are associated with the store that was passed in.
\n","urlObject":{"protocol":"https","path":["v1","stores","(Optional, default is \"staff_id\") The type of external reference to remove. Options are 'staff_id', 'payroll_id', 'ta_id'.
\n","type":"text/plain"},"key":"type","value":"staff_id"}],"variable":[]}},"response":[{"id":"01dc893d-47d2-446d-9378-709c5fa7ccfc","name":"Delete Members External References","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"This endpoint returns an array of customers that are associated with the store that was passed in in a paginated form, 25 results per page.
\nThe meta will provide the total number of results & pages.
\n","urlObject":{"protocol":"https","path":["v1","managers","customers-paginated","Current page.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"(Optional) Store/Wallet ID to further filter by.
\n","type":"text/plain"},"key":"store_id","value":"(Optional) Filter by customer status.
\n","type":"text/plain"},"key":"customer_status","value":"active"}],"variable":[]}},"response":[{"id":"9168f3f8-6ce8-4ed9-b64f-97946dda8e0a","name":"Get Members Paginated","originalRequest":{"method":"GET","header":[{"key":"","value":"","type":"text","disabled":true}],"url":"https://stage-apiv2.xtminc.com/v1/managers/This endpoint returns an array of customers that are associated with the store that was passed in.
\n","urlObject":{"protocol":"https","path":["v1","managers","This endpoint loads funds onto a card.
\nclient_payment_reference - (Optional) Unique Payment reference that you provide.
If a load with the same payment reference on this wallet has occurred, subsequent calls will fail.
\nNote, this is not an XTM internal unique reference. XTM unique reference is returned as rec_id in the Get Transaction Status call and can be used for Reverse Load.
This endpoint reverses funds from a card.
\nThis endpoint must reference
\nReference a previous load to reverse, via the record_id param.
This load transaction must also be within the last 7 days.
\nThe transaction was not already reversed.
\nThis can be retrieved using the Stores > Get Wallet History endpoint. rec_id field.
This endpoint loads funds onto a card.
\n","urlObject":{"protocol":"https","path":["v1","managers","These endpoints are all using our legacy authentication method.
\n","_postman_id":"ab0d1dd4-afb1-433e-9a27-027ac73c814e"}],"id":"c97d7693-6963-4d3e-b26e-2ee7c148cb60","description":"The following endpoints are all from the perspective of a manager in the My AnyDay Card system.
\nAuthentication:
\nTo authorize, you should login as a manager with your given credentials. Once you have logged in, you should receive a x-barry-allen in the response.
\nYou must pass x-barry-allen in the header of all other requests. You may also use the more traditional Authorization key in the header of all other requests
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"9677be4d-34bb-4794-be83-98ad4d5a71cd"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"c970cf9c-8d9b-4990-a2f2-ec20efb79197"}}],"_postman_id":"c97d7693-6963-4d3e-b26e-2ee7c148cb60"},{"name":"Cardholder APIs","item":[{"name":"Authorization","item":[{"name":"Login","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"john_stewart\", jsonData.data.john_stewart);\r","postman.setEnvironmentVariable(\"customer_id\", jsonData.data.customer_id);"],"type":"text/javascript","id":"103db369-a374-4713-9b66-85e661f008b5"}},{"listen":"prerequest","script":{"exec":["postman.setEnvironmentVariable(\"customer_phone_number\", \"This endpoints adds an e-transfer recipient and attaches the recipient to the customer account. In order to send an e-transfer, a recipient must be added and selected for any given transfer.
\n","urlObject":{"protocol":"https","path":["v1","customers","This endpoint receives a list of all recipients for a given card holder.
\n","urlObject":{"protocol":"https","path":["v1","customers","This endpoint initiates an e-transfer for the customer. The recipient_id must be obtained from the View Recipients endpoint. Please make sure to save the transfer_id being returned as you will need it to make any subsequent actions on an e-transfer
\n","urlObject":{"protocol":"https","path":["v1","customers","This endpoint cancels an e-transfer. The etransfer must be marked in a \"sent\" state before a user is able to cancel.
\n","urlObject":{"protocol":"https","path":["v1","customers","This endpoint retrieves the details of a specific e-transfer.
\n","urlObject":{"protocol":"https","path":["v1","customers","The following endpoints open up the e-transfer rails for card holders. Each card holder must add recipients to their account in order to initiate an e-transfer.
\n","_postman_id":"10ce4474-dcc1-4ec0-8049-eefdb93dd8ef"},{"name":"Check Balance","id":"7eb11add-527c-4c0f-b648-af5a07a9d7f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-john-stewart","value":"{{john_stewart}}","type":"text"}],"url":"https://stage-apiv2.xtminc.com/v1/customers/This endpoint allows a card holder to transfer money from their card to another card holders account. They need to have access to the recipients proxy and phone number on file.
\n","urlObject":{"protocol":"https","path":["v1","customers","The following endpoints are all from the perspective of a cardholder in the My AnyDay system.
\nAuthentication:
To authorize, you should login as a customer with your given credentials. Once you have logged in, you should receive a x-john-stewart in the response.
You must pass x-john-stewart in the header of all other requests. You may also use the more traditional Authorization key in the header of all other requests
\n","_postman_id":"bc768cf0-8850-41e9-8577-4b3cfe3be092"}],"event":[{"listen":"prerequest","script":{"id":"ba48ada0-a77c-4ce6-a4e0-962926034023","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d04146df-9358-485e-aab0-0ec18d3fdb85","type":"text/javascript","exec":[""]}}],"variable":[{"key":"client_id","value":"