{"info":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"11189550","collectionId":"b662471b-f760-460e-85eb-7f7f1eff3619","publishedId":"TzCL8oQZ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-04-03T00:15:27.000Z"},"item":[{"name":"API","item":[{"name":"v1","item":[{"name":"Customers","item":[{"name":"Wallet","item":[{"name":"Create","id":"36c19eea-a561-4038-80e8-c339ccb1e16e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"token\": \"{{token_id}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.preferredpayments.com/v1/customers/{{customer_id}}/wallet","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","customers","{{customer_id}}","wallet"],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"36c19eea-a561-4038-80e8-c339ccb1e16e"},{"name":"List","id":"79ef8ab7-31bf-4f68-87bd-716611b38109","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.preferredpayments.com/v1/customers/{{customer_id}}/wallet","urlObject":{"protocol":"https","path":["v1","customers","{{customer_id}}","wallet"],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"79ef8ab7-31bf-4f68-87bd-716611b38109"}],"id":"9b13220e-67f8-4bee-8285-b1afb2003ec6","_postman_id":"9b13220e-67f8-4bee-8285-b1afb2003ec6","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}}},{"name":"Subscriptions","item":[{"name":"Get","id":"88c25ec1-061a-49b2-a39f-40d008125a66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.preferredpayments.com/v1/customers/{{customer_id}}/subscriptions/{{subscription_id}}/","description":"

Get the specified subscription and billing history.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","customers","{{customer_id}}","subscriptions","{{subscription_id}}",""],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"88c25ec1-061a-49b2-a39f-40d008125a66"},{"name":"List","id":"da0299dc-68bf-4041-a183-e0f8b1a63646","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.preferredpayments.com/v1/customers/{{customer_id}}/subscriptions/","description":"

Get a list of all subscriptions with there status associated with the current customer.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","customers","{{customer_id}}","subscriptions",""],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"da0299dc-68bf-4041-a183-e0f8b1a63646"},{"name":"Create","id":"0ecd607f-4388-4b84-ae53-a5841e519c9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"subscription_id\":\"UUID FROM SUBSCRIPTION\",\r\n \"start\":\"YYYY-MM-DD\",\r\n \"skip_first_payment\":false,\r\n \"payment\": {\r\n \"stored\":{\r\n \"wallet\":\"{{wallet_id}}\",\r\n \"initiated_by\":\"customer\"\r\n }\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.preferredpayments.com/v1/customers/{{customer_id}}/subscriptions/","description":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeValuesInfo
subscription_idVARCHARLEN 1-64
startDATEYYYY-MM-DDIf blank or null, start date will be the current date.
skip_first_paymentBOOLEANtrue, falseIf blank or false, the first billing will take place immediately. If true, the billing will happen based on the subscription plan schedule.
payment
payment.stored
payment.stored.walletVARCHARLEN 1-64If blank or null, the customers default payment method on file will be used.
payment.stored.initiated_byVARCHARcustomer, merchantRequired
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","customers","{{customer_id}}","subscriptions",""],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0ecd607f-4388-4b84-ae53-a5841e519c9a"},{"name":"Delete","id":"d08e3aff-f17c-4cff-83e3-cbc5f37db35b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.preferredpayments.com/v1/customers/{{customer_id}}/subscriptions/{{subscription_id}}/","description":"

If you delete a subscription from a customer it will stop all associated subscription billings.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","customers","{{customer_id}}","subscriptions","{{subscription_id}}",""],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d08e3aff-f17c-4cff-83e3-cbc5f37db35b"}],"id":"d69879d4-9516-409e-8489-ae47bdc750cb","_postman_id":"d69879d4-9516-409e-8489-ae47bdc750cb","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}}},{"name":"Create","id":"28e458a8-98a4-42f8-a3dd-24a470419cdd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"first_name\":\"\",\r\n \"last_name\":\"\",\r\n \"company\":\"\",\r\n \"merchant_identifier\":\"\",\r\n \"phone_number\":\"\",\r\n \"email_address\":\"\",\r\n \"shipping_address\":{\r\n \"name\":\"\",\r\n \"line_1\":\"\",\r\n \"line_2\":\"\",\r\n \"city\":\"\",\r\n \"state\":\"\",\r\n \"postal_code\":\"\",\r\n \"country\":\"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.preferredpayments.com/v1/customers","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","customers"],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"28e458a8-98a4-42f8-a3dd-24a470419cdd"},{"name":"Get","id":"7b900084-83b1-4398-b5ca-cb67df8a5cb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.preferredpayments.com/v1/customers/{{customer_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","customers","{{customer_id}}",""],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7b900084-83b1-4398-b5ca-cb67df8a5cb4"},{"name":"List","id":"5cc23311-07d0-4329-b86c-ed19863f66b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.preferredpayments.com/v1/customers/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","customers",""],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5cc23311-07d0-4329-b86c-ed19863f66b5"}],"id":"59819c5c-261a-434e-ba40-758c96507cc6","_postman_id":"59819c5c-261a-434e-ba40-758c96507cc6","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}}},{"name":"Tokens","item":[{"name":"Tokenize - Credit Card","id":"ea69345d-2ecf-4bfe-9765-ba533c1db4ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"credit_card\": {\r\n \"name_on_card\": \"{{name_on_card}}\",\r\n \"account_number\": \"{{account_number}}\",\r\n \"expires\": \"{{expires}}\",\r\n \"verification_value\": \"{{verification_value}}\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.preferredpayments.com/v1/tokens","urlObject":{"protocol":"https","path":["v1","tokens"],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ea69345d-2ecf-4bfe-9765-ba533c1db4ed"},{"name":"Tokenize - Check","id":"70137c68-1a41-415a-be03-d7e256fcdc21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"check\": {\n\t\t\"name\": \"\",\n\t\t\"account_number\": \"\",\n\t\t\"routing_number\": \"\",\n\t\t\"account_holder_type\": \"\",\n\t\t\"account_type\": \"\",\n\t\t\"sec_code\": \"\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.preferredpayments.com/v1/tokens","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","tokens"],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"70137c68-1a41-415a-be03-d7e256fcdc21"}],"id":"3255d1eb-85b9-45a0-a2b1-529c71cb0715","_postman_id":"3255d1eb-85b9-45a0-a2b1-529c71cb0715","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}}},{"name":"Transaction","item":[{"name":"Authorize","item":[{"name":"Authorize - Token","id":"518dbe72-93c2-4830-9fcb-4684bc3bdea1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n\t\t\"token\": \"{{token_id}}\"\r\n\t},\r\n\t\"amount\": {\r\n\t\t\"currency\": \"USD\",\r\n\t\t\"value\": 5.01\r\n\t},\r\n \"order\": {\r\n \"merchant_identifier\": \"\",\r\n \"bill_to\": {\r\n \"name\": \"REQUIRED IF NOT PROVIDED ON TOKEN\",\r\n \"address\": {\r\n \"line1\": \"\",\r\n \"line2\": \"\",\r\n \"city\": \"\",\r\n \"state\": \"\",\r\n \"postal_code\": \"\",\r\n \"country\": \"\"\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.preferredpayments.com/v1/transactions/authorize","urlObject":{"protocol":"https","path":["v1","transactions","authorize"],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"518dbe72-93c2-4830-9fcb-4684bc3bdea1"},{"name":"Authorize - Terminal","id":"004a9145-9280-4dbd-b36e-94a1cab668fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\":{\r\n\t\t\"terminal\":{\r\n\t\t\t\"id\":\"{{terminal_id}}\",\r\n\t\t\t\"prompt_tip\":false,\r\n\t\t\t\"tip_amounts\":[1.00, 2.00, 3.00, 4.00],\r\n\t\t\t\"key_card\":false,\r\n\t\t\t\"prompt_cvv\":false,\r\n\t\t\t\"prompt_postal_code\":false,\r\n\t\t\t\"prompt_amount_confirmation\":false,\r\n\t\t\t\"prompt_signature\":true\r\n\t\t}\r\n\t},\r\n\t\"amount\": {\r\n\t\t\"value\": 0.01\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.preferredpayments.com/v1/transactions/authorize","urlObject":{"protocol":"https","path":["v1","transactions","authorize"],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"004a9145-9280-4dbd-b36e-94a1cab668fa"},{"name":"Authorize - Customer","id":"54dc96be-4d7b-4a17-9c23-f541a7488d45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"stored\":{\r\n \"wallet\":\"{{wallet_id}}\",\r\n \"initiated_by\":\"customer\"\r\n }\r\n\t},\r\n\t\"amount\": {\r\n\t\t\"value\": 6.00\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.preferredpayments.com/v1/transactions/authorize","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","transactions","authorize"],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"54dc96be-4d7b-4a17-9c23-f541a7488d45"}],"id":"d6b731ae-80ad-448e-a4f4-d1ac44cc66f3","_postman_id":"d6b731ae-80ad-448e-a4f4-d1ac44cc66f3","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}}},{"name":"Credit","item":[{"name":"Credit - Token","id":"837c6d4b-08ce-4804-8b56-ef0f8ae5c4c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n\t\t\"token\": \"{{token_id}}\"\r\n\t},\r\n\t\"amount\": {\r\n\t\t\"currency\": \"USD\",\r\n\t\t\"value\": 5.01\r\n\t},\r\n \"order\": {\r\n \"merchant_identifier\": \"\",\r\n \"bill_to\": {\r\n \"name\": \"REQUIRED IF NOT PROVIDED ON TOKEN\",\r\n \"address\": {\r\n \"line1\": \"\",\r\n \"line2\": \"\",\r\n \"city\": \"\",\r\n \"state\": \"\",\r\n \"postal_code\": \"\",\r\n \"country\": \"\"\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.preferredpayments.com/v1/transactions/credit","urlObject":{"protocol":"https","path":["v1","transactions","credit"],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"837c6d4b-08ce-4804-8b56-ef0f8ae5c4c5"},{"name":"Credit - Terminal","id":"5c5b1310-a1a7-4c05-93d7-0d7241295e65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\":{\r\n\t\t\"terminal\":{\r\n\t\t\t\"id\":\"{{terminal_id}}\",\r\n\t\t\t\"prompt_tip\":false,\r\n\t\t\t\"tip_amounts\":[1.00, 2.00, 3.00, 4.00],\r\n\t\t\t\"key_card\":false,\r\n\t\t\t\"prompt_cvv\":false,\r\n\t\t\t\"prompt_postal_code\":false,\r\n\t\t\t\"prompt_amount_confirmation\":false,\r\n\t\t\t\"prompt_signature\":true\r\n\t\t}\r\n\t},\r\n\t\"amount\": {\r\n\t\t\"value\": 0.01\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.preferredpayments.com/v1/transactions/credit","urlObject":{"protocol":"https","path":["v1","transactions","credit"],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5c5b1310-a1a7-4c05-93d7-0d7241295e65"}],"id":"f76fb553-616d-45c6-915b-624a41a40bc6","_postman_id":"f76fb553-616d-45c6-915b-624a41a40bc6","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}}},{"name":"Sale","item":[{"name":"Sale - Token","id":"b2e421c3-7e0a-4b21-8320-46ad8995aa74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n\t\t\"token\": \"{{token_id}}\"\r\n\t},\r\n\t\"amount\": {\r\n\t\t\"currency\": \"USD\",\r\n\t\t\"value\": 5.01\r\n\t},\r\n \"order\": {\r\n \"merchant_identifier\": \"\",\r\n \"bill_to\": {\r\n \"name\": \"REQUIRED IF NOT PROVIDED ON TOKEN\",\r\n \"address\": {\r\n \"line1\": \"\",\r\n \"line2\": \"\",\r\n \"city\": \"\",\r\n \"state\": \"\",\r\n \"postal_code\": \"\",\r\n \"country\": \"\"\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.preferredpayments.com/v1/transactions/sale","urlObject":{"protocol":"https","path":["v1","transactions","sale"],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b2e421c3-7e0a-4b21-8320-46ad8995aa74"},{"name":"Sale - Terminal","id":"4570ae81-ec5e-45e0-a47c-37301876261b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\":{\r\n\t\t\"terminal\":{\r\n\t\t\t\"id\":\"{{terminal_id}}\",\r\n\t\t\t\"prompt_tip\":false,\r\n\t\t\t\"tip_amounts\":[1.00, 2.00, 3.00, 4.00],\r\n\t\t\t\"key_card\":false,\r\n\t\t\t\"prompt_cvv\":false,\r\n\t\t\t\"prompt_postal_code\":false,\r\n\t\t\t\"prompt_amount_confirmation\":false,\r\n\t\t\t\"prompt_signature\":true\r\n\t\t}\r\n\t},\r\n\t\"amount\": {\r\n\t\t\"value\": 0.01\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.preferredpayments.com/v1/transactions/sale","urlObject":{"protocol":"https","path":["v1","transactions","sale"],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4570ae81-ec5e-45e0-a47c-37301876261b"},{"name":"Sale - Customer Wallet","id":"14100583-f688-46e6-b3be-f1433365f8a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"stored\":{\r\n \"wallet\":\"{{wallet_id}}\",\r\n \"initiated_by\":\"customer\"\r\n }\r\n\t},\r\n\t\"amount\": {\r\n\t\t\"value\": 6.00\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.preferredpayments.com/v1/transactions/sale","urlObject":{"protocol":"https","path":["v1","transactions","sale"],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"14100583-f688-46e6-b3be-f1433365f8a7"}],"id":"7cf80d4d-1c8c-4130-a82b-515aa8972af5","_postman_id":"7cf80d4d-1c8c-4130-a82b-515aa8972af5","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}}},{"name":"Capture","id":"64ecdaab-7672-4828-bdda-f7af6d8a4ab2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"transaction_id\":\"{{transaction_id}}\",\n\t\"amount\":1.00\n}","options":{"raw":{"language":"json"}}},"url":"https://api.preferredpayments.com/v1/transactions/capture","urlObject":{"protocol":"https","path":["v1","transactions","capture"],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"64ecdaab-7672-4828-bdda-f7af6d8a4ab2"},{"name":"Refund","id":"4dfb71a0-7c9a-441a-815d-b9da8925ee8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"transaction_id\":\"{{transaction_id}}\",\n\t\"amount\":0.01,\n\t\"reason\":\"required\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.preferredpayments.com/v1/transactions/refund","urlObject":{"protocol":"https","path":["v1","transactions","refund"],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4dfb71a0-7c9a-441a-815d-b9da8925ee8a"},{"name":"Void","id":"1f0bc6df-10aa-41c1-a493-dbd63189543b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"transaction_id\":\"{{transaction_id}}\",\n\t\"reason\":\"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.preferredpayments.com/v1/transactions/void","urlObject":{"protocol":"https","path":["v1","transactions","void"],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1f0bc6df-10aa-41c1-a493-dbd63189543b"}],"id":"5847d2c3-e21b-4519-ac04-80899ff5b880","_postman_id":"5847d2c3-e21b-4519-ac04-80899ff5b880","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}}},{"name":"Terminals","item":[{"name":"Register","id":"f9d1a76c-910c-4fe9-bce7-1c6dadac2b62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"nickname\":\"NICKNAME\",\r\n \"registration_code\":\"REGCODE\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.preferredpayments.com/v1/terminals/","urlObject":{"protocol":"https","path":["v1","terminals",""],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f9d1a76c-910c-4fe9-bce7-1c6dadac2b62"},{"name":"Delete","id":"b31701fe-8a1c-47a7-a89b-848a756842d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.preferredpayments.com/v1/terminals/{{terminal_id}}","urlObject":{"protocol":"https","path":["v1","terminals","{{terminal_id}}"],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b31701fe-8a1c-47a7-a89b-848a756842d2"},{"name":"List","id":"b2b84253-0901-412b-b6f5-213ee49e24eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.preferredpayments.com/v1/terminals/","urlObject":{"protocol":"https","path":["v1","terminals",""],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b2b84253-0901-412b-b6f5-213ee49e24eb"},{"name":"Get","id":"2aeb0f66-2785-4515-920b-ad60e7b18f4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.preferredpayments.com/v1/terminals/{{terminal_id}}","urlObject":{"protocol":"https","path":["v1","terminals","{{terminal_id}}"],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2aeb0f66-2785-4515-920b-ad60e7b18f4f"}],"id":"4f28774e-b3d9-48b6-bf5d-4211ed8ce368","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"21ddbedd-eb73-4957-b22b-1f5ef8fdb963"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b54fe03b-5895-4494-8478-dd76f2953185"}}],"_postman_id":"4f28774e-b3d9-48b6-bf5d-4211ed8ce368","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}}},{"name":"Subscriptions","item":[{"name":"Get","id":"9e52ecde-5c1a-4289-8556-f38ad2f0fc6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.preferredpayments.com/v1/subscriptions/{{subscription_id}}/","description":"

Get a specific subscription.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","subscriptions","{{subscription_id}}",""],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9e52ecde-5c1a-4289-8556-f38ad2f0fc6d"},{"name":"List","id":"682d8bf1-5366-4444-a58c-8da7f09a47ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.preferredpayments.com/v1/subscriptions/","description":"

Get a list of all active subscriptions.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","subscriptions",""],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"682d8bf1-5366-4444-a58c-8da7f09a47ab"},{"name":"Create","id":"b105271a-c242-4f52-bf39-028f811a58c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"label\":\"monthly billing\",\r\n \"cycle\":{\r\n \"unit\":\"month\",\r\n \"interval\":1,\r\n \"day_of_cycle\":1\r\n },\r\n \"amount\":{\r\n \"currency\":\"usd\",\r\n \"value\":29.95\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.preferredpayments.com/v1/subscriptions/","description":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeValuesInfo
labelVARCHARLEN 1-255REQUIRED
cycle
cycle.unitVARCHARday, week, month, yearREQUIRED
cycle.intervalINT[day, 1 = daily, 7 = weekly, 14 = bi-weekly, range 1-365]
\n[week, 1 = weekly, 2 = by-weekly, range 1-52]
\n[month, 1 = monthly, 3 = quarterly, range 1-12]
\n[year, 1 = yearly]
\n[default, 0 = daily for 'day', weekly for 'week', monthly for 'month', yearly for 'year']
cycle.day_of_cycleINT[day, range 1-1]
\n[week, range 1-7]
\n[month, range 1-31]
\n[year, range 1-365]
\n[default, 0 = day subscription was started]
amount
amount.currencyCHARUSD
amount.valueDECIMAL0.00-1000000.00REQUIRED
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","subscriptions",""],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b105271a-c242-4f52-bf39-028f811a58c6"},{"name":"Delete","id":"bf0e44e0-b326-4da2-888e-3d34266058e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.preferredpayments.com/v1/subscriptions/{{subscription_id}}/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","subscriptions","{{subscription_id}}",""],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bf0e44e0-b326-4da2-888e-3d34266058e8"}],"id":"e65935af-6cdc-4382-b2d0-b073fd547ef1","_postman_id":"e65935af-6cdc-4382-b2d0-b073fd547ef1","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}}},{"name":"Health","id":"b06262cf-9fe7-4aee-9c7d-cb325c484d0e","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true,"accept-encoding":true,"connection":true},"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.preferredpayments.com/health","urlObject":{"protocol":"https","path":["health"],"host":["api","preferredpayments","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b06262cf-9fe7-4aee-9c7d-cb325c484d0e"}],"id":"f8548c8b-2a9e-4164-aeea-5b65b6453207","_postman_id":"f8548c8b-2a9e-4164-aeea-5b65b6453207","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}}}],"id":"da613b40-144d-454c-a675-5fda097e307d","_postman_id":"da613b40-144d-454c-a675-5fda097e307d","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b662471b-f760-460e-85eb-7f7f1eff3619","id":"b662471b-f760-460e-85eb-7f7f1eff3619","name":"Ecrypt by PreferredPayments","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{header-x-api-key}}"}]}},"event":[{"listen":"prerequest","script":{"id":"fa7a27e4-9b07-4f7d-8288-6f936cc795d2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5fa18f75-8ecd-41ac-8022-c36344815aa7","type":"text/javascript","exec":[""]}}]}