{"info":{"_postman_id":"3c3bbba2-3334-4ff6-8548-f49d8938f24b","name":"Kovena master-merchant  API","description":"<html><head></head><body><p>This is a quick start guide on how to navigate the Kovena master-merchant API</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"19488105","collectionId":"3c3bbba2-3334-4ff6-8548-f49d8938f24b","publishedId":"UVypyx6e","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-03-30T09:43:55.000Z"},"item":[{"name":"charges","item":[{"name":"search","id":"346332fd-e31f-4641-91d6-09a1d9f54dce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"<p>This is your Kovena Access token</p>\n","key":"x-access-token","value":"{{xaccesstoken}}"},{"description":"<p>Content-Type will always be application/json</p>\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/scope/brand/charges","description":"<p>Returns all charges.</p>\n<h2 id=\"request-query-params\">Request query params</h2>\n<p>Similar you can see on this <a href=\"https://documenter.getpostman.com/view/19488105/UVeJLkRN#02883900-dad0-4ed6-9050-818ff2ac0eb7\">resource</a></p>\n<p><strong>Additional filters</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>field</th>\n<th>required</th>\n<th>type</th>\n<th>description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>company_id</td>\n<td>-</td>\n<td>string (24 hex characters)</td>\n<td>ID of a particular company</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["v1","scope","brand","charges"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"f248df86-d716-47ff-a452-502a02d7fea0","name":"search by phrase","originalRequest":{"method":"GET","header":[{"description":"This is your Kovena Access token","key":"x-access-token","value":"{{xaccesstoken}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"url":{"raw":"{{url}}/v1/scope/brand/charges?search=Wanda","host":["{{url}}"],"path":["v1","scope","brand","charges"],"query":[{"key":"search","value":"Wanda"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 May 2020 14:39:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1049"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Kovena <kovena.com>"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-info-limit","value":"100"},{"key":"x-info-skip","value":"0"},{"key":"x-info-sort-key","value":"created_at"},{"key":"x-info-sort-direction","value":"DESC"},{"key":"x-info-count","value":"1"},{"key":"etag","value":"W/\"419-GTaNC0tX/cSU+NnmCBh7HoFz8h8\""},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0"},{"key":"Pragma","value":"no-cache"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": 200,\n    \"error\": null,\n    \"resource\": {\n        \"type\": \"charges\",\n        \"data\": [\n            {\n                \"_id\": \"5ec69295b12c99579e46ee58\",\n                \"created_at\": \"2020-05-21T14:39:17.056Z\",\n                \"updated_at\": \"2020-05-21T14:39:17.783Z\",\n                \"amount\": 10,\n                \"currency\": \"AUD\",\n                \"_source_ip_address\": \"192.168.0.1\",\n                \"transactions\": [\n                    {\n                        \"created_at\": \"2020-05-21T14:39:17.054Z\",\n                        \"amount\": 10,\n                        \"currency\": \"AUD\",\n                        \"_id\": \"5ec69295b12c99579e46ee59\",\n                        \"error_code\": null,\n                        \"error_message\": null,\n                        \"gateway_specific_description\": null,\n                        \"gateway_specific_code\": null,\n                        \"_source_ip_address\": \"192.168.0.1\",\n                        \"status\": \"complete\",\n                        \"type\": \"sale\"\n                    }\n                ],\n                \"one_off\": true,\n                \"archived\": false,\n                \"customer\": {\n                    \"first_name\": \"Wanda\",\n                    \"last_name\": \"Mertz\",\n                    \"payment_source\": {\n                        \"card_name\": \"Wanda Mertz\",\n                        \"card_number_last4\": \"4242\",\n                        \"expire_month\": 9,\n                        \"expire_year\": 21,\n                        \"gateway_id\": \"5cbede1f151b842653e987be\",\n                        \"card_scheme\": \"visa\",\n                        \"gateway_name\": \"Stripe 1\",\n                        \"gateway_type\": \"Stripe\"\n                    }\n                },\n                \"capture\": true,\n                \"status\": \"complete\",\n                \"items\": [],\n                \"transfer\": {\n                    \"items\": []\n                },\n                \"external_id\": \"ch_0GlFYHjQKtR4Rpd2Vtykp0x2\"\n            }\n        ],\n        \"skip\": 0,\n        \"limit\": 100,\n        \"sortkey\": \"created_at\",\n        \"sortdirection\": \"DESC\",\n        \"count\": 1\n    }\n}"},{"id":"a89b0aec-0710-4f95-b63d-c40e5263a4a2","name":"search with pagination and sorts","originalRequest":{"method":"GET","header":[{"description":"This is your Kovena Access token","key":"x-access-token","value":"{{xaccesstoken}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"url":{"raw":"{{url}}/v1/scope/brand/charges?limit=2&skip=1&sortkey=updated_at&sortdirection=DESC","host":["{{url}}"],"path":["v1","scope","brand","charges"],"query":[{"key":"limit","value":"2"},{"key":"skip","value":"1"},{"key":"sortkey","value":"updated_at"},{"key":"sortdirection","value":"DESC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 May 2020 14:29:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2163"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Kovena <kovena.com>"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-info-limit","value":"2"},{"key":"x-info-skip","value":"1"},{"key":"x-info-sort-key","value":"updated_at"},{"key":"x-info-sort-direction","value":"DESC"},{"key":"x-info-count","value":"19"},{"key":"etag","value":"W/\"873-2n8rca7tWEniayvsaGdhSjGTSD0\""},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0"},{"key":"Pragma","value":"no-cache"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": 200,\n    \"error\": null,\n    \"resource\": {\n        \"type\": \"charges\",\n        \"data\": [\n            {\n                \"_id\": \"5ec63451b12c99579e46ee31\",\n                \"created_at\": \"2020-05-21T07:57:05.911Z\",\n                \"updated_at\": \"2020-05-21T07:57:06.565Z\",\n                \"amount\": 10,\n                \"currency\": \"AUD\",\n                \"_source_ip_address\": \"192.168.0.1\",\n                \"transactions\": [\n                    {\n                        \"created_at\": \"2020-05-21T07:57:05.909Z\",\n                        \"amount\": 10,\n                        \"currency\": \"AUD\",\n                        \"_id\": \"5ec63451b12c99579e46ee32\",\n                        \"error_code\": null,\n                        \"error_message\": null,\n                        \"gateway_specific_description\": null,\n                        \"gateway_specific_code\": null,\n                        \"_source_ip_address\": \"192.168.0.1\",\n                        \"status\": \"complete\",\n                        \"type\": \"sale\"\n                    }\n                ],\n                \"one_off\": true,\n                \"archived\": false,\n                \"customer\": {\n                    \"customer_id\": \"5e4bfbd86d244b438451fbd7\",\n                    \"first_name\": \"Wanda\",\n                    \"last_name\": \"Mertz\",\n                    \"company_name\": \"Hahn Mertz LLC\",\n                    \"payment_source\": {\n                        \"source_id\": \"5e4bfbc96d244b438451fbd6\",\n                        \"type\": \"card\",\n                        \"card_name\": \"Wanda Mertz\",\n                        \"card_number_last4\": \"4242\",\n                        \"card_scheme\": \"visa\",\n                        \"expire_month\": 12,\n                        \"expire_year\": 2020,\n                        \"address_country\": \"AU\",\n                        \"gateway_id\": \"5cbede1f151b842653e987be\"\n                    }\n                },\n                \"capture\": true,\n                \"status\": \"complete\",\n                \"items\": [],\n                \"transfer\": {\n                    \"items\": []\n                },\n                \"external_id\": \"ch_0Gl9H4jQKtR4Rpd2kZBVPd2l\"\n            },\n            {\n                \"_id\": \"5ec63445b12c99579e46ee27\",\n                \"created_at\": \"2020-05-21T07:56:53.298Z\",\n                \"updated_at\": \"2020-05-21T07:56:53.841Z\",\n                \"amount\": 10,\n                \"currency\": \"AUD\",\n                \"_source_ip_address\": \"192.168.0.1\",\n                \"transactions\": [\n                    {\n                        \"created_at\": \"2020-05-21T07:56:53.291Z\",\n                        \"amount\": 10,\n                        \"currency\": \"AUD\",\n                        \"_id\": \"5ec63445b12c99579e46ee28\",\n                        \"error_code\": null,\n                        \"error_message\": null,\n                        \"gateway_specific_description\": null,\n                        \"gateway_specific_code\": null,\n                        \"_source_ip_address\": \"192.168.0.1\",\n                        \"status\": \"pending\",\n                        \"type\": \"sale\",\n                        \"pended_at\": \"2020-05-22T07:56:53.840Z\"\n                    }\n                ],\n                \"one_off\": true,\n                \"archived\": false,\n                \"customer\": {\n                    \"customer_id\": \"5e4bfbd86d244b438451fbd7\",\n                    \"first_name\": \"Wanda\",\n                    \"last_name\": \"Mertz\",\n                    \"company_name\": \"Hahn Mertz LLC\",\n                    \"payment_source\": {\n                        \"source_id\": \"5e4bfbc96d244b438451fbd6\",\n                        \"type\": \"card\",\n                        \"card_name\": \"Wanda Mertz\",\n                        \"card_number_last4\": \"4242\",\n                        \"card_scheme\": \"visa\",\n                        \"expire_month\": 12,\n                        \"expire_year\": 2020,\n                        \"address_country\": \"AU\",\n                        \"gateway_id\": \"5cbede1f151b842653e987be\"\n                    }\n                },\n                \"capture\": true,\n                \"status\": \"pending\",\n                \"items\": [],\n                \"transfer\": {\n                    \"items\": []\n                },\n                \"external_id\": \"ch_0Gl9GrjQKtR4Rpd2pRu8np3P\"\n            }\n        ],\n        \"skip\": 1,\n        \"limit\": 2,\n        \"sortkey\": \"updated_at\",\n        \"sortdirection\": \"DESC\",\n        \"count\": 19\n    }\n}"},{"id":"9f6b7da3-5cd1-4fb9-8b38-ccbdb547a834","name":"search with filters","originalRequest":{"method":"GET","header":[{"description":"This is your Kovena Access token","key":"x-access-token","value":"{{xaccesstoken}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"url":{"raw":"{{url}}/v1/scope/brand/charges?customer_id=5e4bfbd86d244b438451fbd7","host":["{{url}}"],"path":["v1","scope","brand","charges"],"query":[{"key":"customer_id","value":"5e4bfbd86d244b438451fbd7"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 May 2020 14:33:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2162"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Kovena <kovena.com>"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-info-limit","value":"2"},{"key":"x-info-skip","value":"0"},{"key":"x-info-sort-key","value":"created_at"},{"key":"x-info-sort-direction","value":"DESC"},{"key":"x-info-count","value":"4"},{"key":"etag","value":"W/\"872-2+aAQVFVJoo94Eq2y4buQktatmo\""},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0"},{"key":"Pragma","value":"no-cache"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": 200,\n    \"error\": null,\n    \"resource\": {\n        \"type\": \"charges\",\n        \"data\": [\n            {\n                \"_id\": \"5ec63451b12c99579e46ee31\",\n                \"created_at\": \"2020-05-21T07:57:05.911Z\",\n                \"updated_at\": \"2020-05-21T07:57:06.565Z\",\n                \"amount\": 10,\n                \"currency\": \"AUD\",\n                \"_source_ip_address\": \"192.168.0.1\",\n                \"transactions\": [\n                    {\n                        \"created_at\": \"2020-05-21T07:57:05.909Z\",\n                        \"amount\": 10,\n                        \"currency\": \"AUD\",\n                        \"_id\": \"5ec63451b12c99579e46ee32\",\n                        \"error_code\": null,\n                        \"error_message\": null,\n                        \"gateway_specific_description\": null,\n                        \"gateway_specific_code\": null,\n                        \"_source_ip_address\": \"192.168.0.1\",\n                        \"status\": \"complete\",\n                        \"type\": \"sale\"\n                    }\n                ],\n                \"one_off\": true,\n                \"archived\": false,\n                \"customer\": {\n                    \"customer_id\": \"5e4bfbd86d244b438451fbd7\",\n                    \"first_name\": \"Wanda\",\n                    \"last_name\": \"Mertz\",\n                    \"company_name\": \"Hahn Mertz LLC\",\n                    \"payment_source\": {\n                        \"source_id\": \"5e4bfbc96d244b438451fbd6\",\n                        \"type\": \"card\",\n                        \"card_name\": \"Wanda Mertz\",\n                        \"card_number_last4\": \"4242\",\n                        \"card_scheme\": \"visa\",\n                        \"expire_month\": 12,\n                        \"expire_year\": 2020,\n                        \"address_country\": \"AU\",\n                        \"gateway_id\": \"5cbede1f151b842653e987be\"\n                    }\n                },\n                \"capture\": true,\n                \"status\": \"complete\",\n                \"items\": [],\n                \"transfer\": {\n                    \"items\": []\n                },\n                \"external_id\": \"ch_0Gl9H4jQKtR4Rpd2kZBVPd2l\"\n            },\n            {\n                \"_id\": \"5ec63445b12c99579e46ee27\",\n                \"created_at\": \"2020-05-21T07:56:53.298Z\",\n                \"updated_at\": \"2020-05-21T07:56:53.841Z\",\n                \"amount\": 10,\n                \"currency\": \"AUD\",\n                \"_source_ip_address\": \"192.168.0.1\",\n                \"transactions\": [\n                    {\n                        \"created_at\": \"2020-05-21T07:56:53.291Z\",\n                        \"amount\": 10,\n                        \"currency\": \"AUD\",\n                        \"_id\": \"5ec63445b12c99579e46ee28\",\n                        \"error_code\": null,\n                        \"error_message\": null,\n                        \"gateway_specific_description\": null,\n                        \"gateway_specific_code\": null,\n                        \"_source_ip_address\": \"192.168.0.1\",\n                        \"status\": \"pending\",\n                        \"type\": \"sale\",\n                        \"pended_at\": \"2020-05-22T07:56:53.840Z\"\n                    }\n                ],\n                \"one_off\": true,\n                \"archived\": false,\n                \"customer\": {\n                    \"customer_id\": \"5e4bfbd86d244b438451fbd7\",\n                    \"first_name\": \"Wanda\",\n                    \"last_name\": \"Mertz\",\n                    \"company_name\": \"Hahn Mertz LLC\",\n                    \"payment_source\": {\n                        \"source_id\": \"5e4bfbc96d244b438451fbd6\",\n                        \"type\": \"card\",\n                        \"card_name\": \"Wanda Mertz\",\n                        \"card_number_last4\": \"4242\",\n                        \"card_scheme\": \"visa\",\n                        \"expire_month\": 12,\n                        \"expire_year\": 2020,\n                        \"address_country\": \"AU\",\n                        \"gateway_id\": \"5cbede1f151b842653e987be\"\n                    }\n                },\n                \"capture\": true,\n                \"status\": \"pending\",\n                \"items\": [],\n                \"transfer\": {\n                    \"items\": []\n                },\n                \"external_id\": \"ch_0Gl9GrjQKtR4Rpd2pRu8np3P\"\n            }\n        ],\n        \"skip\": 0,\n        \"limit\": 2,\n        \"sortkey\": \"created_at\",\n        \"sortdirection\": \"DESC\",\n        \"count\": 4\n    }\n}"}],"_postman_id":"346332fd-e31f-4641-91d6-09a1d9f54dce"},{"name":"get","id":"2a90b0b6-6fe3-4967-a0d9-cad563a36ba3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"<p>This is your Kovena Access token</p>\n","key":"x-access-token","value":"{{xaccesstoken}}"},{"description":"<p>Content-Type will always be application/json</p>\n","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/scope/brand/charges/:id","description":"<p>Retrieves data on a charges with specified ID.</p>\n<h2 id=\"request-params\">Request params</h2>\n<p>Similar you can see on this <a href=\"https://documenter.getpostman.com/view/19488105/UVeJLkRN#02883900-dad0-4ed6-9050-818ff2ac0eb7\">resource</a></p>\n","urlObject":{"path":["v1","scope","brand","charges",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"5d7f7168-72f0-4a31-aa02-696fd1614626","type":"any","value":"5f084eb39c63b80a26e52b01","key":"id"}]}},"response":[{"id":"d3c77f27-7ef2-4140-b5c7-34324c0f7a24","name":"get","originalRequest":{"method":"GET","header":[{"description":"This is your Kovena Access token","key":"x-access-token","value":"{{xaccesstoken}}"},{"description":"Content-Type will always be application/json","key":"Content-Type","value":"application/json"}],"url":{"raw":"{{url}}/v1/scope/brand/charges/:id","host":["{{url}}"],"path":["v1","scope","brand","charges",":id"],"variable":[{"key":"id","value":"5ec7b21cb12c99579e46f270"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 22 May 2020 14:36:36 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"5267"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Kovena <kovena.com>"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"1493-189qrJovkcqiD7ZNoR1GCdbdxRI\""},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0"},{"key":"Pragma","value":"no-cache"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": 200,\n    \"error\": null,\n    \"resource\": {\n        \"type\": \"charges\",\n        \"data\": {\n            \"_id\": \"5ec7b21cb12c99579e46f270\",\n            \"created_at\": \"2020-05-22T11:06:04.900Z\",\n            \"updated_at\": \"2020-05-22T11:06:06.000Z\",\n            \"remittance_date\": \"2020-05-23T11:06:06.000Z\",\n            \"company_id\": \"5cbeda664fdfb25772b5547f\",\n            \"user_id\": \"5cbeda664fdfb25772b5547e\",\n            \"amount\": 1,\n            \"currency\": \"AUD\",\n            \"subscription_id\": \"5ec7b20ab12c99579e46f26b\",\n            \"_source_ip_address\": \"127.0.0.1\",\n            \"transactions\": [\n                {\n                    \"created_at\": \"2020-05-22T11:06:04.894Z\",\n                    \"amount\": 1,\n                    \"currency\": \"AUD\",\n                    \"_id\": \"5ec7b21cb12c99579e46f271\",\n                    \"error_code\": null,\n                    \"error_message\": null,\n                    \"gateway_specific_description\": null,\n                    \"gateway_specific_code\": null,\n                    \"_source_ip_address\": \"127.0.0.1\",\n                    \"service_logs\": [\n                        {\n                            \"req\": {\n                                \"format\": \"json\",\n                                \"body\": \"{\\\"body\\\":{\\\"amount\\\":1,\\\"customerId\\\":\\\"536537284\\\",\\\"type\\\":\\\"sale\\\"}}\"\n                            },\n                            \"response_body\": {\n                                \"format\": \"json\",\n                                \"body\": \"{\\\"transaction\\\":{\\\"id\\\":\\\"b7vyt6xm\\\",\\\"status\\\":\\\"authorized\\\",\\\"type\\\":\\\"sale\\\",\\\"currencyIsoCode\\\":\\\"USD\\\",\\\"amount\\\":\\\"1.00\\\",\\\"merchantAccountId\\\":\\\"4cptn45444ks9cw4\\\",\\\"subMerchantAccountId\\\":null,\\\"masterMerchantAccountId\\\":null,\\\"orderId\\\":null,\\\"createdAt\\\":\\\"2020-05-22T11:06:05Z\\\",\\\"updatedAt\\\":\\\"2020-05-22T11:06:05Z\\\",\\\"customer\\\":{\\\"id\\\":\\\"536537284\\\",\\\"firstName\\\":null,\\\"lastName\\\":null,\\\"company\\\":null,\\\"email\\\":\\\"wanda.mertz@example.com\\\",\\\"website\\\":null,\\\"phone\\\":null,\\\"fax\\\":null,\\\"globalId\\\":\\\"Y3VzdG9tZXJfNTM2NTM3Mjg0\\\"},\\\"billing\\\":{\\\"id\\\":null,\\\"firstName\\\":null,\\\"lastName\\\":null,\\\"company\\\":null,\\\"streetAddress\\\":null,\\\"extendedAddress\\\":null,\\\"locality\\\":null,\\\"region\\\":null,\\\"postalCode\\\":null,\\\"countryName\\\":null,\\\"countryCodeAlpha2\\\":null,\\\"countryCodeAlpha3\\\":null,\\\"countryCodeNumeric\\\":null},\\\"refundId\\\":null,\\\"refundIds\\\":[],\\\"refundedTransactionId\\\":null,\\\"partialSettlementTransactionIds\\\":[],\\\"authorizedTransactionId\\\":null,\\\"settlementBatchId\\\":null,\\\"shipping\\\":{\\\"id\\\":null,\\\"firstName\\\":null,\\\"lastName\\\":null,\\\"company\\\":null,\\\"streetAddress\\\":null,\\\"extendedAddress\\\":null,\\\"locality\\\":null,\\\"region\\\":null,\\\"postalCode\\\":null,\\\"countryName\\\":null,\\\"countryCodeAlpha2\\\":null,\\\"countryCodeAlpha3\\\":null,\\\"countryCodeNumeric\\\":null},\\\"customFields\\\":\\\"\\\",\\\"avsErrorResponseCode\\\":null,\\\"avsPostalCodeResponseCode\\\":\\\"I\\\",\\\"avsStreetAddressResponseCode\\\":\\\"I\\\",\\\"cvvResponseCode\\\":\\\"I\\\",\\\"gatewayRejectionReason\\\":null,\\\"processorAuthorizationCode\\\":\\\"2783KW\\\",\\\"processorResponseCode\\\":\\\"1000\\\",\\\"processorResponseText\\\":\\\"Approved\\\",\\\"additionalProcessorResponse\\\":null,\\\"voiceReferralNumber\\\":null,\\\"purchaseOrderNumber\\\":null,\\\"taxAmount\\\":null,\\\"taxExempt\\\":false,\\\"creditCard\\\":{\\\"token\\\":\\\"8x6m7fg\\\",\\\"bin\\\":\\\"424242\\\",\\\"last4\\\":\\\"4242\\\",\\\"cardType\\\":\\\"Visa\\\",\\\"expirationMonth\\\":\\\"03\\\",\\\"expirationYear\\\":\\\"2020\\\",\\\"customerLocation\\\":\\\"US\\\",\\\"cardholderName\\\":\\\"Wanda Mertz\\\",\\\"imageUrl\\\":\\\"https://assets.braintreegateway.com/payment_method_logo/visa.png?environment=sandbox\\\",\\\"prepaid\\\":\\\"Unknown\\\",\\\"healthcare\\\":\\\"Unknown\\\",\\\"debit\\\":\\\"Unknown\\\",\\\"durbinRegulated\\\":\\\"Unknown\\\",\\\"commercial\\\":\\\"Unknown\\\",\\\"payroll\\\":\\\"Unknown\\\",\\\"issuingBank\\\":\\\"Unknown\\\",\\\"countryOfIssuance\\\":\\\"Unknown\\\",\\\"productId\\\":\\\"Unknown\\\",\\\"globalId\\\":\\\"cGF5bWVudG1ldGhvZF9jY184eDZtN2Zn\\\",\\\"accountType\\\":null,\\\"uniqueNumberIdentifier\\\":\\\"8a8e0755d14e2ee2a306f4788f4e480a\\\",\\\"venmoSdk\\\":false,\\\"maskedNumber\\\":\\\"424242******4242\\\",\\\"expirationDate\\\":\\\"03/2020\\\"},\\\"statusHistory\\\":[{\\\"timestamp\\\":\\\"2020-05-22T11:06:05Z\\\",\\\"status\\\":\\\"authorized\\\",\\\"amount\\\":\\\"1.00\\\",\\\"user\\\":\\\"juls\\\",\\\"transactionSource\\\":\\\"api\\\"}],\\\"planId\\\":null,\\\"subscriptionId\\\":null,\\\"subscription\\\":{\\\"billingPeriodEndDate\\\":null,\\\"billingPeriodStartDate\\\":null},\\\"addOns\\\":[],\\\"discounts\\\":[],\\\"descriptor\\\":{\\\"name\\\":null,\\\"phone\\\":null,\\\"url\\\":null},\\\"recurring\\\":false,\\\"channel\\\":null,\\\"serviceFeeAmount\\\":null,\\\"escrowStatus\\\":null,\\\"disbursementDetails\\\":{\\\"disbursementDate\\\":null,\\\"settlementAmount\\\":null,\\\"settlementCurrencyIsoCode\\\":null,\\\"settlementCurrencyExchangeRate\\\":null,\\\"fundsHeld\\\":null,\\\"success\\\":null},\\\"disputes\\\":[],\\\"authorizationAdjustments\\\":[],\\\"paymentInstrumentType\\\":\\\"credit_card\\\",\\\"processorSettlementResponseCode\\\":\\\"\\\",\\\"processorSettlementResponseText\\\":\\\"\\\",\\\"networkResponseCode\\\":\\\"XX\\\",\\\"networkResponseText\\\":\\\"sample network response text\\\",\\\"threeDSecureInfo\\\":null,\\\"shipsFromPostalCode\\\":null,\\\"shippingAmount\\\":null,\\\"discountAmount\\\":null,\\\"networkTransactionId\\\":\\\"020200522110605\\\",\\\"processorResponseType\\\":\\\"approved\\\",\\\"authorizationExpiresAt\\\":\\\"2020-05-29T11:06:05Z\\\",\\\"refundGlobalIds\\\":[],\\\"partialSettlementTransactionGlobalIds\\\":[],\\\"refundedTransactionGlobalId\\\":null,\\\"authorizedTransactionGlobalId\\\":null,\\\"globalId\\\":\\\"dHJhbnNhY3Rpb25fYjd2eXQ2eG0\\\",\\\"retryIds\\\":[],\\\"retriedTransactionId\\\":null,\\\"retrievalReferenceNumber\\\":\\\"1234567\\\",\\\"paypalAccount\\\":{},\\\"coinbaseAccount\\\":{},\\\"applePayCard\\\":{},\\\"androidPayCard\\\":{}},\\\"success\\\":true}\"\n                            }\n                        }\n                    ],\n                    \"status\": \"complete\",\n                    \"type\": \"sale\"\n                }\n            ],\n            \"one_off\": false,\n            \"archived\": false,\n            \"customer\": {\n                \"customer_id\": \"5ec7b209b12c99579e46f268\",\n                \"email\": \"wanda.mertz@example.com\",\n                \"payment_source\": {\n                    \"type\": \"card\",\n                    \"card_name\": \"Wanda Mertz\",\n                    \"card_number_last4\": \"4242\",\n                    \"card_scheme\": \"visa\",\n                    \"expire_month\": 3,\n                    \"expire_year\": 2020,\n                    \"address_country\": \"AU\",\n                    \"gateway_id\": \"5cffefaa18b6546015794998\"\n                }\n            },\n            \"capture\": true,\n            \"status\": \"complete\",\n            \"items\": [],\n            \"transfer\": {\n                \"items\": []\n            },\n            \"__v\": 0,\n            \"external_id\": \"b7vyt6xm\"\n        }\n    }\n}"}],"_postman_id":"2a90b0b6-6fe3-4967-a0d9-cad563a36ba3"}],"id":"10101a48-1d29-493c-9c83-5b1e8d972292","description":"<p>A Charges is a one-time payment that can be requested against any connected processing service.</p>\n<p>Charges can be created through through of the following payment instruments in Kovena. Charges can have different states (i.e. when used within a 3DS or anti-fraud workflow) and can be manipulated based on the various states.</p>\n<p>To start working with these endpoints, you should first generate an access token in the Master Merchant dashboard and then use it as a header in your requests.<br />You can learn more on how to generate an access token <a href=\"https://docs.kovena.com/?shell#access-tokens\">here</a></p>\n<h2 id=\"charges-resource\">Charges Resource</h2>\n<p>Similar you can see on merchant scope documentation</p>\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"da08b8a6-3e47-4e7b-a7bf-db47857f1c56"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"22d4433f-c1ef-461d-ad3a-6b9d70dc9bd7"}}],"_postman_id":"10101a48-1d29-493c-9c83-5b1e8d972292"},{"name":"companies","item":[{"name":"create","id":"072e1b88-e95b-4018-9261-186d13275a75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-access-token","value":"{{xaccesstoken}}","description":"<p>This is your Kovena Access token</p>\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"<p>Content-Type will always be application/json</p>\n","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"email\": \"wanda-mertz.mertz@example.com\",\n    \"name\": \"Wanda\",\n    \"user\": {\n        \"password\": \"12345678\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/scope/brand/companies","description":"<p>This endpoint allows creating a company.</p>\n<h2 id=\"request-body\">Request body</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>field</th>\n<th>required</th>\n<th>type</th>\n<th>description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>email</td>\n<td>+</td>\n<td>string</td>\n<td>A company's email</td>\n</tr>\n<tr>\n<td>name</td>\n<td>+</td>\n<td>string</td>\n<td>A company's name (first and last name)</td>\n</tr>\n<tr>\n<td>user.password</td>\n<td>+</td>\n<td>string</td>\n<td>A user's password. This is a password that will be assigned to a new user which is created automatically along with the company</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["v1","scope","brand","companies"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"541cd66f-b48b-4f43-9213-baab2d7615c1","name":"create","originalRequest":{"method":"POST","header":[{"key":"x-access-token","value":"{{xaccesstoken}}","description":"This is your Kovena Access token","type":"text"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"email\": \"wanda-mertz.mertz@example.com\",\n    \"name\": \"Wanda\",\n    \"user\": {\n        \"password\": \"12345678\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/scope/brand/companies"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 28 Apr 2021 07:26:55 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"X-Powered-By","value":"Kovena <kovena.com>"},{"key":"etag","value":"W/\"135-ieNRfDCjRj+ffVZiXPB77JqpTDo\""},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0"},{"key":"Pragma","value":"no-cache"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": 201,\n    \"error\": null,\n    \"resource\": {\n        \"type\": \"company\",\n        \"data\": {\n            \"_id\": \"60890e3fcea13432c7b7775d\",\n            \"name\": \"Wanda\",\n            \"email\": \"wanda-mertz.mertz@example.com\",\n            \"user\": {\n                \"_id\": \"60890e3fcea13432c7b7775c\",\n                \"created_at\": \"2021-04-28T07:26:55.681Z\",\n                \"email\": \"wanda-mertz.mertz@example.com\"\n            }\n        }\n    }\n}"}],"_postman_id":"072e1b88-e95b-4018-9261-186d13275a75"},{"name":"update","id":"a9b50997-6427-4353-b2e1-e9c47b9e66bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-access-token","value":"{{xaccesstoken}}","description":"<p>This is your Kovena Access token</p>\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"<p>Content-Type will always be application/json</p>\n","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"email\": \"wanda-mertz.mertz@example.com\",\n    \"name\": \"Wanda\",\n    \"merchant_first_name\": \"Wanda\",\n    \"merchant_last_name\": \"Mertz\",\n    \"merchant_contact_name\": \"Wanda\",\n    \"address_line1\": \"61426 Osvaldo Plains\",\n    \"address_line2\": \"Apt. 276\",\n    \"description\": \"Description\",\n    \"phone\": \"+1234567890\",\n    \"address_postcode\": \"07396\",\n    \"address_state\": \"WY\",\n    \"address_country\": \"US\",\n    \"website\": \"http://hahn.mertz.llc.biz\",\n    \"address_city\": \"Lake Robyn\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/scope/brand/companies/:id","description":"<p>This endpoint allows updating details of the existing company.</p>\n<h2 id=\"request-params\">Request params</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>field</th>\n<th>required</th>\n<th>type</th>\n<th>description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>id</td>\n<td>+</td>\n<td>string (24 hex characters)</td>\n<td>_id of the company received at the creation stage</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"request-body\">Request body</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>field</th>\n<th>required</th>\n<th>type</th>\n<th>description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>email</td>\n<td>-</td>\n<td>string</td>\n<td>A company's email</td>\n</tr>\n<tr>\n<td>name</td>\n<td>-</td>\n<td>string</td>\n<td>A company's name</td>\n</tr>\n<tr>\n<td>merchant_first_name</td>\n<td>-</td>\n<td>string</td>\n<td>A merchant's first name</td>\n</tr>\n<tr>\n<td>merchant_last_name</td>\n<td>-</td>\n<td>string</td>\n<td>A merchant's last name</td>\n</tr>\n<tr>\n<td>merchant_contact_name</td>\n<td>-</td>\n<td>string</td>\n<td>A merchant's contact name</td>\n</tr>\n<tr>\n<td>address_line1</td>\n<td>-</td>\n<td>string</td>\n<td>A company's address (first line)</td>\n</tr>\n<tr>\n<td>address_line2</td>\n<td>-</td>\n<td>string</td>\n<td>A company's address (second line)</td>\n</tr>\n<tr>\n<td>description</td>\n<td>-</td>\n<td>string</td>\n<td>A custom description for a particular company that helps identify him/her among other companyies</td>\n</tr>\n<tr>\n<td>phone</td>\n<td>-</td>\n<td>string</td>\n<td>A company's phone number</td>\n</tr>\n<tr>\n<td>address_postcode</td>\n<td>-</td>\n<td>string</td>\n<td>A company's ZIP code</td>\n</tr>\n<tr>\n<td>address_state</td>\n<td>-</td>\n<td>string</td>\n<td>A company's state</td>\n</tr>\n<tr>\n<td>address_country</td>\n<td>-</td>\n<td>string</td>\n<td>A company's country</td>\n</tr>\n<tr>\n<td>website</td>\n<td>-</td>\n<td>string</td>\n<td>A company's website</td>\n</tr>\n<tr>\n<td>address_city</td>\n<td>-</td>\n<td>string</td>\n<td>A company's city</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["v1","scope","brand","companies",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"388a4e3d-3165-4d44-bdd1-b8b7b7595fe3","type":"any","value":"60890e3fcea13432c7b7775d","key":"id"}]}},"response":[{"id":"183f3769-b2ef-4f64-948a-47e038148de9","name":"update","originalRequest":{"method":"PUT","header":[{"key":"x-access-token","value":"{{xaccesstoken}}","description":"This is your Kovena Access token","type":"text"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"email\": \"wanda-mertz.mertz@example.com\",\n    \"name\": \"Wanda\",\n    \"merchant_first_name\": \"Wanda\",\n    \"merchant_last_name\": \"Mertz\",\n    \"merchant_contact_name\": \"Wanda\",\n    \"address_line1\": \"61426 Osvaldo Plains\",\n    \"address_line2\": \"Apt. 276\",\n    \"description\": \"Description\",\n    \"phone\": \"+1234567890\",\n    \"address_postcode\": \"07396\",\n    \"address_state\": \"WY\",\n    \"address_country\": \"US\",\n    \"website\": \"http://hahn.mertz.llc.biz\",\n    \"address_city\": \"Lake Robyn\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v1/scope/brand/companies/:id","host":["{{url}}"],"path":["v1","scope","brand","companies",":id"],"variable":[{"key":"id","value":"60890e3fcea13432c7b7775d"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 28 Apr 2021 07:38:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Kovena <kovena.com>"},{"key":"etag","value":"W/\"1df-HXiFenK2Bfw5VZswazIfhOFs13Q\""},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0"},{"key":"Pragma","value":"no-cache"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": 200,\n    \"error\": null,\n    \"resource\": {\n        \"type\": \"company\",\n        \"data\": {\n            \"address_city\": \"Lake Robyn\",\n            \"address_country\": \"US\",\n            \"address_line1\": \"61426 Osvaldo Plains\",\n            \"address_line2\": \"Apt. 276\",\n            \"address_postcode\": \"07396\",\n            \"address_state\": \"WY\",\n            \"email\": \"wanda-mertz.mertz@example.com\",\n            \"merchant_contact_name\": \"Wanda\",\n            \"merchant_first_name\": \"Wanda\",\n            \"merchant_last_name\": \"Mertz\",\n            \"name\": \"Wanda\",\n            \"website\": \"http://hahn.mertz.llc.biz\",\n            \"phone\": \"+1234567890\",\n            \"description\": \"Description\"\n        }\n    }\n}"}],"_postman_id":"a9b50997-6427-4353-b2e1-e9c47b9e66bf"},{"name":"search","id":"94f6cd9e-fe3b-4af5-bb63-b1f7561b1f52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-access-token","value":"{{xaccesstoken}}","description":"<p>This is your Kovena Access token</p>\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"<p>Content-Type will always be application/json</p>\n","type":"text"}],"url":"{{url}}/v1/scope/brand/companies","description":"<p>This endpoint allows searching for all companies of the Master Merchant.</p>\n<p><strong>Pagination</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>field</th>\n<th>required</th>\n<th>type</th>\n<th>description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>skip</td>\n<td>-</td>\n<td>number</td>\n<td>A pagination parameter to skip first <em>No.</em> companies from the list, default = 0</td>\n</tr>\n<tr>\n<td>limit</td>\n<td>-</td>\n<td>number</td>\n<td>A pagination parameter to limit output to <em>No.</em>, default = 100, maximum value = 1000</td>\n</tr>\n<tr>\n<td>sortkey</td>\n<td>-</td>\n<td>string</td>\n<td>A sorting key parameter, i.e. created_at</td>\n</tr>\n<tr>\n<td>sortdirection</td>\n<td>-</td>\n<td>string</td>\n<td>A sorting order direction parameter, i.e. <em>ASC</em> or <em>DESC</em> (<em>DESC</em> by default)</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Filters</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>field</th>\n<th>required</th>\n<th>type</th>\n<th>description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>id</td>\n<td>-</td>\n<td>string (24 hex characters)</td>\n<td>ID of a particular company received at the creation stage</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Other</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>field</th>\n<th>required</th>\n<th>type</th>\n<th>description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>search</td>\n<td>-</td>\n<td>string</td>\n<td>A word or phrase that can be used for searching a particular company (search works by the fields: Name and Email)</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["v1","scope","brand","companies"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"aa7862df-cadb-4c65-92fc-f7b2e645d683","name":"search","originalRequest":{"method":"GET","header":[{"key":"x-access-token","value":"{{xaccesstoken}}","description":"This is your Kovena Access token","type":"text"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json","type":"text"}],"url":"{{url}}/v1/scope/brand/companies"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 28 Apr 2021 07:51:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Kovena <kovena.com>"},{"key":"x-info-limit","value":"100"},{"key":"x-info-skip","value":"0"},{"key":"x-info-sort-key","value":"created_at"},{"key":"x-info-sort-direction","value":"DESC"},{"key":"x-info-count","value":"69"},{"key":"etag","value":"W/\"7dbb-HB5Jg5pFWkbuGrkAFwBtgfw9R88\""},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0"},{"key":"Pragma","value":"no-cache"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": 200,\n    \"error\": null,\n    \"resource\": {\n        \"type\": \"company\",\n        \"data\": [\n            {\n                \"company_account_id\": \"60890e3fcea13432c7b7775d\",\n                \"address_city\": \"Lake Robyn\",\n                \"address_country\": \"US\",\n                \"address_line1\": \"61426 Osvaldo Plains\",\n                \"address_line2\": \"Apt. 276\",\n                \"address_postcode\": \"07396\",\n                \"address_state\": \"WY\",\n                \"email\": \"wanda-mertz.mertz@example.com\",\n                \"merchant_contact_name\": \"Wanda\",\n                \"merchant_first_name\": \"Wanda\",\n                \"merchant_last_name\": \"Mertz\",\n                \"name\": \"Wanda\",\n                \"website\": \"http://hahn.mertz.llc.biz\",\n                \"phone\": \"+1234567890\",\n                \"description\": \"Description\",\n                \"user\": {\n                    \"created_at\": \"2021-04-28T07:26:55.681Z\",\n                    \"email\": \"wanda-mertz.mertz@example.com\"\n                }\n            },\n            {\n                \"company_account_id\": \"60890e3fcea13432c7b7776c\",\n                \"address_city\": \"Prohaskafurt\",\n                \"address_country\": \"AU\",\n                \"address_line1\": \"5031 Jordy Loop\",\n                \"address_line2\": \"Suite 076\",\n                \"address_postcode\": \"4920\",\n                \"address_state\": \"NSW\",\n                \"email\": \"carlie-kuvalis.kuvalis@example.com\",\n                \"merchant_contact_name\": \"Carlie\",\n                \"merchant_first_name\": \"Carlie\",\n                \"merchant_last_name\": \"Kuvalis\",\n                \"name\": \"Carlie\",\n                \"website\": \"http://hahn.mertz.llc.biz\",\n                \"phone\": \"+2234567890\",\n                \"description\": \"Description\",\n                \"user\": {\n                    \"created_at\": \"2021-04-28T07:26:55.681Z\",\n                    \"email\": \"carlie-kuvalis.kuvalis@example.com\"\n                }\n            }\n        ],\n        \"skip\": 0,\n        \"limit\": 100,\n        \"sortkey\": \"created_at\",\n        \"sortdirection\": \"DESC\",\n        \"count\": 69\n    }\n}"}],"_postman_id":"94f6cd9e-fe3b-4af5-bb63-b1f7561b1f52"},{"name":"archive","id":"19dfd29c-0f8d-49df-90a4-5a37e3d64629","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-access-token","value":"{{xaccesstoken}}","description":"<p>This is your Kovena Access token</p>\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"<p>Content-Type will always be application/json</p>\n","type":"text"}],"url":"{{url}}/v1/scope/brand/companies/:id","description":"<p>This endpoint allows archiving a company by ID.</p>\n<h2 id=\"request-params\">Request params</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>field</th>\n<th>required</th>\n<th>type</th>\n<th>description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>id</td>\n<td>+</td>\n<td>string (24 hex characters)</td>\n<td>ID of the company received at the creation stage</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["v1","scope","brand","companies",":id"],"host":["{{url}}"],"query":[],"variable":[{"id":"5fc5aba4-701e-4037-ba45-d35386707e51","type":"any","value":"60890e3fcea13432c7b7775d","key":"id"}]}},"response":[{"id":"7a5c94a4-22aa-427a-bada-c0223a5747d6","name":"common","originalRequest":{"method":"DELETE","header":[{"key":"x-access-token","value":"{{xaccesstoken}}","description":"This is your Kovena Access token","type":"text"},{"key":"Content-Type","value":"application/json","description":"Content-Type will always be application/json","type":"text"}],"url":{"raw":"{{url}}/v1/scope/brand/companies/:id","host":["{{url}}"],"path":["v1","scope","brand","companies",":id"],"variable":[{"key":"id","value":"60890e3fcea13432c7b7775d"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 28 Apr 2021 08:38:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Kovena <kovena.com>"},{"key":"etag","value":"W/\"1f6-wpTa7pVO4GwL+suDY+j6uTXz3/E\""},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0"},{"key":"Pragma","value":"no-cache"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": 200,\n    \"error\": null,\n    \"resource\": {\n        \"type\": \"company\",\n        \"data\": {\n            \"address_city\": \"Lake Robyn\",\n            \"address_country\": \"US\",\n            \"address_line1\": \"61426 Osvaldo Plains\",\n            \"address_line2\": \"Apt. 276\",\n            \"address_postcode\": \"07396\",\n            \"address_state\": \"WY\",\n            \"email\": \"archived|wanda-mertz.mertz@example.com|1619599083812\",\n            \"merchant_contact_name\": \"Wanda\",\n            \"merchant_first_name\": \"Wanda\",\n            \"merchant_last_name\": \"Mertz\",\n            \"name\": \"Wanda\",\n            \"website\": \"http://hahn.mertz.llc.biz\",\n            \"phone\": \"+1234567890\",\n            \"description\": \"Description\"\n        }\n    }\n}"}],"_postman_id":"19dfd29c-0f8d-49df-90a4-5a37e3d64629"}],"id":"045071eb-cb21-4265-bf97-29e1c464ecd4","description":"<p>The 'companies' endpoints are used for managing company accounts on the Master Merchant side. To start working with these endpoints, you should first generate an access token in the Master Merchant dashboard and then use it as a header in your requests.\nYou can learn more on how to generate an access token <a href=\"https://docs.kovena.com/?shell#access-tokens\">here</a></p>\n<h2 id=\"merchant-resource\">Merchant Resource</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>field</th>\n<th>required</th>\n<th>type</th>\n<th>description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>email</td>\n<td>+</td>\n<td>string</td>\n<td>A company's email</td>\n</tr>\n<tr>\n<td>name</td>\n<td>+</td>\n<td>string</td>\n<td>A company's name</td>\n</tr>\n<tr>\n<td>merchant_first_name</td>\n<td>-</td>\n<td>string</td>\n<td>A merchant's first name</td>\n</tr>\n<tr>\n<td>merchant_last_name</td>\n<td>-</td>\n<td>string</td>\n<td>A merchant's last name</td>\n</tr>\n<tr>\n<td>merchant_contact_name</td>\n<td>-</td>\n<td>string</td>\n<td>A merchant's contact name</td>\n</tr>\n<tr>\n<td>address_line1</td>\n<td>-</td>\n<td>string</td>\n<td>A company's address (first line)</td>\n</tr>\n<tr>\n<td>address_line2</td>\n<td>-</td>\n<td>string</td>\n<td>A company's address (second line)</td>\n</tr>\n<tr>\n<td>description</td>\n<td>-</td>\n<td>string</td>\n<td>A custom description for a particular company that helps identify him/her among other companies</td>\n</tr>\n<tr>\n<td>phone</td>\n<td>-</td>\n<td>string</td>\n<td>A merchant's phone number</td>\n</tr>\n<tr>\n<td>address_postcode</td>\n<td>-</td>\n<td>string</td>\n<td>A company's ZIP code</td>\n</tr>\n<tr>\n<td>address_state</td>\n<td>-</td>\n<td>string</td>\n<td>A company's state</td>\n</tr>\n<tr>\n<td>address_country</td>\n<td>-</td>\n<td>string</td>\n<td>A company's country</td>\n</tr>\n<tr>\n<td>website</td>\n<td>-</td>\n<td>string</td>\n<td>A company's website</td>\n</tr>\n<tr>\n<td>address_city</td>\n<td>-</td>\n<td>string</td>\n<td>A company's city</td>\n</tr>\n<tr>\n<td>user.email</td>\n<td>+</td>\n<td>string</td>\n<td>A user's email. This is an email that will be assigned to a new user which is created automatically along with the company</td>\n</tr>\n</tbody>\n</table>\n</div>","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"9ea39d91-cd85-41cf-8cb2-ab28f3302871"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"afd8a619-510b-4e1c-a7a7-9e48dc577b33"}}],"_postman_id":"045071eb-cb21-4265-bf97-29e1c464ecd4"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"abaec984-46bf-41e7-8452-dfc285254f98"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b806e1c8-9b02-4ba8-9d4c-6de78d9117cd"}}]}