Repository navigation
Expand file tree
/
Copy pathwooviPostman.json
More file actions
1 lines (1 loc) · 195 KB
/
Copy pathwooviPostman.json
File metadata and controls
1 lines (1 loc) · 195 KB
1
{"item":[{"name":"api","description":"","item":[{"name":"v1","description":"","item":[{"name":"account","description":"","item":[{"name":"{accountId}","description":"","item":[{"id":"8b1ad91b-12cc-44a9-8c1a-48d66b0f7b51","name":"Get an Account","request":{"name":"Get an Account","description":{},"url":{"path":["api","v1","account",":accountId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"accountId","disabled":false,"description":{"content":"(Required) ID of the Account","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"160c26a0-91ce-4767-a434-97333da571df","name":"The Account retrieve using the given Account ID","originalRequest":{"url":{"path":["api","v1","account",":accountId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"account\": {\n \"accountId\": \"<string>\",\n \"isDefault\": \"<boolean>\",\n \"balance\": {\n \"total\": \"<number>\",\n \"blocked\": \"<number>\",\n \"available\": \"<number>\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d3005b75-6f7e-4bd7-80f3-c1315e3c0e1a","name":"An error message","originalRequest":{"url":{"path":["api","v1","account",":accountId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"name":"withdraw","description":"","item":[{"id":"778c279c-2f7a-41e5-a722-46c02ee53aa4","name":"Withdraw from an Account","request":{"name":"Withdraw from an Account","description":{"content":"An additional fee may be charged depending on the minimum free withdrawal amount. See more about at https://developers.openpix.com.br/docs/FAQ/faq-virtual-account/#onde-posso-consultar-as-taxas-da-minha-conta-virtual","type":"text/plain"},"url":{"path":["api","v1","account",":accountId","withdraw"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"accountId","disabled":false,"description":{"content":"(Required) ID of the Account","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"36c46563-2418-4094-abc0-d6c5b75a2440","name":"Withdraw and Acccount information","originalRequest":{"url":{"path":["api","v1","account",":accountId","withdraw"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"withdraw\": {\n \"account\": {\n \"accountId\": \"<string>\",\n \"isDefault\": \"<boolean>\",\n \"balance\": {\n \"total\": \"<number>\",\n \"blocked\": \"<number>\",\n \"available\": \"<number>\"\n }\n },\n \"transaction\": {\n \"endToEndId\": \"<string>\",\n \"value\": \"<string>\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"786bfd6c-8727-44f4-8a0f-7adf99c7d6df","name":"An error message","originalRequest":{"url":{"path":["api","v1","account",":accountId","withdraw"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]},{"id":"45091b2b-6ca6-48ac-bfe2-ba14b9e675d5","name":"Get a list of Accounts","request":{"name":"Get a list of Accounts","description":{},"url":{"path":["api","v1","account",""],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"b97eb148-4463-496e-aacf-fcfc3153154c","name":"A list of Accounts","originalRequest":{"url":{"path":["api","v1","account",""],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"accounts\": [\n {\n \"accountId\": \"<string>\",\n \"isDefault\": \"<boolean>\",\n \"balance\": {\n \"total\": \"<number>\",\n \"blocked\": \"<number>\",\n \"available\": \"<number>\"\n }\n },\n {\n \"accountId\": \"<string>\",\n \"isDefault\": \"<boolean>\",\n \"balance\": {\n \"total\": \"<number>\",\n \"blocked\": \"<number>\",\n \"available\": \"<number>\"\n }\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9fab1f48-b53a-413f-a058-f77304628c13","name":"An error message","originalRequest":{"url":{"path":["api","v1","account",""],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"account-register","description":"","item":[{"id":"f39ff5db-7cd8-4222-b050-d9e95dcfb4a8","name":"Register a new account","request":{"name":"Register a new account","description":{"content":"Creates a new account registration with the provided details","type":"text/plain"},"url":{"path":["api","v1","account-register"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"officialName\": \"<string>\",\n \"tradeName\": \"<string>\",\n \"taxID\": \"<string>\",\n \"annualRevenue\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"37db59b4-4d38-429f-a133-8224f37722b3","name":"Account successfully registered","originalRequest":{"url":{"path":["api","v1","account-register"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"officialName\": \"<string>\",\n \"tradeName\": \"<string>\",\n \"taxID\": \"<string>\",\n \"annualRevenue\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"officialName\": \"<string>\",\n \"tradeName\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"status\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ab496b7f-e332-49b2-81de-56c1a273aa7c","name":"An error message","originalRequest":{"url":{"path":["api","v1","account-register"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"officialName\": \"<string>\",\n \"tradeName\": \"<string>\",\n \"taxID\": \"<string>\",\n \"annualRevenue\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"10d3a600-90f1-4162-ac38-4df2c6610567","name":"Forbidden action","originalRequest":{"url":{"path":["api","v1","account-register"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"officialName\": \"<string>\",\n \"tradeName\": \"<string>\",\n \"taxID\": \"<string>\",\n \"annualRevenue\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"60096dfa-b66e-451f-b121-ec0789aad16d","name":"Internal server error","originalRequest":{"url":{"path":["api","v1","account-register"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"officialName\": \"<string>\",\n \"tradeName\": \"<string>\",\n \"taxID\": \"<string>\",\n \"annualRevenue\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"application","description":"","item":[{"id":"37cd4fbd-112a-4177-9177-e2945245d500","name":"Delete an application","request":{"name":"Delete an application","description":{"content":"Deactivates an application by setting isActive to false and adding a removedAt timestamp","type":"text/plain"},"url":{"path":["api","v1","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{"mode":"raw","raw":"{\n \"clientId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"eab9a74d-5516-4466-8321-d4bd21a2e931","name":"Application successfully deleted","originalRequest":{"url":{"path":["api","v1","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{"mode":"raw","raw":"{\n \"clientId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"success\": \"<boolean>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b4a1c00b-8f55-46ae-baab-018d2d714581","name":"Validation error or other client error","originalRequest":{"url":{"path":["api","v1","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{"mode":"raw","raw":"{\n \"clientId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\",\n \"details\": [\n {\n \"field\": \"<string>\",\n \"message\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"db3f221d-0076-496e-9653-e03ca9fac37a","name":"Application not found","originalRequest":{"url":{"path":["api","v1","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{"mode":"raw","raw":"{\n \"clientId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9d70285c-3c80-49e0-a29a-2352ddb03944","name":"Server error","originalRequest":{"url":{"path":["api","v1","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{"mode":"raw","raw":"{\n \"clientId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"685a6a66-c5e0-4679-953b-77ecd163cb9a","name":"Create a new application","request":{"name":"Create a new application","description":{"content":"Creates a new application for a company","type":"text/plain"},"url":{"path":["api","v1","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"accountId\": \"<string>\",\n \"application\": {\n \"name\": \"<string>\",\n \"type\": \"API\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"ef8fffb0-d783-4fd2-abe0-5400bca79ac8","name":"Application successfully created","originalRequest":{"url":{"path":["api","v1","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"accountId\": \"<string>\",\n \"application\": {\n \"name\": \"<string>\",\n \"type\": \"API\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"application\": {\n \"name\": \"<string>\",\n \"isActive\": \"<boolean>\",\n \"type\": \"CHECKOUT\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"appID\": \"<string>\",\n \"companyBankAccount\": \"<string>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c67ae9cf-7708-497b-8841-dd7b930c9d43","name":"Validation error or other client error","originalRequest":{"url":{"path":["api","v1","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"accountId\": \"<string>\",\n \"application\": {\n \"name\": \"<string>\",\n \"type\": \"API\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\",\n \"details\": [\n {\n \"field\": \"<string>\",\n \"message\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"87360aac-61ce-4f62-a7cd-1ebb76b01a1d","name":"Forbidden - Missing required feature","originalRequest":{"url":{"path":["api","v1","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"accountId\": \"<string>\",\n \"application\": {\n \"name\": \"<string>\",\n \"type\": \"API\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fead3b59-1667-4afe-a855-f64369067f29","name":"Server error","originalRequest":{"url":{"path":["api","v1","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"accountId\": \"<string>\",\n \"application\": {\n \"name\": \"<string>\",\n \"type\": \"API\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"cashback-fidelity","description":"","item":[{"name":"balance","description":"","item":[{"name":"{taxID}","description":"","item":[{"id":"385d64df-c054-4e15-b988-790e83c8839e","name":"Get the exclusive cashback amount an user still has to receive by taxID.","request":{"name":"Get the exclusive cashback amount an user still has to receive by taxID.","description":{},"url":{"path":["api","v1","cashback-fidelity","balance",":taxID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"taxID","disabled":false,"description":{"content":"(Required) The raw tax ID from the customer you want to get the balance.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"1c7b12dc-a720-4ae9-85c1-925a87f0c6d4","name":"Amount the user still has to receive.","originalRequest":{"url":{"path":["api","v1","cashback-fidelity","balance",":taxID"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"balance\": \"<number>\",\n \"status\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c8caf4a1-d5c1-4157-8d70-f07c770813e7","name":"An error message","originalRequest":{"url":{"path":["api","v1","cashback-fidelity","balance",":taxID"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]},{"id":"9a7c8a1e-c362-4de5-9ba9-abcfbeae9b7f","name":"Get or create cashback for a customer.","request":{"name":"Get or create cashback for a customer.","description":{"content":"Create a new cashback exclusive for the customer with a given taxID. If the customer already has a pending excluisve cashback, this endpoint will return it instead.","type":"text/plain"},"url":{"path":["api","v1","cashback-fidelity"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"taxID\": \"<string>\",\n \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"1619eae5-a0c5-4b92-bdd1-bd5fb9e3f5a7","name":"Didn't create a new cashback, returning previously existing cashback information instead.","originalRequest":{"url":{"path":["api","v1","cashback-fidelity"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"taxID\": \"<string>\",\n \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"cashback\": {\n \"value\": \"<number>\"\n },\n \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"17359c05-88fb-4e31-b34a-b631e8f22961","name":"New cashback created successfully","originalRequest":{"url":{"path":["api","v1","cashback-fidelity"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"taxID\": \"<string>\",\n \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"cashback\": {\n \"value\": \"<number>\"\n },\n \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"805d17fe-67ae-4980-a2ec-ad72fe530152","name":"An error message","originalRequest":{"url":{"path":["api","v1","cashback-fidelity"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"taxID\": \"<string>\",\n \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"charge","description":"","item":[{"name":"{id}","description":"","item":[{"id":"07f7ac11-44dd-46d9-98a8-4e72ad2fd161","name":"Delete a charge","request":{"name":"Delete a charge","description":{},"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) charge ID or correlation ID. You will need URI encoding if your correlation ID has characters outside the ASCII set or reserved characters (%, \\#, /).","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{},"auth":null},"response":[{"id":"3d7c714b-8ed7-4530-9be2-d7b43cc31cad","name":"The charge deleted","originalRequest":{"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"<string>\",\n \"id\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4bda17e6-90cc-40a0-a635-94a72e27391f","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"71136c65-0683-454a-8141-a3c8c65a6fa6","name":"Edit expiration date of a charge","request":{"name":"Edit expiration date of a charge","description":{},"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) correlation ID. You will need URI encoding if your correlation ID has characters outside the ASCII set or reserved characters (%, \\#, /).","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"expiresDate\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"f73f200b-4add-4543-9ced-ee9eced828c0","name":"The charge was updated to new expiration date","originalRequest":{"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"expiresDate\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"<string>\",\n \"id\": \"<string>\",\n \"expiresDate\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4f88aefb-c8f4-4620-b6e9-f93d2b987273","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"expiresDate\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ee339f8a-443a-4dae-a34e-b4d385112788","name":"Get one charge","request":{"name":"Get one charge","description":{},"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) charge ID or correlation ID. You will need URI encoding if your correlation ID has characters outside the ASCII set or reserved characters (%, \\#, /).","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"7b73d2fe-53df-46ca-b077-affa185fb420","name":"The charge retrieve using the given ID","originalRequest":{"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"charge\": {\n \"value\": \"<number>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"type\": \"OVERDUE\",\n \"comment\": \"<string>\",\n \"brCode\": \"<string>\",\n \"status\": \"ACTIVE\",\n \"correlationID\": \"<string>\",\n \"paymentLinkID\": \"<string>\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"globalID\": {\n \"description\": \"External ID of this charge\"\n },\n \"transactionID\": {\n \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n },\n \"identifier\": \"<string>\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"pixKey\": \"<string>\",\n \"createdAt\": \"<string>\",\n \"updatedAt\": \"<string>\",\n \"expiresIn\": \"<string>\",\n \"subscription\": {\n \"globalID\": \"<string>\",\n \"value\": \"<number>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"dayGenerateCharge\": \"<number>\",\n \"frequency\": \"MONTHLY\",\n \"status\": \"EXPIRED\",\n \"correlationID\": \"<string>\"\n },\n \"paymentMethods\": {\n \"pix\": {\n \"method\": \"<string>\",\n \"transactionID\": \"<string>\",\n \"identifier\": \"<string>\",\n \"additionalInfo\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"fee\": \"<number>\",\n \"value\": \"<number>\",\n \"status\": \"<string>\",\n \"txId\": \"<string>\",\n \"brCode\": \"<string>\",\n \"qrCodeImage\": \"<string>\"\n }\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bd75c96d-6315-48d2-b1be-b601bafb158a","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"name":"refund","description":"","item":[{"id":"c83458b1-ba67-407f-9eda-5255f06d3a56","name":"Get all refunds of a charge","request":{"name":"Get all refunds of a charge","description":{"content":"Endpoint to get all refunds of a charge","type":"text/plain"},"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) The correlation ID of the charge. You will need URI encoding if your correlation ID has characters outside the ASCII set or reserved characters (%, \\#, /).","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"223e7df6-2b00-4086-a41d-bc657f71b9ab","name":"A list of refunds","originalRequest":{"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"refunds\": [\n {\n \"value\": \"<number>\",\n \"status\": \"IN_PROCESSING\",\n \"correlationID\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"time\": \"<string>\",\n \"comment\": \"<string>\"\n },\n {\n \"value\": \"<number>\",\n \"status\": \"REJECTED\",\n \"correlationID\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"time\": \"<string>\",\n \"comment\": \"<string>\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c870a24b-3b23-4cf0-b13f-c771b1a594bd","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5dc9bb54-f7b8-4e7a-8c16-c181d1d0a52c","name":"Create a new refund for a charge","request":{"name":"Create a new refund for a charge","description":{"content":"Endpoint to create a new refund for a charge","type":"text/plain"},"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) The correlation ID of the charge. You will need URI encoding if your correlation ID has characters outside the ASCII set or reserved characters (%, \\#, /).","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"<string>\",\n \"value\": \"<number>\",\n \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"4b55d39a-e711-40e5-996f-fa175e1954a5","name":"The created Refund","originalRequest":{"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"<string>\",\n \"value\": \"<number>\",\n \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"refund\": {\n \"value\": \"<number>\",\n \"status\": \"CONFIRMED\",\n \"correlationID\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"time\": \"<string>\",\n \"comment\": \"<string>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2df4e0d5-0101-43bb-adb8-8045281f2f76","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"<string>\",\n \"value\": \"<number>\",\n \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]},{"id":"1fb6e783-51dc-4480-8f34-1b478fae91b6","name":"Get a list of charges","request":{"name":"Get a list of charges","description":{},"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"status","value":"COMPLETED"},{"disabled":false,"description":{"content":"Customer Correlation ID","type":"text/plain"},"key":"customer","value":"<string>"},{"disabled":false,"description":{"content":"Subscription Correlation ID","type":"text/plain"},"key":"subscription","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"7af83d7d-dfd9-460f-8614-ad74cc8c2fcf","name":"A list of charges","originalRequest":{"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"status","value":"COMPLETED"},{"disabled":false,"description":{"content":"Customer Correlation ID","type":"text/plain"},"key":"customer","value":"<string>"},{"disabled":false,"description":{"content":"Subscription Correlation ID","type":"text/plain"},"key":"subscription","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"charges\": [\n {\n \"value\": \"<number>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"type\": \"OVERDUE\",\n \"comment\": \"<string>\",\n \"brCode\": \"<string>\",\n \"status\": \"ACTIVE\",\n \"correlationID\": \"<string>\",\n \"paymentLinkID\": \"<string>\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"globalID\": {\n \"description\": \"External ID of this charge\"\n },\n \"transactionID\": {\n \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n },\n \"identifier\": \"<string>\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"pixKey\": \"<string>\",\n \"createdAt\": \"<string>\",\n \"updatedAt\": \"<string>\",\n \"expiresIn\": \"<string>\",\n \"subscription\": {\n \"globalID\": \"<string>\",\n \"value\": \"<number>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"dayGenerateCharge\": \"<number>\",\n \"frequency\": \"SEMIANNUALY\",\n \"status\": \"OVERDUE\",\n \"correlationID\": \"<string>\"\n },\n \"paymentMethods\": {\n \"pix\": {\n \"method\": \"<string>\",\n \"transactionID\": \"<string>\",\n \"identifier\": \"<string>\",\n \"additionalInfo\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"fee\": \"<number>\",\n \"value\": \"<number>\",\n \"status\": \"<string>\",\n \"txId\": \"<string>\",\n \"brCode\": \"<string>\",\n \"qrCodeImage\": \"<string>\"\n }\n }\n },\n {\n \"value\": \"<number>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"type\": \"BOLETO\",\n \"comment\": \"<string>\",\n \"brCode\": \"<string>\",\n \"status\": \"COMPLETED\",\n \"correlationID\": \"<string>\",\n \"paymentLinkID\": \"<string>\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"globalID\": {\n \"description\": \"External ID of this charge\"\n },\n \"transactionID\": {\n \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n },\n \"identifier\": \"<string>\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"pixKey\": \"<string>\",\n \"createdAt\": \"<string>\",\n \"updatedAt\": \"<string>\",\n \"expiresIn\": \"<string>\",\n \"subscription\": {\n \"globalID\": \"<string>\",\n \"value\": \"<number>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"dayGenerateCharge\": \"<number>\",\n \"frequency\": \"SEMIANNUALY\",\n \"status\": \"COMPLETED\",\n \"correlationID\": \"<string>\"\n },\n \"paymentMethods\": {\n \"pix\": {\n \"method\": \"<string>\",\n \"transactionID\": \"<string>\",\n \"identifier\": \"<string>\",\n \"additionalInfo\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"fee\": \"<number>\",\n \"value\": \"<number>\",\n \"status\": \"<string>\",\n \"txId\": \"<string>\",\n \"brCode\": \"<string>\",\n \"qrCodeImage\": \"<string>\"\n }\n }\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"<string>\",\n \"data\": {\n \"skip\": \"<number>\",\n \"limit\": \"<number>\"\n }\n },\n {\n \"message\": \"<string>\",\n \"data\": {\n \"skip\": \"<number>\",\n \"limit\": \"<number>\"\n }\n }\n ],\n \"skip\": \"<number>\",\n \"limit\": \"<number>\",\n \"totalCount\": \"<number>\",\n \"hasPreviousPage\": \"<boolean>\",\n \"hasNextPage\": \"<boolean>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"483cd733-faca-45a4-a3fd-debc94be447f","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"status","value":"COMPLETED"},{"disabled":false,"description":{"content":"Customer Correlation ID","type":"text/plain"},"key":"customer","value":"<string>"},{"disabled":false,"description":{"content":"Subscription Correlation ID","type":"text/plain"},"key":"subscription","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1a40f39a-0073-4d3f-8294-1d140f57b310","name":"Create a new Charge","request":{"name":"Create a new Charge","description":{"content":"Endpoint to create a new Charge for a customer","type":"text/plain"},"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Make the endpoint idempotent, will return an existent charge if already has a one with the correlationID","type":"text/plain"},"key":"return_existing","value":"<boolean>"}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"<string>\",\n \"value\": \"<number>\",\n \"type\": \"DYNAMIC\",\n \"comment\": \"<string>\",\n \"expiresIn\": \"<number>\",\n \"expiresDate\": \"<string>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"taxID\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"daysForDueDate\": \"<number>\",\n \"daysAfterDueDate\": \"<number>\",\n \"interests\": {\n \"value\": \"<number>\"\n },\n \"fines\": {\n \"value\": \"<number>\"\n },\n \"discountSettings\": {\n \"modality\": \"FIXED_VALUE_UNTIL_SPECIFIED_DATE\",\n \"discountFixedDate\": [\n {\n \"daysActive\": \"<number>\",\n \"value\": \"<number>\"\n },\n {\n \"daysActive\": \"<number>\",\n \"value\": \"<number>\"\n }\n ]\n },\n \"additionalInfo\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"enableCashbackPercentage\": \"<boolean>\",\n \"enableCashbackExclusivePercentage\": \"<boolean>\",\n \"subaccount\": \"<string>\",\n \"splits\": [\n {\n \"value\": \"<number>\",\n \"pixKey\": \"<string>\",\n \"splitType\": \"SPLIT_SUB_ACCOUNT\"\n },\n {\n \"value\": \"<number>\",\n \"pixKey\": \"<string>\",\n \"splitType\": \"SPLIT_SUB_ACCOUNT\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"aaba04d7-4b9c-428a-8a3f-1f7075a0998a","name":"Charge ID and also the generated Dynamic BR Code to be rendered as a QRCode","originalRequest":{"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Make the endpoint idempotent, will return an existent charge if already has a one with the correlationID","type":"text/plain"},"key":"return_existing","value":"<boolean>"}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"<string>\",\n \"value\": \"<number>\",\n \"type\": \"DYNAMIC\",\n \"comment\": \"<string>\",\n \"expiresIn\": \"<number>\",\n \"expiresDate\": \"<string>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"taxID\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"daysForDueDate\": \"<number>\",\n \"daysAfterDueDate\": \"<number>\",\n \"interests\": {\n \"value\": \"<number>\"\n },\n \"fines\": {\n \"value\": \"<number>\"\n },\n \"discountSettings\": {\n \"modality\": \"FIXED_VALUE_UNTIL_SPECIFIED_DATE\",\n \"discountFixedDate\": [\n {\n \"daysActive\": \"<number>\",\n \"value\": \"<number>\"\n },\n {\n \"daysActive\": \"<number>\",\n \"value\": \"<number>\"\n }\n ]\n },\n \"additionalInfo\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"enableCashbackPercentage\": \"<boolean>\",\n \"enableCashbackExclusivePercentage\": \"<boolean>\",\n \"subaccount\": \"<string>\",\n \"splits\": [\n {\n \"value\": \"<number>\",\n \"pixKey\": \"<string>\",\n \"splitType\": \"SPLIT_SUB_ACCOUNT\"\n },\n {\n \"value\": \"<number>\",\n \"pixKey\": \"<string>\",\n \"splitType\": \"SPLIT_SUB_ACCOUNT\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"charge\": {\n \"value\": \"<number>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"type\": \"DYNAMIC\",\n \"comment\": \"<string>\",\n \"brCode\": \"<string>\",\n \"status\": \"ACTIVE\",\n \"correlationID\": \"<string>\",\n \"paymentLinkID\": \"<string>\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"globalID\": {\n \"description\": \"External ID of this charge\"\n },\n \"transactionID\": {\n \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n },\n \"identifier\": \"<string>\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"pixKey\": \"<string>\",\n \"createdAt\": \"<string>\",\n \"updatedAt\": \"<string>\",\n \"expiresIn\": \"<string>\",\n \"subscription\": {\n \"globalID\": \"<string>\",\n \"value\": \"<number>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"dayGenerateCharge\": \"<number>\",\n \"frequency\": \"MONTHLY\",\n \"status\": \"ACTIVE\",\n \"correlationID\": \"<string>\"\n },\n \"paymentMethods\": {\n \"pix\": {\n \"method\": \"<string>\",\n \"transactionID\": \"<string>\",\n \"identifier\": \"<string>\",\n \"additionalInfo\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"fee\": \"<number>\",\n \"value\": \"<number>\",\n \"status\": \"<string>\",\n \"txId\": \"<string>\",\n \"brCode\": \"<string>\",\n \"qrCodeImage\": \"<string>\"\n }\n }\n },\n \"correlationID\": \"<string>\",\n \"brCode\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"82f14600-e137-4c55-a9f5-ef3f6be24bd9","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Make the endpoint idempotent, will return an existent charge if already has a one with the correlationID","type":"text/plain"},"key":"return_existing","value":"<boolean>"}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"<string>\",\n \"value\": \"<number>\",\n \"type\": \"DYNAMIC\",\n \"comment\": \"<string>\",\n \"expiresIn\": \"<number>\",\n \"expiresDate\": \"<string>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"taxID\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"daysForDueDate\": \"<number>\",\n \"daysAfterDueDate\": \"<number>\",\n \"interests\": {\n \"value\": \"<number>\"\n },\n \"fines\": {\n \"value\": \"<number>\"\n },\n \"discountSettings\": {\n \"modality\": \"FIXED_VALUE_UNTIL_SPECIFIED_DATE\",\n \"discountFixedDate\": [\n {\n \"daysActive\": \"<number>\",\n \"value\": \"<number>\"\n },\n {\n \"daysActive\": \"<number>\",\n \"value\": \"<number>\"\n }\n ]\n },\n \"additionalInfo\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"enableCashbackPercentage\": \"<boolean>\",\n \"enableCashbackExclusivePercentage\": \"<boolean>\",\n \"subaccount\": \"<string>\",\n \"splits\": [\n {\n \"value\": \"<number>\",\n \"pixKey\": \"<string>\",\n \"splitType\": \"SPLIT_SUB_ACCOUNT\"\n },\n {\n \"value\": \"<number>\",\n \"pixKey\": \"<string>\",\n \"splitType\": \"SPLIT_SUB_ACCOUNT\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"customer","description":"","item":[{"name":"{id}","description":"","item":[{"id":"a8beeba2-464d-4921-bc36-631ac7aa16dc","name":"Get one customer","request":{"name":"Get one customer","description":{},"url":{"path":["api","v1","customer",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) Correlation ID or Tax ID","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"0452d873-58db-41d4-a6a4-d1efefb00d2a","name":"The customer retrieved using the given ID","originalRequest":{"url":{"path":["api","v1","customer",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"92038ac5-3a7a-465b-9334-672cf86e1ec5","name":"An error message","originalRequest":{"url":{"path":["api","v1","customer",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"a737c5be-64d3-4b21-a612-2c7f14b2d946","name":"Get a list of customers","request":{"name":"Get a list of customers","description":{},"url":{"path":["api","v1","customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"de4c6fe2-3fd2-479b-ae8e-371be1119976","name":"A list of customers","originalRequest":{"url":{"path":["api","v1","customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"customers\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"<string>\",\n \"data\": {\n \"skip\": \"<number>\",\n \"limit\": \"<number>\"\n }\n },\n {\n \"message\": \"<string>\",\n \"data\": {\n \"skip\": \"<number>\",\n \"limit\": \"<number>\"\n }\n }\n ],\n \"skip\": \"<number>\",\n \"limit\": \"<number>\",\n \"totalCount\": \"<number>\",\n \"hasPreviousPage\": \"<boolean>\",\n \"hasNextPage\": \"<boolean>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"eda7ea63-3248-4e07-b872-baad260b88b7","name":"An error message","originalRequest":{"url":{"path":["api","v1","customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"83080688-3c5f-46f4-980f-396d2685f1e8","name":"Create a new Customer","request":{"name":"Create a new Customer","description":{"content":"Endpoint to create a new Customer","type":"text/plain"},"url":{"path":["api","v1","customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"<string>\",\n \"taxID\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"830fdb1a-b000-47ed-88b3-7ada4ec702f6","name":"Customer ID","originalRequest":{"url":{"path":["api","v1","customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"<string>\",\n \"taxID\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"eb4bc409-4872-4cc1-bf38-00ef521e68c5","name":"An error message","originalRequest":{"url":{"path":["api","v1","customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"<string>\",\n \"taxID\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"name":"{correlationID}","description":"","item":[{"id":"cc4e6909-5a87-4ddf-8a02-bd90f56d787a","name":"Update a Customer","request":{"name":"Update a Customer","description":{"content":"Endpoint to update a Customer","type":"text/plain"},"url":{"path":["api","v1","customer",":correlationID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"correlationID","disabled":false,"description":{"content":"(Required) correlation ID","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"6d8babb1-3128-4791-82c1-6e5e9c165583","name":"Customer ID","originalRequest":{"url":{"path":["api","v1","customer",":correlationID"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ec45283a-d033-4c01-8c81-85f1052f6340","name":"An error message","originalRequest":{"url":{"path":["api","v1","customer",":correlationID"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]},{"name":"dispute","description":"","item":[{"name":"{id}","description":"","item":[{"id":"6fdc21b6-5001-446f-a67a-e082bc88791c","name":"Get one dispute","request":{"name":"Get one dispute","description":{},"url":{"path":["api","v1","dispute",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) The id must be the endToEndId of the transaction that originated the Dispute","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"14844c31-a102-4c8b-91be-71302d6c7260","name":"The dispute retrieve using endToEndId","originalRequest":{"url":{"path":["api","v1","dispute",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"dispute\": {\n \"status\": \"CANCELED\",\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"value\": \"<string>\",\n \"disputeReason\": \"<string>\",\n \"endToEndId\": \"<string>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"359ead0c-989c-435d-b3a0-f2d8e73f0886","name":"Bad request","originalRequest":{"url":{"path":["api","v1","dispute",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7dbe9fc4-2a42-4454-8943-c6f8f55d74d8","name":"Internal server error","originalRequest":{"url":{"path":["api","v1","dispute",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Internal Server Error","code":500,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"f0cac7f7-b2cc-47d5-8092-331229ce1d8b","name":"Get a list of disputes","request":{"name":"Get a list of disputes","description":{},"url":{"path":["api","v1","dispute"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"61c177b1-d190-47a3-ac2c-7f2f47742eed","name":"A list of disputes","originalRequest":{"url":{"path":["api","v1","dispute"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"disputes\": [\n {\n \"status\": \"CANCELED\",\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"value\": \"<number>\",\n \"disputeReason\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"createdAt\": \"<dateTime>\",\n \"updatedAt\": \"<dateTime>\"\n },\n {\n \"status\": \"CANCELED\",\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"value\": \"<number>\",\n \"disputeReason\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"createdAt\": \"<dateTime>\",\n \"updatedAt\": \"<dateTime>\"\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"<string>\",\n \"data\": {\n \"skip\": \"<number>\",\n \"limit\": \"<number>\"\n }\n },\n {\n \"message\": \"<string>\",\n \"data\": {\n \"skip\": \"<number>\",\n \"limit\": \"<number>\"\n }\n }\n ],\n \"skip\": \"<number>\",\n \"limit\": \"<number>\",\n \"totalCount\": \"<number>\",\n \"hasPreviousPage\": \"<boolean>\",\n \"hasNextPage\": \"<boolean>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"38fb19e2-87b0-4bc6-86b0-db37b10cc116","name":"An error message","originalRequest":{"url":{"path":["api","v1","dispute"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"partner","description":"","item":[{"name":"application","description":"","item":[{"id":"566d0f21-b058-45cd-97b9-5d0cf0928a6c","name":"Create a new application to some of your preregistration's company.","request":{"name":"Create a new application to some of your preregistration's company.","description":{"content":"As a partner company, you can create a new application to some of your companies.\nThe application should give access to our API to this companies, so they can use\nit too.\n","type":"text/plain"},"url":{"path":["api","v1","partner","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"application\": {\n \"name\": \"<string>\",\n \"type\": \"ORACLE\"\n },\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"88925808-5ced-4a9f-95bc-059abaa890e0","name":"Our \"idempotence output\", if you get this HTTP code, it's an application\nthat already has been registered.\n","originalRequest":{"url":{"path":["api","v1","partner","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"application\": {\n \"name\": \"<string>\",\n \"type\": \"ORACLE\"\n },\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"application\": {\n \"name\": \"<string>\",\n \"isActive\": \"<boolean>\",\n \"type\": \"API\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"37ae0ac9-4ac4-4f1e-9ce9-bc8866cb75a3","name":"A new application has been registered. It'll be identified by the name that you give to it\nand by the company that has been referenced.\n","originalRequest":{"url":{"path":["api","v1","partner","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"application\": {\n \"name\": \"<string>\",\n \"type\": \"ORACLE\"\n },\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"application\": {\n \"name\": \"<string>\",\n \"isActive\": \"<boolean>\",\n \"type\": \"API\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9af037c8-9c53-4b04-8eb4-43ed34614f81","name":"An error message","originalRequest":{"url":{"path":["api","v1","partner","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"application\": {\n \"name\": \"<string>\",\n \"type\": \"ORACLE\"\n },\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2ca0abea-5eaf-4c48-b251-b8430b26a87d","name":"You are unauthorized to use this endpoint.","originalRequest":{"url":{"path":["api","v1","partner","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"application\": {\n \"name\": \"<string>\",\n \"type\": \"ORACLE\"\n },\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"company","description":"","item":[{"name":"{taxID}","description":"","item":[{"id":"c9dda90c-e415-49fc-9a30-ed83e18816ed","name":"Get an specific preregistration via taxID param.","request":{"name":"Get an specific preregistration via taxID param.","description":{},"url":{"path":["api","v1","partner","company",":taxID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"taxID","disabled":false,"description":{"content":"(Required) The raw tax ID from the preregistration that you want to get.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"b6042977-b513-4784-8c57-bb835f0ae5e0","name":"The preregistration retrieved by the tax ID.","originalRequest":{"url":{"path":["api","v1","partner","company",":taxID"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"preRegistration\": {\n \"preRegistration\": {\n \"name\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n }\n },\n \"user\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n }\n },\n \"company\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n }\n },\n \"account\": {\n \"clientId\": \"<string>\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d92952d6-e93b-4823-afba-e3f2a63cfa6c","name":"An error message","originalRequest":{"url":{"path":["api","v1","partner","company",":taxID"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"15108d4f-41eb-4c12-9ba4-12fd87d5653b","name":"Get every preregistration that is managed by you.","request":{"name":"Get every preregistration that is managed by you.","description":{},"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"c91bcf9c-0886-4f1d-a889-04a684af0ad6","name":"A list with preregistrations.","originalRequest":{"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"preRegistrations\": [\n {\n \"preRegistration\": {\n \"name\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n }\n },\n \"user\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CNPJ\"\n }\n },\n \"company\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n }\n },\n \"account\": {\n \"clientId\": \"<string>\"\n }\n },\n {\n \"preRegistration\": {\n \"name\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CNPJ\"\n }\n },\n \"user\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CNPJ\"\n }\n },\n \"company\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CNPJ\"\n }\n },\n \"account\": {\n \"clientId\": \"<string>\"\n }\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"<string>\",\n \"data\": {\n \"skip\": \"<number>\",\n \"limit\": \"<number>\"\n }\n },\n {\n \"message\": \"<string>\",\n \"data\": {\n \"skip\": \"<number>\",\n \"limit\": \"<number>\"\n }\n }\n ],\n \"skip\": \"<number>\",\n \"limit\": \"<number>\",\n \"totalCount\": \"<number>\",\n \"hasPreviousPage\": \"<boolean>\",\n \"hasNextPage\": \"<boolean>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b11153b8-5ce6-4432-9d39-4348262eb50c","name":"An error message","originalRequest":{"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3bcdce90-4790-45d6-ac7d-e4349a2026c8","name":"Create a pre registration with a partner reference (your company)","request":{"name":"Create a pre registration with a partner reference (your company)","description":{"content":"As a partner company, you can create a new pre registration referencing your\ncompany as a partner.\n","type":"text/plain"},"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"preRegistration\": {\n \"name\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n },\n \"website\": \"<string>\"\n },\n \"user\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"14bd2ceb-33d9-4a0e-9d73-38b797a3271c","name":"Payload with a pre registration data.\nBeing the taxID our idempotence key, if you do the request with the same taxID multiple times,\nevery time you'll receive the same data from our endpoint.\n","originalRequest":{"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"preRegistration\": {\n \"name\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n },\n \"website\": \"<string>\"\n },\n \"user\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"preRegistration\": {\n \"name\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n },\n \"website\": \"<string>\"\n },\n \"user\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d1aa825e-5914-41ec-8a38-e4065bdbef78","name":"A new preregistration that is related to you has been created.","originalRequest":{"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"preRegistration\": {\n \"name\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n },\n \"website\": \"<string>\"\n },\n \"user\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"preRegistration\": {\n \"name\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n },\n \"website\": \"<string>\"\n },\n \"user\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fca35a9d-17c6-47d2-aa8a-ab96edf2ecc1","name":"An error message","originalRequest":{"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"preRegistration\": {\n \"name\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n },\n \"website\": \"<string>\"\n },\n \"user\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8bb574d7-885f-4898-a94a-a64aad1340f0","name":"You are unauthorized to use this endpoint.","originalRequest":{"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"preRegistration\": {\n \"name\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n },\n \"website\": \"<string>\"\n },\n \"user\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"BR:CPF\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]},{"name":"payment","description":"","item":[{"name":"approve","description":"","item":[{"id":"d2bc9706-c436-42bf-b234-68f840afdf81","name":"Approve a Payment Request","request":{"name":"Approve a Payment Request","description":{"content":"Endpoint to approve a payment","type":"text/plain"},"url":{"path":["api","v1","payment","approve"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"b976bb36-18a6-4c18-a5db-db4feeae3efb","name":"The approved payment","originalRequest":{"url":{"path":["api","v1","payment","approve"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"payment\": {\n \"value\": \"<number>\",\n \"destinationAlias\": \"<string>\",\n \"destinationAliasType\": \"EMAIL\",\n \"qrCode\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"comment\": \"<string>\",\n \"status\": \"CREATED\"\n },\n \"transaction\": {\n \"value\": \"<number>\",\n \"endToEndId\": \"<string>\",\n \"time\": \"<string>\"\n },\n \"destination\": {\n \"name\": \"<string>\",\n \"taxID\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"bank\": \"<string>\",\n \"branch\": \"<string>\",\n \"account\": \"<string>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"11ed1111-cad6-4710-af32-e99b6eda43ab","name":"An error message","originalRequest":{"url":{"path":["api","v1","payment","approve"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"{id}","description":"","item":[{"id":"de625d68-ad6b-4c78-abde-8d2e088474bc","name":"Get one Payment","request":{"name":"Get one Payment","description":{},"url":{"path":["api","v1","payment",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) payment ID or correlation ID","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"acae363e-a194-4b37-aee8-61e2e04d7ca8","name":"The payment retrieved using the given ID","originalRequest":{"url":{"path":["api","v1","payment",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"payment\": {\n \"value\": \"<number>\",\n \"destinationAlias\": \"<string>\",\n \"destinationAliasType\": \"CNPJ\",\n \"qrCode\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"comment\": \"<string>\",\n \"status\": \"CREATED\"\n },\n \"transaction\": {\n \"value\": \"<number>\",\n \"endToEndId\": \"<string>\",\n \"time\": \"<string>\"\n },\n \"destination\": {\n \"name\": \"<string>\",\n \"taxID\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"bank\": \"<string>\",\n \"branch\": \"<string>\",\n \"account\": \"<string>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"82be8b66-3569-4858-a320-010f051467f7","name":"An error message","originalRequest":{"url":{"path":["api","v1","payment",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"f1c8971f-4ecd-4b70-9a49-85acbd3504cd","name":"Get a list of payments","request":{"name":"Get a list of payments","description":{},"url":{"path":["api","v1","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"37a47401-c2f0-4427-a339-e172f1fc2e28","name":"A list of payments","originalRequest":{"url":{"path":["api","v1","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"<string>\",\n \"payments\": [\n {\n \"payment\": {\n \"value\": \"<number>\",\n \"destinationAlias\": \"<string>\",\n \"destinationAliasType\": \"PHONE\",\n \"qrCode\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"comment\": \"<string>\",\n \"status\": \"FAILED\"\n },\n \"transaction\": {\n \"value\": \"<number>\",\n \"endToEndId\": \"<string>\",\n \"time\": \"<string>\"\n },\n \"destination\": {\n \"name\": \"<string>\",\n \"taxID\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"bank\": \"<string>\",\n \"branch\": \"<string>\",\n \"account\": \"<string>\"\n }\n },\n {\n \"payment\": {\n \"value\": \"<number>\",\n \"destinationAlias\": \"<string>\",\n \"destinationAliasType\": \"EMAIL\",\n \"qrCode\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"comment\": \"<string>\",\n \"status\": \"CREATED\"\n },\n \"transaction\": {\n \"value\": \"<number>\",\n \"endToEndId\": \"<string>\",\n \"time\": \"<string>\"\n },\n \"destination\": {\n \"name\": \"<string>\",\n \"taxID\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"bank\": \"<string>\",\n \"branch\": \"<string>\",\n \"account\": \"<string>\"\n }\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"<string>\",\n \"data\": {\n \"skip\": \"<number>\",\n \"limit\": \"<number>\"\n }\n },\n {\n \"message\": \"<string>\",\n \"data\": {\n \"skip\": \"<number>\",\n \"limit\": \"<number>\"\n }\n }\n ],\n \"skip\": \"<number>\",\n \"limit\": \"<number>\",\n \"totalCount\": \"<number>\",\n \"hasPreviousPage\": \"<boolean>\",\n \"hasNextPage\": \"<boolean>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"87e68b9f-813a-44ea-b506-27ca4875263e","name":"An error message","originalRequest":{"url":{"path":["api","v1","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1e641bf1-4fac-4064-b170-bd88c8c53293","name":"Create a Payment Request","request":{"name":"Create a Payment Request","description":{"content":"Endpoint to request a payment","type":"text/plain"},"url":{"path":["api","v1","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\",\n \"destinationAlias\": \"<string>\",\n \"destinationAliasType\": \"RANDOM\",\n \"correlationID\": \"<string>\",\n \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"43ada276-18b5-41c2-af46-078938779f28","name":"Payment destination account information","originalRequest":{"url":{"path":["api","v1","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\",\n \"destinationAlias\": \"<string>\",\n \"destinationAliasType\": \"RANDOM\",\n \"correlationID\": \"<string>\",\n \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"payment\": {\n \"value\": \"<number>\",\n \"destinationAlias\": \"<string>\",\n \"destinationAliasType\": \"CPF\",\n \"qrCode\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"comment\": \"<string>\",\n \"status\": \"CREATED\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"123cca12-7c5f-4c25-b7f0-4d29400461d7","name":"An error message","originalRequest":{"url":{"path":["api","v1","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\",\n \"destinationAlias\": \"<string>\",\n \"destinationAliasType\": \"RANDOM\",\n \"correlationID\": \"<string>\",\n \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"qrcode-static","description":"","item":[{"name":"{id}","description":"","item":[{"id":"7ae81de7-3609-49bb-812c-eacb764a74ba","name":"Get one Pix QrCode","request":{"name":"Get one Pix QrCode","description":{},"url":{"path":["api","v1","qrcode-static",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) pixQrCode ID, correlation ID or emv identifier","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"bd793138-2095-4023-998a-d9ae308f6d4a","name":"The pixQrCode retrieve using the given ID","originalRequest":{"url":{"path":["api","v1","qrcode-static",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"pixQrCode\": {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"comment\": \"<string>\",\n \"brCode\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"paymentLinkID\": \"<string>\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"<string>\",\n \"updatedAt\": \"<string>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0b25f3ce-ffd0-46d6-9460-7b615d5c698e","name":"An error message","originalRequest":{"url":{"path":["api","v1","qrcode-static",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"b8ec42aa-9df9-475f-b6bd-5d95b1f68176","name":"Get a list of Pix QrCodes","request":{"name":"Get a list of Pix QrCodes","description":{},"url":{"path":["api","v1","qrcode-static"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"0f5d1e95-8356-4ff4-abb8-98308c914cdb","name":"A list of pixQrCodes","originalRequest":{"url":{"path":["api","v1","qrcode-static"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"pixQrCodes\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"comment\": \"<string>\",\n \"brCode\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"paymentLinkID\": \"<string>\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"<string>\",\n \"updatedAt\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"comment\": \"<string>\",\n \"brCode\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"paymentLinkID\": \"<string>\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"<string>\",\n \"updatedAt\": \"<string>\"\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"<string>\",\n \"data\": {\n \"skip\": \"<number>\",\n \"limit\": \"<number>\"\n }\n },\n {\n \"message\": \"<string>\",\n \"data\": {\n \"skip\": \"<number>\",\n \"limit\": \"<number>\"\n }\n }\n ],\n \"skip\": \"<number>\",\n \"limit\": \"<number>\",\n \"totalCount\": \"<number>\",\n \"hasPreviousPage\": \"<boolean>\",\n \"hasNextPage\": \"<boolean>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"61601b78-1775-4c2f-a4a8-f5ab8ff46e2b","name":"An error message","originalRequest":{"url":{"path":["api","v1","qrcode-static"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"9563b019-fdbc-408b-8eba-b540961859ac","name":"Create a new Pix QrCode Static","request":{"name":"Create a new Pix QrCode Static","description":{"content":"Endpoint to create a new Pix QrCode Static","type":"text/plain"},"url":{"path":["api","v1","qrcode-static"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"value\": \"<number>\",\n \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"4199e0f5-d84b-4bfb-b6e1-ffda86ef9dc8","name":"PixQrCode ID and also the generated Dynamic BR Code to be rendered as a QRCode","originalRequest":{"url":{"path":["api","v1","qrcode-static"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"value\": \"<number>\",\n \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"pixQrCode\": {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"comment\": \"<string>\",\n \"brCode\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"paymentLinkID\": \"<string>\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"<string>\",\n \"updatedAt\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"brCode\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c4956763-c2b8-44ab-8912-6007790833d9","name":"An error message","originalRequest":{"url":{"path":["api","v1","qrcode-static"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"value\": \"<number>\",\n \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"transaction","description":"","item":[{"name":"{id}","description":"","item":[{"id":"abb94bdd-d151-4313-9acd-223c4ee3f971","name":"Get a Transaction","request":{"name":"Get a Transaction","description":{},"url":{"path":["api","v1","transaction",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) you can use the transaction id from openpix or the endToEndId of transaction from bank","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"321150dc-43fc-45b0-af2b-4051945965f2","name":"The transaction retrieve using the given ID","originalRequest":{"url":{"path":["api","v1","transaction",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"transaction\": {\n \"charge\": {\n \"value\": \"<number>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"type\": \"BOLETO\",\n \"comment\": \"<string>\",\n \"brCode\": \"<string>\",\n \"status\": \"EXPIRED\",\n \"correlationID\": \"<string>\",\n \"paymentLinkID\": \"<string>\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"globalID\": {\n \"description\": \"External ID of this charge\"\n },\n \"transactionID\": {\n \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n },\n \"identifier\": \"<string>\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"pixKey\": \"<string>\",\n \"createdAt\": \"<string>\",\n \"updatedAt\": \"<string>\",\n \"expiresIn\": \"<string>\",\n \"subscription\": {\n \"globalID\": \"<string>\",\n \"value\": \"<number>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"dayGenerateCharge\": \"<number>\",\n \"frequency\": \"ANNUALY\",\n \"status\": \"COMPLETED\",\n \"correlationID\": \"<string>\"\n },\n \"paymentMethods\": {\n \"pix\": {\n \"method\": \"<string>\",\n \"transactionID\": \"<string>\",\n \"identifier\": \"<string>\",\n \"additionalInfo\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"fee\": \"<number>\",\n \"value\": \"<number>\",\n \"status\": \"<string>\",\n \"txId\": \"<string>\",\n \"brCode\": \"<string>\",\n \"qrCodeImage\": \"<string>\"\n }\n }\n },\n \"value\": \"<number>\",\n \"time\": \"<string>\",\n \"endToEndID\": \"<string>\",\n \"transactionID\": \"<string>\",\n \"infoPagador\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"withdraw\": {\n \"value\": \"<number>\",\n \"time\": \"<string>\",\n \"endToEndID\": \"<string>\",\n \"transactionID\": \"<string>\",\n \"infoPagador\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"payer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"type\": \"<string>\"\n },\n \"payer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"type\": \"FEE\",\n \"globalID\": {\n \"description\": \"External ID of this transaction\"\n },\n \"pixQrCode\": {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"comment\": \"<string>\",\n \"brCode\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"paymentLinkID\": \"<string>\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"<string>\",\n \"updatedAt\": \"<string>\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"836b8f42-e5ad-40a5-9a22-ead1a00da7c4","name":"An error message","originalRequest":{"url":{"path":["api","v1","transaction",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"4078a787-14cd-4707-bf13-0c8285295fc7","name":"Get a list of transactions","request":{"name":"Get a list of transactions","description":{},"url":{"path":["api","v1","transaction"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"},{"disabled":false,"description":{"content":"You can use the charge ID or correlation ID or transaction ID of charge to get a list of transactions related of this transaction","type":"text/plain"},"key":"charge","value":"<string>"},{"disabled":false,"description":{"content":"You can use the QrCode static ID or correlation ID or identifier field of QrCode static to get a list of QrCode related of this transaction","type":"text/plain"},"key":"pixQrCode","value":"<string>"},{"disabled":false,"description":{"content":"You can use the ID or EndToEndId of a withdrawal transaction to get all transactions related to the withdrawal","type":"text/plain"},"key":"withdrawal","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"6324df08-e079-483b-879f-f83e918f7b5d","name":"A list of transactions","originalRequest":{"url":{"path":["api","v1","transaction"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"},{"disabled":false,"description":{"content":"You can use the charge ID or correlation ID or transaction ID of charge to get a list of transactions related of this transaction","type":"text/plain"},"key":"charge","value":"<string>"},{"disabled":false,"description":{"content":"You can use the QrCode static ID or correlation ID or identifier field of QrCode static to get a list of QrCode related of this transaction","type":"text/plain"},"key":"pixQrCode","value":"<string>"},{"disabled":false,"description":{"content":"You can use the ID or EndToEndId of a withdrawal transaction to get all transactions related to the withdrawal","type":"text/plain"},"key":"withdrawal","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"<string>\",\n \"transactions\": [\n {\n \"charge\": {\n \"value\": \"<number>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"type\": \"OVERDUE\",\n \"comment\": \"<string>\",\n \"brCode\": \"<string>\",\n \"status\": \"ACTIVE\",\n \"correlationID\": \"<string>\",\n \"paymentLinkID\": \"<string>\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"globalID\": {\n \"description\": \"External ID of this charge\"\n },\n \"transactionID\": {\n \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n },\n \"identifier\": \"<string>\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"pixKey\": \"<string>\",\n \"createdAt\": \"<string>\",\n \"updatedAt\": \"<string>\",\n \"expiresIn\": \"<string>\",\n \"subscription\": {\n \"globalID\": \"<string>\",\n \"value\": \"<number>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"dayGenerateCharge\": \"<number>\",\n \"frequency\": \"TRIMONTHLY\",\n \"status\": \"COMPLETED\",\n \"correlationID\": \"<string>\"\n },\n \"paymentMethods\": {\n \"pix\": {\n \"method\": \"<string>\",\n \"transactionID\": \"<string>\",\n \"identifier\": \"<string>\",\n \"additionalInfo\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"fee\": \"<number>\",\n \"value\": \"<number>\",\n \"status\": \"<string>\",\n \"txId\": \"<string>\",\n \"brCode\": \"<string>\",\n \"qrCodeImage\": \"<string>\"\n }\n }\n },\n \"value\": \"<number>\",\n \"time\": \"<string>\",\n \"endToEndID\": \"<string>\",\n \"transactionID\": \"<string>\",\n \"infoPagador\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"withdraw\": {\n \"value\": \"<number>\",\n \"time\": \"<string>\",\n \"endToEndID\": \"<string>\",\n \"transactionID\": \"<string>\",\n \"infoPagador\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"payer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"type\": \"<string>\"\n },\n \"payer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"type\": \"PAYMENT\",\n \"globalID\": {\n \"description\": \"External ID of this transaction\"\n },\n \"pixQrCode\": {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"comment\": \"<string>\",\n \"brCode\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"paymentLinkID\": \"<string>\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"<string>\",\n \"updatedAt\": \"<string>\"\n }\n },\n {\n \"charge\": {\n \"value\": \"<number>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"type\": \"BOLETO\",\n \"comment\": \"<string>\",\n \"brCode\": \"<string>\",\n \"status\": \"EXPIRED\",\n \"correlationID\": \"<string>\",\n \"paymentLinkID\": \"<string>\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"globalID\": {\n \"description\": \"External ID of this charge\"\n },\n \"transactionID\": {\n \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n },\n \"identifier\": \"<string>\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"pixKey\": \"<string>\",\n \"createdAt\": \"<string>\",\n \"updatedAt\": \"<string>\",\n \"expiresIn\": \"<string>\",\n \"subscription\": {\n \"globalID\": \"<string>\",\n \"value\": \"<number>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"dayGenerateCharge\": \"<number>\",\n \"frequency\": \"ANNUALY\",\n \"status\": \"COMPLETED\",\n \"correlationID\": \"<string>\"\n },\n \"paymentMethods\": {\n \"pix\": {\n \"method\": \"<string>\",\n \"transactionID\": \"<string>\",\n \"identifier\": \"<string>\",\n \"additionalInfo\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"fee\": \"<number>\",\n \"value\": \"<number>\",\n \"status\": \"<string>\",\n \"txId\": \"<string>\",\n \"brCode\": \"<string>\",\n \"qrCodeImage\": \"<string>\"\n }\n }\n },\n \"value\": \"<number>\",\n \"time\": \"<string>\",\n \"endToEndID\": \"<string>\",\n \"transactionID\": \"<string>\",\n \"infoPagador\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"withdraw\": {\n \"value\": \"<number>\",\n \"time\": \"<string>\",\n \"endToEndID\": \"<string>\",\n \"transactionID\": \"<string>\",\n \"infoPagador\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"payer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"type\": \"<string>\"\n },\n \"payer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"type\": \"REFUND\",\n \"globalID\": {\n \"description\": \"External ID of this transaction\"\n },\n \"pixQrCode\": {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"comment\": \"<string>\",\n \"brCode\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"paymentLinkID\": \"<string>\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"<string>\",\n \"updatedAt\": \"<string>\"\n }\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"<string>\",\n \"data\": {\n \"skip\": \"<number>\",\n \"limit\": \"<number>\"\n }\n },\n {\n \"message\": \"<string>\",\n \"data\": {\n \"skip\": \"<number>\",\n \"limit\": \"<number>\"\n }\n }\n ],\n \"skip\": \"<number>\",\n \"limit\": \"<number>\",\n \"totalCount\": \"<number>\",\n \"hasPreviousPage\": \"<boolean>\",\n \"hasNextPage\": \"<boolean>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cce84443-60ee-46b3-b55b-d7f110dc65d1","name":"An error message","originalRequest":{"url":{"path":["api","v1","transaction"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"},{"disabled":false,"description":{"content":"You can use the charge ID or correlation ID or transaction ID of charge to get a list of transactions related of this transaction","type":"text/plain"},"key":"charge","value":"<string>"},{"disabled":false,"description":{"content":"You can use the QrCode static ID or correlation ID or identifier field of QrCode static to get a list of QrCode related of this transaction","type":"text/plain"},"key":"pixQrCode","value":"<string>"},{"disabled":false,"description":{"content":"You can use the ID or EndToEndId of a withdrawal transaction to get all transactions related to the withdrawal","type":"text/plain"},"key":"withdrawal","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"refund","description":"","item":[{"name":"{id}","description":"","item":[{"id":"18772e39-0112-4573-9807-b42cd0dc6339","name":"Get one refund","request":{"name":"Get one refund","description":{},"url":{"path":["api","v1","refund",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) refund ID or correlation ID","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"f8a007bb-9935-4e50-b083-f4428c2a282c","name":"The refund retrieve using the given ID","originalRequest":{"url":{"path":["api","v1","refund",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"pixTransactionRefund\": {\n \"value\": \"<number>\",\n \"status\": \"REFUNDED\",\n \"correlationID\": \"<string>\",\n \"refundId\": \"<string>\",\n \"time\": \"<string>\",\n \"comment\": \"<string>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"dad62179-31eb-45a6-9238-58b71f8bc991","name":"An error message","originalRequest":{"url":{"path":["api","v1","refund",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"fda1c4b7-2dc6-4695-ad95-d869bab7fa40","name":"Get a list of refunds","request":{"name":"Get a list of refunds","description":{},"url":{"path":["api","v1","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"6e753c34-fd4f-4418-85ad-b7c5f3cfcc4b","name":"A list of refunds","originalRequest":{"url":{"path":["api","v1","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"refunds\": [\n {\n \"value\": \"<number>\",\n \"status\": \"REFUNDED\",\n \"correlationID\": \"<string>\",\n \"refundId\": \"<string>\",\n \"time\": \"<string>\",\n \"comment\": \"<string>\"\n },\n {\n \"value\": \"<number>\",\n \"status\": \"IN_PROCESSING\",\n \"correlationID\": \"<string>\",\n \"refundId\": \"<string>\",\n \"time\": \"<string>\",\n \"comment\": \"<string>\"\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"<string>\",\n \"data\": {\n \"skip\": \"<number>\",\n \"limit\": \"<number>\"\n }\n },\n {\n \"message\": \"<string>\",\n \"data\": {\n \"skip\": \"<number>\",\n \"limit\": \"<number>\"\n }\n }\n ],\n \"skip\": \"<number>\",\n \"limit\": \"<number>\",\n \"totalCount\": \"<number>\",\n \"hasPreviousPage\": \"<boolean>\",\n \"hasNextPage\": \"<boolean>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"329f8b44-99c2-47d6-89db-e9b6706bffee","name":"An error message","originalRequest":{"url":{"path":["api","v1","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"530a72ea-b335-4e04-8a45-1e0fc5b4f114","name":"Create a new refund","request":{"name":"Create a new refund","description":{"content":"Endpoint to create a new refund for a customer","type":"text/plain"},"url":{"path":["api","v1","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\",\n \"transactionEndToEndId\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"08cbe190-973d-45b6-8b29-d7260e49139a","name":"The created Refund","originalRequest":{"url":{"path":["api","v1","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\",\n \"transactionEndToEndId\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"refund\": {\n \"value\": \"<number>\",\n \"status\": \"IN_PROCESSING\",\n \"correlationID\": \"<string>\",\n \"refundId\": \"<string>\",\n \"time\": \"<string>\",\n \"comment\": \"<string>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e2b52915-d9ca-4b0b-aae5-2872bca1830a","name":"An error message","originalRequest":{"url":{"path":["api","v1","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\",\n \"transactionEndToEndId\": \"<string>\",\n \"correlationID\": \"<string>\",\n \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"receipt","description":"","item":[{"name":"{EndToEndId}","description":"","item":[{"id":"639db6dc-2aa2-4f5e-a6dc-16e18d902385","name":"Get a PDF document related to a payment transaction formatted as a receipt.","request":{"name":"Get a PDF document related to a payment transaction formatted as a receipt.","description":{},"url":{"path":["api","v1","receipt",":EndToEndId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"EndToEndId","disabled":false,"description":{"content":"(Required) The EndToEndId from the payment transaction to export.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"7b5d39b8-c2ce-494b-8af9-14a79b4af2f0","name":"Exported transaction as a receipt in PDF format.","originalRequest":{"url":{"path":["api","v1","receipt",":EndToEndId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"file\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"697a6592-eaa6-4151-a07f-ba3371d65ab7","name":"An error occurred due to a bad request.","originalRequest":{"url":{"path":["api","v1","receipt",":EndToEndId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9f347f5b-f8e6-437e-8f6f-642ad0754fe2","name":"Unauthorized access.","originalRequest":{"url":{"path":["api","v1","receipt",":EndToEndId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8b9c9614-f85e-459c-a8fb-78848aa7dbb4","name":"The specified EndToEndId was not found.","originalRequest":{"url":{"path":["api","v1","receipt",":EndToEndId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"{receiptType}","description":"","item":[{"name":"{EndToEndId}","description":"","item":[{"id":"87357de7-3877-484c-be69-1d92565c36d4","name":"Get a PDF document related to a payment transaction formatted as a receipt by type (pix-in, pix-out or pix-refund).","request":{"name":"Get a PDF document related to a payment transaction formatted as a receipt by type (pix-in, pix-out or pix-refund).","description":{},"url":{"path":["api","v1","receipt",":receiptType",":EndToEndId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","key":"receiptType"},{"type":"any","value":"<string>","key":"EndToEndId","disabled":false,"description":{"content":"(Required) The EndToEndId from the payment transaction to export.","type":"text/plain"}},{"disabled":false,"description":{"content":"(Required) The ReceiptType from the payment transaction to export.","type":"text/plain"},"type":"any","value":"pix-refund","key":"ReceiptType"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"2814c7cf-cab3-43a1-ab22-f5f03f06a129","name":"Exported transaction as a receipt in PDF format.","originalRequest":{"url":{"path":["api","v1","receipt",":receiptType",":EndToEndId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"file\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e014027d-638d-4c23-97fe-6a08894529fc","name":"An error occurred due to a bad request.","originalRequest":{"url":{"path":["api","v1","receipt",":receiptType",":EndToEndId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d7f8d4a8-2caa-453e-bd05-b0e01f29e7db","name":"Unauthorized access.","originalRequest":{"url":{"path":["api","v1","receipt",":receiptType",":EndToEndId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Unauthorized","code":401,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"38bcd226-6fb2-42b5-b7a8-d0b4d4846712","name":"The specified EndToEndId was not found.","originalRequest":{"url":{"path":["api","v1","receipt",":receiptType",":EndToEndId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Not Found","code":404,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]}]},{"name":"subaccount","description":"","item":[{"name":"{id}","description":"","item":[{"name":"withdraw","description":"","item":[{"id":"29d6e14e-87a4-4a2d-b9da-32d18c35be4c","name":"Withdraw from a Sub Account","request":{"name":"Withdraw from a Sub Account","description":{"content":"Withdraw from a Sub Account and return the withdrawal transaction information","type":"text/plain"},"url":{"path":["api","v1","subaccount",":id","withdraw"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) pix key registered to the subaccount","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"794ab387-377e-4c95-8d40-1f0094d48267","name":"Withdrawal Transaction information","originalRequest":{"url":{"path":["api","v1","subaccount",":id","withdraw"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"withdraw\": {\n \"account\": {\n \"status\": \"<string>\",\n \"value\": \"<number>\",\n \"correlationID\": \"<string>\",\n \"destinationAlias\": \"<string>\",\n \"comment\": \"<string>\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1b6db46a-d764-4810-9380-ba9e231d8587","name":"An error message","originalRequest":{"url":{"path":["api","v1","subaccount",":id","withdraw"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"5f62edce-2d25-403c-a74a-71af0e855073","name":"Delete a Sub Account","request":{"name":"Delete a Sub Account","description":{"content":"Deletes a Sub Account if it has no remaining balance","type":"text/plain"},"url":{"path":["api","v1","subaccount",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) Pix key registered to the subaccount","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{},"auth":null},"response":[{"id":"02ccea7a-ccfe-470f-8c3e-52de750ad68a","name":"Sub Account successfully deleted","originalRequest":{"url":{"path":["api","v1","subaccount",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"<string>\",\n \"pixKey\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"74f1b606-f45d-4c40-8fd7-acea64127688","name":"An error message","originalRequest":{"url":{"path":["api","v1","subaccount",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2487ee08-fca0-440a-8b59-2ca9abbab576","name":"Forbidden action","originalRequest":{"url":{"path":["api","v1","subaccount",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"e16839e1-e176-43fe-a3dc-259e347b99d6","name":"Get subaccount details","request":{"name":"Get subaccount details","description":{},"url":{"path":["api","v1","subaccount",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) pix key registered to the subaccount","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"fe74ddd1-6ed4-4b2e-ab1f-7be8955e142a","name":"The Subccount retrieve using the given pix key","originalRequest":{"url":{"path":["api","v1","subaccount",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"SubAccount\": {\n \"name\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"balance\": \"<number>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e8e5e86a-df4e-45e8-aa49-8fb7f70a4e8d","name":"An error message","originalRequest":{"url":{"path":["api","v1","subaccount",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"name":"debit","description":"","item":[{"id":"83fd50fb-6b24-47e6-a679-61f433599193","name":"Debit from a Sub Account and send to the main account","request":{"name":"Debit from a Sub Account and send to the main account","description":{"content":"Transfers the amount from the subaccount to the main account.","type":"text/plain"},"url":{"path":["api","v1","subaccount",":id","debit"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) Pix key registered to the subaccount","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\",\n \"description\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"bc42251f-8f17-44da-821c-2f13c9d64302","name":"Sub Account successfully debited","originalRequest":{"url":{"path":["api","v1","subaccount",":id","debit"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\",\n \"description\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"pixKey\": \"<string>\",\n \"value\": \"<number>\",\n \"description\": \"<string>\",\n \"success\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"52269c5f-1505-413b-83e6-d5738dc1af1e","name":"An error message","originalRequest":{"url":{"path":["api","v1","subaccount",":id","debit"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\",\n \"description\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"10ac6cdb-ced1-455f-b2d7-9bf3c78a3be5","name":"Forbidden action","originalRequest":{"url":{"path":["api","v1","subaccount",":id","debit"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\",\n \"description\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]},{"id":"a14ebb41-c1bb-4f99-9dfe-e9c01d536b9b","name":"Get a list of subaccounts","request":{"name":"Get a list of subaccounts","description":{},"url":{"path":["api","v1","subaccount"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"a058e88a-b048-4f46-b2c6-f8144b45af60","name":"A list of subaccounts","originalRequest":{"url":{"path":["api","v1","subaccount"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"subaccounts\": [\n {\n \"name\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"balance\": \"<number>\"\n },\n {\n \"name\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"balance\": \"<number>\"\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"<string>\",\n \"data\": {\n \"skip\": \"<number>\",\n \"limit\": \"<number>\"\n }\n },\n {\n \"message\": \"<string>\",\n \"data\": {\n \"skip\": \"<number>\",\n \"limit\": \"<number>\"\n }\n }\n ],\n \"skip\": \"<number>\",\n \"limit\": \"<number>\",\n \"totalCount\": \"<number>\",\n \"hasPreviousPage\": \"<boolean>\",\n \"hasNextPage\": \"<boolean>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"70aa0404-e50b-476a-bf0a-663246e2a004","name":"An error message","originalRequest":{"url":{"path":["api","v1","subaccount"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1adc14e2-eca7-4b3b-9f48-b63e5ce037a0","name":"Create a subaccount","request":{"name":"Create a subaccount","description":{},"url":{"path":["api","v1","subaccount"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"pixKey\": \"<string>\",\n \"name\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"ecec2f43-fe74-43c3-a337-17d93bdcd733","name":"The Subccount created or retrieved if exists using the given pix key","originalRequest":{"url":{"path":["api","v1","subaccount"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"pixKey\": \"<string>\",\n \"name\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"SubAccount\": {\n \"name\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"balance\": \"<number>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2de5324f-9012-45ef-aea7-6cd077699cca","name":"An error message","originalRequest":{"url":{"path":["api","v1","subaccount"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"pixKey\": \"<string>\",\n \"name\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"name":"transfer","description":"","item":[{"id":"ec7aea79-d2a0-4772-8922-fd0312f3f1f7","name":"Transfer between subaccounts","request":{"name":"Transfer between subaccounts","description":{"content":"Transfer between subaccounts","type":"text/plain"},"url":{"path":["api","v1","subaccount","transfer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\",\n \"fromPixKey\": \"<string>\",\n \"fromPixKeyType\": \"RANDOM\",\n \"toPixKey\": \"<string>\",\n \"toPixKeyType\": \"PHONE\",\n \"correlationID\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"88220c4a-e82c-45a8-b54e-7e0f5508f288","name":"Transfer response success","originalRequest":{"url":{"path":["api","v1","subaccount","transfer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\",\n \"fromPixKey\": \"<string>\",\n \"fromPixKeyType\": \"RANDOM\",\n \"toPixKey\": \"<string>\",\n \"toPixKeyType\": \"PHONE\",\n \"correlationID\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"value\": \"<number>\",\n \"destinationSubaccount\": {\n \"name\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"balance\": \"<number>\"\n },\n \"originSubaccount\": {\n \"name\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"balance\": \"<number>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e61832fd-059d-4132-9564-75d34190d21e","name":"An error message","originalRequest":{"url":{"path":["api","v1","subaccount","transfer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\",\n \"fromPixKey\": \"<string>\",\n \"fromPixKeyType\": \"RANDOM\",\n \"toPixKey\": \"<string>\",\n \"toPixKeyType\": \"PHONE\",\n \"correlationID\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]},{"name":"subscriptions","description":"","item":[{"name":"{id}","description":"","item":[{"id":"cb6c0110-3ed8-4f7a-a492-2b6067d5a73c","name":"Get one subscription","request":{"name":"Get one subscription","description":{},"url":{"path":["api","v1","subscriptions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) The globalID or correlationID of the subscription.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"df1be4ab-175f-4416-acb9-963ebee85020","name":"The subscription retrieved using the given ID","originalRequest":{"url":{"path":["api","v1","subscriptions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"subscription\": {\n \"globalID\": \"<string>\",\n \"value\": \"<number>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"dayGenerateCharge\": \"<number>\",\n \"frequency\": \"BIMONTHLY\",\n \"status\": \"OVERDUE\",\n \"correlationID\": \"<string>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e5db1838-d597-4ba7-ba8b-fc4c7e148698","name":"An error message","originalRequest":{"url":{"path":["api","v1","subscriptions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"fba39667-b795-433d-a9cf-e908d48b3384","name":"Create a new Subscription","request":{"name":"Create a new Subscription","description":{"content":"Endpoint to create a new Subcription","type":"text/plain"},"url":{"path":["api","v1","subscriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"value\": \"<number>\",\n \"correlationID\": \"<string>\",\n \"comment\": \"<string>\",\n \"additionalInfo\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"dayGenerateCharge\": 5,\n \"frequency\": \"TRIMONTHLY\",\n \"chargeType\": \"DYNAMIC\",\n \"dayDue\": 7\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"b3299e56-a45c-45fa-97be-5a52bb0150a8","name":"The subscription created","originalRequest":{"url":{"path":["api","v1","subscriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"value\": \"<number>\",\n \"correlationID\": \"<string>\",\n \"comment\": \"<string>\",\n \"additionalInfo\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"dayGenerateCharge\": 5,\n \"frequency\": \"TRIMONTHLY\",\n \"chargeType\": \"DYNAMIC\",\n \"dayDue\": 7\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"subscription\": {\n \"globalID\": \"<string>\",\n \"value\": \"<number>\",\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": {\n \"taxID\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"correlationID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"dayGenerateCharge\": \"<number>\",\n \"frequency\": \"MONTHLY\",\n \"status\": \"EXPIRED\",\n \"correlationID\": \"<string>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d47614b5-f5b5-4fce-9ff7-6354aa69f15b","name":"An error message","originalRequest":{"url":{"path":["api","v1","subscriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"taxID\": \"<string>\",\n \"address\": {\n \"zipcode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"complement\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"value\": \"<number>\",\n \"correlationID\": \"<string>\",\n \"comment\": \"<string>\",\n \"additionalInfo\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"dayGenerateCharge\": 5,\n \"frequency\": \"TRIMONTHLY\",\n \"chargeType\": \"DYNAMIC\",\n \"dayDue\": 7\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"transfer","description":"","item":[{"id":"34e6e754-5329-4128-8651-cad0a7a4a592","name":"Create a Transfer","request":{"name":"Create a Transfer","description":{"content":"Endpoint to to transfer values between accounts","type":"text/plain"},"url":{"path":["api","v1","transfer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\",\n \"fromPixKey\": \"<string>\",\n \"toPixKey\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"c70a5316-83a7-429a-a366-929f51407199","name":"Transfer transaction information","originalRequest":{"url":{"path":["api","v1","transfer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\",\n \"fromPixKey\": \"<string>\",\n \"toPixKey\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"transaction\": {\n \"value\": \"<number>\",\n \"time\": \"<string>\",\n \"correlationID\": \"<string>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e6c7a2dc-be2c-41cc-a221-27f8b8a72fe8","name":"An error message","originalRequest":{"url":{"path":["api","v1","transfer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"<number>\",\n \"fromPixKey\": \"<string>\",\n \"toPixKey\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"webhook","description":"","item":[{"name":"{id}","description":"","item":[{"id":"b5ec6f46-31e3-47b7-87fd-3af7cb9b93a9","name":"Delete a Webhook","request":{"name":"Delete a Webhook","description":{"content":"Endpoint to delete a Webhook","type":"text/plain"},"url":{"path":["api","v1","webhook",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) webhook ID","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{},"auth":null},"response":[{"id":"e3b7d7f3-80a4-4326-a2d5-f59467c4024c","name":"Webhook ID and also the status code","originalRequest":{"url":{"path":["api","v1","webhook",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"855657cb-5884-496f-ac65-611b33739709","name":"An error message","originalRequest":{"url":{"path":["api","v1","webhook",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\",\n \"status\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"fe122a28-f3c8-4c72-b09a-226d29d547b6","name":"Get a list of webhooks","request":{"name":"Get a list of webhooks","description":{},"url":{"path":["api","v1","webhook"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"You can use the url to filter all webhooks","type":"text/plain"},"key":"url","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"5e280290-f5b9-4fd6-a032-f71503f8c0f1","name":"A list of webhooks","originalRequest":{"url":{"path":["api","v1","webhook"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"You can use the url to filter all webhooks","type":"text/plain"},"key":"url","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"webhooks\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"event\": \"OPENPIX:MOVEMENT_FAILED\",\n \"url\": \"<string>\",\n \"authorization\": \"<string>\",\n \"isActive\": \"<boolean>\",\n \"createdAt\": \"<string>\",\n \"updatedAt\": \"<string>\"\n },\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"event\": \"OPENPIX:MOVEMENT_REMOVED\",\n \"url\": \"<string>\",\n \"authorization\": \"<string>\",\n \"isActive\": \"<boolean>\",\n \"createdAt\": \"<string>\",\n \"updatedAt\": \"<string>\"\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"<string>\",\n \"data\": {\n \"skip\": \"<number>\",\n \"limit\": \"<number>\"\n }\n },\n {\n \"message\": \"<string>\",\n \"data\": {\n \"skip\": \"<number>\",\n \"limit\": \"<number>\"\n }\n }\n ]\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a36fca44-8d25-4b55-baa0-33de0495ddc9","name":"An error message","originalRequest":{"url":{"path":["api","v1","webhook"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"You can use the url to filter all webhooks","type":"text/plain"},"key":"url","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4ba09b95-f158-4d21-9b14-082b4823ec1e","name":"Create a new Webhook","request":{"name":"Create a new Webhook","description":{"content":"Endpoint to create a new Webhook","type":"text/plain"},"url":{"path":["api","v1","webhook"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"webhook\": {\n \"name\": \"<string>\",\n \"event\": \"OPENPIX:MOVEMENT_FAILED\",\n \"url\": \"<string>\",\n \"authorization\": \"<string>\",\n \"isActive\": \"<boolean>\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"ab225feb-c7fb-44a6-a2a6-3be3c2c0fd2d","name":"Webhook created specific event when receives a new pix transaction","originalRequest":{"url":{"path":["api","v1","webhook"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"webhook\": {\n \"name\": \"<string>\",\n \"event\": \"OPENPIX:MOVEMENT_FAILED\",\n \"url\": \"<string>\",\n \"authorization\": \"<string>\",\n \"isActive\": \"<boolean>\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"webhook\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"event\": \"OPENPIX:TRANSACTION_REFUND_RECEIVED\",\n \"url\": \"<string>\",\n \"authorization\": \"<string>\",\n \"isActive\": \"<boolean>\",\n \"createdAt\": \"<string>\",\n \"updatedAt\": \"<string>\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cd3c3bc8-9949-47ac-a4a8-9e6ad7582b42","name":"An error message","originalRequest":{"url":{"path":["api","v1","webhook"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"webhook\": {\n \"name\": \"<string>\",\n \"event\": \"OPENPIX:MOVEMENT_FAILED\",\n \"url\": \"<string>\",\n \"authorization\": \"<string>\",\n \"isActive\": \"<boolean>\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"name":"ips","description":"","item":[{"id":"e51bddf7-4f3e-44d7-95e1-5ef610c7abaf","name":"Get a list of webhook IPs","request":{"name":"Get a list of webhook IPs","description":{},"url":{"path":["api","v1","webhook","ips"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"d8cd1363-1cad-437d-8891-272e8ccc6e68","name":"A list of webhook IPs","originalRequest":{"url":{"path":["api","v1","webhook","ips"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"ips\": [\n \"<string>\",\n \"<string>\"\n ]\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]}]}]},{"name":"openpix","description":"","item":[{"name":"charge","description":"","item":[{"name":"brcode","description":"","item":[{"name":"image","description":"","item":[{"name":"{:id}.png?size=1024","description":"","item":[{"id":"ffbee222-968e-4366-9768-fefb854a7bdc","name":"Get an image of Qr Code from a Charge","request":{"name":"Get an image of Qr Code from a Charge","description":{},"url":{"path":["openpix","charge","brcode","image","{{:id}}.png"],"host":["{{baseUrl}}"],"query":[{"key":"size","value":"1024"},{"disabled":false,"description":{"content":"Size for the image. This size should be between 600 and 4096. if the size parameter was not passed, the default value will be 1024.","type":"text/plain"},"key":"size","value":"<string>"}],"variable":[{"disabled":false,"description":{"content":"(Required) charge link payment ID","type":"text/plain"},"type":"any","value":"<string>","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"5e00adb8-2196-4adb-a5b4-42c8ee3be130","name":"The Qr Code image as MIME type","originalRequest":{"url":{"path":["openpix","charge","brcode","image","{{:id}}.png"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Size for the image. This size should be between 600 and 4096. if the size parameter was not passed, the default value will be 1024.","type":"text/plain"},"key":"size","value":"<string>"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[],"cookie":[],"_postman_previewlanguage":"text"},{"id":"efbee45c-97f0-4ee7-9313-6861911edee1","name":"An error message","originalRequest":{"url":{"path":["openpix","charge","brcode","image","{{:id}}.png"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Size for the image. This size should be between 600 and 4096. if the size parameter was not passed, the default value will be 1024.","type":"text/plain"},"key":"size","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]}]}]}]}],"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"{{apiKey}}","key":"value"},{"type":"any","value":"header","key":"in"}]},"event":[],"variable":[{"key":"baseUrl","value":"https://api.woovi.com"}],"info":{"_postman_id":"b59cd8a9-d209-4846-841b-058db8edb746","name":"Woovi","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json","description":{"content":"A OpenPix é uma Plataforma de Gestão de Pagamentos. \n\n Para utilizar nossa API de Produção, utilize exclusivamente o seguinte endpoint: \n\n 👉 __[https://api.openpix.com.br/](https://api.openpix.com.br/)__ \n\n Além disso, oferecemos também um ambiente de sandbox (ambiente de testes), ideal para desenvolvimento e validação de integrações sem impactar dados reais. \n\n 👉 __[https://api.woovi-sandbox.com/](https://api.woovi-sandbox.com/)__ \n\n Veja como configurar seu acesso a nossa API [aqui](https://developers.openpix.com.br/docs/apis/api-getting-started).","type":"text/plain"}}}