The freely acceptance API is used to integrate applications to the freely payments ecosystem
\nFreely Payments Postman Team Bio
\nIn order to work with freely payments API you will need to work with our support team to have a distrinbutor profile established and client credentials provisioned.
\nPlease reach out to mailto:DevSupport@freelypayments.com.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"34196851","collectionId":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","publishedId":"2sAXqmCm7r","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-02-21T21:40:30.000Z"},"item":[{"name":"Security - Freely Auth","item":[{"name":"get self","event":[{"listen":"test","script":{"id":"0608d103-70cc-4cd7-850f-84697976d85c","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"78d7532f-6a40-48c2-9816-0f5784f47531","exec":[""],"type":"text/javascript","packages":{}}}],"id":"e29d1c54-717d-4d76-9309-2d5716f0bcc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"profileKey","value":"coolco","description":"The customer profile key. If not specified it will use the default profile specified by user profile.
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/self","description":"Retreives all customers from the freely system of record.
\n","urlObject":{"path":["self"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"d6087072-b76e-49e1-a2ce-69a219fa88f3","name":"Successful response","originalRequest":{"method":"GET","header":[{"key":"profileKey","value":"tHuhzexRG9r2kCMx","description":"The customer profile key. If not specified it will use the default profile specified by user profile."},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerThese requests are used to create a regular user. To obtain credentials please contact devsupport@freelypayments.com
\n","_postman_id":"8532e842-ec44-4c6e-89e0-96ba579fcc96","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","name":"Public Freely Payment - Public Documentation","type":"collection"}}},{"name":"Security - OAuth","item":[{"name":"oauth - client_credentials","event":[{"listen":"test","script":{"id":"f08b856e-1342-4f67-88dd-4b46f94a6f4b","exec":["var access_token = pm.response.json().access_token;","pm.environment.set(\"bearerToken\", access_token);"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"3ef91f27-fe1f-43ba-a473-18c6cc8a5977","exec":[],"type":"text/javascript"}}],"id":"cabae7c4-c70d-4845-b1bc-8037e3c542e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{clientId}}"},{"key":"password","value":"{{clientSecret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"scope","value":"","type":"text"}]},"url":"{{oauthUrl}}/oauth/token","urlObject":{"path":["oauth","token"],"host":["{{oauthUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cabae7c4-c70d-4845-b1bc-8037e3c542e9"}],"id":"aea40e2c-609e-4e13-bf73-2760e0639635","description":"These requests are used for application to application authentication via standard OAUTH.
\nTo obtain an oauth client id and secret please contact devsupport@freelypayments.com
\n","_postman_id":"aea40e2c-609e-4e13-bf73-2760e0639635","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","name":"Public Freely Payment - Public Documentation","type":"collection"}}},{"name":"customers","item":[{"name":"Get a list of customers","event":[{"listen":"test","script":{"id":"0608d103-70cc-4cd7-850f-84697976d85c","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response content type is application/json\", function () {"," pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");","});","","","pm.test(\"Response time is within an acceptable range\", function () {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"Validate the schema for the response includes the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('array');"," "," const requiredFields = ["," \"id\", \"displayName\", \"companyName\", \"contactFirstName\", \"contactLastName\","," \"companyAccountNumber\", \"notes\", \"contactEmail\", \"contactPhoneNumber\","," \"mobilePhoneNumber\", \"freelyProfileId\", \"processorId\", \"lastModified\", "," \"defaultPaymentToken\""," ];"," "," responseData.forEach(function(customer) {"," requiredFields.forEach(function(field) {"," pm.expect(customer).to.have.property(field);"," });"," });","});","var template = `","","","| Company Name | ","Display Name | ","Contact First Name | ","Contact Last Name | ","Company Account Number | ","Notes | ","Contact Email | ","Processor ID | ","Contact Phone Number | ","Freely Profile ID | ","Mobile Phone Number | ","Processor Secondary ID | ","Processor Primary Sync DateTime | ","ID | ","Last Modified | ","Default Payment Token | ","
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| {{companyName}} | ","{{displayName}} | ","{{contactFirstName}} | ","{{contactLastName}} | ","{{companyAccountNumber}} | ","{{notes}} | ","{{contactEmail}} | ","{{processorId}} | ","{{contactPhoneNumber}} | ","{{freelyProfileId}} | ","{{mobilePhoneNumber}} | ","{{processorSecondaryId}} | ","{{processorPrimarySyncDateTime}} | ","{{id}} | ","{{lastModified}} | ","{{defaultPaymentToken}} | ","
The customer profile key. If not specified it will use the default profile specified by user profile.
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/customers","description":"Retreives all customers from the freely system of record.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","name":"Public Freely Payment - Public Documentation","type":"collection"}},"urlObject":{"path":["customers"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"c7c912e5-a543-4f29-a60a-b9a15bb3e096","name":"Successful response","originalRequest":{"method":"GET","header":[{"key":"profileKey","value":"tHuhzexRG9r2kCMx","description":"The customer profile key. If not specified it will use the default profile specified by user profile."},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerThe customer profile key. If not specified it will use the default profile specified by user profile.
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"{{RestaurantName}}\",\n \"companyName\": \"{{RestaurantName}}\",\n \"contactFirstName\": \"{{OwnerFirstName}}\",\n \"contactLastName\": \"{{OwnerLastName}}\",\n \"companyAccountNumber\": \"{{AccountNumber}}\",\n \"contactEmail\": \"{{EmailAddress}}\",\n \"notes\": \"{{Notes}}\",\n \"contactPhoneNumber\": \"{{RestaurantPhoneNumber}}\",\n \"mobilePhoneNumber\": \"{{MobilePhoneNumber}}\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/customer","description":"Creates a new Customer in the Freely System of Record.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","name":"Public Freely Payment - Public Documentation","type":"collection"}},"urlObject":{"path":["customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"19afe9b5-a2cb-457b-901b-d408e32e559e","name":"Successful response","originalRequest":{"method":"POST","header":[{"key":"profileKey","value":"tHuhzexRG9r2kCMx","description":"The customer profile key. If not specified it will use the default profile specified by user profile."},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer| ID | ","Display Name | ","Company Name | ","Contact First Name | ","Contact Last Name | ","Company Account Number | ","Notes | ","Contact Email | ","Contact Phone Number | ","Mobile Phone Number | ","Processor ID | ","Processor Secondary ID | ","Processor Primary Sync DateTime | ","Last Modified | ","Default Payment Token | ","
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| {{response.id}} | ","{{response.displayName}} | ","{{response.companyName}} | ","{{response.contactFirstName}} | ","{{response.contactLastName}} | ","{{response.companyAccountNumber}} | ","{{response.notes}} | ","{{response.contactEmail}} | ","{{response.contactPhoneNumber}} | ","{{response.mobilePhoneNumber}} | ","{{response.processorId}} | ","{{response.processorSecondaryId}} | ","{{response.processorPrimarySyncDateTime}} | ","{{response.lastModified}} | ","{{response.defaultPaymentToken}} | ","
The customer profile key. If not specified it will use the default profile specified by user profile.
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/customer/:id","description":"retrieves a single customer via their assigned freely customer id.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","name":"Public Freely Payment - Public Documentation","type":"collection"}},"urlObject":{"path":["customer",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"{{customerId}}","key":"id"}]}},"response":[{"id":"d011b571-fd5c-4381-bd06-1cf0bb84fba8","name":"Successful response","originalRequest":{"method":"GET","header":[{"key":"profileKey","value":"tHuhzexRG9r2kCMx","description":"The customer profile key. If not specified it will use the default profile specified by user profile."},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer| ID | ","{{response.id}} | ","
| Display Name | ","{{response.displayName}} | ","
| Company Name | ","{{response.companyName}} | ","
| Contact First Name | ","{{response.contactFirstName}} | ","
| Contact Last Name | ","{{response.contactLastName}} | ","
| Company Account Number | ","{{response.companyAccountNumber}} | ","
| Notes | ","{{response.notes}} | ","
| Contact Email | ","{{response.contactEmail}} | ","
| Contact Phone Number | ","{{response.contactPhoneNumber}} | ","
| Mobile Phone Number | ","{{response.mobilePhoneNumber}} | ","
| Processor ID | ","{{response.processorId}} | ","
| Processor Secondary ID | ","{{response.processorSecondaryId}} | ","
| Processor Primary Sync Date Time | ","{{response.processorPrimarySyncDateTime}} | ","
| Last Modified | ","{{response.lastModified}} | ","
| Default Payment Token | ","{{response.defaultPaymentToken}} | ","
The customer profile key. If not specified it will use the default profile specified by user profile.
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"{{customerId}}\",\n \"displayName\": \"{{UpdatedRestaurantName}}\",\n \"companyName\": \"{{UpdatedRestaurantName}}\",\n \"contactFirstName\": \"{{UpdatedOwnerFirstName}}\",\n \"contactLastName\": \"{{UpdatedOwnerLastName}}\",\n \"companyAccountNumber\": \"{{UpdatedAccountNumber}}\",\n \"contactEmail\": \"{{UpdatedEmailAddress}}\",\n \"contactPhoneNumber\": \"{{UpdatedRestaurantPhoneNumber}}\",\n \"notes\": \"\",\n \"mobilePhoneNumber\": \"{{UpdatedMobilePhoneNumber}}\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/customer/:id","description":"Updates a customer record in the freely system of Record.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","name":"Public Freely Payment - Public Documentation","type":"collection"}},"urlObject":{"path":["customer",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"{{customerId}}","key":"id"}]}},"response":[{"id":"30244cfd-4a32-4e2b-ad35-9ffcbda18010","name":"Successful response","originalRequest":{"method":"PUT","header":[{"description":"The customer profile key. If not specified it will use the default profile specified by user profile.","key":"profileKey","value":"COOLCO"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThe customer profile key. If not specified it will use the default profile specified by user profile.
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/customer/:id","description":"Deletes a single customer from the freely system of record.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","name":"Public Freely Payment - Public Documentation","type":"collection"}},"urlObject":{"path":["customer",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"{{customerId}}","key":"id"}]}},"response":[{"id":"446f1dfd-d25e-4c4a-b96a-d74d257308a8","name":"Successful response","originalRequest":{"method":"DELETE","header":[{"description":"The customer profile key. If not specified it will use the default profile specified by user profile.","key":"profileKey","value":"tHuhzexRG9r2kCMx"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerCustomers are typically the restaurants which purchase food from the distributors. These APIS are for creating, getting, updating and deleting customer records.
\n","_postman_id":"0209d563-1097-4e4b-838f-64d1997ec3e3","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","name":"Public Freely Payment - Public Documentation","type":"collection"}}},{"name":"paymentTokens","item":[{"name":"Freely Accept Secure Frame","item":[{"name":"create tokenizer session","id":"61b35db0-d6f9-4484-94ed-68e174a3ff75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ProfileKey","value":"coolco","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": \"{{customerId}}\",\n \"tokenType\": \"CARD\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/auth/tokenizer","description":"This request is meant to be executed server side to create an authorized session that can be passed back to the browser to initialize the SDK. This request returns a secure guid
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","name":"Public Freely Payment - Public Documentation","type":"collection"}},"urlObject":{"path":["auth","tokenizer"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"61b35db0-d6f9-4484-94ed-68e174a3ff75"}],"id":"682ff8ea-9e70-4942-80ce-c048c19b632a","description":"The freely accept secure frame is freely payments SDK allowing third parties to limit their PCI exposure. The freely accept secure frame is meant to be used in combination with the Freely Payments API.
\nThe SDK allows third parties to embed a customized iframe that handles all tokenization of card data. Once a card are tokenized... the tokens can be used via the rest of the API ecosystem.
\nAs part of this
\n\nThis request will return a \"tokenizerSession\" that must be passed back to the brower. The session is specific to the CUSTOMER.
\nThis is where the entry iframe will be embedded inside your experience.
\nExample:
\nconst tokenSDK = new AcceptTokenSDK({\n containerId: 'token-form-container',\n tokenizerSession: '{session created on step 1}',\n onValidation: handleOnValidation,\n onTokenization: handleTokenization,\n onError: handleError\n});\npaymentSDK.initialize();\n\nExample:
\ntokenSDK.setStyles({\n cardInput: css\n cvvInput: css\n cardExpireInput: css\n cvvExpireInput: css\n zipInput: css\n addressInput: css\n errorFeedBack: css\n });\n\nExample:
\nfunction handleOnValidation(isValid) {\n if (isValid) {\n console.log('Form data is valid. Ready for submission.');\n // Enable submit button or proceed with tokenization\n } else {\n console.log('Form data is invalid. Please check the fields.');\n // Display error messages to the user\n }\n}\nfunction handleTokenization(tokenData) {\n console.log('Card successfully tokenized:', tokenData.token);\n // Process the payment using the token\n}\nfunction handleError(error) {\n console.error('An error occurred:', error.message);\n // Display error message to the user\n}\n\nNotes: The callback functions are called interactively leaving your application able to customize the experience including calling the .tokenize function. The handleTokenization passes back the tokenData with the tokenId that has now been added to the customer profile.
\nExample:
\n//Shows the tokenizer iframe. Initially the iframe is not displayed.\ntokenSDK.showTokenizer();\n//submits the validated input to be tokenized\n//This will throw an exception if the data is not valid. \ntokenSDK.tokenize();\n//hide the tokenizer iframe\ntokenSDK.hideTokenizer();\n//reset the tokenizer iframe \ntokenSdK.resetForm();\n\nThe customer profile key. If not specified it will use the default profile specified by user profile.
\n"},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/tokens","description":"Gets a full list of all payment tokens that are currently on Freely for a given profile.
\nThe returned list of tokens card information is redacted. For example: Account Numbers would display as \"XXXXXXXXXXXX1234\".
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","name":"Public Freely Payment - Public Documentation","type":"collection"}},"urlObject":{"path":["tokens"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"ba3d6a9d-6c1e-45b8-9250-7e1696b7b813","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"The customer profile key. If not specified it will use the default profile specified by user profile.","key":"profileKey","value":"tHuhzexRG9r2kCMx"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThe customer profile key. If not specified it will use the default profile specified by user profile.
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"paymentAccount\": {\n \"requestType\": \"CARD\",\n \"account\": \"5405222222222226\",\n \"cardHolderName\": \"John Doe\",\n \"expirationDate\": \"0925\",\n \"streetAddress\": \"5800 NW 39th AVE\",\n \"zipCode\": \"32606\",\n \"cvv\": \"123\"\n\n }\n\n}\n\n\n\n","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/validateCard","description":"Validates a payment card information including the AVS (Address Verification) and CV (Card Verification). The return payload will return details on the card.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","name":"Public Freely Payment - Public Documentation","type":"collection"}},"urlObject":{"path":["validateCard"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"30532b7d-305f-4baf-a2de-7d1664825c9f","name":"Successful response","originalRequest":{"method":"POST","header":[{"description":"The customer profile key. If not specified it will use the default profile specified by user profile.","key":"profileKey","value":"tHuhzexRG9r2kCMx"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThe customer profile key. If not specified it will use the default profile specified by user profile.
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account\": \"4055011111111111\",\n \"cardHolderName\": \"John Doe\",\n \"expirationDate\": \"0925\",\n \"streetAddress\": \"5800 NW 39th AVE\",\n \"zipCode\": \"32606\",\n \"cvv\": \"999\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/validateCard","description":"Validates a payment card information including the AVS (Address Verification) and CV (Card Verification). The return payload will return details on the card.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","id":"ee090ebb-0e96-47a8-9b5c-beddf66c21ec","name":"Public Freely Payment - Public Documentation","type":"collection"}},"urlObject":{"path":["validateCard"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"b40aa4db-acfa-42ac-8f28-34e89c3f6500","name":"Successful response","originalRequest":{"method":"POST","header":[{"description":"The customer profile key. If not specified it will use the default profile specified by user profile.","key":"profileKey","value":"tHuhzexRG9r2kCMx"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer