{"item":[{"name":"api","description":"","item":[{"name":"v1","description":"","item":[{"name":"account","description":"","item":[{"name":"{accountId}","description":"","item":[{"id":"8531d4ea-5b25-47fc-bd2d-3f86f0c79f0b","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":"a3f89465-9cc9-467e-b93c-fd0b77c734ac","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":"f8bc46d8-6c16-4936-afa6-810428958d26","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":"9df357e2-30a2-47ae-8dfd-4c0c05f888da","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":"fd05b6e0-d0a6-458c-a491-8a52fb03f64f","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":"f63bfbfe-0275-4c48-93bd-5b448c450071","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":"2ba63829-22bd-4031-a8ba-f37e24ca1fb1","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":"a8d906c6-13f0-4b40-8226-394f96221e52","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":"f5d8a6d4-6b74-4321-96a7-4984937f76d2","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":"cashback-fidelity","description":"","item":[{"name":"balance","description":"","item":[{"name":"{taxID}","description":"","item":[{"id":"d52937ff-3378-4d3c-98bc-ce27c0c3a035","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":"b55889ba-7d17-4f01-bbb7-7203932ed4b1","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":"6d64ee39-5e2c-4dd4-8b03-be0743c6334d","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":"c912a372-0cb5-4954-a8ef-7196a861c024","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":"5d026f7b-3e39-4df6-a235-90ffc9a48a1e","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":"cf201766-12a3-4061-bd5c-224c117bed4d","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":"0c6984fc-dfb9-4838-bfef-bc99d1de67f2","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":"ccc80201-7d93-42a4-b3bb-c6116c1191e5","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":"cb8d8f84-3707-4593-9ee0-cdd5be822791","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":"b8eea7cb-fbc0-4a8e-bf15-1ea6b9326d09","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":"092566a7-95f7-4a8f-9e2b-1ad381381e75","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":"e0e3ff9e-9df2-49b4-983c-d3cae92a657e","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\": \"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      \"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":"32c69dfe-dbae-4492-8363-0d746e7c5447","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":"b209cb8f-45c7-4a8c-975f-dbe59b4392dc","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":"43eb7ef2-6650-48f7-9cb5-6716984d756b","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\": \"CONFIRMED\",\n      \"correlationID\": \"<string>\",\n      \"endToEndId\": \"<string>\",\n      \"time\": \"<string>\",\n      \"comment\": \"<string>\"\n    },\n    {\n      \"value\": \"<number>\",\n      \"status\": \"IN_PROCESSING\",\n      \"correlationID\": \"<string>\",\n      \"endToEndId\": \"<string>\",\n      \"time\": \"<string>\",\n      \"comment\": \"<string>\"\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"90b7376a-cb64-45c6-8efc-513d22477499","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":"663ab61a-52f8-4234-a958-3fac3380a7e5","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":"617c7923-a51f-4e5b-b946-c402f48b495e","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":"351549e2-e1d2-463c-b521-5e57268e734a","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":"8d0210cd-c74a-4d41-b66a-0d4c2e35b609","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":"EXPIRED"},{"disabled":false,"description":{"content":"Customer Correlation ID","type":"text/plain"},"key":"customer","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"86fb4274-c001-495b-8a07-1aafb8ebc23e","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":"EXPIRED"},{"disabled":false,"description":{"content":"Customer Correlation ID","type":"text/plain"},"key":"customer","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\": \"DYNAMIC\",\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        \"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      \"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\": \"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        \"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  ],\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":"2093e54e-082c-4614-a1d3-443f75969bb7","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":"EXPIRED"},{"disabled":false,"description":{"content":"Customer Correlation ID","type":"text/plain"},"key":"customer","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":"c4cc3886-c4b2-452a-8510-b41407d66973","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_INTERNAL_TRANSFER\"\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":"6915e855-fb68-49c8-a675-55a939360815","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_INTERNAL_TRANSFER\"\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      \"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":"4d9cb5ed-1d95-46af-aa40-0bb4fc1eb14b","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_INTERNAL_TRANSFER\"\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":"585e6419-5907-4357-a13a-29cfbf234fae","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","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"18961f80-1088-4e9a-88cf-487fc00cd1ec","name":"The customer retrieve 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":"ed3c458f-3c85-4d1a-a17d-d3baf46832cf","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":"2c8fa13d-e48c-46bc-b7cc-0393db60f10e","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":"f82a0745-033b-45dd-8c2c-2d45edbd0d9a","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":"8e256c03-9abc-4e25-9529-c2b4679deb24","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":"2ebb1116-6cbd-41e1-8991-c4736f15e73c","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":"3e4d18e7-5974-4799-90be-7166b13b4ec0","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":"d10e4f96-572c-48e0-b00e-3fcc37c99345","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":"685007fd-70c8-4b0e-a213-1cd8d583cf79","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":"2a7c6c94-9820-4faa-8d37-c17f606201f1","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":"509df51d-67c7-409f-a700-0e4f716d0fef","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":"partner","description":"","item":[{"name":"application","description":"","item":[{"id":"3ee1d6f7-66b2-4a17-be2e-a061372a7fc4","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\": \"API\"\n  },\n  \"taxID\": {\n    \"taxID\": \"<string>\",\n    \"type\": \"BR:CNPJ\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"4d7ddc0a-09cb-4912-8ea2-493675dff43a","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\": \"API\"\n  },\n  \"taxID\": {\n    \"taxID\": \"<string>\",\n    \"type\": \"BR:CNPJ\"\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":"50b07518-9cc6-4726-9012-3c09a91d8b8e","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\": \"API\"\n  },\n  \"taxID\": {\n    \"taxID\": \"<string>\",\n    \"type\": \"BR:CNPJ\"\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":"2a9ccaf2-6324-469b-8194-d5789e07ff08","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\": \"API\"\n  },\n  \"taxID\": {\n    \"taxID\": \"<string>\",\n    \"type\": \"BR:CNPJ\"\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":"602f795c-a104-4d24-af6c-b3689b666971","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\": \"API\"\n  },\n  \"taxID\": {\n    \"taxID\": \"<string>\",\n    \"type\": \"BR:CNPJ\"\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":"2e12924e-6be8-427a-ae03-8f0e2c5480b9","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":"a33b7a87-fe4d-4cb5-880e-da2a3e67fe4e","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:CNPJ\"\n      }\n    },\n    \"user\": {\n      \"firstName\": \"<string>\",\n      \"lastName\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\"\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}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0892a684-111c-47e6-9549-9a1bedf8f4a6","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":"ac84503b-f98e-49b6-807a-3215acc0e67c","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":"80760027-c97b-41d2-afd9-507d7a9d265e","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:CNPJ\"\n        }\n      },\n      \"user\": {\n        \"firstName\": \"<string>\",\n        \"lastName\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\"\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      \"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      },\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":"5f39e605-91c0-40ea-8764-a2c764d98979","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":"80f252b8-4ac7-4206-a0d9-0158ce944754","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:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"d1eac32c-ceff-4f45-a05a-338d205ae4ee","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:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\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:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ad4a62b3-2aea-4d7d-813a-ebbffaa546f4","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:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\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:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bc7a1d60-1939-46e0-8d2f-8fadaa54d5cd","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:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<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"},{"id":"5aa6ff83-1b4e-4fa3-8ff7-883b4863f998","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:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\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":"a9c03776-86f4-4f78-97f4-0c35d24601b7","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":"1ff7f413-3455-4e91-b226-572a79e2747b","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\": \"CONFIRMED\",\n    \"sourceAccountId\": \"<string>\"\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":"cd4115a5-5ef0-43aa-b73d-fce99af3e209","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":"f8bcece8-021c-4538-8b40-0162659828b0","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":"35708185-da97-420e-baf8-8a2904d215c5","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\": \"RANDOM\",\n    \"qrCode\": \"<string>\",\n    \"correlationID\": \"<string>\",\n    \"comment\": \"<string>\",\n    \"status\": \"DENIED\",\n    \"sourceAccountId\": \"<string>\"\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":"5a5b0ec1-0072-4868-b4bb-0a5fb34e0a1b","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":"477a7259-850d-4ea1-808f-5ce2e16bb50f","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":"9c013c46-2fb6-4aff-bdd1-d25f2830ebfd","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\": \"EMAIL\",\n        \"qrCode\": \"<string>\",\n        \"correlationID\": \"<string>\",\n        \"comment\": \"<string>\",\n        \"status\": \"DENIED\",\n        \"sourceAccountId\": \"<string>\"\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\": \"CPF\",\n        \"qrCode\": \"<string>\",\n        \"correlationID\": \"<string>\",\n        \"comment\": \"<string>\",\n        \"status\": \"DENIED\",\n        \"sourceAccountId\": \"<string>\"\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":"c3606f72-3e85-43e1-bfab-07420f503c53","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":"b70830dd-37c6-4f97-a34e-d1c78e11c35e","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\": \"CNPJ\",\n  \"correlationID\": \"<string>\",\n  \"comment\": \"<string>\",\n  \"sourceAccountId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"dfba0fc1-ab8f-48ac-8293-637117c990a3","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\": \"CNPJ\",\n  \"correlationID\": \"<string>\",\n  \"comment\": \"<string>\",\n  \"sourceAccountId\": \"<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    \"sourceAccountId\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d1d7882e-2bc1-4e94-8843-1675c4d19238","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\": \"CNPJ\",\n  \"correlationID\": \"<string>\",\n  \"comment\": \"<string>\",\n  \"sourceAccountId\": \"<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":"5e4cf423-21f4-4a8f-9467-ab6ef2a4ccc4","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":"273ba1ee-6bb5-4156-b9b0-d68b0f0f8390","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":"0bd39855-da30-4421-a418-c5eed1fc517e","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":"a6944ef7-1459-4027-9192-6c81550280bc","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":"20550f09-bc6d-48ae-82a7-a4d45e1c12e2","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":"65544765-e403-4a69-99ed-fc63ab9007ba","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":"1be1c778-6a33-4676-abe4-1b46ce0612d8","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":"e1d63e79-1c23-45ca-9f71-f6c2fa2ec66c","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":"94200d33-36fd-4980-bb05-876f503ee095","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":"refund","description":"","item":[{"name":"{id}","description":"","item":[{"id":"42464d8b-c05b-4e9b-b1ee-16b2b2cfe839","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":"847d85df-ae4e-45f5-9097-7aad78bafd8f","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":"7b08e3bb-d74b-473b-b8d0-802e81c3d70e","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":"990d06ce-59ab-464a-918d-a282d71cdb57","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":"b64c8c9f-5bd1-4164-9698-3f4c6d1bd332","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\": \"IN_PROCESSING\",\n      \"correlationID\": \"<string>\",\n      \"refundId\": \"<string>\",\n      \"time\": \"<string>\",\n      \"comment\": \"<string>\"\n    },\n    {\n      \"value\": \"<number>\",\n      \"status\": \"NOT_ACCOMPLISHED\",\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":"e0c19bf4-3b05-4296-8bd2-79b83567f552","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":"0223a085-b30f-4a1b-9546-d1fc9ef3e9d7","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":"f1754011-057c-41b2-903d-e238f894e299","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\": \"REFUNDED\",\n    \"correlationID\": \"<string>\",\n    \"refundId\": \"<string>\",\n    \"time\": \"<string>\",\n    \"comment\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bf8cd6a9-a69c-4bb8-ac76-689b7af546c9","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":"subscriptions","description":"","item":[{"name":"{id}","description":"","item":[{"id":"3ac9c38a-63c6-4fe6-8aee-146ae2510e8e","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":"075fcd3e-9ea3-47a2-8bc3-495b17da39f3","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    \"status\": \"COMPLETED\",\n    \"correlationID\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cbcd7e1d-cef1-4957-8dce-e7a140bf70d9","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":"b3c5ffec-2e14-4eda-b38e-0d291d97e65b","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  \"chargeType\": \"DYNAMIC\",\n  \"dayDue\": 7\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"e3c4e143-0952-4a87-8ecb-cc96b73c7129","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  \"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    \"status\": \"ACTIVE\",\n    \"correlationID\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0122faa6-5ec4-49b6-b662-8e330325d1ee","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  \"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":"transaction","description":"","item":[{"name":"{id}","description":"","item":[{"id":"13a52083-d3df-40dc-be14-81fe87006e4e","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":"acb9e8ce-2b0b-4721-baa3-c6abe6973eb2","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        \"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    \"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}","cookie":[],"_postman_previewlanguage":"json"},{"id":"48d09fef-1b4b-4fb5-836a-be50f5df6a42","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":"d39dc476-4892-4387-b37f-08fec26e1ba0","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":"df184506-aabc-415e-a68e-afc2307b4e71","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\": \"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          \"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      \"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    {\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\": \"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          \"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  ],\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":"9f53cfb3-7f6c-4f77-8f01-a98143c4f668","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":"transfer","description":"","item":[{"id":"d0d9c96d-39ff-48d5-b797-7e7e793da6a7","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":"96a73e6f-a9ac-4ea3-a0ac-4f76d70aeb31","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":"f01ae712-d64d-4e9e-8712-68c21a132fa2","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":"79611c33-6339-4a1c-abcf-ba5b494426f0","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":"83ec9772-e094-423b-a514-06c55f987684","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":"f67e8123-3119-4e45-a8fd-bdedf4754764","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":"7704755f-a3aa-4a66-89f7-c34fce758608","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":"17b56c93-b617-46ee-8545-a46155aba91c","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:CHARGE_EXPIRED\",\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":"d6347508-ffb7-4d61-a514-9378dad82241","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":"16689809-85ec-493f-802a-8500af7c0f5d","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":"744c4c56-4cfc-49e6-8eaf-0e6f97b7718f","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:CHARGE_EXPIRED\",\n    \"url\": \"<string>\",\n    \"authorization\": \"<string>\",\n    \"isActive\": \"<boolean>\",\n    \"createdAt\": \"<string>\",\n    \"updatedAt\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"dd6bd8f1-4f97-4494-a8ce-5b59a439bc6f","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":"3b389d77-9db8-428e-8bb7-78a864328e7a","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":"d4d10030-1ee0-4bce-aefb-8dfd3ee615d6","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":"subaccount","description":"","item":[{"name":"{id}","description":"","item":[{"name":"withdraw","description":"","item":[{"id":"e9f66ad7-be58-467a-a7e7-7091314e09bc","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":"Accept","value":"application/json"}],"method":"POST","body":{},"auth":null},"response":[{"id":"21607b29-1ba3-4a6d-bded-d6e4ad77f63f","name":"Withdrawal Transaction information","originalRequest":{"url":{"path":["api","v1","subaccount",":id","withdraw"],"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":"POST","body":{}},"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":"39140efe-bda2-4074-af42-9da8445b3115","name":"An error message","originalRequest":{"url":{"path":["api","v1","subaccount",":id","withdraw"],"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":"POST","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":"42b8cdcc-be04-46c5-9925-ed2fdb76f67d","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":"f523d52e-4b51-492e-b29c-534df3e4be1e","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":"ffde4a71-419b-41d0-b999-32b6c519ab58","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}}]},{"id":"3a2406fd-f197-4ed0-b190-c53f0819d043","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":"2c3feee1-8acb-4202-8c30-5df4220714a0","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":"cc72382c-74e4-45a8-a962-a5ecf6b95a78","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":"ceaa48b1-3fe9-4711-86e6-c3a807784505","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":"fed9437e-6e46-4a7f-8b1f-b4cbc6a7bd54","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":"63b918cd-c8f9-4ac2-add3-8d457e0ba87b","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":"6dd47c64-a0ad-4d75-b100-91eca3070a9d","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\": \"CNPJ\",\n  \"toPixKey\": \"<string>\",\n  \"toPixKeyType\": \"RANDOM\",\n  \"correlationID\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"2558c7d6-7dfc-4bba-8083-54714205d9cd","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\": \"CNPJ\",\n  \"toPixKey\": \"<string>\",\n  \"toPixKeyType\": \"RANDOM\",\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":"a0d5a725-1e7d-4383-ae5b-a83bc5249b5e","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\": \"CNPJ\",\n  \"toPixKey\": \"<string>\",\n  \"toPixKeyType\": \"RANDOM\",\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":"openpix","description":"","item":[{"name":"charge","description":"","item":[{"name":"brcode","description":"","item":[{"name":"image","description":"","item":[{"name":"{:id}.png?size=1024","description":"","item":[{"id":"07036910-210c-4497-a536-3cf91df545d3","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":"d8d933cb-a9e1-4e6f-892b-f7761ef1e56f","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":"fa52cd7a-890e-44e5-82be-2eeea3bd8f86","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.openpix.com.br"}],"info":{"_postman_id":"5073def0-3cf2-41ed-9174-2308923d0955","name":"OpenPix","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json","description":{"content":"A OpenPix é uma Plataforma de Gestão de Pagamentos. Para utilizar nossa API você deve acessar  __[https://api.openpix.com.br/](https://api.openpix.com.br/)__ e somente o mesmo. A OpenPix não aceita subdominios para a API.\n\nVeja como configurar seu acesso a nossa API [aqui](https://developers.openpix.com.br/docs/apis/api-getting-started).","type":"text/plain"}}}