{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"fe0dc39f-cbe3-41ec-961d-c151bba1a237","name":"Boxlockconnect","description":"# GENERAL PROCESS FLOW: \n\n*Notes*\n\n> Fields surrounded by () denote field-specific data, the parentheses are not to be included in the actual field value.\n\n> A Token and PIN combination is needed to access most API calls. This Token is connected to the Primary_ID field in a call. In order to get a token, the customer account under the given Primary_ID must be validated. The validation process sends a randomly generated PIN to the customer's phone number and a token to the API caller. The token and PIN are then entered into their respective fields, \"Token\" and \"PIN\", to send an API call.\n\n## Account Creation:\n\nTo begin a customer account creation, use the ['Validate_Customer_Create'](https://api.boxlockconnect.com/?version=latest#9430221f-c858-4482-a3b2-65eb8bcbb0ed) call to send the user a PIN code via text message to the number in the 'to' field. A successful response will return a customer creation token with its accompanying created and expiration times, this token can only be used for a customer creation call and is linked to the customers phone number and PIN.\n\nUse the returned creation token and user entered PIN combo in the ['Create_Customer'](https://api.boxlockconnect.com/?version=latest#9421cb6f-bab0-4b18-8dc9-33cc80442f68) call. This call validates user data and creates the customer record and accompanying card/accounts on successful validation. A successful call will return the customer's 'Profile_ID' which should be filled into the 'Primary_ID' field on all subsequent calls relating to that customer. Also note that on a successful creation, the customer creation token becomes a master validation token for the rest of its lifespan meaning it can be used for any call other than customer creation.\n\n\n## Transactions:\n\n**Load:**\n\nUsing the ['Create_Transaction'](https://api.boxlockconnect.com/?version=latest#a3619f48-e3eb-4c12-beaf-96d203c937cf) call, fill in fields using the main card account data and the 'To_Card' field using the ID of the card being loaded. The 'Token' and 'PIN' fields can be left null. A successful transaction call will return a success message and the transaction ID's of the in/out transactions.\n\n**Other:**\n\nUsing the ['Validate_Customer_Transaction'](https://api.boxlockconnect.com/?version=latest#be009d70-9cf5-4774-ba47-dd3582bed216) call, fill in the 'to' field with the phone number of the customer that the funds are being taken from. This customer will receive a transaction PIN code. A successful call will return a transaction token which is linked to the customer's Primary_ID and the PIN sent to the customer.\n\nUsing the customer PIN and transaction token in the ['Create_Transaction'](https://api.boxlockconnect.com/?version=latest#a3619f48-e3eb-4c12-beaf-96d203c937cf) call, fill in remainging fields using data corresponding to the 'Primary_ID' field (i.e 'From_Card' is card ID of card from customer with Primary_ID = 'Primary_ID' field, this can be pulled using the ['List_Cards'](https://api.boxlockconnect.com/?version=latest#904cd1b5-b94d-4b94-86b1-35132ea8f72d) call with same 'Primary_ID' and Token/PIN combination). In the 'To_Card' field use the ID of the card being credited. A successful transaction call will return a success message and the transaction ID's of the in/out transactions.\n\t\n\t\n## Token Reset:\n\nIf a token has expired due to its lifespan, it can be reset for another 2 hours from the current time using the ['Reset_Token'](https://api.boxlockconnect.com/?version=latest#904cd1b5-b94d-4b94-86b1-35132ea8f72d) call. This call accepts multiple tokens to be reset at once. A successul call will return the number of token successfully reset and give reasons for unsuccessful token resets.\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"7803008","team":403237,"collectionId":"fe0dc39f-cbe3-41ec-961d-c151bba1a237","publishedId":"S1Zw7APa","public":true,"publicUrl":"https://api.boxlockconnect.com","privateUrl":"https://go.postman.co/documentation/7803008-fe0dc39f-cbe3-41ec-961d-c151bba1a237","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2019-06-14T09:21:13.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/a05088ffb44f8b963f30e7c88e8d4aba65e7139f77c60d714a6557b5b5edb002","favicon":"https://boxlockconnect.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api.boxlockconnect.com/view/metadata/S1Zw7APa"}