From 12dad4d3b6b8df5d04d2cb66bfbcc26985c7cc22 Mon Sep 17 00:00:00 2001 From: jgcmarins Date: Mon, 30 Oct 2023 10:52:22 -0300 Subject: [PATCH] feat(customer): improve customer payload with required fields --- src/swaggers/woovi.json | 2 +- src/swaggers/woovi.yml | 130 +++++++++++++++++++++++++++++++-------- static/wooviPostman.json | 2 +- 3 files changed, 106 insertions(+), 28 deletions(-) diff --git a/src/swaggers/woovi.json b/src/swaggers/woovi.json index b148461..e0cfa44 100644 --- a/src/swaggers/woovi.json +++ b/src/swaggers/woovi.json @@ -1 +1 @@ -{"openapi":"3.0.3","info":{"title":"Woovi","description":"A Woovi é uma Plataforma de Gestão de Pagamentos. Para utilizar nossa API você deve acessar __[https://api.woovi.com/](https://api.woovi.com/)__ e somente o mesmo. A Woovi não aceita subdominios para a API.\n\nVeja como configurar seu acesso a nossa API [aqui](https://developers.woovi.com/docs/apis/api-getting-started).","version":"1.0.0"},"servers":[{"url":"https://api.woovi.com","description":"Production server"}],"security":[{"AppID":[]}],"paths":{"/api/v1/account/{accountId}":{"get":{"tags":["account"],"summary":"Get an Account","parameters":[{"name":"accountId","in":"path","description":"ID of the Account","required":true,"schema":{"type":"string"},"example":"6290ccfd42831958a405debc"}],"responses":{"200":{"description":"The Account retrieve using the given Account ID","content":{"application/json":{"schema":{"type":"object","properties":{"account":{"type":"object","$ref":"#/components/schemas/CompanyBankAccount"}}},"example":{"account":{"accountId":"6290ccfd42831958a405debc","isDefault":true,"balance":{"total":129430,"blocked":0,"available":129430}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/account/6290ccfd42831958a405debc\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/account/6290ccfd42831958a405debc \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/account/6290ccfd42831958a405debc\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/account/6290ccfd42831958a405debc\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/account/6290ccfd42831958a405debc\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/account/6290ccfd42831958a405debc\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/account/6290ccfd42831958a405debc\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/account/":{"get":{"tags":["account"],"summary":"Get a list of Accounts","responses":{"200":{"description":"A list of Accounts","content":{"application/json":{"schema":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/CompanyBankAccount"}}}},"example":{"accounts":[{"accountId":"6290ccfd42831958a405debc","isDefault":true,"balance":{"total":129430,"blocked":0,"available":129430}},{"accountId":"6286b467a7910113577e00ce","isDefault":false,"balance":{"total":130,"blocked":100,"available":30}}]}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/account/\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/account/ \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/account/\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/account/\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/account/\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/account/\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/account/\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/account/{accountId}/withdraw":{"post":{"tags":["account"],"summary":"Withdraw from an Account","description":"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","parameters":[{"name":"accountId","in":"path","description":"ID of the Account","required":true,"schema":{"type":"string"},"example":"6290ccfd42831958a405debc"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"number","description":"Value in cents"}}},"example":{"value":7000}}}},"responses":{"200":{"description":"Withdraw and Acccount information","content":{"application/json":{"schema":{"type":"object","properties":{"withdraw":{"type":"object","properties":{"account":{"type":"object","$ref":"#/components/schemas/CompanyBankAccount"},"transaction":{"type":"object","$ref":"#/components/schemas/WithdrawTransaction"}}}}},"example":{"withdraw":{"account":{"accountId":"6290ccfd42831958a405debc","isDefault":true,"balance":{"total":122430,"blocked":0,"available":122430}},"transaction":{"endToEndId":"E23114447202205191817cx6VMrbwtw6","transaction":7000}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/account/6290ccfd42831958a405debc/withdraw\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({value: 0}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/account/6290ccfd42831958a405debc/withdraw \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"value\":0}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/account/6290ccfd42831958a405debc/withdraw\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"value\\\":0}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"value\\\":0}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/account/6290ccfd42831958a405debc/withdraw\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/account/6290ccfd42831958a405debc/withdraw\"\n\n\tpayload := strings.NewReader(\"{\\\"value\\\":0}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"value\\\":0}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/account/6290ccfd42831958a405debc/withdraw\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/account/6290ccfd42831958a405debc/withdraw\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"value\\\":0}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/cashback-fidelity/balance/{taxID}":{"get":{"tags":["cashback-fidelity"],"summary":"Get the exclusive cashback amount an user still has to receive by taxID.","parameters":[{"name":"taxID","in":"path","description":"The raw tax ID from the customer you want to get the balance.","required":true,"schema":{"type":"string"},"examples":{"taxID":{"value":"60151449000182"}}}],"responses":{"200":{"description":"Amount the user still has to receive.","content":{"application/json":{"schema":{"type":"object","properties":{"balance":{"type":"number"},"status":{"type":"string"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/cashback-fidelity/balance/%7BtaxID%7D\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/cashback-fidelity/balance/%7BtaxID%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/cashback-fidelity/balance/%7BtaxID%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/cashback-fidelity/balance/%7BtaxID%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/cashback-fidelity/balance/%7BtaxID%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/cashback-fidelity/balance/%7BtaxID%7D\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/cashback-fidelity/balance/%7BtaxID%7D\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/cashback-fidelity":{"post":{"tags":["cashback-fidelity"],"summary":"Get or create cashback for a customer.","description":"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.","requestBody":{"description":"Customer's taxID and the cash","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"taxID":{"type":"string","description":"Customer taxID (CPF or CNPJ)"},"value":{"type":"number","description":"Cashback value in centavos"}}},"example":{"value":100,"taxID":11111111111}}}},"responses":{"200":{"description":"Didn't create a new cashback, returning previously existing cashback information instead.","content":{"application/json":{"schema":{"type":"object","properties":{"cashback":{"description":"Object representing the existing cashback","type":"object","properties":{"value":{"type":"number","description":"Cashback value in centavos"}}},"message":{"type":"string","description":"String explaining what happened"}}}}}},"201":{"description":"New cashback created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"cashback":{"description":"Object representing the new cashback","type":"object","properties":{"value":{"type":"number","description":"Cashback value in centavos"}}},"message":{"type":"string","description":"String explaining what happened"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/cashback-fidelity\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({taxID: 'string', value: 0}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/cashback-fidelity \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"taxID\":\"string\",\"value\":0}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/cashback-fidelity\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"taxID\\\":\\\"string\\\",\\\"value\\\":0}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"taxID\\\":\\\"string\\\",\\\"value\\\":0}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/cashback-fidelity\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/cashback-fidelity\"\n\n\tpayload := strings.NewReader(\"{\\\"taxID\\\":\\\"string\\\",\\\"value\\\":0}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"taxID\\\":\\\"string\\\",\\\"value\\\":0}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/cashback-fidelity\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/cashback-fidelity\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"taxID\\\":\\\"string\\\",\\\"value\\\":0}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/charge/{id}":{"delete":{"tags":["charge"],"summary":"Delete a charge","parameters":[{"name":"id","in":"path","description":"charge ID or correlation ID. You will need URI encoding if your correlation ID has characters outside the ASCII set or reserved characters (%, \\#, /).","required":true,"schema":{"type":"string"},"examples":{"chargeId":{"value":"Q2hhcmdlOjYwM2U3NDlhNDI1NjAyYmJiZjRlN2JlZA=="},"correlationID":{"value":"fe7834b4060c488a9b0f89811be5f5cf"}}}],"responses":{"200":{"description":"The charge deleted","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"id":{"type":"string","description":"the id previously informed to be found and deleted"}},"example":{"status":"OK","id":"fe7834b4060c488a9b0f89811be5f5cf"}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/charge/%7Bid%7D\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request DELETE \\\n --url https://api.woovi.com/api/v1/charge/%7Bid%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/charge/%7Bid%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"DELETE\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"DELETE\", \"/api/v1/charge/%7Bid%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/charge/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/charge/%7Bid%7D\")\n .delete(null)\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/charge/%7Bid%7D\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Delete.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]},"get":{"tags":["charge"],"summary":"Get one charge","parameters":[{"name":"id","in":"path","description":"charge ID or correlation ID. You will need URI encoding if your correlation ID has characters outside the ASCII set or reserved characters (%, \\#, /).","required":true,"schema":{"type":"string"},"example":"fe7834b4060c488a9b0f89811be5f5cf"}],"responses":{"200":{"description":"The charge retrieve using the given ID","content":{"application/json":{"schema":{"type":"object","properties":{"charge":{"type":"object","$ref":"#/components/schemas/Charge"}},"example":{"charge":{"status":"ACTIVE","customer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"}},"value":100,"comment":"good","correlationID":"9134e286-6f71-427a-bf00-241681624586","paymentLinkID":"7777-6f71-427a-bf00-241681624586","paymentLinkUrl":"https://openpix.com.br/pay/9134e286-6f71-427a-bf00-241681624586","globalID":"Q2hhcmdlOjcxOTFmMWIwMjA0NmJmNWY1M2RjZmEwYg==","qrCodeImage":"https://api.openpix.com.br/openpix/charge/brcode/image/9134e286-6f71-427a-bf00-241681624586.png","brCode":"000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA","additionalInfo":[{"key":"Product","value":"Pencil"},{"key":"Invoice","value":"18476"},{"key":"Order","value":"302"}],"expiresIn":2592000,"expiresDate":"2021-04-01T17:28:51.882Z","createdAt":"2021-03-02T17:28:51.882Z","updatedAt":"2021-03-02T17:28:51.882Z"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/charge/fe7834b4060c488a9b0f89811be5f5cf\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/charge/fe7834b4060c488a9b0f89811be5f5cf \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/charge/fe7834b4060c488a9b0f89811be5f5cf\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/charge/fe7834b4060c488a9b0f89811be5f5cf\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/charge/fe7834b4060c488a9b0f89811be5f5cf\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/charge/fe7834b4060c488a9b0f89811be5f5cf\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/charge/fe7834b4060c488a9b0f89811be5f5cf\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/charge":{"get":{"tags":["charge"],"summary":"Get a list of charges","parameters":[{"in":"query","name":"start","schema":{"type":"string","format":"date-time","title":"Start Date","description":"Start date used in the query. Complies with RFC 3339.","example":"2020-01-01T00:00:00Z"}},{"in":"query","name":"end","schema":{"type":"string","format":"date-time","title":"End Date","description":"End date used in the query. Complies with RFC 3339.","example":"2020-12-01T17:00:00Z"}},{"name":"status","in":"query","schema":{"type":"string","enum":["ACTIVE","COMPLETED","EXPIRED"]}}],"responses":{"200":{"description":"A list of charges","content":{"application/json":{"schema":{"type":"object","properties":{"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}},"pageInfo":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"skip":{"type":"number"},"limit":{"type":"number"}}}}}},"skip":{"type":"number"},"limit":{"type":"number"},"totalCount":{"type":"number"},"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}}}},"example":{"pageInfo":{"skip":0,"limit":10,"totalCount":20,"hasPreviousPage":false,"hasNextPage":true},"charges":{"status":"ACTIVE","customer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"}},"value":100,"comment":"good","correlationID":"9134e286-6f71-427a-bf00-241681624586","paymentLinkID":"7777a23s-6f71-427a-bf00-241681624586","paymentLinkUrl":"https://openpix.com.br/pay/9134e286-6f71-427a-bf00-241681624586","qrCodeImage":"https://api.openpix.com.br/openpix/charge/brcode/image/9134e286-6f71-427a-bf00-241681624586.png","brCode":"000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA","additionalInfo":[{"key":"Product","value":"Pencil"},{"key":"Invoice","value":"18476"},{"key":"Order","value":"302"}],"expiresIn":2592000,"expiresDate":"2021-04-01T17:28:51.882Z","createdAt":"2021-03-02T17:28:51.882Z","updatedAt":"2021-03-02T17:28:51.882Z"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/charge?start=2020-01-01T00%3A00%3A00Z&end=2020-12-01T17%3A00%3A00Z&status=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.woovi.com/api/v1/charge?start=2020-01-01T00%3A00%3A00Z&end=2020-12-01T17%3A00%3A00Z&status=SOME_STRING_VALUE' \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/charge?start=2020-01-01T00%3A00%3A00Z&end=2020-12-01T17%3A00%3A00Z&status=SOME_STRING_VALUE\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/charge?start=2020-01-01T00%3A00%3A00Z&end=2020-12-01T17%3A00%3A00Z&status=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/charge?start=2020-01-01T00%3A00%3A00Z&end=2020-12-01T17%3A00%3A00Z&status=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/charge?start=2020-01-01T00%3A00%3A00Z&end=2020-12-01T17%3A00%3A00Z&status=SOME_STRING_VALUE\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/charge?start=2020-01-01T00%3A00%3A00Z&end=2020-12-01T17%3A00%3A00Z&status=SOME_STRING_VALUE\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]},"post":{"tags":["charge"],"summary":"Create a new Charge","parameters":[{"in":"query","name":"return_existing","description":"Make the endpoint idempotent, will return an existent charge if already has a one with the correlationID","required":false,"schema":{"type":"boolean"},"examples":{"return_existing":{"value":true}}}],"description":"Endpoint to create a new Charge for a customer","requestBody":{"description":"Data to create a new charge","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ChargePayload"},"examples":{"Charge":{"value":{"correlationID":"9134e286-6f71-427a-bf00-241681624587","value":100,"comment":"good","customer":{"name":"Dan","taxID":"31324227036","email":"email0@example.com","phone":"5511999999999"},"additionalInfo":[{"key":"Product","value":"Pencil"},{"key":"Invoice","value":"18476"},{"key":"Order","value":"302"}]}},"Charge with Interests and Fines":{"value":{"type":"OVERDUE","correlationID":"9134e286-6f71-427a-bf00-241681624587","value":100,"comment":"good","daysForDueDate":5,"daysAfterDueDate":5,"interests":{"value":10},"fines":{"value":20},"customer":{"name":"Dan","taxID":"31324227036","email":"email0@example.com","phone":"5511999999999","address":{"zipcode":"30421322","street":"Street","number":"100","neighborhood":"Neighborhood","city":"Belo Horizonte","state":"MG","complement":"APTO","country":"BR"}},"additionalInfo":[{"key":"Product","value":"Pencil"},{"key":"Invoice","value":"18476"},{"key":"Order","value":"302"}]}}}}}},"responses":{"200":{"description":"Charge ID and also the generated Dynamic BR Code to be rendered as a QRCode","content":{"application/json":{"schema":{"type":"object","properties":{"charge":{"$ref":"#/components/schemas/Charge"},"correlationID":{"type":"string"},"brCode":{"type":"string"}},"example":{"charge":{"status":"ACTIVE","customer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"}},"value":100,"comment":"good","correlationID":"9134e286-6f71-427a-bf00-241681624586","paymentLinkID":"7777a23s-6f71-427a-bf00-241681624586","paymentLinkUrl":"https://openpix.com.br/pay/9134e286-6f71-427a-bf00-241681624586","qrCodeImage":"https://api.openpix.com.br/openpix/charge/brcode/image/9134e286-6f71-427a-bf00-241681624586.png","expiresIn":2592000,"expiresDate":"2021-04-01T17:28:51.882Z","createdAt":"2021-03-02T17:28:51.882Z","updatedAt":"2021-03-02T17:28:51.882Z","brCode":"000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA","additionalInfo":[{"key":"Product","value":"Pencil"},{"key":"Invoice","value":"18476"},{"key":"Order","value":"302"}]}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/charge?return_existing=SOME_BOOLEAN_VALUE\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n correlationID: 'string',\n value: 0,\n type: 'DYNAMIC',\n comment: 'string',\n identifier: 'string',\n expiresIn: 0,\n customer: {\n name: 'string',\n email: 'string',\n phone: 'string',\n taxID: '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: 0,\n daysAfterDueDate: 0,\n interests: {value: 0},\n fines: {value: 0},\n additionalInfo: [{key: 'string', value: 'string'}]\n}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url 'https://api.woovi.com/api/v1/charge?return_existing=SOME_BOOLEAN_VALUE' \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"correlationID\":\"string\",\"value\":0,\"type\":\"DYNAMIC\",\"comment\":\"string\",\"identifier\":\"string\",\"expiresIn\":0,\"customer\":{\"name\":\"string\",\"email\":\"string\",\"phone\":\"string\",\"taxID\":\"string\",\"correlationID\":\"string\",\"address\":{\"zipcode\":\"string\",\"street\":\"string\",\"number\":\"string\",\"neighborhood\":\"string\",\"city\":\"string\",\"state\":\"string\",\"complement\":\"string\",\"country\":\"string\"}},\"daysForDueDate\":0,\"daysAfterDueDate\":0,\"interests\":{\"value\":0},\"fines\":{\"value\":0},\"additionalInfo\":[{\"key\":\"string\",\"value\":\"string\"}]}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/charge?return_existing=SOME_BOOLEAN_VALUE\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"type\\\":\\\"DYNAMIC\\\",\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\",\\\"expiresIn\\\":0,\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"daysForDueDate\\\":0,\\\"daysAfterDueDate\\\":0,\\\"interests\\\":{\\\"value\\\":0},\\\"fines\\\":{\\\"value\\\":0},\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}]}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"type\\\":\\\"DYNAMIC\\\",\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\",\\\"expiresIn\\\":0,\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"daysForDueDate\\\":0,\\\"daysAfterDueDate\\\":0,\\\"interests\\\":{\\\"value\\\":0},\\\"fines\\\":{\\\"value\\\":0},\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}]}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/charge?return_existing=SOME_BOOLEAN_VALUE\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/charge?return_existing=SOME_BOOLEAN_VALUE\"\n\n\tpayload := strings.NewReader(\"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"type\\\":\\\"DYNAMIC\\\",\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\",\\\"expiresIn\\\":0,\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"daysForDueDate\\\":0,\\\"daysAfterDueDate\\\":0,\\\"interests\\\":{\\\"value\\\":0},\\\"fines\\\":{\\\"value\\\":0},\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}]}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"type\\\":\\\"DYNAMIC\\\",\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\",\\\"expiresIn\\\":0,\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"daysForDueDate\\\":0,\\\"daysAfterDueDate\\\":0,\\\"interests\\\":{\\\"value\\\":0},\\\"fines\\\":{\\\"value\\\":0},\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}]}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/charge?return_existing=SOME_BOOLEAN_VALUE\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/charge?return_existing=SOME_BOOLEAN_VALUE\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"type\\\":\\\"DYNAMIC\\\",\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\",\\\"expiresIn\\\":0,\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"daysForDueDate\\\":0,\\\"daysAfterDueDate\\\":0,\\\"interests\\\":{\\\"value\\\":0},\\\"fines\\\":{\\\"value\\\":0},\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}]}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/charge/{id}/refund":{"get":{"tags":["charge refund"],"summary":"Get all refunds of a charge","description":"Endpoint to get all refunds of a charge","parameters":[{"name":"id","in":"path","description":"The correlation ID of the charge. You will need URI encoding if your correlation ID has characters outside the ASCII set or reserved characters (%, \\#, /).","required":true,"schema":{"type":"string"},"examples":{"uuid":{"value":"cf4012c9-b2ac-484d-8121-deedd1c6d8af"},"random-string":{"value":"fe7834b4060c488a9b0f89811be5f5cf"}}}],"responses":{"200":{"description":"A list of refunds","content":{"application/json":{"schema":{"type":"object","properties":{"refunds":{"type":"array","items":{"$ref":"#/components/schemas/ChargeRefund"}}},"example":{"refunds":[{"status":"IN_PROCESSING","value":10,"correlationID":"9134e286-6f71-427a-bf00-241681624586","endToEndId":"E23114447202304181826HJNwY577YDX","time":"2021-03-02T17:28:51.882Z"},{"status":"CONFIRMED","value":40,"correlationID":"589a378e-ab45-4f30-bd4d-4496c60f88cf","endToEndId":"E23114447202304181057pOhPMsp2pJZ","time":"2021-03-05T14:49:02.922Z","comment":"Comentário do reembolso"}]}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/charge/%7Bid%7D/refund\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/charge/%7Bid%7D/refund \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/charge/%7Bid%7D/refund\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/charge/%7Bid%7D/refund\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/charge/%7Bid%7D/refund\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/charge/%7Bid%7D/refund\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/charge/%7Bid%7D/refund\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]},"post":{"tags":["charge refund"],"summary":"Create a new refund for a charge","description":"Endpoint to create a new refund for a charge","parameters":[{"name":"id","in":"path","description":"The correlation ID of the charge. You will need URI encoding if your correlation ID has characters outside the ASCII set or reserved characters (%, \\#, /).","required":true,"schema":{"type":"string"},"examples":{"uuid":{"value":"cf4012c9-b2ac-484d-8121-deedd1c6d8af"},"random-string":{"value":"fe7834b4060c488a9b0f89811be5f5cf"}}}],"requestBody":{"description":"Data to create a new refund for a charge","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ChargeRefundPayload"},"example":{"correlationID":"a273e72c-9547-4c75-a213-3b0a2735b8d5","value":100,"comment":"Comentário do reembolso"}}}},"responses":{"200":{"description":"The created Refund","content":{"application/json":{"schema":{"type":"object","properties":{"refund":{"$ref":"#/components/schemas/ChargeRefund"}},"example":{"refund":{"status":"IN_PROCESSING","value":100,"correlationID":"a273e72c-9547-4c75-a213-3b0a2735b8d5","endToEndId":"E23114447202304181826HJNwY577YDX","time":"2023-03-02T17:28:51.882Z","comment":"Comentário do reembolso"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/charge/%7Bid%7D/refund\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({correlationID: 'string', value: 0, comment: 'string'}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/charge/%7Bid%7D/refund \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"correlationID\":\"string\",\"value\":0,\"comment\":\"string\"}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/charge/%7Bid%7D/refund\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"comment\\\":\\\"string\\\"}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"comment\\\":\\\"string\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/charge/%7Bid%7D/refund\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/charge/%7Bid%7D/refund\"\n\n\tpayload := strings.NewReader(\"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"comment\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"comment\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/charge/%7Bid%7D/refund\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/charge/%7Bid%7D/refund\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"comment\\\":\\\"string\\\"}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/customer/{id}":{"get":{"tags":["customer"],"summary":"Get one customer","parameters":[{"name":"id","in":"path","description":"correlation ID","required":true,"schema":{"type":"string"},"examples":{"correlationID":{"value":"fe7834b4060c488a9b0f89811be5f5cf"}}}],"responses":{"200":{"description":"The customer retrieve using the given ID","content":{"application/json":{"schema":{"type":"object","properties":{"customer":{"type":"object","$ref":"#/components/schemas/Customer"}},"example":{"customer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"},"correlationID":"fe7834b4060c488a9b0f89811be5f5cf"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/customer/%7Bid%7D\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/customer/%7Bid%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/customer/%7Bid%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/customer/%7Bid%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/customer/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/customer/%7Bid%7D\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/customer/%7Bid%7D\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/customer":{"get":{"tags":["customer"],"summary":"Get a list of customers","responses":{"200":{"description":"A list of customers","content":{"application/json":{"schema":{"type":"object","properties":{"customers":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}},"pageInfo":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"skip":{"type":"number"},"limit":{"type":"number"}}}}}},"skip":{"type":"number"},"limit":{"type":"number"},"totalCount":{"type":"number"},"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}}}},"example":{"pageInfo":{"skip":0,"limit":10,"totalCount":20,"hasPreviousPage":false,"hasNextPage":true},"customers":{"customer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"}}}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/customer\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/customer \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/customer\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/customer\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/customer\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/customer\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/customer\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]},"post":{"tags":["customer"],"summary":"Create a new Customer","description":"Endpoint to create a new Customer","requestBody":{"description":"Data to create a new customer","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/CustomerPayload"},"example":{"name":"Dan","taxID":"31324227036","email":"email0@example.com","phone":"5511999999999","correlationID":"9134e286-6f71-427a-bf00-241681624586","address":{"zipcode":"30421322","street":"Street","number":"100","neighborhood":"Neighborhood","city":"Belo Horizonte","state":"MG","complement":"APTO","country":"BR"}}}}},"responses":{"200":{"description":"Customer ID","content":{"application/json":{"schema":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/Customer"}},"example":{"customer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"},"address":{"zipcode":"30421322","street":"Street","number":"100","neighborhood":"Neighborhood","city":"Belo Horizonte","state":"MG","complement":"APTO","country":"BR"}}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/customer\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n name: 'string',\n email: 'string',\n phone: 'string',\n taxID: '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}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/customer \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"name\":\"string\",\"email\":\"string\",\"phone\":\"string\",\"taxID\":\"string\",\"correlationID\":\"string\",\"address\":{\"zipcode\":\"string\",\"street\":\"string\",\"number\":\"string\",\"neighborhood\":\"string\",\"city\":\"string\",\"state\":\"string\",\"complement\":\"string\",\"country\":\"string\"}}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/customer\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/customer\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/customer\"\n\n\tpayload := strings.NewReader(\"{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/customer\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/customer\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/partner/application":{"post":{"tags":["partner (request access)"],"summary":"Create a new application to some of your preregistration's company.","description":"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","requestBody":{"description":"The request body to create a pre registration.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"application":{"type":"object","properties":{"name":{"type":"string","description":"The name you want to give your application"},"type":{"$ref":"#/components/schemas/ApplicationEnumTypePayload"}},"required":["name","type"]},"taxID":{"$ref":"#/components/schemas/TaxIDObjectPayload","required":["taxID","type"]}}},"example":{"application":{"name":"MyAPIAccess","type":"API"},"taxID":{"taxID":"65914571000187","type":"BR:CNPJ"}}}}},"responses":{"200":{"description":"Our \"idempotence output\", if you get this HTTP code, it's an application\nthat already has been registered.\n","content":{"application/json":{"schema":{"type":"object","properties":{"application":{"$ref":"#/components/schemas/PartnerApplicationPayload"}}}}}},"201":{"description":"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","content":{"application/json":{"schema":{"type":"object","properties":{"application":{"$ref":"#/components/schemas/PartnerApplicationPayload"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"403":{"description":"You are unauthorized to use this endpoint.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/partner/application\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n application: {name: 'string', type: 'API'},\n taxID: {taxID: 'string', type: 'BR:CNPJ'}\n}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/partner/application \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"application\":{\"name\":\"string\",\"type\":\"API\"},\"taxID\":{\"taxID\":\"string\",\"type\":\"BR:CNPJ\"}}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/partner/application\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"application\\\":{\\\"name\\\":\\\"string\\\",\\\"type\\\":\\\"API\\\"},\\\"taxID\\\":{\\\"taxID\\\":\\\"string\\\",\\\"type\\\":\\\"BR:CNPJ\\\"}}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"application\\\":{\\\"name\\\":\\\"string\\\",\\\"type\\\":\\\"API\\\"},\\\"taxID\\\":{\\\"taxID\\\":\\\"string\\\",\\\"type\\\":\\\"BR:CNPJ\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/partner/application\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/partner/application\"\n\n\tpayload := strings.NewReader(\"{\\\"application\\\":{\\\"name\\\":\\\"string\\\",\\\"type\\\":\\\"API\\\"},\\\"taxID\\\":{\\\"taxID\\\":\\\"string\\\",\\\"type\\\":\\\"BR:CNPJ\\\"}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"application\\\":{\\\"name\\\":\\\"string\\\",\\\"type\\\":\\\"API\\\"},\\\"taxID\\\":{\\\"taxID\\\":\\\"string\\\",\\\"type\\\":\\\"BR:CNPJ\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/partner/application\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/partner/application\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"application\\\":{\\\"name\\\":\\\"string\\\",\\\"type\\\":\\\"API\\\"},\\\"taxID\\\":{\\\"taxID\\\":\\\"string\\\",\\\"type\\\":\\\"BR:CNPJ\\\"}}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/partner/company/{taxID}":{"get":{"tags":["partner (request access)"],"summary":"Get an specific preregistration via taxID param.","parameters":[{"name":"taxID","in":"path","description":"The raw tax ID from the preregistration that you want to get.","required":true,"schema":{"type":"string"},"examples":{"taxID":{"value":"60151449000182"}}}],"responses":{"200":{"description":"The preregistration retrieved by the tax ID.","content":{"application/json":{"schema":{"type":"object","properties":{"preRegistration":{"type":"object","properties":{"preRegistration":{"$ref":"#/components/schemas/PreRegistrationObjectPayload"},"user":{"$ref":"#/components/schemas/PreRegistrationUserObject"},"company":{"$ref":"#/components/schemas/CompanyObjectPayload"},"account":{"$ref":"#/components/schemas/AccountObjectPayload"}},"required":["preRegistration","user"]}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/partner/company/%7BtaxID%7D\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/partner/company/%7BtaxID%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/partner/company/%7BtaxID%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/partner/company/%7BtaxID%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/partner/company/%7BtaxID%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/partner/company/%7BtaxID%7D\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/partner/company/%7BtaxID%7D\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/partner/company":{"get":{"tags":["partner (request access)"],"summary":"Get every preregistration that is managed by you.","responses":{"200":{"description":"A list with preregistrations.","content":{"application/json":{"schema":{"type":"object","properties":{"preRegistrations":{"type":"array","items":{"type":"object","properties":{"preRegistration":{"$ref":"#/components/schemas/PreRegistrationObjectPayload"},"user":{"$ref":"#/components/schemas/PreRegistrationUserObject"},"company":{"$ref":"#/components/schemas/CompanyObjectPayload"},"account":{"$ref":"#/components/schemas/AccountObjectPayload"}},"required":["preRegistration","user"]}},"pageInfo":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"skip":{"type":"number"},"limit":{"type":"number"}}}}}},"skip":{"type":"number"},"limit":{"type":"number"},"totalCount":{"type":"number"},"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}}}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/partner/company\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/partner/company \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/partner/company\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/partner/company\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/partner/company\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/partner/company\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/partner/company\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]},"post":{"tags":["partner (request access)"],"summary":"Create a pre registration with a partner reference (your company)","description":"As a partner company, you can create a new pre registration referencing your\ncompany as a partner.\n","requestBody":{"description":"The request body to create a pre registration.","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PreRegistrationPayloadObject"},"example":{"preRegistration":{"name":"Example LLC","taxID":{"taxID":"11111111111111","type":"BR:CNPJ"},"website":"examplellc.com"},"user":{"firstName":"John","lastName":"Doe","email":"johndoe@examplellc.com","phone":"+5511912345678"}}}}},"responses":{"200":{"description":"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","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreRegistrationPayloadObject"}}}},"201":{"description":"A new preregistration that is related to you has been created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreRegistrationPayloadObject"}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"403":{"description":"You are unauthorized to use this endpoint.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/partner/company\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n preRegistration: {name: 'string', website: 'string', taxID: {taxID: 'string', type: 'BR:CNPJ'}},\n user: {firstName: 'string', lastName: 'string', email: 'string', phone: 'string'}\n}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/partner/company \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"preRegistration\":{\"name\":\"string\",\"website\":\"string\",\"taxID\":{\"taxID\":\"string\",\"type\":\"BR:CNPJ\"}},\"user\":{\"firstName\":\"string\",\"lastName\":\"string\",\"email\":\"string\",\"phone\":\"string\"}}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/partner/company\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"preRegistration\\\":{\\\"name\\\":\\\"string\\\",\\\"website\\\":\\\"string\\\",\\\"taxID\\\":{\\\"taxID\\\":\\\"string\\\",\\\"type\\\":\\\"BR:CNPJ\\\"}},\\\"user\\\":{\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\"}}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"preRegistration\\\":{\\\"name\\\":\\\"string\\\",\\\"website\\\":\\\"string\\\",\\\"taxID\\\":{\\\"taxID\\\":\\\"string\\\",\\\"type\\\":\\\"BR:CNPJ\\\"}},\\\"user\\\":{\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/partner/company\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/partner/company\"\n\n\tpayload := strings.NewReader(\"{\\\"preRegistration\\\":{\\\"name\\\":\\\"string\\\",\\\"website\\\":\\\"string\\\",\\\"taxID\\\":{\\\"taxID\\\":\\\"string\\\",\\\"type\\\":\\\"BR:CNPJ\\\"}},\\\"user\\\":{\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\"}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"preRegistration\\\":{\\\"name\\\":\\\"string\\\",\\\"website\\\":\\\"string\\\",\\\"taxID\\\":{\\\"taxID\\\":\\\"string\\\",\\\"type\\\":\\\"BR:CNPJ\\\"}},\\\"user\\\":{\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/partner/company\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/partner/company\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"preRegistration\\\":{\\\"name\\\":\\\"string\\\",\\\"website\\\":\\\"string\\\",\\\"taxID\\\":{\\\"taxID\\\":\\\"string\\\",\\\"type\\\":\\\"BR:CNPJ\\\"}},\\\"user\\\":{\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\"}}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/payment/approve":{"post":{"tags":["payment (request access)"],"summary":"Approve a Payment Request","description":"Endpoint to approve a payment","requestBody":{"description":"Data to approve a payment request","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PaymentApprovePayload"},"example":{"correlationID":"payment1"}}}},"responses":{"200":{"description":"The approved payment","content":{"application/json":{"schema":{"type":"object","properties":{"payment":{"type":"object","$ref":"#/components/schemas/Payment"},"transaction":{"type":"object","$ref":"#/components/schemas/PaymentTransaction"},"destination":{"type":"object","$ref":"#/components/schemas/PaymentDestination"}},"example":{"payment":{"value":100,"status":"APPROVED","destinationAlias":"c4249323-b4ca-43f2-8139-8232aab09b93","comment":"payment comment","correlationID":"payment1","sourceAccountId":"my-source-account-id"},"transaction":{"value":100,"endToEndId":"transaction-end-to-end-id","time":"2023-03-20T13:14:17.000Z"},"destination":{"name":"Dan","taxID":"31324227036","pixKey":"c4249323-b4ca-43f2-8139-8232aab09b93","bank":"A Bank","branch":"1","account":"123456"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/payment/approve\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({correlationID: 'string'}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/payment/approve \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"correlationID\":\"string\"}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/payment/approve\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"correlationID\\\":\\\"string\\\"}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"correlationID\\\":\\\"string\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/payment/approve\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/payment/approve\"\n\n\tpayload := strings.NewReader(\"{\\\"correlationID\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"correlationID\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/payment/approve\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/payment/approve\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"correlationID\\\":\\\"string\\\"}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/payment/{id}":{"get":{"tags":["payment (request access)"],"summary":"Get one Payment","parameters":[{"name":"id","in":"path","description":"payment ID or correlation ID","required":true,"schema":{"type":"string"},"examples":{"paymentID":{"value":"Q2hhcmdlOjYwM2U3NDlhNDI1NjAyYmJiZjRlN2JlZA=="},"correlationID":{"value":"fe7834b4060c488a9b0f89811be5f5cf"}}}],"responses":{"200":{"description":"The payment retrieved using the given ID","content":{"application/json":{"schema":{"type":"object","properties":{"payment":{"type":"object","$ref":"#/components/schemas/Payment"},"transaction":{"type":"object","$ref":"#/components/schemas/PaymentTransaction"},"destination":{"type":"object","$ref":"#/components/schemas/PaymentDestination"}},"example":{"payment":{"value":100,"status":"CONFIRMED","destinationAlias":"c4249323-b4ca-43f2-8139-8232aab09b93","comment":"payment comment","correlationID":"payment1","sourceAccountId":"my-source-account-id"},"transaction":{"value":100,"endToEndId":"transaction-end-to-end-id","time":"2023-03-20T13:14:17.000Z"},"destination":{"name":"Dan","taxID":"31324227036","pixKey":"c4249323-b4ca-43f2-8139-8232aab09b93","bank":"A Bank","branch":"1","account":"123456"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/payment/%7Bid%7D\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/payment/%7Bid%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/payment/%7Bid%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/payment/%7Bid%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/payment/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/payment/%7Bid%7D\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/payment/%7Bid%7D\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/payment":{"get":{"tags":["payment (request access)"],"summary":"Get a list of payments","responses":{"200":{"description":"A list of payments","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"payments":{"type":"array","items":{"type":"object","properties":{"payment":{"type":"object","$ref":"#/components/schemas/Payment"},"transaction":{"type":"object","$ref":"#/components/schemas/PaymentTransaction"},"destination":{"type":"object","$ref":"#/components/schemas/PaymentDestination"}}}},"pageInfo":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"skip":{"type":"number"},"limit":{"type":"number"}}}}}},"skip":{"type":"number"},"limit":{"type":"number"},"totalCount":{"type":"number"},"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}}}}},"example":{"pageInfo":{"skip":0,"limit":10,"totalCount":20,"hasPreviousPage":false,"hasNextPage":true},"payments":{"payment":{"value":100,"status":"CONFIRMED","destinationAlias":"c4249323-b4ca-43f2-8139-8232aab09b93","comment":"payment comment","correlationID":"payment1","sourceAccountId":"my-source-account-id"},"transaction":{"value":100,"endToEndId":"transaction-end-to-end-id","time":"2023-03-20T13:14:17.000Z"},"destination":{"name":"Dan","taxID":"31324227036","pixKey":"c4249323-b4ca-43f2-8139-8232aab09b93","bank":"A Bank","branch":"1","account":"123456"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/payment\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/payment \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/payment\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/payment\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/payment\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/payment\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/payment\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]},"post":{"tags":["payment (request access)"],"summary":"Create a Payment Request","description":"Endpoint to request a payment","requestBody":{"description":"Data to create a payment request","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PaymentCreatePayload"},"example":{"value":100,"destinationAlias":"c4249323-b4ca-43f2-8139-8232aab09b93","comment":"payment comment","correlationID":"payment1","sourceAccountId":"my-source-account-id"}}}},"responses":{"200":{"description":"Payment destination account information","content":{"application/json":{"schema":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/Payment"}},"example":{"payment":{"value":100,"status":"CREATED","destinationAlias":"c4249323-b4ca-43f2-8139-8232aab09b93","comment":"payment comment","correlationID":"payment1","sourceAccountId":"my-source-account-id"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/payment\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n value: 0,\n destinationAlias: 'string',\n correlationID: 'string',\n comment: 'string',\n sourceAccountId: 'string'\n}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/payment \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"value\":0,\"destinationAlias\":\"string\",\"correlationID\":\"string\",\"comment\":\"string\",\"sourceAccountId\":\"string\"}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/payment\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"value\\\":0,\\\"destinationAlias\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"comment\\\":\\\"string\\\",\\\"sourceAccountId\\\":\\\"string\\\"}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"value\\\":0,\\\"destinationAlias\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"comment\\\":\\\"string\\\",\\\"sourceAccountId\\\":\\\"string\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/payment\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/payment\"\n\n\tpayload := strings.NewReader(\"{\\\"value\\\":0,\\\"destinationAlias\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"comment\\\":\\\"string\\\",\\\"sourceAccountId\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"value\\\":0,\\\"destinationAlias\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"comment\\\":\\\"string\\\",\\\"sourceAccountId\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/payment\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/payment\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"value\\\":0,\\\"destinationAlias\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"comment\\\":\\\"string\\\",\\\"sourceAccountId\\\":\\\"string\\\"}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/qrcode-static/{id}":{"get":{"tags":["pixQrCode"],"summary":"Get one Pix QrCode","parameters":[{"name":"id","in":"path","description":"pixQrCode ID, correlation ID or emv identifier","required":true,"schema":{"type":"string"},"examples":{"pixQrCodeId":{"value":"Q2hhcmdlOjYwM2U3NDlhNDI1NjAyYmJiZjRlN2JlZA=="},"correlationID":{"value":"fe7834b4060c488a9b0f89811be5f5cf"},"identifier":{"value":"zr7833b4060c488a9b0f89811"}}}],"responses":{"200":{"description":"The pixQrCode retrieve using the given ID","content":{"application/json":{"schema":{"type":"object","properties":{"pixQrCode":{"type":"object","$ref":"#/components/schemas/PixQrCode"}},"example":{"pixQrCode":{"name":"pix qrcode static","value":100,"comment":"pix qrcode static","correlationID":"fe7834b4060c488a9b0f89811be5f5cf","identifier":"zr7833b4060c488a9b0f89811","paymentLinkID":"7777-6f71-427a-bf00-241681624586","paymentLinkUrl":"https://openpix.com.br/pay/fe7834b4060c488a9b0f89811be5f5cf","qrCodeImage":"https://api.openpix.com.br/openpix/charge/brcode/image/fe7834b4060c488a9b0f89811be5f5cf.png","brCode":"000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA","createdAt":"2021-03-02T17:28:51.882Z","updatedAt":"2021-03-02T17:28:51.882Z"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/qrcode-static/%7Bid%7D\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/qrcode-static/%7Bid%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/qrcode-static/%7Bid%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/qrcode-static/%7Bid%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/qrcode-static/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/qrcode-static/%7Bid%7D\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/qrcode-static/%7Bid%7D\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/qrcode-static":{"get":{"tags":["pixQrCode"],"summary":"Get a list of Pix QrCodes","responses":{"200":{"description":"A list of pixQrCodes","content":{"application/json":{"schema":{"type":"object","properties":{"pixQrCodes":{"type":"array","items":{"$ref":"#/components/schemas/PixQrCode"}},"pageInfo":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"skip":{"type":"number"},"limit":{"type":"number"}}}}}},"skip":{"type":"number"},"limit":{"type":"number"},"totalCount":{"type":"number"},"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}}}},"example":{"pageInfo":{"skip":0,"limit":10,"totalCount":20,"hasPreviousPage":false,"hasNextPage":true},"pixQrCodes":{"name":"pix qrcode","value":100,"comment":"good","correlationID":"9134e286-6f71-427a-bf00-241681624586","identifier":"zr7833b4060c488a9b0f89811","paymentLinkID":"7777a23s-6f71-427a-bf00-241681624586","paymentLinkUrl":"https://openpix.com.br/pay/9134e286-6f71-427a-bf00-241681624586","qrCodeImage":"https://api.openpix.com.br/openpix/pixQrCode/brcode/image/9134e286-6f71-427a-bf00-241681624586.png","brCode":"000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA","createdAt":"2021-03-02T17:28:51.882Z","updatedAt":"2021-03-02T17:28:51.882Z"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/qrcode-static\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/qrcode-static \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/qrcode-static\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/qrcode-static\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/qrcode-static\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/qrcode-static\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/qrcode-static\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]},"post":{"tags":["pixQrCode"],"summary":"Create a new Pix QrCode Static","description":"Endpoint to create a new Pix QrCode Static","requestBody":{"description":"Data to create a new Pix QrCode Static","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PixQrCodePayload"},"example":{"correlationID":"9134e286-6f71-427a-bf00-241681624586","value":100,"comment":"good","identifier":"zr7833b4060c488a9b0f89811"}}}},"responses":{"200":{"description":"PixQrCode ID and also the generated Dynamic BR Code to be rendered as a QRCode","content":{"application/json":{"schema":{"type":"object","properties":{"pixQrCode":{"$ref":"#/components/schemas/PixQrCode"},"correlationID":{"type":"string"},"brCode":{"type":"string"}},"example":{"pixQrCode":{"value":100,"comment":"good","correlationID":"9134e286-6f71-427a-bf00-241681624586","identifier":"zr7833b4060c488a9b0f89811","paymentLinkID":"7777a23s-6f71-427a-bf00-241681624586","paymentLinkUrl":"https://openpix.com.br/pay/9134e286-6f71-427a-bf00-241681624586","qrCodeImage":"https://api.openpix.com.br/openpix/pixQrCode/brcode/image/9134e286-6f71-427a-bf00-241681624586.png","createdAt":"2021-03-02T17:28:51.882Z","updatedAt":"2021-03-02T17:28:51.882Z","brCode":"000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/qrcode-static\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n name: 'string',\n correlationID: 'string',\n value: 0,\n comment: 'string',\n identifier: 'string'\n}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/qrcode-static \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"name\":\"string\",\"correlationID\":\"string\",\"value\":0,\"comment\":\"string\",\"identifier\":\"string\"}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/qrcode-static\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"name\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\"}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"name\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/qrcode-static\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/qrcode-static\"\n\n\tpayload := strings.NewReader(\"{\\\"name\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"name\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/qrcode-static\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/qrcode-static\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"name\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\"}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/refund/{id}":{"get":{"tags":["refund"],"summary":"Get one refund","parameters":[{"name":"id","in":"path","description":"refund ID or correlation ID","required":true,"schema":{"type":"string"},"examples":{"id":{"value":"Q2hhcmdlOjYwM2U3NDlhNDI1NjAyYmJiZjRlN2JlZA=="},"correlationID":{"value":"fe7834b4060c488a9b0f89811be5f5cf"}}}],"responses":{"200":{"description":"The refund retrieve using the given ID","content":{"application/json":{"schema":{"type":"object","properties":{"pixTransactionRefund":{"type":"object","$ref":"#/components/schemas/Refund"}},"example":{"pixTransactionRefund":{"value":100,"correlationID":"7777-6f71-427a-bf00-241681624586","refundId":"11bf5b37e0b842e08dcfdc8c4aefc000","returnIdentification":"D09089356202108032000a543e325902","comment":"Comentário do reembolso"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/refund/%7Bid%7D\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/refund/%7Bid%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/refund/%7Bid%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/refund/%7Bid%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/refund/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/refund/%7Bid%7D\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/refund/%7Bid%7D\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/refund":{"get":{"tags":["refund"],"summary":"Get a list of refunds","responses":{"200":{"description":"A list of refunds","content":{"application/json":{"schema":{"type":"object","properties":{"refunds":{"type":"array","items":{"$ref":"#/components/schemas/Refund"}},"pageInfo":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"skip":{"type":"number"},"limit":{"type":"number"}}}}}},"skip":{"type":"number"},"limit":{"type":"number"},"totalCount":{"type":"number"},"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}}}},"example":{"pageInfo":{"skip":0,"limit":10,"totalCount":20,"hasPreviousPage":false,"hasNextPage":true},"refunds":[{"status":"IN_PROCESSING","value":100,"correlationID":"9134e286-6f71-427a-bf00-241681624586","refundId":"9134e2866f71427abf00241681624586","time":"2021-03-02T17:28:51.882Z","comment":"Comentário do reembolso"}]}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/refund\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/refund \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/refund\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/refund\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/refund\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/refund\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/refund\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]},"post":{"tags":["refund"],"summary":"Create a new refund","description":"Endpoint to create a new refund for a customer","requestBody":{"description":"Data to create a new refund","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/RefundPayload"},"example":{"transactionEndToEndId":"9134e286-6f71-427a-bf00-241681624586","correlationID":"9134e286-6f71-427a-bf00-241681624586","value":100,"comment":"Comentário do reembolso"}}}},"responses":{"200":{"description":"The created Refund","content":{"application/json":{"schema":{"type":"object","properties":{"refund":{"$ref":"#/components/schemas/Refund"}},"example":{"refund":{"status":"IN_PROCESSING","value":100,"correlationID":"9134e286-6f71-427a-bf00-241681624586","refundId":"9134e2866f71427abf00241681624586","time":"2021-03-02T17:28:51.882Z","comment":"Comentário do reembolso"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/refund\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n value: 0,\n transactionEndToEndId: 'string',\n correlationID: 'string',\n comment: 'string'\n}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/refund \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"value\":0,\"transactionEndToEndId\":\"string\",\"correlationID\":\"string\",\"comment\":\"string\"}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/refund\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"value\\\":0,\\\"transactionEndToEndId\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"comment\\\":\\\"string\\\"}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"value\\\":0,\\\"transactionEndToEndId\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"comment\\\":\\\"string\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/refund\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/refund\"\n\n\tpayload := strings.NewReader(\"{\\\"value\\\":0,\\\"transactionEndToEndId\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"comment\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"value\\\":0,\\\"transactionEndToEndId\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"comment\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/refund\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/refund\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"value\\\":0,\\\"transactionEndToEndId\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"comment\\\":\\\"string\\\"}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/subscriptions/{id}":{"get":{"tags":["subscription"],"summary":"Get one subscription","parameters":[{"name":"id","in":"path","description":"The globalID of the subscription.","required":true,"schema":{"type":"string"},"example":"UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM="}],"responses":{"200":{"description":"The subscription retrieved using the given ID","content":{"application/json":{"schema":{"type":"object","properties":{"subscription":{"type":"object","$ref":"#/components/schemas/Subscription"}},"example":{"subscription":{"globalID":"UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM=","customer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"}},"value":100,"dayGenerateCharge":5}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/subscriptions/UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM=\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/subscriptions/UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM= \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/subscriptions/UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM=\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/subscriptions/UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM=\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/subscriptions/UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM=\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/subscriptions/UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM=\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/subscriptions/UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM=\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/subscriptions":{"post":{"tags":["subscription"],"summary":"Create a new Subscription","description":"Endpoint to create a new Subcription","requestBody":{"description":"Data to create a new Subscription","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/SubscriptionPayload"},"examples":{"Subscription":{"value":{"value":100,"customer":{"name":"Dan","taxID":"31324227036","email":"email0@example.com","phone":"5511999999999"},"dayGenerateCharge":15}},"Subscription with Interests and Fines":{"value":{"value":100,"customer":{"name":"Dan","taxID":"31324227036","email":"email0@example.com","phone":"5511999999999","address":{"zipcode":"30421322","street":"Street","number":"100","neighborhood":"Neighborhood","city":"Belo Horizonte","state":"MG","complement":"APTO","country":"BR"}},"dayGenerateCharge":15,"chargeType":"OVERDUE"}}}}}},"responses":{"200":{"description":"The subscription created","content":{"application/json":{"schema":{"type":"object","properties":{"subscription":{"$ref":"#/components/schemas/Subscription"}},"example":{"subscription":{"globalID":"UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM=","customer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"}},"value":100,"dayGenerateCharge":5}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/subscriptions\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\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: 0,\n comment: 'string',\n additionalInfo: [{key: 'string', value: 'string'}],\n dayGenerateCharge: 5,\n chargeType: 'DYNAMIC',\n dayDue: 7\n}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/subscriptions \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"customer\":{\"name\":\"string\",\"email\":\"string\",\"phone\":\"string\",\"taxID\":\"string\",\"address\":{\"zipcode\":\"string\",\"street\":\"string\",\"number\":\"string\",\"neighborhood\":\"string\",\"city\":\"string\",\"state\":\"string\",\"complement\":\"string\",\"country\":\"string\"}},\"value\":0,\"comment\":\"string\",\"additionalInfo\":[{\"key\":\"string\",\"value\":\"string\"}],\"dayGenerateCharge\":5,\"chargeType\":\"DYNAMIC\",\"dayDue\":7}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/subscriptions\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"value\\\":0,\\\"comment\\\":\\\"string\\\",\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"dayGenerateCharge\\\":5,\\\"chargeType\\\":\\\"DYNAMIC\\\",\\\"dayDue\\\":7}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"value\\\":0,\\\"comment\\\":\\\"string\\\",\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"dayGenerateCharge\\\":5,\\\"chargeType\\\":\\\"DYNAMIC\\\",\\\"dayDue\\\":7}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/subscriptions\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/subscriptions\"\n\n\tpayload := strings.NewReader(\"{\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"value\\\":0,\\\"comment\\\":\\\"string\\\",\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"dayGenerateCharge\\\":5,\\\"chargeType\\\":\\\"DYNAMIC\\\",\\\"dayDue\\\":7}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"value\\\":0,\\\"comment\\\":\\\"string\\\",\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"dayGenerateCharge\\\":5,\\\"chargeType\\\":\\\"DYNAMIC\\\",\\\"dayDue\\\":7}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/subscriptions\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/subscriptions\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"value\\\":0,\\\"comment\\\":\\\"string\\\",\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"dayGenerateCharge\\\":5,\\\"chargeType\\\":\\\"DYNAMIC\\\",\\\"dayDue\\\":7}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/transaction/{id}":{"get":{"tags":["transactions"],"summary":"Get a Transaction","parameters":[{"name":"id","in":"path","description":"you can use the transaction id from openpix or the endToEndId of transaction from bank","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The transaction retrieve using the given ID","content":{"application/json":{"schema":{"type":"object","properties":{"transaction":{"type":"object","$ref":"#/components/schemas/Transaction"}}},"example":{"transaction":{"customer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"},"correlationID":"9134e286-6f71-427a-bf00-241681624586"},"payer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"},"correlationID":"9134e286-6f71-427a-bf00-241681624586"},"charge":{"status":"ACTIVE","customer":"603f81fcc6bccc24326ffb43","correlationID":"9134e286-6f71-427a-bf00-241681624586","createdAt":"2021-03-03T12:33:00.546Z","updatedAt":"2021-03-03T12:33:00.546Z"},"withdraw":{"value":100,"time":"2021-03-03T12:33:00.536Z","infoPagador":"payer info 1","endToEndId":"E18236120202012032010s01345689XBY","createdAt":"2021-03-03T12:33:00.546Z"},"infoPagador":"payer info 0","value":100,"time":"2021-03-03T12:33:00.536Z","transactionID":"transactionID","type":"PAYMENT","endToEndId":"E18236120202012032010s0133872GZA","globalID":"UGl4VHJhbnNhY3Rpb246NzE5MWYxYjAyMDQ2YmY1ZjUzZGNmYTBi"}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/transaction/%7Bid%7D\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/transaction/%7Bid%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/transaction/%7Bid%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/transaction/%7Bid%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/transaction/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/transaction/%7Bid%7D\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/transaction/%7Bid%7D\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/transaction":{"parameters":[{"in":"query","name":"start","schema":{"$ref":"#/components/schemas/Start"}},{"in":"query","name":"end","schema":{"$ref":"#/components/schemas/End"}},{"in":"query","name":"charge","description":"You can use the charge ID or correlation ID or transaction ID of charge to get a list of transactions related of this transaction","schema":{"type":"string"},"example":"Q2hhcmdlOjYwM2U3NDlhNDI1NjAyYmJiZjRlN2JlZA"},{"in":"query","name":"pixQrCode","description":"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","schema":{"type":"string"},"example":"Q2hhcmdlOjYwM2U3NDlhNDI1NjAyYmJiZjRlN2JlZA"},{"in":"query","name":"withdrawal","description":"You can use the ID or EndToEndId of a withdrawal transaction to get all transactions related to the withdrawal","schema":{"type":"string"},"example":"Q2hhcmdlOjYwM2U3NDlhNDI1NjAyYmJiZjRlN2JlZA"}],"get":{"tags":["transactions"],"summary":"Get a list of transactions","responses":{"200":{"description":"A list of transactions","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"}},"pageInfo":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"skip":{"type":"number"},"limit":{"type":"number"}}}}}},"skip":{"type":"number"},"limit":{"type":"number"},"totalCount":{"type":"number"},"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}}}}},"example":{"pageInfo":{"skip":0,"limit":10,"totalCount":20,"hasPreviousPage":false,"hasNextPage":true},"transactions":{"customer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"},"correlationID":"9134e286-6f71-427a-bf00-241681624586"},"payer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"},"correlationID":"9134e286-6f71-427a-bf00-241681624586"},"charge":{"status":"ACTIVE","customer":"603f81fcc6bccc24326ffb43","correlationID":"9134e286-6f71-427a-bf00-241681624586","createdAt":"2021-03-03T12:33:00.546Z","updatedAt":"2021-03-03T12:33:00.546Z"},"withdraw":{"value":100,"time":"2021-03-03T12:33:00.536Z","infoPagador":"payer info 1","endToEndId":"E18236120202012032010s01345689XBY"},"type":"PAYMENT","infoPagador":"payer info 0","value":100,"time":"2021-03-03T12:33:00.536Z","transactionID":"transactionID","endToEndId":"E18236120202012032010s0133872GZA"}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/transaction\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/transaction \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/transaction\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/transaction\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/transaction\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/transaction\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/transaction\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/transfer":{"post":{"tags":["transfer (request access)"],"summary":"Create a Transfer","description":"Endpoint to to transfer values between sub accounts","requestBody":{"description":"Data to create a transfer","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/TransferCreatePayload"},"example":{"value":100,"fromPixKey":"from@openpix.com.br","toPixKey":"to@openpix.com.br"}}}},"responses":{"200":{"description":"Transfer transaction information","content":{"application/json":{"schema":{"type":"object","properties":{"transaction":{"$ref":"#/components/schemas/TransferTransaction"}},"example":{"transaction":{"value":100,"time":"2023-06-22T15:33:27.165Z,","correlationID":"c782e0ac-833d-4a89-9e73-9b60b2b41d3a"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/transfer\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({value: 0, fromPixKey: 'string', toPixKey: 'string'}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/transfer \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"value\":0,\"fromPixKey\":\"string\",\"toPixKey\":\"string\"}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/transfer\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"value\\\":0,\\\"fromPixKey\\\":\\\"string\\\",\\\"toPixKey\\\":\\\"string\\\"}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"value\\\":0,\\\"fromPixKey\\\":\\\"string\\\",\\\"toPixKey\\\":\\\"string\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/transfer\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/transfer\"\n\n\tpayload := strings.NewReader(\"{\\\"value\\\":0,\\\"fromPixKey\\\":\\\"string\\\",\\\"toPixKey\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"value\\\":0,\\\"fromPixKey\\\":\\\"string\\\",\\\"toPixKey\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/transfer\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/transfer\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"value\\\":0,\\\"fromPixKey\\\":\\\"string\\\",\\\"toPixKey\\\":\\\"string\\\"}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/webhook/{id}":{"delete":{"tags":["webhook"],"summary":"Delete a Webhook","description":"Endpoint to delete a Webhook","parameters":[{"name":"id","in":"path","description":"webhook ID","required":true,"schema":{"type":"string"},"examples":{"webhookID":{"value":"Q2hhcmdlOjYwM2U3NDlhNDI1NjAyYmJiZjRlN2JlZA=="},"id":{"value":"fe7834b4060c488a9b0f89811be5f5cf"}}}],"responses":{"200":{"description":"Webhook ID and also the status code","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"status":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/webhook/%7Bid%7D\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request DELETE \\\n --url https://api.woovi.com/api/v1/webhook/%7Bid%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/webhook/%7Bid%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"DELETE\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"DELETE\", \"/api/v1/webhook/%7Bid%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/webhook/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/webhook/%7Bid%7D\")\n .delete(null)\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/webhook/%7Bid%7D\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Delete.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/webhook":{"get":{"parameters":[{"in":"query","name":"url","description":"You can use the url to filter all webhooks","schema":{"type":"string"},"example":"https://mycompany.com.br/webhook"}],"tags":["webhook"],"summary":"Get a list of webhooks","responses":{"200":{"description":"A list of webhooks","content":{"application/json":{"schema":{"type":"object","properties":{"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"}},"pageInfo":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"skip":{"type":"number"},"limit":{"type":"number"}}}}}}}}},"example":{"pageInfo":{"skip":0,"limit":100,"totalCount":2,"hasPreviousPage":false,"hasNextPage":true},"webhooks":[{"id":"V2ViaG9vazo2MDNlYmUxZWRlYjkzNWU4NmQyMmNmMTg=","name":"webhookName","url":"https://mycompany.com.br/webhook","authorization":"openpix","event":"OPENPIX:TRANSACTION_RECEIVED","isActive":true,"createdAt":"2021-03-02T22:29:10.720Z","updatedAt":"2021-03-02T22:29:10.720Z"},{"id":"V2ViaG9vazo2MDNlYmUxZWRlYjkzNWU4NmQyMmNmOTk=","name":"webhookName","url":"https://mycompany.com.br/webhook","authorization":"openpix","event":"OPENPIX:CHARGE_CREATED","isActive":true,"createdAt":"2021-03-02T22:29:10.720Z","updatedAt":"2021-03-02T22:29:10.720Z"}]}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/webhook?url=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.woovi.com/api/v1/webhook?url=SOME_STRING_VALUE' \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/webhook?url=SOME_STRING_VALUE\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/webhook?url=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/webhook?url=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/webhook?url=SOME_STRING_VALUE\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/webhook?url=SOME_STRING_VALUE\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]},"post":{"tags":["webhook"],"summary":"Create a new Webhook","description":"Endpoint to create a new Webhook","requestBody":{"description":"Data to create a new webhook","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"webhook":{"type":"object","$ref":"#/components/schemas/WebhookPayload"}},"example":{"webhook":{"name":"webhookName","event":"OPENPIX:CHARGE_CREATED","url":"https://mycompany.com.br/webhook","authorization":"openpix","isActive":true}}}}}},"responses":{"200":{"description":"Webhook created specific event when receives a new pix transaction","content":{"application/json":{"schema":{"type":"object","properties":{"webhook":{"type":"object","$ref":"#/components/schemas/Webhook"}},"example":{"webhook":{"id":"V2ViaG9vazo2MDNlYmUxZWRlYjkzNWU4NmQyMmNmMTg=","name":"webhookName","url":"https://mycompany.com.br/webhook","authorization":"openpix","isActive":true,"event":"OPENPIX:TRANSACTION_RECEIVED","createdAt":"2021-03-02T22:29:10.720Z","updatedAt":"2021-03-02T22:29:10.720Z"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"callbacks":{"receivedPix":{"{$request.body#/webhook.url}":{"post":{"description":"Pix - O callback vai ser acionado sempre que um Pix for recebido enviando uma charge e um pix\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"charge":{"type":"object","$ref":"#/components/schemas/Charge"},"pix":{"type":"object","properties":{"pixQrCode":{"type":"object","$ref":"#/components/schemas/PixQrCode"},"charge":{"type":"object","$ref":"#/components/schemas/Charge"},"customer":{"type":"object","$ref":"#/components/schemas/Customer"},"payer":{"type":"object","$ref":"#/components/schemas/Customer"},"time":{"type":"string"},"value":{"type":"string"},"transactionID":{"type":"string"},"infoPagador":{"type":"string"},"raw":{"type":"object","properties":{"endToEndId":{"type":"string"},"txid":{"type":"string"},"valor":{"type":"string"},"horario":{"type":"string"},"infoPagador":{"type":"string"}}}}},"pixQrCode":{"type":"object"}},"example":{"charge":{"status":"COMPLETED","customer":{"name":"Julio","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31928282008","type":"BR:CPF"},"correlationID":"9134e286-6f71-427a-bf00-241681624586"},"correlationID":"9134e286-6f71-427a-bf00-241681624586","transactionID":"9134e2866f71427abf00241681624586","brCode":"000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA","createdAt":"2021-03-03T20:49:23.605Z","updatedAt":"2021-03-03T20:49:23.668Z"},"pix":{"pixQrCode":null,"charge":{"status":"COMPLETED","customer":"604002035cce3b60132343cb","correlationID":"9134e286-6f71-427a-bf00-241681624586","brCode":"000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA","createdAt":"2021-03-03T21:39:15.831Z","updatedAt":"2021-03-03T21:39:15.896Z"},"customer":{"name":"Julio","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31928282008","type":"BR:CPF"},"correlationID":"9134e286-6f71-427a-bf00-241681624586"},"payer":{"name":"Julio","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31928282008","type":"BR:CPF"},"correlationID":"9134e286-6f71-427a-bf00-241681624586"},"time":"2020-09-09T20:15:00.358Z","value":9999,"transactionID":"9134e2866f71427abf00241681624586","infoPagador":"conta","raw":{"endToEndId":"9134e2866f71427abf00241681624586","txid":"9134e2866f71427abf00241681624586","valor":"99.99","horario":"2020-09-09T20:15:00.358Z","infoPagador":"conta"}},"pixQrCode":null}}}}},"responses":{"200":{"description":"Notificação recebida com sucesso"}}}}},"receivedPixDetached":{"{$request.body#/webhook.url}":{"post":{"description":"Pix Avulso - O callback vai ser acionado sempre que um Pix for recebido devolvendo um pix avulso\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"charge":{"type":"object"},"pix":{"type":"object","properties":{"pixQrCode":{"type":"object","$ref":"#/components/schemas/PixQrCode"},"charge":{"type":"object","$ref":"#/components/schemas/Charge"},"customer":{"type":"object","$ref":"#/components/schemas/Customer"},"payer":{"type":"object","$ref":"#/components/schemas/Customer"},"time":{"type":"string"},"value":{"type":"string"},"transactionID":{"type":"string"},"infoPagador":{"type":"string"},"raw":{"type":"object","properties":{"endToEndId":{"type":"string"},"txid":{"type":"string"},"valor":{"type":"string"},"horario":{"type":"string"},"infoPagador":{"type":"string"}}}}},"pixQrCode":{"type":"object"}},"example":{"charge":null,"pix":{"pixQrCode":null,"charge":null,"customer":null,"time":"2020-09-09T20:15:00.358Z","value":9999,"transactionID":"9134e2866f71427abf00241681624586","infoPagador":"conta","raw":{"endToEndId":"9134e2866f71427abf00241681624586","txid":"9134e2866f71427abf00241681624586","valor":"99.99","horario":"2020-09-09T20:15:00.358Z","infoPagador":"conta"}}}}}}},"responses":{"200":{"description":"Notificação recebida com sucesso"}}}}},"receivedPixQrCode":{"{$request.body#/webhook.url}":{"post":{"description":"Pix QrCode - O callback vai ser acionado sempre que um Pix QrCOde for recebido devolvendo um pix e um pixQrCode\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"charge":{"type":"object"},"pix":{"type":"object","properties":{"pixQrCode":{"type":"object","$ref":"#/components/schemas/PixQrCode"},"charge":{"type":"object","$ref":"#/components/schemas/Charge"},"payer":{"type":"object","$ref":"#/components/schemas/Customer"},"time":{"type":"string"},"value":{"type":"string"},"transactionID":{"type":"string"},"infoPagador":{"type":"string"},"raw":{"type":"object","properties":{"endToEndId":{"type":"string"},"txid":{"type":"string"},"valor":{"type":"string"},"horario":{"type":"string"},"infoPagador":{"type":"string"}}}}},"pixQrCode":{"type":"object","$ref":"#/components/schemas/PixQrCode"}},"example":{"charge":null,"pix":{"pixQrCode":{"value":100,"comment":"good","correlationID":"9134e286-6f71-427a-bf00-241681624586","identifier":"9134e2866f71427abf00241681624586","paymentLinkID":"7777a23s-6f71-427a-bf00-241681624586","paymentLinkUrl":"https://openpix.com.br/pay/9134e286-6f71-427a-bf00-241681624586","qrCodeImage":"https://api.openpix.com.br/openpix/pixQrCode/brcode/image/9134e286-6f71-427a-bf00-241681624586.png","createdAt":"2021-03-02T17:28:51.882Z","updatedAt":"2021-03-02T17:28:51.882Z","brCode":"000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA"},"customer":null,"time":"2020-09-09T20:15:00.358Z","value":9999,"transactionID":"9134e2866f71427abf00241681624586","infoPagador":"conta","raw":{"endToEndId":"9134e2866f71427abf00241681624586","txid":"9134e2866f71427abf00241681624586","valor":"99.99","horario":"2020-09-09T20:15:00.358Z","infoPagador":"conta"}}}}}}},"responses":{"200":{"description":"Notificação recebida com sucesso"}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/webhook\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n webhook: {\n name: 'webhookName',\n event: 'OPENPIX:CHARGE_CREATED',\n url: 'https://mycompany.com.br/webhook',\n authorization: 'openpix',\n isActive: true\n }\n}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/webhook \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"webhook\":{\"name\":\"webhookName\",\"event\":\"OPENPIX:CHARGE_CREATED\",\"url\":\"https://mycompany.com.br/webhook\",\"authorization\":\"openpix\",\"isActive\":true}}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/webhook\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"webhook\\\":{\\\"name\\\":\\\"webhookName\\\",\\\"event\\\":\\\"OPENPIX:CHARGE_CREATED\\\",\\\"url\\\":\\\"https://mycompany.com.br/webhook\\\",\\\"authorization\\\":\\\"openpix\\\",\\\"isActive\\\":true}}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"webhook\\\":{\\\"name\\\":\\\"webhookName\\\",\\\"event\\\":\\\"OPENPIX:CHARGE_CREATED\\\",\\\"url\\\":\\\"https://mycompany.com.br/webhook\\\",\\\"authorization\\\":\\\"openpix\\\",\\\"isActive\\\":true}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/webhook\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/webhook\"\n\n\tpayload := strings.NewReader(\"{\\\"webhook\\\":{\\\"name\\\":\\\"webhookName\\\",\\\"event\\\":\\\"OPENPIX:CHARGE_CREATED\\\",\\\"url\\\":\\\"https://mycompany.com.br/webhook\\\",\\\"authorization\\\":\\\"openpix\\\",\\\"isActive\\\":true}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"webhook\\\":{\\\"name\\\":\\\"webhookName\\\",\\\"event\\\":\\\"OPENPIX:CHARGE_CREATED\\\",\\\"url\\\":\\\"https://mycompany.com.br/webhook\\\",\\\"authorization\\\":\\\"openpix\\\",\\\"isActive\\\":true}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/webhook\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/webhook\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"webhook\\\":{\\\"name\\\":\\\"webhookName\\\",\\\"event\\\":\\\"OPENPIX:CHARGE_CREATED\\\",\\\"url\\\":\\\"https://mycompany.com.br/webhook\\\",\\\"authorization\\\":\\\"openpix\\\",\\\"isActive\\\":true}}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/openpix/charge/brcode/image/{:id}.png?size=1024":{"get":{"tags":["charge"],"summary":"Get an image of Qr Code from a Charge","parameters":[{"in":"path","name":"id","description":"charge link payment ID","required":true,"schema":{"type":"string"},"examples":{"paymentLinkID":{"value":"fe7834b4060c488a9b0f89811be5f5cf"}}},{"in":"query","name":"size","description":"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.","required":false,"schema":{"type":"string"},"examples":{"size":{"value":768}}}],"responses":{"200":{"description":"The Qr Code image as MIME type"},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/openpix/charge/brcode/image/%7B:id%7D.png?size=1024\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.woovi.com/openpix/charge/brcode/image/%7B:id%7D.png?size=1024' \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/openpix/charge/brcode/image/%7B:id%7D.png?size=1024\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/openpix/charge/brcode/image/%7B:id%7D.png?size=1024\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/openpix/charge/brcode/image/%7B:id%7D.png?size=1024\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/openpix/charge/brcode/image/%7B:id%7D.png?size=1024\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/openpix/charge/brcode/image/%7B:id%7D.png?size=1024\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/subaccount/{id}/withdraw":{"post":{"tags":["sub account (request access)"],"summary":"Withdraw from a Sub Account","description":"Withdraw from a Sub Account and return the withdrawal transaction information","parameters":[{"name":"id","in":"path","description":"pix key registered to the subaccount","required":true,"schema":{"type":"string"},"example":"destination@test.com"}],"responses":{"200":{"description":"Withdrawal Transaction information","content":{"application/json":{"schema":{"type":"object","properties":{"withdraw":{"type":"object","properties":{"account":{"type":"object","$ref":"#/components/schemas/transaction"}}}}},"example":{"transaction":{"status":"CREATED","value":100,"correlationID":"TESTING1323","destinationAlias":"pixKeyTest@test.com","comment":"testing-transaction"}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/subaccount/destination@test.com/withdraw\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/subaccount/destination@test.com/withdraw \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/subaccount/destination@test.com/withdraw\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"POST\", \"/api/v1/subaccount/destination@test.com/withdraw\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/subaccount/destination@test.com/withdraw\"\n\n\treq, _ := http.NewRequest(\"POST\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/subaccount/destination@test.com/withdraw\")\n .post(null)\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/subaccount/destination@test.com/withdraw\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/subaccount/{id}":{"get":{"tags":["sub account (request access)"],"summary":"Get subaccount details","parameters":[{"name":"id","in":"path","description":"pix key registered to the subaccount","required":true,"schema":{"type":"string"},"examples":{"id":{"value":"c4249323-b4ca-43f2-8139-8232aab09b93"}}}],"responses":{"200":{"description":"The Subccount retrieve using the given pix key","content":{"application/json":{"schema":{"type":"object","properties":{"SubAccount":{"type":"object","$ref":"#/components/schemas/SubAccount"}},"example":{"SubAccount":{"name":"test-sub-account","pixKey":"c4249323-b4ca-43f2-8139-8232aab09b93","balance":100}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/subaccount/%7Bid%7D\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/subaccount/%7Bid%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/subaccount/%7Bid%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/subaccount/%7Bid%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/subaccount/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/subaccount/%7Bid%7D\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/subaccount/%7Bid%7D\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/subaccount":{"get":{"tags":["sub account (request access)"],"summary":"Get a list of subaccounts","responses":{"200":{"description":"A list of subaccounts","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"subaccounts":{"type":"array","items":{"type":"object","properties":{"payment":{"type":"object","$ref":"#/components/schemas/SubAccount"}}}},"pageInfo":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"skip":{"type":"number"},"limit":{"type":"number"}}}}}},"skip":{"type":"number"},"limit":{"type":"number"},"totalCount":{"type":"number"},"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}}}}},"example":{"subAccounts":{"subaccount":{"name":"test-sub-account","pixKey":"c4249323-b4ca-43f2-8139-8232aab09b93","balance":100}},"pageInfo":{"skip":0,"limit":10,"totalCount":20,"hasPreviousPage":false,"hasNextPage":true}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/subaccount\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/subaccount \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/subaccount\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/subaccount\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/subaccount\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/subaccount\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/subaccount\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]},"post":{"tags":["sub account (request access)"],"summary":"Create a subaccount","requestBody":{"description":"Data to create a new subAccount or retrieve existing one","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/SubAccountPayload"},"examples":{"SubAccount":{"value":{"pixKey":"9134e286-6f71-427a-bf00-241681624587","name":"Test Account"}}}}}},"responses":{"200":{"description":"The Subccount created or retrieved if exists using the given pix key","content":{"application/json":{"schema":{"type":"object","properties":{"SubAccount":{"type":"object","$ref":"#/components/schemas/SubAccount"}},"example":{"SubAccount":{"name":"test-sub-account","pixKey":"c4249323-b4ca-43f2-8139-8232aab09b93","balance":0}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/subaccount\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({pixKey: 'string', name: 'string'}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/subaccount \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"pixKey\":\"string\",\"name\":\"string\"}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/subaccount\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"pixKey\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\"}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"pixKey\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/subaccount\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/subaccount\"\n\n\tpayload := strings.NewReader(\"{\\\"pixKey\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"pixKey\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/subaccount\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/subaccount\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"pixKey\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\"}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}}},"components":{"schemas":{"CompanyBankAccount":{"type":"object","properties":{"accountId":{"type":"string","description":"ID of the Account"},"isDefault":{"type":"boolean"},"balance":{"type":"object","properties":{"total":{"type":"number","description":"Total amount in cents"},"blocked":{"type":"number","description":"Blocked amount in cents"},"available":{"type":"number","description":"Available amount in cents"}}}}},"WithdrawTransaction":{"type":"object","properties":{"endToEndId":{"type":"string","description":"ID of the Withdraw Transaction"},"value":{"type":"string"}}},"Charge":{"type":"object","properties":{"value":{"type":"number"},"customer":{"type":"object","$ref":"#/components/schemas/Customer"},"type":{"type":"string","enum":["DYNAMIC","OVERDUE"],"description":"Charge type is used to determine whether a charge will have a deadline, fines and interests"},"comment":{"type":"string"},"brCode":{"type":"string","description":"EMV BRCode to be rendered as a QRCode"},"status":{"type":"string","enum":["ACTIVE","COMPLETED","EXPIRED"]},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this charge"},"paymentLinkID":{"type":"string","description":"Payment Link ID, used on payment link and to retrieve qrcode image"},"paymentLinkUrl":{"description":"Payment Link URL to be shared with customers"},"globalID":{"description":"External ID of this charge"},"transactionID":{"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."},"identifier":{"type":"string","description":"Custom identifier for EMV"},"qrCodeImage":{"description":"QRCode image link URL"},"additionalInfo":{"description":"Additional info of the charge","type":"array","items":{"type":"object","properties":{"key":{"description":"key of object","type":"string"},"value":{"description":"value of object","type":"string"}}}},"pixKey":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"expiresIn":{"type":"string"}}},"ChargePayload":{"type":"object","properties":{"correlationID":{"type":"string","description":"Your correlation ID to keep track of this charge"},"value":{"type":"number","description":"Value in cents of this charge"},"type":{"type":"string","enum":["DYNAMIC","OVERDUE"],"description":"Charge type is used to determine whether a charge will have a deadline, fines and interests"},"comment":{"type":"string","description":"Comment to be added in infoPagador"},"identifier":{"type":"string","description":"Custom identifier for EMV"},"expiresIn":{"type":"number","description":"Expires the charge in seconds (minimum is 15 minutes)"},"customer":{"type":"object","$ref":"#/components/schemas/CustomerPayload"},"daysForDueDate":{"type":"number","description":"Time in days until the charge hits the deadline so fines and interests start applying. This property is only considered for charges of type OVERDUE"},"daysAfterDueDate":{"type":"number","description":"Time in days that a charge is still payable after the deadline. This property is only considered for charges of type OVERDUE"},"interests":{"description":"Interests configuration. This property is only considered for charges of type OVERDUE","type":"object","properties":{"value":{"type":"number","description":"Value in basis points of interests to be applied daily after the charge hits the deadline"}}},"fines":{"description":"Fines configuration. This property is only considered for charges of type OVERDUE","type":"object","properties":{"value":{"type":"number","description":"Value in basis points of fines to be applied when the charge hits the deadline"}}},"additionalInfo":{"type":"array","description":"Additional info of the charge","items":{"type":"object","properties":{"key":{"type":"string","description":"key of object"},"value":{"type":"string","description":"value of object"}}}}},"required":["correlationID","value"]},"ChargeRefund":{"type":"object","properties":{"value":{"type":"number","description":"Value in cents of this refund"},"status":{"type":"string","enum":["IN_PROCESSING","CONFIRMED","REJECTED"]},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this refund"},"endToEndId":{"type":"string","description":"The endToEndId of this refund"},"time":{"type":"string","description":"Time of this refund"},"comment":{"type":"string","description":"Comment of this refund"}}},"ChargeRefundPayload":{"type":"object","properties":{"correlationID":{"type":"string","description":"Your correlation ID to keep track for this refund"},"value":{"type":"number","description":"Value in cents for this refund"},"comment":{"type":"string","description":"Comment for this refund. Maximum length of 140 characters.","maximum":140}},"required":["correlationID"]},"Customer":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"taxID":{"type":"object","properties":{"taxID":{"type":"string"},"type":{"type":"string"}}},"correlationID":{"type":"string"},"address":{"type":"object","properties":{"zipcode":{"type":"string"},"street":{"type":"string"},"number":{"type":"string"},"neighborhood":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"complement":{"type":"string"},"country":{"type":"string"}}}}},"CustomerPayload":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"taxID":{"type":"string"},"correlationID":{"type":"string"},"address":{"type":"object","properties":{"zipcode":{"type":"string"},"street":{"type":"string"},"number":{"type":"string"},"neighborhood":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"complement":{"type":"string"},"country":{"type":"string"}}}},"required":["name","taxID"]},"End":{"type":"string","format":"date-time","title":"End Date","description":"End date used in the query. Complies with RFC 3339.","example":"2020-12-01T17:00:00Z"},"ApplicationEnumTypePayload":{"type":"string","description":"Type of the application that you want to register. Each of this has some kind of permissions.","enum":["API","PLUGIN","ORACLE"]},"TaxIDObjectPayload":{"type":"object","properties":{"taxID":{"type":"string","description":"The tax identifier of your account holder. This should be a raw string with only digits."},"type":{"type":"string","enum":["BR:CNPJ"]}}},"PreRegistrationUserObject":{"type":"object","properties":{"firstName":{"type":"string","description":"The user's first name.\nIf the pre registration has been approved, this will be turn the company's first user first name.\n"},"lastName":{"type":"string","description":"The user's last name.\nIf the pre registration has been approved, this will be turn the company's first user last name.\n"},"email":{"type":"string","description":"The user's email.\nIt'll be the email that will entered in contact to validate that it's a real person (it's a step to approve the preregistration).\nAfter approving the preregistration, it'll be the company's user email.\n"},"phone":{"type":"string","description":"The user's phone number, need to be a validated phone number because it'll receive a SMS confirming that is a real person.\nWe're accept only values that matches the E.164 standard, that follows this pattern: [+][country code][local phone number].\n"}},"required":["firstName","lastName","email","phone"]},"PreRegistrationObject":{"type":"object","properties":{"name":{"type":"string","description":"The name of this preregistration. It'll be related as your company name too."},"website":{"type":"string","description":"A website that is related to this preregistration."},"taxID":{"$ref":"#/components/schemas/TaxIDObjectPayload"}},"required":["name","taxID"]},"PreRegistrationPayloadObject":{"type":"object","properties":{"preRegistration":{"$ref":"#/components/schemas/PreRegistrationObject"},"user":{"$ref":"#/components/schemas/PreRegistrationUserObject"}}},"AccountObjectPayload":{"type":"object","properties":{"clientId":{"type":"string","description":"The client ID from the company bank account that is related to this preregistration/company."}}},"CompanyObjectPayload":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the company that is related to this preregistration."},"name":{"type":"string","description":"The name of the company that is related to this preregistration."},"taxID":{"$ref":"#/components/schemas/TaxIDObjectPayload"}}},"PreRegistrationObjectPayload":{"type":"object","properties":{"name":{"type":"string","description":"When the preregistration will turn a company, this will be the name of the company that this preregistration is related."},"taxID":{"$ref":"#/components/schemas/TaxIDObjectPayload"}}},"PartnerApplicationPayload":{"type":"object","properties":{"name":{"type":"string","description":"The name that identifies your application."},"isActive":{"type":"boolean","description":"Current status of your application."},"type":{"$ref":"#/components/schemas/ApplicationEnumTypePayload"},"clientId":{"type":"string","description":"The ID of this client application."},"clientSecret":{"type":"string","description":"The secret of this client application."}}},"PaymentApprovePayload":{"type":"object","properties":{"correlationID":{"type":"string","description":"the correlation ID of the payment to be approved"}}},"PaymentCreatePayload":{"type":"object","properties":{"value":{"type":"number","description":"value of the requested payment in cents"},"destinationAlias":{"type":"string","description":"the pix key the payment should be sent to"},"correlationID":{"type":"string","description":"an unique identifier for your payment"},"comment":{"type":"string","description":"the comment that will be send alongisde your payment"},"sourceAccountId":{"type":"string","description":"an optional id for the source account of the payment, if not informed will assume the default account"}}},"Payment":{"type":"object","properties":{"value":{"type":"number","description":"value of the requested payment in cents"},"destinationAlias":{"type":"string","description":"the pix key the payment should be sent to"},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this payment"},"comment":{"type":"string","description":"the comment that will be send alongisde your payment"},"status":{"type":"string","description":"payment status","enum":["CREATED","FAILED","CONFIRMED","DENIED"]},"sourceAccountId":{"type":"string","description":"the id of the payment source account"}}},"PaymentTransaction":{"type":"object","properties":{"value":{"type":"number","description":"value of the transaction generated by the payment in cents"},"endToEndId":{"type":"string","description":"endToEndId of the transaction generated by the payment"},"time":{"type":"string","description":"time the transaction generated by the payment happened"}}},"PaymentDestination":{"type":"object","properties":{"name":{"type":"string","description":"the name of the payment destination"},"taxID":{"type":"string","description":"the tax id of the payment destination"},"pixKey":{"type":"string","description":"the pix key of the payment destination"},"bank":{"type":"string","description":"the payment destination bank name"},"branch":{"type":"string","description":"the payment destination bank branch"},"account":{"type":"string","description":"the payment destination bank account"}}},"PixQrCode":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"comment":{"type":"string"},"identifier":{"type":"string","description":"Custom identifier for EMV"},"brCode":{"type":"string","description":"EMV BRCode to be rendered as a Pix QRCode"},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this pix qrcode"},"paymentLinkID":{"type":"string","description":"Payment Link ID, used on payment link and to retrieve qrcode image"},"paymentLinkUrl":{"description":"Payment Link URL to be shared with customers"},"qrCodeImage":{"description":"QRCode image link URL"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"PixQrCodePayload":{"type":"object","properties":{"name":{"type":"string","description":"Name of this pix qrcode"},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this qrcode"},"value":{"type":"number","description":"Value in cents of this qrcode"},"comment":{"type":"string","description":"Comment to be added in infoPagador"},"identifier":{"type":"string","description":"Custom identifier for EMV"}},"required":["name","identifier"]},"Refund":{"type":"object","properties":{"value":{"type":"number"},"status":{"type":"string","enum":["IN_PROCESSING","REFUNDED","NOT_ACCOMPLISHED"]},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this refund"},"refundId":{"type":"string","description":"Unique refund ID for this pix refund"},"time":{"type":"string","description":"Time of this refund"},"comment":{"type":"string","description":"Comment of this refund"}}},"RefundPayload":{"type":"object","properties":{"value":{"type":"number"},"transactionEndToEndId":{"type":"string","description":"Your transaction ID, or endToEnd ID, to keep track of this refund"},"correlationID":{"type":"string","description":"Your correlation ID, unique identifier refund"},"comment":{"type":"string","description":"Comment of this refund. Maximum length of 140 characters.","maximum":140}}},"Start":{"type":"string","format":"date-time","title":"Start Date","description":"Start date used in the query. Complies with RFC 3339.","example":"2020-01-01T00:00:00Z"},"Subscription":{"type":"object","properties":{"globalID":{"type":"string","description":"The globalID of the subscription."},"value":{"type":"number","description":"Value in cents of the subscription"},"customer":{"type":"object","$ref":"#/components/schemas/Customer"},"dayGenerateCharge":{"type":"number","description":"Day of the month that the charges will be generated"}}},"SubscriptionPayload":{"type":"object","properties":{"customer":{"type":"object","description":"Customer of this subscription","properties":{"name":{"type":"string","description":"Customer name"},"email":{"type":"string","description":"Customer email"},"phone":{"type":"string","description":"Customer phone"},"taxID":{"type":"string","description":"Customer taxID (CPF or CNPJ)"},"address":{"type":"object","properties":{"zipcode":{"type":"string"},"street":{"type":"string"},"number":{"type":"string"},"neighborhood":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"complement":{"type":"string"},"country":{"type":"string"}}}}},"value":{"type":"number","description":"Value in cents of this subscription"},"comment":{"type":"string","description":"Comment to be added in infoPagador"},"additionalInfo":{"description":"Additional info of the charge","type":"array","items":{"type":"object","properties":{"key":{"description":"key of object","type":"string"},"value":{"description":"value of object","type":"string"}}}},"dayGenerateCharge":{"type":"number","description":"Day of the month that the charges will be generated. Maximun of 27.","minimum":0,"maximum":27,"default":5},"chargeType":{"type":"string","enum":["DYNAMIC","OVERDUE"],"description":"The charge type is used to determine whether charges generated by the subscription will have fines and interests","default":"DYNAMIC"},"dayDue":{"type":"number","minimum":3,"default":7,"description":"Days that the charge will take to expire from the generation day."}},"required":["customer","value"]},"Transaction":{"type":"object","properties":{"charge":{"type":"object","$ref":"#/components/schemas/Charge"},"value":{"type":"number"},"time":{"type":"string"},"endToEndID":{"type":"string"},"transactionID":{"type":"string"},"infoPagador":{"type":"string"},"endToEndId":{"type":"string"},"customer":{"type":"object","$ref":"#/components/schemas/Customer"},"withdraw":{"type":"object","$ref":"#/components/schemas/PixWithdrawTransaction"},"payer":{"type":"object","$ref":"#/components/schemas/Customer"},"type":{"type":"string","description":"Pix Transaction type","enum":["PAYMENT","WITHDRAW","REFUND","FEE"]},"globalID":{"description":"External ID of this transaction"},"pixQrCode":{"type":"object","$ref":"#/components/schemas/PixQrCode"}}},"PixWithdrawTransaction":{"type":"object","properties":{"value":{"type":"number"},"time":{"type":"string"},"endToEndID":{"type":"string"},"transactionID":{"type":"string"},"infoPagador":{"type":"string"},"endToEndId":{"type":"string"},"payer":{"type":"object","$ref":"#/components/schemas/Customer"},"type":{"type":"string"}}},"TransferCreatePayload":{"type":"object","properties":{"value":{"type":"number","description":"value of the transfer in cents"},"fromPixKey":{"type":"string","description":"the pix key of the account the value of the transfer will come out from"},"toPixKey":{"type":"string","description":"the pix key of the account the value of the transfer will go to"}}},"TransferTransaction":{"type":"object","properties":{"value":{"type":"number","description":"value of the transaction generated by the transfer"},"time":{"type":"string","description":"the time the transfer happened"},"correlationID":{"type":"string","description":"your correlation ID to keep track of this transfer"}}},"WebhookPayload":{"type":"object","properties":{"name":{"type":"string"},"event":{"type":"string","description":"The event to listen to. If omitted, the webhook will be registered to listen the OPENPIX:TRANSACTION_RECEIVED. Event called when a new pix transactions is received","$ref":"#/components/schemas/WebhookEventEnum"},"url":{"type":"string"},"authorization":{"type":"string"},"isActive":{"type":"boolean"}}},"Webhook":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/WebhookEventEnum"},"url":{"type":"string"},"authorization":{"type":"string"},"isActive":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"WebhookEventEnum":{"type":"string","description":"Available events to register a webhook to listen to. If no one selected anyone the default event will be OPENPIX:TRANSACTION_RECEIVED.\n\n* **OPENPIX:CHARGE_CREATED** - New charge created\n* **OPENPIX:CHARGE_COMPLETED** - Charge completed is when a charge is fully paid\n* **OPENPIX:CHARGE_EXPIRED** - Charge expired is when a charge is not fully paid and expired\n* **OPENPIX:TRANSACTION_RECEIVED** - New PIX transaction received\n* **OPENPIX:TRANSACTION_REFUND_RECEIVED** - New PIX transaction refund received or refunded\n* **OPENPIX:MOVEMENT_CONFIRMED** - Payment confirmed is when the pix transaction related to the payment gets confirmed\n* **OPENPIX:MOVEMENT_FAILED** - Payment failed is when the payment gets approved and a error occurs\n* **OPENPIX:MOVEMENT_REMOVED** - Payment was removed by a user\n","enum":["OPENPIX:CHARGE_CREATED","OPENPIX:CHARGE_COMPLETED","OPENPIX:CHARGE_EXPIRED","OPENPIX:TRANSACTION_RECEIVED","OPENPIX:TRANSACTION_REFUND_RECEIVED","OPENPIX:MOVEMENT_CONFIRMED","OPENPIX:MOVEMENT_FAILED","OPENPIX:MOVEMENT_REMOVED"]},"SubAccount":{"type":"object","properties":{"name":{"type":"string","description":"Name of the sub account"},"pixKey":{"type":"string","description":"The pix key for the sub account"},"balance":{"type":"number","description":"Number in cents that represent the balance of the sub account"}}},"transaction":{"type":"object","properties":{"status":{"type":"string","description":"The status of the transaction"},"value":{"type":"number","description":"The value of the transaction in cents"},"correlationID":{"type":"string","description":"The correlation ID of the transaction"},"destinationAlias":{"type":"string","description":"The pix key of the transaction"},"comment":{"type":"string","description":"The comment of the transaction"}}},"SubAccountPayload":{"type":"object","properties":{"pixKey":{"type":"string","description":"The pix key for the sub account"},"name":{"type":"string","description":"Name of the sub account"}}}},"securitySchemes":{"AppID":{"type":"apiKey","in":"header","name":"Authorization"}}},"tags":[{"name":"account","description":"Endpoint to manage Accounts\n"},{"name":"cashback-fidelity","description":"Endpoint to manage exclusive cashbacks\n"},{"name":"charge","description":"Endpoint to manage Charges\n"},{"name":"charge refund","description":"Endpoint to manage charge refunds\n"},{"name":"customer","description":"Endpoint to manage Customer\n"},{"name":"partner (request access)","description":"Partners integrate affiliated companies.
\nThey can register new companies, manage them, and earn money from them.\n"},{"name":"payment (request access)","description":"Endpoint to init a payment using a Pix Key.\n"},{"name":"pixQrCode","description":"Endpoint to manage static QRCodes\n"},{"name":"refund","description":"Endpoint to manage Refunds\n"},{"name":"subscription","description":"Endpoint to manage Subscriptions\n"},{"name":"transactions","description":"Endpoint to manage Transactions\n"},{"name":"transfer (request access)","description":"Endpoint to transfer values between sub accounts.\n"},{"name":"webhook","description":"Endpoint to manage Webhooks\n"},{"name":"sub account (request access)","description":"Endpoint to manage sub accounts.\n"}]} +{"openapi":"3.0.3","info":{"title":"Woovi","description":"A Woovi é uma Plataforma de Gestão de Pagamentos. Para utilizar nossa API você deve acessar __[https://api.woovi.com/](https://api.woovi.com/)__ e somente o mesmo. A Woovi não aceita subdominios para a API.\n\nVeja como configurar seu acesso a nossa API [aqui](https://developers.woovi.com/docs/apis/api-getting-started).","version":"1.0.0"},"servers":[{"url":"https://api.woovi.com","description":"Production server"}],"security":[{"AppID":[]}],"paths":{"/api/v1/account/{accountId}":{"get":{"tags":["account"],"summary":"Get an Account","parameters":[{"name":"accountId","in":"path","description":"ID of the Account","required":true,"schema":{"type":"string"},"example":"6290ccfd42831958a405debc"}],"responses":{"200":{"description":"The Account retrieve using the given Account ID","content":{"application/json":{"schema":{"type":"object","properties":{"account":{"type":"object","$ref":"#/components/schemas/CompanyBankAccount"}}},"example":{"account":{"accountId":"6290ccfd42831958a405debc","isDefault":true,"balance":{"total":129430,"blocked":0,"available":129430}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/account/6290ccfd42831958a405debc\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/account/6290ccfd42831958a405debc \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/account/6290ccfd42831958a405debc\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/account/6290ccfd42831958a405debc\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/account/6290ccfd42831958a405debc\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/account/6290ccfd42831958a405debc\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/account/6290ccfd42831958a405debc\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/account/":{"get":{"tags":["account"],"summary":"Get a list of Accounts","responses":{"200":{"description":"A list of Accounts","content":{"application/json":{"schema":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/CompanyBankAccount"}}}},"example":{"accounts":[{"accountId":"6290ccfd42831958a405debc","isDefault":true,"balance":{"total":129430,"blocked":0,"available":129430}},{"accountId":"6286b467a7910113577e00ce","isDefault":false,"balance":{"total":130,"blocked":100,"available":30}}]}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/account/\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/account/ \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/account/\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/account/\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/account/\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/account/\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/account/\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/account/{accountId}/withdraw":{"post":{"tags":["account"],"summary":"Withdraw from an Account","description":"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","parameters":[{"name":"accountId","in":"path","description":"ID of the Account","required":true,"schema":{"type":"string"},"example":"6290ccfd42831958a405debc"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"number","description":"Value in cents"}}},"example":{"value":7000}}}},"responses":{"200":{"description":"Withdraw and Acccount information","content":{"application/json":{"schema":{"type":"object","properties":{"withdraw":{"type":"object","properties":{"account":{"type":"object","$ref":"#/components/schemas/CompanyBankAccount"},"transaction":{"type":"object","$ref":"#/components/schemas/WithdrawTransaction"}}}}},"example":{"withdraw":{"account":{"accountId":"6290ccfd42831958a405debc","isDefault":true,"balance":{"total":122430,"blocked":0,"available":122430}},"transaction":{"endToEndId":"E23114447202205191817cx6VMrbwtw6","transaction":7000}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/account/6290ccfd42831958a405debc/withdraw\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({value: 0}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/account/6290ccfd42831958a405debc/withdraw \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"value\":0}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/account/6290ccfd42831958a405debc/withdraw\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"value\\\":0}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"value\\\":0}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/account/6290ccfd42831958a405debc/withdraw\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/account/6290ccfd42831958a405debc/withdraw\"\n\n\tpayload := strings.NewReader(\"{\\\"value\\\":0}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"value\\\":0}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/account/6290ccfd42831958a405debc/withdraw\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/account/6290ccfd42831958a405debc/withdraw\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"value\\\":0}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/cashback-fidelity/balance/{taxID}":{"get":{"tags":["cashback-fidelity"],"summary":"Get the exclusive cashback amount an user still has to receive by taxID.","parameters":[{"name":"taxID","in":"path","description":"The raw tax ID from the customer you want to get the balance.","required":true,"schema":{"type":"string"},"examples":{"taxID":{"value":"60151449000182"}}}],"responses":{"200":{"description":"Amount the user still has to receive.","content":{"application/json":{"schema":{"type":"object","properties":{"balance":{"type":"number"},"status":{"type":"string"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/cashback-fidelity/balance/%7BtaxID%7D\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/cashback-fidelity/balance/%7BtaxID%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/cashback-fidelity/balance/%7BtaxID%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/cashback-fidelity/balance/%7BtaxID%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/cashback-fidelity/balance/%7BtaxID%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/cashback-fidelity/balance/%7BtaxID%7D\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/cashback-fidelity/balance/%7BtaxID%7D\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/cashback-fidelity":{"post":{"tags":["cashback-fidelity"],"summary":"Get or create cashback for a customer.","description":"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.","requestBody":{"description":"Customer's taxID and the cash","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"taxID":{"type":"string","description":"Customer taxID (CPF or CNPJ)"},"value":{"type":"number","description":"Cashback value in centavos"}}},"example":{"value":100,"taxID":11111111111}}}},"responses":{"200":{"description":"Didn't create a new cashback, returning previously existing cashback information instead.","content":{"application/json":{"schema":{"type":"object","properties":{"cashback":{"description":"Object representing the existing cashback","type":"object","properties":{"value":{"type":"number","description":"Cashback value in centavos"}}},"message":{"type":"string","description":"String explaining what happened"}}}}}},"201":{"description":"New cashback created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"cashback":{"description":"Object representing the new cashback","type":"object","properties":{"value":{"type":"number","description":"Cashback value in centavos"}}},"message":{"type":"string","description":"String explaining what happened"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/cashback-fidelity\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({taxID: 'string', value: 0}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/cashback-fidelity \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"taxID\":\"string\",\"value\":0}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/cashback-fidelity\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"taxID\\\":\\\"string\\\",\\\"value\\\":0}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"taxID\\\":\\\"string\\\",\\\"value\\\":0}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/cashback-fidelity\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/cashback-fidelity\"\n\n\tpayload := strings.NewReader(\"{\\\"taxID\\\":\\\"string\\\",\\\"value\\\":0}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"taxID\\\":\\\"string\\\",\\\"value\\\":0}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/cashback-fidelity\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/cashback-fidelity\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"taxID\\\":\\\"string\\\",\\\"value\\\":0}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/charge/{id}":{"delete":{"tags":["charge"],"summary":"Delete a charge","parameters":[{"name":"id","in":"path","description":"charge ID or correlation ID. You will need URI encoding if your correlation ID has characters outside the ASCII set or reserved characters (%, \\#, /).","required":true,"schema":{"type":"string"},"examples":{"chargeId":{"value":"Q2hhcmdlOjYwM2U3NDlhNDI1NjAyYmJiZjRlN2JlZA=="},"correlationID":{"value":"fe7834b4060c488a9b0f89811be5f5cf"}}}],"responses":{"200":{"description":"The charge deleted","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"id":{"type":"string","description":"the id previously informed to be found and deleted"}},"example":{"status":"OK","id":"fe7834b4060c488a9b0f89811be5f5cf"}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/charge/%7Bid%7D\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request DELETE \\\n --url https://api.woovi.com/api/v1/charge/%7Bid%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/charge/%7Bid%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"DELETE\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"DELETE\", \"/api/v1/charge/%7Bid%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/charge/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/charge/%7Bid%7D\")\n .delete(null)\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/charge/%7Bid%7D\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Delete.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]},"get":{"tags":["charge"],"summary":"Get one charge","parameters":[{"name":"id","in":"path","description":"charge ID or correlation ID. You will need URI encoding if your correlation ID has characters outside the ASCII set or reserved characters (%, \\#, /).","required":true,"schema":{"type":"string"},"example":"fe7834b4060c488a9b0f89811be5f5cf"}],"responses":{"200":{"description":"The charge retrieve using the given ID","content":{"application/json":{"schema":{"type":"object","properties":{"charge":{"type":"object","$ref":"#/components/schemas/Charge"}},"example":{"charge":{"status":"ACTIVE","customer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"}},"value":100,"comment":"good","correlationID":"9134e286-6f71-427a-bf00-241681624586","paymentLinkID":"7777-6f71-427a-bf00-241681624586","paymentLinkUrl":"https://openpix.com.br/pay/9134e286-6f71-427a-bf00-241681624586","globalID":"Q2hhcmdlOjcxOTFmMWIwMjA0NmJmNWY1M2RjZmEwYg==","qrCodeImage":"https://api.openpix.com.br/openpix/charge/brcode/image/9134e286-6f71-427a-bf00-241681624586.png","brCode":"000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA","additionalInfo":[{"key":"Product","value":"Pencil"},{"key":"Invoice","value":"18476"},{"key":"Order","value":"302"}],"expiresIn":2592000,"expiresDate":"2021-04-01T17:28:51.882Z","createdAt":"2021-03-02T17:28:51.882Z","updatedAt":"2021-03-02T17:28:51.882Z"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/charge/fe7834b4060c488a9b0f89811be5f5cf\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/charge/fe7834b4060c488a9b0f89811be5f5cf \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/charge/fe7834b4060c488a9b0f89811be5f5cf\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/charge/fe7834b4060c488a9b0f89811be5f5cf\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/charge/fe7834b4060c488a9b0f89811be5f5cf\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/charge/fe7834b4060c488a9b0f89811be5f5cf\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/charge/fe7834b4060c488a9b0f89811be5f5cf\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/charge":{"get":{"tags":["charge"],"summary":"Get a list of charges","parameters":[{"in":"query","name":"start","schema":{"type":"string","format":"date-time","title":"Start Date","description":"Start date used in the query. Complies with RFC 3339.","example":"2020-01-01T00:00:00Z"}},{"in":"query","name":"end","schema":{"type":"string","format":"date-time","title":"End Date","description":"End date used in the query. Complies with RFC 3339.","example":"2020-12-01T17:00:00Z"}},{"name":"status","in":"query","schema":{"type":"string","enum":["ACTIVE","COMPLETED","EXPIRED"]}}],"responses":{"200":{"description":"A list of charges","content":{"application/json":{"schema":{"type":"object","properties":{"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}},"pageInfo":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"skip":{"type":"number"},"limit":{"type":"number"}}}}}},"skip":{"type":"number"},"limit":{"type":"number"},"totalCount":{"type":"number"},"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}}}},"example":{"pageInfo":{"skip":0,"limit":10,"totalCount":20,"hasPreviousPage":false,"hasNextPage":true},"charges":{"status":"ACTIVE","customer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"}},"value":100,"comment":"good","correlationID":"9134e286-6f71-427a-bf00-241681624586","paymentLinkID":"7777a23s-6f71-427a-bf00-241681624586","paymentLinkUrl":"https://openpix.com.br/pay/9134e286-6f71-427a-bf00-241681624586","qrCodeImage":"https://api.openpix.com.br/openpix/charge/brcode/image/9134e286-6f71-427a-bf00-241681624586.png","brCode":"000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA","additionalInfo":[{"key":"Product","value":"Pencil"},{"key":"Invoice","value":"18476"},{"key":"Order","value":"302"}],"expiresIn":2592000,"expiresDate":"2021-04-01T17:28:51.882Z","createdAt":"2021-03-02T17:28:51.882Z","updatedAt":"2021-03-02T17:28:51.882Z"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/charge?start=2020-01-01T00%3A00%3A00Z&end=2020-12-01T17%3A00%3A00Z&status=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.woovi.com/api/v1/charge?start=2020-01-01T00%3A00%3A00Z&end=2020-12-01T17%3A00%3A00Z&status=SOME_STRING_VALUE' \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/charge?start=2020-01-01T00%3A00%3A00Z&end=2020-12-01T17%3A00%3A00Z&status=SOME_STRING_VALUE\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/charge?start=2020-01-01T00%3A00%3A00Z&end=2020-12-01T17%3A00%3A00Z&status=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/charge?start=2020-01-01T00%3A00%3A00Z&end=2020-12-01T17%3A00%3A00Z&status=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/charge?start=2020-01-01T00%3A00%3A00Z&end=2020-12-01T17%3A00%3A00Z&status=SOME_STRING_VALUE\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/charge?start=2020-01-01T00%3A00%3A00Z&end=2020-12-01T17%3A00%3A00Z&status=SOME_STRING_VALUE\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]},"post":{"tags":["charge"],"summary":"Create a new Charge","parameters":[{"in":"query","name":"return_existing","description":"Make the endpoint idempotent, will return an existent charge if already has a one with the correlationID","required":false,"schema":{"type":"boolean"},"examples":{"return_existing":{"value":true}}}],"description":"Endpoint to create a new Charge for a customer","requestBody":{"description":"Data to create a new charge","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ChargePayload"},"examples":{"Charge":{"value":{"correlationID":"9134e286-6f71-427a-bf00-241681624587","value":100,"comment":"good","customer":{"name":"Dan","taxID":"31324227036","email":"email0@example.com","phone":"5511999999999"},"additionalInfo":[{"key":"Product","value":"Pencil"},{"key":"Invoice","value":"18476"},{"key":"Order","value":"302"}]}},"Charge with Interests and Fines":{"value":{"type":"OVERDUE","correlationID":"9134e286-6f71-427a-bf00-241681624587","value":100,"comment":"good","daysForDueDate":5,"daysAfterDueDate":5,"interests":{"value":10},"fines":{"value":20},"customer":{"name":"Dan","taxID":"31324227036","email":"email0@example.com","phone":"5511999999999","address":{"zipcode":"30421322","street":"Street","number":"100","neighborhood":"Neighborhood","city":"Belo Horizonte","state":"MG","complement":"APTO","country":"BR"}},"additionalInfo":[{"key":"Product","value":"Pencil"},{"key":"Invoice","value":"18476"},{"key":"Order","value":"302"}]}}}}}},"responses":{"200":{"description":"Charge ID and also the generated Dynamic BR Code to be rendered as a QRCode","content":{"application/json":{"schema":{"type":"object","properties":{"charge":{"$ref":"#/components/schemas/Charge"},"correlationID":{"type":"string"},"brCode":{"type":"string"}},"example":{"charge":{"status":"ACTIVE","customer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"}},"value":100,"comment":"good","correlationID":"9134e286-6f71-427a-bf00-241681624586","paymentLinkID":"7777a23s-6f71-427a-bf00-241681624586","paymentLinkUrl":"https://openpix.com.br/pay/9134e286-6f71-427a-bf00-241681624586","qrCodeImage":"https://api.openpix.com.br/openpix/charge/brcode/image/9134e286-6f71-427a-bf00-241681624586.png","expiresIn":2592000,"expiresDate":"2021-04-01T17:28:51.882Z","createdAt":"2021-03-02T17:28:51.882Z","updatedAt":"2021-03-02T17:28:51.882Z","brCode":"000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA","additionalInfo":[{"key":"Product","value":"Pencil"},{"key":"Invoice","value":"18476"},{"key":"Order","value":"302"}]}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/charge?return_existing=SOME_BOOLEAN_VALUE\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n correlationID: 'string',\n value: 0,\n type: 'DYNAMIC',\n comment: 'string',\n identifier: 'string',\n expiresIn: 0,\n customer: {\n name: 'string',\n email: 'string',\n phone: 'string',\n taxID: '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: 0,\n daysAfterDueDate: 0,\n interests: {value: 0},\n fines: {value: 0},\n additionalInfo: [{key: 'string', value: 'string'}],\n enableCashbackPercentage: true,\n enableCashbackExclusivePercentage: true\n}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url 'https://api.woovi.com/api/v1/charge?return_existing=SOME_BOOLEAN_VALUE' \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"correlationID\":\"string\",\"value\":0,\"type\":\"DYNAMIC\",\"comment\":\"string\",\"identifier\":\"string\",\"expiresIn\":0,\"customer\":{\"name\":\"string\",\"email\":\"string\",\"phone\":\"string\",\"taxID\":\"string\",\"correlationID\":\"string\",\"address\":{\"zipcode\":\"string\",\"street\":\"string\",\"number\":\"string\",\"neighborhood\":\"string\",\"city\":\"string\",\"state\":\"string\",\"complement\":\"string\",\"country\":\"string\"}},\"daysForDueDate\":0,\"daysAfterDueDate\":0,\"interests\":{\"value\":0},\"fines\":{\"value\":0},\"additionalInfo\":[{\"key\":\"string\",\"value\":\"string\"}],\"enableCashbackPercentage\":true,\"enableCashbackExclusivePercentage\":true}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/charge?return_existing=SOME_BOOLEAN_VALUE\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"type\\\":\\\"DYNAMIC\\\",\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\",\\\"expiresIn\\\":0,\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"daysForDueDate\\\":0,\\\"daysAfterDueDate\\\":0,\\\"interests\\\":{\\\"value\\\":0},\\\"fines\\\":{\\\"value\\\":0},\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"enableCashbackPercentage\\\":true,\\\"enableCashbackExclusivePercentage\\\":true}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"type\\\":\\\"DYNAMIC\\\",\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\",\\\"expiresIn\\\":0,\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"daysForDueDate\\\":0,\\\"daysAfterDueDate\\\":0,\\\"interests\\\":{\\\"value\\\":0},\\\"fines\\\":{\\\"value\\\":0},\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"enableCashbackPercentage\\\":true,\\\"enableCashbackExclusivePercentage\\\":true}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/charge?return_existing=SOME_BOOLEAN_VALUE\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/charge?return_existing=SOME_BOOLEAN_VALUE\"\n\n\tpayload := strings.NewReader(\"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"type\\\":\\\"DYNAMIC\\\",\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\",\\\"expiresIn\\\":0,\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"daysForDueDate\\\":0,\\\"daysAfterDueDate\\\":0,\\\"interests\\\":{\\\"value\\\":0},\\\"fines\\\":{\\\"value\\\":0},\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"enableCashbackPercentage\\\":true,\\\"enableCashbackExclusivePercentage\\\":true}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"type\\\":\\\"DYNAMIC\\\",\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\",\\\"expiresIn\\\":0,\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"daysForDueDate\\\":0,\\\"daysAfterDueDate\\\":0,\\\"interests\\\":{\\\"value\\\":0},\\\"fines\\\":{\\\"value\\\":0},\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"enableCashbackPercentage\\\":true,\\\"enableCashbackExclusivePercentage\\\":true}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/charge?return_existing=SOME_BOOLEAN_VALUE\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/charge?return_existing=SOME_BOOLEAN_VALUE\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"type\\\":\\\"DYNAMIC\\\",\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\",\\\"expiresIn\\\":0,\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"daysForDueDate\\\":0,\\\"daysAfterDueDate\\\":0,\\\"interests\\\":{\\\"value\\\":0},\\\"fines\\\":{\\\"value\\\":0},\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"enableCashbackPercentage\\\":true,\\\"enableCashbackExclusivePercentage\\\":true}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/charge/{id}/refund":{"get":{"tags":["charge refund"],"summary":"Get all refunds of a charge","description":"Endpoint to get all refunds of a charge","parameters":[{"name":"id","in":"path","description":"The correlation ID of the charge. You will need URI encoding if your correlation ID has characters outside the ASCII set or reserved characters (%, \\#, /).","required":true,"schema":{"type":"string"},"examples":{"uuid":{"value":"cf4012c9-b2ac-484d-8121-deedd1c6d8af"},"random-string":{"value":"fe7834b4060c488a9b0f89811be5f5cf"}}}],"responses":{"200":{"description":"A list of refunds","content":{"application/json":{"schema":{"type":"object","properties":{"refunds":{"type":"array","items":{"$ref":"#/components/schemas/ChargeRefund"}}},"example":{"refunds":[{"status":"IN_PROCESSING","value":10,"correlationID":"9134e286-6f71-427a-bf00-241681624586","endToEndId":"E23114447202304181826HJNwY577YDX","time":"2021-03-02T17:28:51.882Z"},{"status":"CONFIRMED","value":40,"correlationID":"589a378e-ab45-4f30-bd4d-4496c60f88cf","endToEndId":"E23114447202304181057pOhPMsp2pJZ","time":"2021-03-05T14:49:02.922Z","comment":"Comentário do reembolso"}]}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/charge/%7Bid%7D/refund\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/charge/%7Bid%7D/refund \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/charge/%7Bid%7D/refund\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/charge/%7Bid%7D/refund\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/charge/%7Bid%7D/refund\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/charge/%7Bid%7D/refund\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/charge/%7Bid%7D/refund\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]},"post":{"tags":["charge refund"],"summary":"Create a new refund for a charge","description":"Endpoint to create a new refund for a charge","parameters":[{"name":"id","in":"path","description":"The correlation ID of the charge. You will need URI encoding if your correlation ID has characters outside the ASCII set or reserved characters (%, \\#, /).","required":true,"schema":{"type":"string"},"examples":{"uuid":{"value":"cf4012c9-b2ac-484d-8121-deedd1c6d8af"},"random-string":{"value":"fe7834b4060c488a9b0f89811be5f5cf"}}}],"requestBody":{"description":"Data to create a new refund for a charge","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ChargeRefundPayload"},"example":{"correlationID":"a273e72c-9547-4c75-a213-3b0a2735b8d5","value":100,"comment":"Comentário do reembolso"}}}},"responses":{"200":{"description":"The created Refund","content":{"application/json":{"schema":{"type":"object","properties":{"refund":{"$ref":"#/components/schemas/ChargeRefund"}},"example":{"refund":{"status":"IN_PROCESSING","value":100,"correlationID":"a273e72c-9547-4c75-a213-3b0a2735b8d5","endToEndId":"E23114447202304181826HJNwY577YDX","time":"2023-03-02T17:28:51.882Z","comment":"Comentário do reembolso"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/charge/%7Bid%7D/refund\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({correlationID: 'string', value: 0, comment: 'string'}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/charge/%7Bid%7D/refund \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"correlationID\":\"string\",\"value\":0,\"comment\":\"string\"}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/charge/%7Bid%7D/refund\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"comment\\\":\\\"string\\\"}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"comment\\\":\\\"string\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/charge/%7Bid%7D/refund\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/charge/%7Bid%7D/refund\"\n\n\tpayload := strings.NewReader(\"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"comment\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"comment\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/charge/%7Bid%7D/refund\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/charge/%7Bid%7D/refund\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"comment\\\":\\\"string\\\"}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/customer/{id}":{"get":{"tags":["customer"],"summary":"Get one customer","parameters":[{"name":"id","in":"path","description":"correlation ID","required":true,"schema":{"type":"string"},"examples":{"correlationID":{"value":"fe7834b4060c488a9b0f89811be5f5cf"}}}],"responses":{"200":{"description":"The customer retrieve using the given ID","content":{"application/json":{"schema":{"type":"object","properties":{"customer":{"type":"object","$ref":"#/components/schemas/Customer"}},"example":{"customer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"},"correlationID":"fe7834b4060c488a9b0f89811be5f5cf"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/customer/%7Bid%7D\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/customer/%7Bid%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/customer/%7Bid%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/customer/%7Bid%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/customer/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/customer/%7Bid%7D\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/customer/%7Bid%7D\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/customer":{"get":{"tags":["customer"],"summary":"Get a list of customers","responses":{"200":{"description":"A list of customers","content":{"application/json":{"schema":{"type":"object","properties":{"customers":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}},"pageInfo":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"skip":{"type":"number"},"limit":{"type":"number"}}}}}},"skip":{"type":"number"},"limit":{"type":"number"},"totalCount":{"type":"number"},"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}}}},"example":{"pageInfo":{"skip":0,"limit":10,"totalCount":20,"hasPreviousPage":false,"hasNextPage":true},"customers":{"customer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"}}}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/customer\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/customer \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/customer\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/customer\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/customer\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/customer\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/customer\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]},"post":{"tags":["customer"],"summary":"Create a new Customer","description":"Endpoint to create a new Customer","requestBody":{"description":"Data to create a new customer","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/CustomerPayload"},"example":{"name":"Dan","taxID":"31324227036","email":"email0@example.com","phone":"5511999999999","correlationID":"9134e286-6f71-427a-bf00-241681624586","address":{"zipcode":"30421322","street":"Street","number":"100","neighborhood":"Neighborhood","city":"Belo Horizonte","state":"MG","complement":"APTO","country":"BR"}}}}},"responses":{"200":{"description":"Customer ID","content":{"application/json":{"schema":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/Customer"}},"example":{"customer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"},"address":{"zipcode":"30421322","street":"Street","number":"100","neighborhood":"Neighborhood","city":"Belo Horizonte","state":"MG","complement":"APTO","country":"BR"}}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/customer\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n name: 'string',\n email: 'string',\n phone: 'string',\n taxID: '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}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/customer \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"name\":\"string\",\"email\":\"string\",\"phone\":\"string\",\"taxID\":\"string\",\"correlationID\":\"string\",\"address\":{\"zipcode\":\"string\",\"street\":\"string\",\"number\":\"string\",\"neighborhood\":\"string\",\"city\":\"string\",\"state\":\"string\",\"complement\":\"string\",\"country\":\"string\"}}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/customer\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/customer\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/customer\"\n\n\tpayload := strings.NewReader(\"{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/customer\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/customer\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/partner/application":{"post":{"tags":["partner (request access)"],"summary":"Create a new application to some of your preregistration's company.","description":"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","requestBody":{"description":"The request body to create a pre registration.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"application":{"type":"object","properties":{"name":{"type":"string","description":"The name you want to give your application"},"type":{"$ref":"#/components/schemas/ApplicationEnumTypePayload"}},"required":["name","type"]},"taxID":{"$ref":"#/components/schemas/TaxIDObjectPayload","required":["taxID","type"]}}},"example":{"application":{"name":"MyAPIAccess","type":"API"},"taxID":{"taxID":"65914571000187","type":"BR:CNPJ"}}}}},"responses":{"200":{"description":"Our \"idempotence output\", if you get this HTTP code, it's an application\nthat already has been registered.\n","content":{"application/json":{"schema":{"type":"object","properties":{"application":{"$ref":"#/components/schemas/PartnerApplicationPayload"}}}}}},"201":{"description":"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","content":{"application/json":{"schema":{"type":"object","properties":{"application":{"$ref":"#/components/schemas/PartnerApplicationPayload"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"403":{"description":"You are unauthorized to use this endpoint.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/partner/application\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n application: {name: 'string', type: 'API'},\n taxID: {taxID: 'string', type: 'BR:CNPJ'}\n}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/partner/application \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"application\":{\"name\":\"string\",\"type\":\"API\"},\"taxID\":{\"taxID\":\"string\",\"type\":\"BR:CNPJ\"}}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/partner/application\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"application\\\":{\\\"name\\\":\\\"string\\\",\\\"type\\\":\\\"API\\\"},\\\"taxID\\\":{\\\"taxID\\\":\\\"string\\\",\\\"type\\\":\\\"BR:CNPJ\\\"}}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"application\\\":{\\\"name\\\":\\\"string\\\",\\\"type\\\":\\\"API\\\"},\\\"taxID\\\":{\\\"taxID\\\":\\\"string\\\",\\\"type\\\":\\\"BR:CNPJ\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/partner/application\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/partner/application\"\n\n\tpayload := strings.NewReader(\"{\\\"application\\\":{\\\"name\\\":\\\"string\\\",\\\"type\\\":\\\"API\\\"},\\\"taxID\\\":{\\\"taxID\\\":\\\"string\\\",\\\"type\\\":\\\"BR:CNPJ\\\"}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"application\\\":{\\\"name\\\":\\\"string\\\",\\\"type\\\":\\\"API\\\"},\\\"taxID\\\":{\\\"taxID\\\":\\\"string\\\",\\\"type\\\":\\\"BR:CNPJ\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/partner/application\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/partner/application\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"application\\\":{\\\"name\\\":\\\"string\\\",\\\"type\\\":\\\"API\\\"},\\\"taxID\\\":{\\\"taxID\\\":\\\"string\\\",\\\"type\\\":\\\"BR:CNPJ\\\"}}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/partner/company/{taxID}":{"get":{"tags":["partner (request access)"],"summary":"Get an specific preregistration via taxID param.","parameters":[{"name":"taxID","in":"path","description":"The raw tax ID from the preregistration that you want to get.","required":true,"schema":{"type":"string"},"examples":{"taxID":{"value":"60151449000182"}}}],"responses":{"200":{"description":"The preregistration retrieved by the tax ID.","content":{"application/json":{"schema":{"type":"object","properties":{"preRegistration":{"type":"object","properties":{"preRegistration":{"$ref":"#/components/schemas/PreRegistrationObjectPayload"},"user":{"$ref":"#/components/schemas/PreRegistrationUserObject"},"company":{"$ref":"#/components/schemas/CompanyObjectPayload"},"account":{"$ref":"#/components/schemas/AccountObjectPayload"}},"required":["preRegistration","user"]}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/partner/company/%7BtaxID%7D\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/partner/company/%7BtaxID%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/partner/company/%7BtaxID%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/partner/company/%7BtaxID%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/partner/company/%7BtaxID%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/partner/company/%7BtaxID%7D\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/partner/company/%7BtaxID%7D\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/partner/company":{"get":{"tags":["partner (request access)"],"summary":"Get every preregistration that is managed by you.","responses":{"200":{"description":"A list with preregistrations.","content":{"application/json":{"schema":{"type":"object","properties":{"preRegistrations":{"type":"array","items":{"type":"object","properties":{"preRegistration":{"$ref":"#/components/schemas/PreRegistrationObjectPayload"},"user":{"$ref":"#/components/schemas/PreRegistrationUserObject"},"company":{"$ref":"#/components/schemas/CompanyObjectPayload"},"account":{"$ref":"#/components/schemas/AccountObjectPayload"}},"required":["preRegistration","user"]}},"pageInfo":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"skip":{"type":"number"},"limit":{"type":"number"}}}}}},"skip":{"type":"number"},"limit":{"type":"number"},"totalCount":{"type":"number"},"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}}}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/partner/company\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/partner/company \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/partner/company\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/partner/company\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/partner/company\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/partner/company\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/partner/company\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]},"post":{"tags":["partner (request access)"],"summary":"Create a pre registration with a partner reference (your company)","description":"As a partner company, you can create a new pre registration referencing your\ncompany as a partner.\n","requestBody":{"description":"The request body to create a pre registration.","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PreRegistrationPayloadObject"},"example":{"preRegistration":{"name":"Example LLC","taxID":{"taxID":"11111111111111","type":"BR:CNPJ"},"website":"examplellc.com"},"user":{"firstName":"John","lastName":"Doe","email":"johndoe@examplellc.com","phone":"+5511912345678"}}}}},"responses":{"200":{"description":"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","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreRegistrationPayloadObject"}}}},"201":{"description":"A new preregistration that is related to you has been created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreRegistrationPayloadObject"}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"403":{"description":"You are unauthorized to use this endpoint.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/partner/company\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n preRegistration: {name: 'string', website: 'string', taxID: {taxID: 'string', type: 'BR:CNPJ'}},\n user: {firstName: 'string', lastName: 'string', email: 'string', phone: 'string'}\n}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/partner/company \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"preRegistration\":{\"name\":\"string\",\"website\":\"string\",\"taxID\":{\"taxID\":\"string\",\"type\":\"BR:CNPJ\"}},\"user\":{\"firstName\":\"string\",\"lastName\":\"string\",\"email\":\"string\",\"phone\":\"string\"}}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/partner/company\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"preRegistration\\\":{\\\"name\\\":\\\"string\\\",\\\"website\\\":\\\"string\\\",\\\"taxID\\\":{\\\"taxID\\\":\\\"string\\\",\\\"type\\\":\\\"BR:CNPJ\\\"}},\\\"user\\\":{\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\"}}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"preRegistration\\\":{\\\"name\\\":\\\"string\\\",\\\"website\\\":\\\"string\\\",\\\"taxID\\\":{\\\"taxID\\\":\\\"string\\\",\\\"type\\\":\\\"BR:CNPJ\\\"}},\\\"user\\\":{\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\"}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/partner/company\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/partner/company\"\n\n\tpayload := strings.NewReader(\"{\\\"preRegistration\\\":{\\\"name\\\":\\\"string\\\",\\\"website\\\":\\\"string\\\",\\\"taxID\\\":{\\\"taxID\\\":\\\"string\\\",\\\"type\\\":\\\"BR:CNPJ\\\"}},\\\"user\\\":{\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\"}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"preRegistration\\\":{\\\"name\\\":\\\"string\\\",\\\"website\\\":\\\"string\\\",\\\"taxID\\\":{\\\"taxID\\\":\\\"string\\\",\\\"type\\\":\\\"BR:CNPJ\\\"}},\\\"user\\\":{\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/partner/company\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/partner/company\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"preRegistration\\\":{\\\"name\\\":\\\"string\\\",\\\"website\\\":\\\"string\\\",\\\"taxID\\\":{\\\"taxID\\\":\\\"string\\\",\\\"type\\\":\\\"BR:CNPJ\\\"}},\\\"user\\\":{\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\"}}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/payment/approve":{"post":{"tags":["payment (request access)"],"summary":"Approve a Payment Request","description":"Endpoint to approve a payment","requestBody":{"description":"Data to approve a payment request","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PaymentApprovePayload"},"example":{"correlationID":"payment1"}}}},"responses":{"200":{"description":"The approved payment","content":{"application/json":{"schema":{"type":"object","properties":{"payment":{"type":"object","$ref":"#/components/schemas/Payment"},"transaction":{"type":"object","$ref":"#/components/schemas/PaymentTransaction"},"destination":{"type":"object","$ref":"#/components/schemas/PaymentDestination"}},"example":{"payment":{"value":100,"status":"APPROVED","destinationAlias":"c4249323-b4ca-43f2-8139-8232aab09b93","comment":"payment comment","correlationID":"payment1","sourceAccountId":"my-source-account-id"},"transaction":{"value":100,"endToEndId":"transaction-end-to-end-id","time":"2023-03-20T13:14:17.000Z"},"destination":{"name":"Dan","taxID":"31324227036","pixKey":"c4249323-b4ca-43f2-8139-8232aab09b93","bank":"A Bank","branch":"1","account":"123456"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/payment/approve\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({correlationID: 'string'}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/payment/approve \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"correlationID\":\"string\"}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/payment/approve\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"correlationID\\\":\\\"string\\\"}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"correlationID\\\":\\\"string\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/payment/approve\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/payment/approve\"\n\n\tpayload := strings.NewReader(\"{\\\"correlationID\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"correlationID\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/payment/approve\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/payment/approve\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"correlationID\\\":\\\"string\\\"}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/payment/{id}":{"get":{"tags":["payment (request access)"],"summary":"Get one Payment","parameters":[{"name":"id","in":"path","description":"payment ID or correlation ID","required":true,"schema":{"type":"string"},"examples":{"paymentID":{"value":"Q2hhcmdlOjYwM2U3NDlhNDI1NjAyYmJiZjRlN2JlZA=="},"correlationID":{"value":"fe7834b4060c488a9b0f89811be5f5cf"}}}],"responses":{"200":{"description":"The payment retrieved using the given ID","content":{"application/json":{"schema":{"type":"object","properties":{"payment":{"type":"object","$ref":"#/components/schemas/Payment"},"transaction":{"type":"object","$ref":"#/components/schemas/PaymentTransaction"},"destination":{"type":"object","$ref":"#/components/schemas/PaymentDestination"}},"example":{"payment":{"value":100,"status":"CONFIRMED","destinationAlias":"c4249323-b4ca-43f2-8139-8232aab09b93","comment":"payment comment","correlationID":"payment1","sourceAccountId":"my-source-account-id"},"transaction":{"value":100,"endToEndId":"transaction-end-to-end-id","time":"2023-03-20T13:14:17.000Z"},"destination":{"name":"Dan","taxID":"31324227036","pixKey":"c4249323-b4ca-43f2-8139-8232aab09b93","bank":"A Bank","branch":"1","account":"123456"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/payment/%7Bid%7D\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/payment/%7Bid%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/payment/%7Bid%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/payment/%7Bid%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/payment/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/payment/%7Bid%7D\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/payment/%7Bid%7D\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/payment":{"get":{"tags":["payment (request access)"],"summary":"Get a list of payments","responses":{"200":{"description":"A list of payments","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"payments":{"type":"array","items":{"type":"object","properties":{"payment":{"type":"object","$ref":"#/components/schemas/Payment"},"transaction":{"type":"object","$ref":"#/components/schemas/PaymentTransaction"},"destination":{"type":"object","$ref":"#/components/schemas/PaymentDestination"}}}},"pageInfo":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"skip":{"type":"number"},"limit":{"type":"number"}}}}}},"skip":{"type":"number"},"limit":{"type":"number"},"totalCount":{"type":"number"},"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}}}}},"example":{"pageInfo":{"skip":0,"limit":10,"totalCount":20,"hasPreviousPage":false,"hasNextPage":true},"payments":{"payment":{"value":100,"status":"CONFIRMED","destinationAlias":"c4249323-b4ca-43f2-8139-8232aab09b93","comment":"payment comment","correlationID":"payment1","sourceAccountId":"my-source-account-id"},"transaction":{"value":100,"endToEndId":"transaction-end-to-end-id","time":"2023-03-20T13:14:17.000Z"},"destination":{"name":"Dan","taxID":"31324227036","pixKey":"c4249323-b4ca-43f2-8139-8232aab09b93","bank":"A Bank","branch":"1","account":"123456"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/payment\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/payment \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/payment\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/payment\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/payment\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/payment\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/payment\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]},"post":{"tags":["payment (request access)"],"summary":"Create a Payment Request","description":"Endpoint to request a payment","requestBody":{"description":"Data to create a payment request","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PaymentCreatePayload"},"example":{"value":100,"destinationAlias":"c4249323-b4ca-43f2-8139-8232aab09b93","comment":"payment comment","correlationID":"payment1","sourceAccountId":"my-source-account-id"}}}},"responses":{"200":{"description":"Payment destination account information","content":{"application/json":{"schema":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/Payment"}},"example":{"payment":{"value":100,"status":"CREATED","destinationAlias":"c4249323-b4ca-43f2-8139-8232aab09b93","comment":"payment comment","correlationID":"payment1","sourceAccountId":"my-source-account-id"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/payment\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n value: 0,\n destinationAlias: 'string',\n correlationID: 'string',\n comment: 'string',\n sourceAccountId: 'string'\n}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/payment \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"value\":0,\"destinationAlias\":\"string\",\"correlationID\":\"string\",\"comment\":\"string\",\"sourceAccountId\":\"string\"}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/payment\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"value\\\":0,\\\"destinationAlias\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"comment\\\":\\\"string\\\",\\\"sourceAccountId\\\":\\\"string\\\"}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"value\\\":0,\\\"destinationAlias\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"comment\\\":\\\"string\\\",\\\"sourceAccountId\\\":\\\"string\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/payment\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/payment\"\n\n\tpayload := strings.NewReader(\"{\\\"value\\\":0,\\\"destinationAlias\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"comment\\\":\\\"string\\\",\\\"sourceAccountId\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"value\\\":0,\\\"destinationAlias\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"comment\\\":\\\"string\\\",\\\"sourceAccountId\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/payment\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/payment\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"value\\\":0,\\\"destinationAlias\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"comment\\\":\\\"string\\\",\\\"sourceAccountId\\\":\\\"string\\\"}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/qrcode-static/{id}":{"get":{"tags":["pixQrCode"],"summary":"Get one Pix QrCode","parameters":[{"name":"id","in":"path","description":"pixQrCode ID, correlation ID or emv identifier","required":true,"schema":{"type":"string"},"examples":{"pixQrCodeId":{"value":"Q2hhcmdlOjYwM2U3NDlhNDI1NjAyYmJiZjRlN2JlZA=="},"correlationID":{"value":"fe7834b4060c488a9b0f89811be5f5cf"},"identifier":{"value":"zr7833b4060c488a9b0f89811"}}}],"responses":{"200":{"description":"The pixQrCode retrieve using the given ID","content":{"application/json":{"schema":{"type":"object","properties":{"pixQrCode":{"type":"object","$ref":"#/components/schemas/PixQrCode"}},"example":{"pixQrCode":{"name":"pix qrcode static","value":100,"comment":"pix qrcode static","correlationID":"fe7834b4060c488a9b0f89811be5f5cf","identifier":"zr7833b4060c488a9b0f89811","paymentLinkID":"7777-6f71-427a-bf00-241681624586","paymentLinkUrl":"https://openpix.com.br/pay/fe7834b4060c488a9b0f89811be5f5cf","qrCodeImage":"https://api.openpix.com.br/openpix/charge/brcode/image/fe7834b4060c488a9b0f89811be5f5cf.png","brCode":"000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA","createdAt":"2021-03-02T17:28:51.882Z","updatedAt":"2021-03-02T17:28:51.882Z"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/qrcode-static/%7Bid%7D\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/qrcode-static/%7Bid%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/qrcode-static/%7Bid%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/qrcode-static/%7Bid%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/qrcode-static/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/qrcode-static/%7Bid%7D\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/qrcode-static/%7Bid%7D\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/qrcode-static":{"get":{"tags":["pixQrCode"],"summary":"Get a list of Pix QrCodes","responses":{"200":{"description":"A list of pixQrCodes","content":{"application/json":{"schema":{"type":"object","properties":{"pixQrCodes":{"type":"array","items":{"$ref":"#/components/schemas/PixQrCode"}},"pageInfo":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"skip":{"type":"number"},"limit":{"type":"number"}}}}}},"skip":{"type":"number"},"limit":{"type":"number"},"totalCount":{"type":"number"},"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}}}},"example":{"pageInfo":{"skip":0,"limit":10,"totalCount":20,"hasPreviousPage":false,"hasNextPage":true},"pixQrCodes":{"name":"pix qrcode","value":100,"comment":"good","correlationID":"9134e286-6f71-427a-bf00-241681624586","identifier":"zr7833b4060c488a9b0f89811","paymentLinkID":"7777a23s-6f71-427a-bf00-241681624586","paymentLinkUrl":"https://openpix.com.br/pay/9134e286-6f71-427a-bf00-241681624586","qrCodeImage":"https://api.openpix.com.br/openpix/pixQrCode/brcode/image/9134e286-6f71-427a-bf00-241681624586.png","brCode":"000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA","createdAt":"2021-03-02T17:28:51.882Z","updatedAt":"2021-03-02T17:28:51.882Z"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/qrcode-static\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/qrcode-static \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/qrcode-static\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/qrcode-static\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/qrcode-static\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/qrcode-static\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/qrcode-static\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]},"post":{"tags":["pixQrCode"],"summary":"Create a new Pix QrCode Static","description":"Endpoint to create a new Pix QrCode Static","requestBody":{"description":"Data to create a new Pix QrCode Static","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PixQrCodePayload"},"example":{"correlationID":"9134e286-6f71-427a-bf00-241681624586","value":100,"comment":"good","identifier":"zr7833b4060c488a9b0f89811"}}}},"responses":{"200":{"description":"PixQrCode ID and also the generated Dynamic BR Code to be rendered as a QRCode","content":{"application/json":{"schema":{"type":"object","properties":{"pixQrCode":{"$ref":"#/components/schemas/PixQrCode"},"correlationID":{"type":"string"},"brCode":{"type":"string"}},"example":{"pixQrCode":{"value":100,"comment":"good","correlationID":"9134e286-6f71-427a-bf00-241681624586","identifier":"zr7833b4060c488a9b0f89811","paymentLinkID":"7777a23s-6f71-427a-bf00-241681624586","paymentLinkUrl":"https://openpix.com.br/pay/9134e286-6f71-427a-bf00-241681624586","qrCodeImage":"https://api.openpix.com.br/openpix/pixQrCode/brcode/image/9134e286-6f71-427a-bf00-241681624586.png","createdAt":"2021-03-02T17:28:51.882Z","updatedAt":"2021-03-02T17:28:51.882Z","brCode":"000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/qrcode-static\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n name: 'string',\n correlationID: 'string',\n value: 0,\n comment: 'string',\n identifier: 'string'\n}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/qrcode-static \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"name\":\"string\",\"correlationID\":\"string\",\"value\":0,\"comment\":\"string\",\"identifier\":\"string\"}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/qrcode-static\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"name\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\"}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"name\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/qrcode-static\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/qrcode-static\"\n\n\tpayload := strings.NewReader(\"{\\\"name\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"name\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/qrcode-static\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/qrcode-static\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"name\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\"}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/refund/{id}":{"get":{"tags":["refund"],"summary":"Get one refund","parameters":[{"name":"id","in":"path","description":"refund ID or correlation ID","required":true,"schema":{"type":"string"},"examples":{"id":{"value":"Q2hhcmdlOjYwM2U3NDlhNDI1NjAyYmJiZjRlN2JlZA=="},"correlationID":{"value":"fe7834b4060c488a9b0f89811be5f5cf"}}}],"responses":{"200":{"description":"The refund retrieve using the given ID","content":{"application/json":{"schema":{"type":"object","properties":{"pixTransactionRefund":{"type":"object","$ref":"#/components/schemas/Refund"}},"example":{"pixTransactionRefund":{"value":100,"correlationID":"7777-6f71-427a-bf00-241681624586","refundId":"11bf5b37e0b842e08dcfdc8c4aefc000","returnIdentification":"D09089356202108032000a543e325902","comment":"Comentário do reembolso"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/refund/%7Bid%7D\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/refund/%7Bid%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/refund/%7Bid%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/refund/%7Bid%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/refund/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/refund/%7Bid%7D\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/refund/%7Bid%7D\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/refund":{"get":{"tags":["refund"],"summary":"Get a list of refunds","responses":{"200":{"description":"A list of refunds","content":{"application/json":{"schema":{"type":"object","properties":{"refunds":{"type":"array","items":{"$ref":"#/components/schemas/Refund"}},"pageInfo":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"skip":{"type":"number"},"limit":{"type":"number"}}}}}},"skip":{"type":"number"},"limit":{"type":"number"},"totalCount":{"type":"number"},"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}}}},"example":{"pageInfo":{"skip":0,"limit":10,"totalCount":20,"hasPreviousPage":false,"hasNextPage":true},"refunds":[{"status":"IN_PROCESSING","value":100,"correlationID":"9134e286-6f71-427a-bf00-241681624586","refundId":"9134e2866f71427abf00241681624586","time":"2021-03-02T17:28:51.882Z","comment":"Comentário do reembolso"}]}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/refund\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/refund \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/refund\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/refund\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/refund\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/refund\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/refund\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]},"post":{"tags":["refund"],"summary":"Create a new refund","description":"Endpoint to create a new refund for a customer","requestBody":{"description":"Data to create a new refund","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/RefundPayload"},"example":{"transactionEndToEndId":"9134e286-6f71-427a-bf00-241681624586","correlationID":"9134e286-6f71-427a-bf00-241681624586","value":100,"comment":"Comentário do reembolso"}}}},"responses":{"200":{"description":"The created Refund","content":{"application/json":{"schema":{"type":"object","properties":{"refund":{"$ref":"#/components/schemas/Refund"}},"example":{"refund":{"status":"IN_PROCESSING","value":100,"correlationID":"9134e286-6f71-427a-bf00-241681624586","refundId":"9134e2866f71427abf00241681624586","time":"2021-03-02T17:28:51.882Z","comment":"Comentário do reembolso"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/refund\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n value: 0,\n transactionEndToEndId: 'string',\n correlationID: 'string',\n comment: 'string'\n}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/refund \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"value\":0,\"transactionEndToEndId\":\"string\",\"correlationID\":\"string\",\"comment\":\"string\"}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/refund\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"value\\\":0,\\\"transactionEndToEndId\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"comment\\\":\\\"string\\\"}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"value\\\":0,\\\"transactionEndToEndId\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"comment\\\":\\\"string\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/refund\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/refund\"\n\n\tpayload := strings.NewReader(\"{\\\"value\\\":0,\\\"transactionEndToEndId\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"comment\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"value\\\":0,\\\"transactionEndToEndId\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"comment\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/refund\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/refund\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"value\\\":0,\\\"transactionEndToEndId\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"comment\\\":\\\"string\\\"}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/subscriptions/{id}":{"get":{"tags":["subscription"],"summary":"Get one subscription","parameters":[{"name":"id","in":"path","description":"The globalID of the subscription.","required":true,"schema":{"type":"string"},"example":"UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM="}],"responses":{"200":{"description":"The subscription retrieved using the given ID","content":{"application/json":{"schema":{"type":"object","properties":{"subscription":{"type":"object","$ref":"#/components/schemas/Subscription"}},"example":{"subscription":{"globalID":"UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM=","customer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"}},"value":100,"dayGenerateCharge":5}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/subscriptions/UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM=\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/subscriptions/UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM= \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/subscriptions/UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM=\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/subscriptions/UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM=\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/subscriptions/UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM=\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/subscriptions/UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM=\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/subscriptions/UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM=\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/subscriptions":{"post":{"tags":["subscription"],"summary":"Create a new Subscription","description":"Endpoint to create a new Subcription","requestBody":{"description":"Data to create a new Subscription","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/SubscriptionPayload"},"examples":{"Subscription":{"value":{"value":100,"customer":{"name":"Dan","taxID":"31324227036","email":"email0@example.com","phone":"5511999999999"},"dayGenerateCharge":15}},"Subscription with Interests and Fines":{"value":{"value":100,"customer":{"name":"Dan","taxID":"31324227036","email":"email0@example.com","phone":"5511999999999","address":{"zipcode":"30421322","street":"Street","number":"100","neighborhood":"Neighborhood","city":"Belo Horizonte","state":"MG","complement":"APTO","country":"BR"}},"dayGenerateCharge":15,"chargeType":"OVERDUE"}}}}}},"responses":{"200":{"description":"The subscription created","content":{"application/json":{"schema":{"type":"object","properties":{"subscription":{"$ref":"#/components/schemas/Subscription"}},"example":{"subscription":{"globalID":"UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM=","customer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"}},"value":100,"dayGenerateCharge":5}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/subscriptions\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\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: 0,\n comment: 'string',\n additionalInfo: [{key: 'string', value: 'string'}],\n dayGenerateCharge: 5,\n chargeType: 'DYNAMIC',\n dayDue: 7\n}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/subscriptions \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"customer\":{\"name\":\"string\",\"email\":\"string\",\"phone\":\"string\",\"taxID\":\"string\",\"address\":{\"zipcode\":\"string\",\"street\":\"string\",\"number\":\"string\",\"neighborhood\":\"string\",\"city\":\"string\",\"state\":\"string\",\"complement\":\"string\",\"country\":\"string\"}},\"value\":0,\"comment\":\"string\",\"additionalInfo\":[{\"key\":\"string\",\"value\":\"string\"}],\"dayGenerateCharge\":5,\"chargeType\":\"DYNAMIC\",\"dayDue\":7}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/subscriptions\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"value\\\":0,\\\"comment\\\":\\\"string\\\",\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"dayGenerateCharge\\\":5,\\\"chargeType\\\":\\\"DYNAMIC\\\",\\\"dayDue\\\":7}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"value\\\":0,\\\"comment\\\":\\\"string\\\",\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"dayGenerateCharge\\\":5,\\\"chargeType\\\":\\\"DYNAMIC\\\",\\\"dayDue\\\":7}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/subscriptions\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/subscriptions\"\n\n\tpayload := strings.NewReader(\"{\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"value\\\":0,\\\"comment\\\":\\\"string\\\",\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"dayGenerateCharge\\\":5,\\\"chargeType\\\":\\\"DYNAMIC\\\",\\\"dayDue\\\":7}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"value\\\":0,\\\"comment\\\":\\\"string\\\",\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"dayGenerateCharge\\\":5,\\\"chargeType\\\":\\\"DYNAMIC\\\",\\\"dayDue\\\":7}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/subscriptions\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/subscriptions\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"value\\\":0,\\\"comment\\\":\\\"string\\\",\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}],\\\"dayGenerateCharge\\\":5,\\\"chargeType\\\":\\\"DYNAMIC\\\",\\\"dayDue\\\":7}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/transaction/{id}":{"get":{"tags":["transactions"],"summary":"Get a Transaction","parameters":[{"name":"id","in":"path","description":"you can use the transaction id from openpix or the endToEndId of transaction from bank","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The transaction retrieve using the given ID","content":{"application/json":{"schema":{"type":"object","properties":{"transaction":{"type":"object","$ref":"#/components/schemas/Transaction"}}},"example":{"transaction":{"customer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"},"correlationID":"9134e286-6f71-427a-bf00-241681624586"},"payer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"},"correlationID":"9134e286-6f71-427a-bf00-241681624586"},"charge":{"status":"ACTIVE","customer":"603f81fcc6bccc24326ffb43","correlationID":"9134e286-6f71-427a-bf00-241681624586","createdAt":"2021-03-03T12:33:00.546Z","updatedAt":"2021-03-03T12:33:00.546Z"},"withdraw":{"value":100,"time":"2021-03-03T12:33:00.536Z","infoPagador":"payer info 1","endToEndId":"E18236120202012032010s01345689XBY","createdAt":"2021-03-03T12:33:00.546Z"},"infoPagador":"payer info 0","value":100,"time":"2021-03-03T12:33:00.536Z","transactionID":"transactionID","type":"PAYMENT","endToEndId":"E18236120202012032010s0133872GZA","globalID":"UGl4VHJhbnNhY3Rpb246NzE5MWYxYjAyMDQ2YmY1ZjUzZGNmYTBi"}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/transaction/%7Bid%7D\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/transaction/%7Bid%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/transaction/%7Bid%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/transaction/%7Bid%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/transaction/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/transaction/%7Bid%7D\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/transaction/%7Bid%7D\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/transaction":{"parameters":[{"in":"query","name":"start","schema":{"$ref":"#/components/schemas/Start"}},{"in":"query","name":"end","schema":{"$ref":"#/components/schemas/End"}},{"in":"query","name":"charge","description":"You can use the charge ID or correlation ID or transaction ID of charge to get a list of transactions related of this transaction","schema":{"type":"string"},"example":"Q2hhcmdlOjYwM2U3NDlhNDI1NjAyYmJiZjRlN2JlZA"},{"in":"query","name":"pixQrCode","description":"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","schema":{"type":"string"},"example":"Q2hhcmdlOjYwM2U3NDlhNDI1NjAyYmJiZjRlN2JlZA"},{"in":"query","name":"withdrawal","description":"You can use the ID or EndToEndId of a withdrawal transaction to get all transactions related to the withdrawal","schema":{"type":"string"},"example":"Q2hhcmdlOjYwM2U3NDlhNDI1NjAyYmJiZjRlN2JlZA"}],"get":{"tags":["transactions"],"summary":"Get a list of transactions","responses":{"200":{"description":"A list of transactions","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"}},"pageInfo":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"skip":{"type":"number"},"limit":{"type":"number"}}}}}},"skip":{"type":"number"},"limit":{"type":"number"},"totalCount":{"type":"number"},"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}}}}},"example":{"pageInfo":{"skip":0,"limit":10,"totalCount":20,"hasPreviousPage":false,"hasNextPage":true},"transactions":{"customer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"},"correlationID":"9134e286-6f71-427a-bf00-241681624586"},"payer":{"name":"Dan","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31324227036","type":"BR:CPF"},"correlationID":"9134e286-6f71-427a-bf00-241681624586"},"charge":{"status":"ACTIVE","customer":"603f81fcc6bccc24326ffb43","correlationID":"9134e286-6f71-427a-bf00-241681624586","createdAt":"2021-03-03T12:33:00.546Z","updatedAt":"2021-03-03T12:33:00.546Z"},"withdraw":{"value":100,"time":"2021-03-03T12:33:00.536Z","infoPagador":"payer info 1","endToEndId":"E18236120202012032010s01345689XBY"},"type":"PAYMENT","infoPagador":"payer info 0","value":100,"time":"2021-03-03T12:33:00.536Z","transactionID":"transactionID","endToEndId":"E18236120202012032010s0133872GZA"}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/transaction\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/transaction \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/transaction\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/transaction\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/transaction\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/transaction\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/transaction\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/transfer":{"post":{"tags":["transfer (request access)"],"summary":"Create a Transfer","description":"Endpoint to to transfer values between sub accounts","requestBody":{"description":"Data to create a transfer","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/TransferCreatePayload"},"example":{"value":100,"fromPixKey":"from@openpix.com.br","toPixKey":"to@openpix.com.br"}}}},"responses":{"200":{"description":"Transfer transaction information","content":{"application/json":{"schema":{"type":"object","properties":{"transaction":{"$ref":"#/components/schemas/TransferTransaction"}},"example":{"transaction":{"value":100,"time":"2023-06-22T15:33:27.165Z,","correlationID":"c782e0ac-833d-4a89-9e73-9b60b2b41d3a"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/transfer\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({value: 0, fromPixKey: 'string', toPixKey: 'string'}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/transfer \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"value\":0,\"fromPixKey\":\"string\",\"toPixKey\":\"string\"}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/transfer\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"value\\\":0,\\\"fromPixKey\\\":\\\"string\\\",\\\"toPixKey\\\":\\\"string\\\"}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"value\\\":0,\\\"fromPixKey\\\":\\\"string\\\",\\\"toPixKey\\\":\\\"string\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/transfer\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/transfer\"\n\n\tpayload := strings.NewReader(\"{\\\"value\\\":0,\\\"fromPixKey\\\":\\\"string\\\",\\\"toPixKey\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"value\\\":0,\\\"fromPixKey\\\":\\\"string\\\",\\\"toPixKey\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/transfer\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/transfer\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"value\\\":0,\\\"fromPixKey\\\":\\\"string\\\",\\\"toPixKey\\\":\\\"string\\\"}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/webhook/{id}":{"delete":{"tags":["webhook"],"summary":"Delete a Webhook","description":"Endpoint to delete a Webhook","parameters":[{"name":"id","in":"path","description":"webhook ID","required":true,"schema":{"type":"string"},"examples":{"webhookID":{"value":"Q2hhcmdlOjYwM2U3NDlhNDI1NjAyYmJiZjRlN2JlZA=="},"id":{"value":"fe7834b4060c488a9b0f89811be5f5cf"}}}],"responses":{"200":{"description":"Webhook ID and also the status code","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"status":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/webhook/%7Bid%7D\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request DELETE \\\n --url https://api.woovi.com/api/v1/webhook/%7Bid%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/webhook/%7Bid%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"DELETE\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"DELETE\", \"/api/v1/webhook/%7Bid%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/webhook/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/webhook/%7Bid%7D\")\n .delete(null)\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/webhook/%7Bid%7D\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Delete.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/webhook":{"get":{"parameters":[{"in":"query","name":"url","description":"You can use the url to filter all webhooks","schema":{"type":"string"},"example":"https://mycompany.com.br/webhook"}],"tags":["webhook"],"summary":"Get a list of webhooks","responses":{"200":{"description":"A list of webhooks","content":{"application/json":{"schema":{"type":"object","properties":{"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"}},"pageInfo":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"skip":{"type":"number"},"limit":{"type":"number"}}}}}}}}},"example":{"pageInfo":{"skip":0,"limit":100,"totalCount":2,"hasPreviousPage":false,"hasNextPage":true},"webhooks":[{"id":"V2ViaG9vazo2MDNlYmUxZWRlYjkzNWU4NmQyMmNmMTg=","name":"webhookName","url":"https://mycompany.com.br/webhook","authorization":"openpix","event":"OPENPIX:TRANSACTION_RECEIVED","isActive":true,"createdAt":"2021-03-02T22:29:10.720Z","updatedAt":"2021-03-02T22:29:10.720Z"},{"id":"V2ViaG9vazo2MDNlYmUxZWRlYjkzNWU4NmQyMmNmOTk=","name":"webhookName","url":"https://mycompany.com.br/webhook","authorization":"openpix","event":"OPENPIX:CHARGE_CREATED","isActive":true,"createdAt":"2021-03-02T22:29:10.720Z","updatedAt":"2021-03-02T22:29:10.720Z"}]}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/webhook?url=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.woovi.com/api/v1/webhook?url=SOME_STRING_VALUE' \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/webhook?url=SOME_STRING_VALUE\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/webhook?url=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/webhook?url=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/webhook?url=SOME_STRING_VALUE\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/webhook?url=SOME_STRING_VALUE\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]},"post":{"tags":["webhook"],"summary":"Create a new Webhook","description":"Endpoint to create a new Webhook","requestBody":{"description":"Data to create a new webhook","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"webhook":{"type":"object","$ref":"#/components/schemas/WebhookPayload"}},"example":{"webhook":{"name":"webhookName","event":"OPENPIX:CHARGE_CREATED","url":"https://mycompany.com.br/webhook","authorization":"openpix","isActive":true}}}}}},"responses":{"200":{"description":"Webhook created specific event when receives a new pix transaction","content":{"application/json":{"schema":{"type":"object","properties":{"webhook":{"type":"object","$ref":"#/components/schemas/Webhook"}},"example":{"webhook":{"id":"V2ViaG9vazo2MDNlYmUxZWRlYjkzNWU4NmQyMmNmMTg=","name":"webhookName","url":"https://mycompany.com.br/webhook","authorization":"openpix","isActive":true,"event":"OPENPIX:TRANSACTION_RECEIVED","createdAt":"2021-03-02T22:29:10.720Z","updatedAt":"2021-03-02T22:29:10.720Z"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"callbacks":{"receivedPix":{"{$request.body#/webhook.url}":{"post":{"description":"Pix - O callback vai ser acionado sempre que um Pix for recebido enviando uma charge e um pix\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"charge":{"type":"object","$ref":"#/components/schemas/Charge"},"pix":{"type":"object","properties":{"pixQrCode":{"type":"object","$ref":"#/components/schemas/PixQrCode"},"charge":{"type":"object","$ref":"#/components/schemas/Charge"},"customer":{"type":"object","$ref":"#/components/schemas/Customer"},"payer":{"type":"object","$ref":"#/components/schemas/Customer"},"time":{"type":"string"},"value":{"type":"string"},"transactionID":{"type":"string"},"infoPagador":{"type":"string"},"raw":{"type":"object","properties":{"endToEndId":{"type":"string"},"txid":{"type":"string"},"valor":{"type":"string"},"horario":{"type":"string"},"infoPagador":{"type":"string"}}}}},"pixQrCode":{"type":"object"}},"example":{"charge":{"status":"COMPLETED","customer":{"name":"Julio","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31928282008","type":"BR:CPF"},"correlationID":"9134e286-6f71-427a-bf00-241681624586"},"correlationID":"9134e286-6f71-427a-bf00-241681624586","transactionID":"9134e2866f71427abf00241681624586","brCode":"000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA","createdAt":"2021-03-03T20:49:23.605Z","updatedAt":"2021-03-03T20:49:23.668Z"},"pix":{"pixQrCode":null,"charge":{"status":"COMPLETED","customer":"604002035cce3b60132343cb","correlationID":"9134e286-6f71-427a-bf00-241681624586","brCode":"000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA","createdAt":"2021-03-03T21:39:15.831Z","updatedAt":"2021-03-03T21:39:15.896Z"},"customer":{"name":"Julio","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31928282008","type":"BR:CPF"},"correlationID":"9134e286-6f71-427a-bf00-241681624586"},"payer":{"name":"Julio","email":"email0@example.com","phone":"5511999999999","taxID":{"taxID":"31928282008","type":"BR:CPF"},"correlationID":"9134e286-6f71-427a-bf00-241681624586"},"time":"2020-09-09T20:15:00.358Z","value":9999,"transactionID":"9134e2866f71427abf00241681624586","infoPagador":"conta","raw":{"endToEndId":"9134e2866f71427abf00241681624586","txid":"9134e2866f71427abf00241681624586","valor":"99.99","horario":"2020-09-09T20:15:00.358Z","infoPagador":"conta"}},"pixQrCode":null}}}}},"responses":{"200":{"description":"Notificação recebida com sucesso"}}}}},"receivedPixDetached":{"{$request.body#/webhook.url}":{"post":{"description":"Pix Avulso - O callback vai ser acionado sempre que um Pix for recebido devolvendo um pix avulso\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"charge":{"type":"object"},"pix":{"type":"object","properties":{"pixQrCode":{"type":"object","$ref":"#/components/schemas/PixQrCode"},"charge":{"type":"object","$ref":"#/components/schemas/Charge"},"customer":{"type":"object","$ref":"#/components/schemas/Customer"},"payer":{"type":"object","$ref":"#/components/schemas/Customer"},"time":{"type":"string"},"value":{"type":"string"},"transactionID":{"type":"string"},"infoPagador":{"type":"string"},"raw":{"type":"object","properties":{"endToEndId":{"type":"string"},"txid":{"type":"string"},"valor":{"type":"string"},"horario":{"type":"string"},"infoPagador":{"type":"string"}}}}},"pixQrCode":{"type":"object"}},"example":{"charge":null,"pix":{"pixQrCode":null,"charge":null,"customer":null,"time":"2020-09-09T20:15:00.358Z","value":9999,"transactionID":"9134e2866f71427abf00241681624586","infoPagador":"conta","raw":{"endToEndId":"9134e2866f71427abf00241681624586","txid":"9134e2866f71427abf00241681624586","valor":"99.99","horario":"2020-09-09T20:15:00.358Z","infoPagador":"conta"}}}}}}},"responses":{"200":{"description":"Notificação recebida com sucesso"}}}}},"receivedPixQrCode":{"{$request.body#/webhook.url}":{"post":{"description":"Pix QrCode - O callback vai ser acionado sempre que um Pix QrCOde for recebido devolvendo um pix e um pixQrCode\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"charge":{"type":"object"},"pix":{"type":"object","properties":{"pixQrCode":{"type":"object","$ref":"#/components/schemas/PixQrCode"},"charge":{"type":"object","$ref":"#/components/schemas/Charge"},"payer":{"type":"object","$ref":"#/components/schemas/Customer"},"time":{"type":"string"},"value":{"type":"string"},"transactionID":{"type":"string"},"infoPagador":{"type":"string"},"raw":{"type":"object","properties":{"endToEndId":{"type":"string"},"txid":{"type":"string"},"valor":{"type":"string"},"horario":{"type":"string"},"infoPagador":{"type":"string"}}}}},"pixQrCode":{"type":"object","$ref":"#/components/schemas/PixQrCode"}},"example":{"charge":null,"pix":{"pixQrCode":{"value":100,"comment":"good","correlationID":"9134e286-6f71-427a-bf00-241681624586","identifier":"9134e2866f71427abf00241681624586","paymentLinkID":"7777a23s-6f71-427a-bf00-241681624586","paymentLinkUrl":"https://openpix.com.br/pay/9134e286-6f71-427a-bf00-241681624586","qrCodeImage":"https://api.openpix.com.br/openpix/pixQrCode/brcode/image/9134e286-6f71-427a-bf00-241681624586.png","createdAt":"2021-03-02T17:28:51.882Z","updatedAt":"2021-03-02T17:28:51.882Z","brCode":"000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA"},"customer":null,"time":"2020-09-09T20:15:00.358Z","value":9999,"transactionID":"9134e2866f71427abf00241681624586","infoPagador":"conta","raw":{"endToEndId":"9134e2866f71427abf00241681624586","txid":"9134e2866f71427abf00241681624586","valor":"99.99","horario":"2020-09-09T20:15:00.358Z","infoPagador":"conta"}}}}}}},"responses":{"200":{"description":"Notificação recebida com sucesso"}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/webhook\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n webhook: {\n name: 'webhookName',\n event: 'OPENPIX:CHARGE_CREATED',\n url: 'https://mycompany.com.br/webhook',\n authorization: 'openpix',\n isActive: true\n }\n}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/webhook \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"webhook\":{\"name\":\"webhookName\",\"event\":\"OPENPIX:CHARGE_CREATED\",\"url\":\"https://mycompany.com.br/webhook\",\"authorization\":\"openpix\",\"isActive\":true}}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/webhook\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"webhook\\\":{\\\"name\\\":\\\"webhookName\\\",\\\"event\\\":\\\"OPENPIX:CHARGE_CREATED\\\",\\\"url\\\":\\\"https://mycompany.com.br/webhook\\\",\\\"authorization\\\":\\\"openpix\\\",\\\"isActive\\\":true}}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"webhook\\\":{\\\"name\\\":\\\"webhookName\\\",\\\"event\\\":\\\"OPENPIX:CHARGE_CREATED\\\",\\\"url\\\":\\\"https://mycompany.com.br/webhook\\\",\\\"authorization\\\":\\\"openpix\\\",\\\"isActive\\\":true}}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/webhook\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/webhook\"\n\n\tpayload := strings.NewReader(\"{\\\"webhook\\\":{\\\"name\\\":\\\"webhookName\\\",\\\"event\\\":\\\"OPENPIX:CHARGE_CREATED\\\",\\\"url\\\":\\\"https://mycompany.com.br/webhook\\\",\\\"authorization\\\":\\\"openpix\\\",\\\"isActive\\\":true}}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"webhook\\\":{\\\"name\\\":\\\"webhookName\\\",\\\"event\\\":\\\"OPENPIX:CHARGE_CREATED\\\",\\\"url\\\":\\\"https://mycompany.com.br/webhook\\\",\\\"authorization\\\":\\\"openpix\\\",\\\"isActive\\\":true}}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/webhook\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/webhook\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"webhook\\\":{\\\"name\\\":\\\"webhookName\\\",\\\"event\\\":\\\"OPENPIX:CHARGE_CREATED\\\",\\\"url\\\":\\\"https://mycompany.com.br/webhook\\\",\\\"authorization\\\":\\\"openpix\\\",\\\"isActive\\\":true}}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/openpix/charge/brcode/image/{:id}.png?size=1024":{"get":{"tags":["charge"],"summary":"Get an image of Qr Code from a Charge","parameters":[{"in":"path","name":"id","description":"charge link payment ID","required":true,"schema":{"type":"string"},"examples":{"paymentLinkID":{"value":"fe7834b4060c488a9b0f89811be5f5cf"}}},{"in":"query","name":"size","description":"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.","required":false,"schema":{"type":"string"},"examples":{"size":{"value":768}}}],"responses":{"200":{"description":"The Qr Code image as MIME type"},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/openpix/charge/brcode/image/%7B:id%7D.png?size=1024\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.woovi.com/openpix/charge/brcode/image/%7B:id%7D.png?size=1024' \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/openpix/charge/brcode/image/%7B:id%7D.png?size=1024\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/openpix/charge/brcode/image/%7B:id%7D.png?size=1024\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/openpix/charge/brcode/image/%7B:id%7D.png?size=1024\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/openpix/charge/brcode/image/%7B:id%7D.png?size=1024\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/openpix/charge/brcode/image/%7B:id%7D.png?size=1024\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/subaccount/{id}/withdraw":{"post":{"tags":["sub account (request access)"],"summary":"Withdraw from a Sub Account","description":"Withdraw from a Sub Account and return the withdrawal transaction information","parameters":[{"name":"id","in":"path","description":"pix key registered to the subaccount","required":true,"schema":{"type":"string"},"example":"destination@test.com"}],"responses":{"200":{"description":"Withdrawal Transaction information","content":{"application/json":{"schema":{"type":"object","properties":{"withdraw":{"type":"object","properties":{"account":{"type":"object","$ref":"#/components/schemas/transaction"}}}}},"example":{"transaction":{"status":"CREATED","value":100,"correlationID":"TESTING1323","destinationAlias":"pixKeyTest@test.com","comment":"testing-transaction"}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/subaccount/destination@test.com/withdraw\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/subaccount/destination@test.com/withdraw \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/subaccount/destination@test.com/withdraw\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"POST\", \"/api/v1/subaccount/destination@test.com/withdraw\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/subaccount/destination@test.com/withdraw\"\n\n\treq, _ := http.NewRequest(\"POST\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/subaccount/destination@test.com/withdraw\")\n .post(null)\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/subaccount/destination@test.com/withdraw\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/subaccount/{id}":{"get":{"tags":["sub account (request access)"],"summary":"Get subaccount details","parameters":[{"name":"id","in":"path","description":"pix key registered to the subaccount","required":true,"schema":{"type":"string"},"examples":{"id":{"value":"c4249323-b4ca-43f2-8139-8232aab09b93"}}}],"responses":{"200":{"description":"The Subccount retrieve using the given pix key","content":{"application/json":{"schema":{"type":"object","properties":{"SubAccount":{"type":"object","$ref":"#/components/schemas/SubAccount"}},"example":{"SubAccount":{"name":"test-sub-account","pixKey":"c4249323-b4ca-43f2-8139-8232aab09b93","balance":100}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/subaccount/%7Bid%7D\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/subaccount/%7Bid%7D \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/subaccount/%7Bid%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/subaccount/%7Bid%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/subaccount/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/subaccount/%7Bid%7D\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/subaccount/%7Bid%7D\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/subaccount":{"get":{"tags":["sub account (request access)"],"summary":"Get a list of subaccounts","responses":{"200":{"description":"A list of subaccounts","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"subaccounts":{"type":"array","items":{"type":"object","properties":{"payment":{"type":"object","$ref":"#/components/schemas/SubAccount"}}}},"pageInfo":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"skip":{"type":"number"},"limit":{"type":"number"}}}}}},"skip":{"type":"number"},"limit":{"type":"number"},"totalCount":{"type":"number"},"hasPreviousPage":{"type":"boolean"},"hasNextPage":{"type":"boolean"}}}}},"example":{"subAccounts":{"subaccount":{"name":"test-sub-account","pixKey":"c4249323-b4ca-43f2-8139-8232aab09b93","balance":100}},"pageInfo":{"skip":0,"limit":10,"totalCount":20,"hasPreviousPage":false,"hasNextPage":true}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/subaccount\",\n \"headers\": {\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.woovi.com/api/v1/subaccount \\\n --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/subaccount\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\nheaders = { 'Authorization': \"REPLACE_KEY_VALUE\" }\n\nconn.request(\"GET\", \"/api/v1/subaccount\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/subaccount\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/subaccount\")\n .get()\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/subaccount\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\n\nresponse = http.request(request)\nputs response.read_body"}]},"post":{"tags":["sub account (request access)"],"summary":"Create a subaccount","requestBody":{"description":"Data to create a new subAccount or retrieve existing one","required":true,"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/SubAccountPayload"},"examples":{"SubAccount":{"value":{"pixKey":"9134e286-6f71-427a-bf00-241681624587","name":"Test Account"}}}}}},"responses":{"200":{"description":"The Subccount created or retrieved if exists using the given pix key","content":{"application/json":{"schema":{"type":"object","properties":{"SubAccount":{"type":"object","$ref":"#/components/schemas/SubAccount"}},"example":{"SubAccount":{"name":"test-sub-account","pixKey":"c4249323-b4ca-43f2-8139-8232aab09b93"}}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.woovi.com\",\n \"port\": null,\n \"path\": \"/api/v1/subaccount\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"Authorization\": \"REPLACE_KEY_VALUE\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({pixKey: 'string', name: 'string'}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.woovi.com/api/v1/subaccount \\\n --header 'Authorization: REPLACE_KEY_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"pixKey\":\"string\",\"name\":\"string\"}'"},{"lang":"Php + Curl","source":" \"https://api.woovi.com/api/v1/subaccount\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"pixKey\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\"}\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: REPLACE_KEY_VALUE\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.woovi.com\")\n\npayload = \"{\\\"pixKey\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\"}\"\n\nheaders = {\n 'content-type': \"application/json\",\n 'Authorization': \"REPLACE_KEY_VALUE\"\n }\n\nconn.request(\"POST\", \"/api/v1/subaccount\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.woovi.com/api/v1/subaccount\"\n\n\tpayload := strings.NewReader(\"{\\\"pixKey\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"pixKey\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://api.woovi.com/api/v1/subaccount\")\n .post(body)\n .addHeader(\"content-type\", \"application/json\")\n .addHeader(\"Authorization\", \"REPLACE_KEY_VALUE\")\n .build();\n\nResponse response = client.newCall(request).execute();"},{"lang":"Ruby + Native","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI(\"https://api.woovi.com/api/v1/subaccount\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"pixKey\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\"}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}}},"components":{"schemas":{"CompanyBankAccount":{"type":"object","properties":{"accountId":{"type":"string","description":"ID of the Account"},"isDefault":{"type":"boolean"},"balance":{"type":"object","properties":{"total":{"type":"number","description":"Total amount in cents"},"blocked":{"type":"number","description":"Blocked amount in cents"},"available":{"type":"number","description":"Available amount in cents"}}}}},"WithdrawTransaction":{"type":"object","properties":{"endToEndId":{"type":"string","description":"ID of the Withdraw Transaction"},"value":{"type":"string"}}},"Charge":{"type":"object","properties":{"value":{"type":"number"},"customer":{"type":"object","$ref":"#/components/schemas/Customer"},"type":{"type":"string","enum":["DYNAMIC","OVERDUE"],"description":"Charge type is used to determine whether a charge will have a deadline, fines and interests"},"comment":{"type":"string"},"brCode":{"type":"string","description":"EMV BRCode to be rendered as a QRCode"},"status":{"type":"string","enum":["ACTIVE","COMPLETED","EXPIRED"]},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this charge"},"paymentLinkID":{"type":"string","description":"Payment Link ID, used on payment link and to retrieve qrcode image"},"paymentLinkUrl":{"description":"Payment Link URL to be shared with customers"},"globalID":{"description":"External ID of this charge"},"transactionID":{"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."},"identifier":{"type":"string","description":"Custom identifier for EMV"},"qrCodeImage":{"description":"QRCode image link URL"},"additionalInfo":{"description":"Additional info of the charge","type":"array","items":{"type":"object","properties":{"key":{"description":"key of object","type":"string"},"value":{"description":"value of object","type":"string"}}}},"pixKey":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"expiresIn":{"type":"string"}}},"ChargePayload":{"type":"object","properties":{"correlationID":{"type":"string","description":"Your correlation ID to keep track of this charge"},"value":{"type":"number","description":"Value in cents of this charge"},"type":{"type":"string","enum":["DYNAMIC","OVERDUE"],"description":"Charge type is used to determine whether a charge will have a deadline, fines and interests"},"comment":{"type":"string","description":"Comment to be added in infoPagador"},"identifier":{"type":"string","description":"Custom identifier for EMV"},"expiresIn":{"type":"number","description":"Expires the charge in seconds (minimum is 15 minutes)"},"customer":{"type":"object","$ref":"#/components/schemas/CustomerPayload"},"daysForDueDate":{"type":"number","description":"Time in days until the charge hits the deadline so fines and interests start applying. This property is only considered for charges of type OVERDUE"},"daysAfterDueDate":{"type":"number","description":"Time in days that a charge is still payable after the deadline. This property is only considered for charges of type OVERDUE"},"interests":{"description":"Interests configuration. This property is only considered for charges of type OVERDUE","type":"object","properties":{"value":{"type":"number","description":"Value in basis points of interests to be applied daily after the charge hits the deadline"}}},"fines":{"description":"Fines configuration. This property is only considered for charges of type OVERDUE","type":"object","properties":{"value":{"type":"number","description":"Value in basis points of fines to be applied when the charge hits the deadline"}}},"additionalInfo":{"type":"array","description":"Additional info of the charge","items":{"type":"object","properties":{"key":{"type":"string","description":"key of object"},"value":{"type":"string","description":"value of object"}}}},"enableCashbackPercentage":{"type":"boolean","description":"true to enable cashback and false to disable."},"enableCashbackExclusivePercentage":{"type":"boolean","description":"true to enable fidelity cashback and false to disable."}},"required":["correlationID","value"]},"ChargeRefund":{"type":"object","properties":{"value":{"type":"number","description":"Value in cents of this refund"},"status":{"type":"string","enum":["IN_PROCESSING","CONFIRMED","REJECTED"]},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this refund"},"endToEndId":{"type":"string","description":"The endToEndId of this refund"},"time":{"type":"string","description":"Time of this refund"},"comment":{"type":"string","description":"Comment of this refund"}}},"ChargeRefundPayload":{"type":"object","properties":{"correlationID":{"type":"string","description":"Your correlation ID to keep track for this refund"},"value":{"type":"number","description":"Value in cents for this refund"},"comment":{"type":"string","description":"Comment for this refund. Maximum length of 140 characters.","maximum":140}},"required":["correlationID"]},"Customer":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"taxID":{"type":"object","properties":{"taxID":{"type":"string"},"type":{"type":"string"}}},"correlationID":{"type":"string"},"address":{"type":"object","properties":{"zipcode":{"type":"string"},"street":{"type":"string"},"number":{"type":"string"},"neighborhood":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"complement":{"type":"string"},"country":{"type":"string"}}}}},"CustomerPayload":{"description":"Customer field is not required. However, if you decide to send it, you must send at least one of the following combinations, name + taxID or name + email or name + phone.","oneOf":[{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"taxID":{"type":"string"},"correlationID":{"type":"string"},"address":{"type":"object","properties":{"zipcode":{"type":"string"},"street":{"type":"string"},"number":{"type":"string"},"neighborhood":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"complement":{"type":"string"},"country":{"type":"string"}}}},"required":["name","taxID"]},{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"taxID":{"type":"string"},"correlationID":{"type":"string"},"address":{"type":"object","properties":{"zipcode":{"type":"string"},"street":{"type":"string"},"number":{"type":"string"},"neighborhood":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"complement":{"type":"string"},"country":{"type":"string"}}}},"required":["name","email"]},{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"taxID":{"type":"string"},"correlationID":{"type":"string"},"address":{"type":"object","properties":{"zipcode":{"type":"string"},"street":{"type":"string"},"number":{"type":"string"},"neighborhood":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"complement":{"type":"string"},"country":{"type":"string"}}}},"required":["name","phone"]}]},"End":{"type":"string","format":"date-time","title":"End Date","description":"End date used in the query. Complies with RFC 3339.","example":"2020-12-01T17:00:00Z"},"ApplicationEnumTypePayload":{"type":"string","description":"Type of the application that you want to register. Each of this has some kind of permissions.","enum":["API","PLUGIN","ORACLE"]},"TaxIDObjectPayload":{"type":"object","properties":{"taxID":{"type":"string","description":"The tax identifier of your account holder. This should be a raw string with only digits."},"type":{"type":"string","enum":["BR:CNPJ"]}}},"PreRegistrationUserObject":{"type":"object","properties":{"firstName":{"type":"string","description":"The user's first name.\nIf the pre registration has been approved, this will be turn the company's first user first name.\n"},"lastName":{"type":"string","description":"The user's last name.\nIf the pre registration has been approved, this will be turn the company's first user last name.\n"},"email":{"type":"string","description":"The user's email.\nIt'll be the email that will entered in contact to validate that it's a real person (it's a step to approve the preregistration).\nAfter approving the preregistration, it'll be the company's user email.\n"},"phone":{"type":"string","description":"The user's phone number, need to be a validated phone number because it'll receive a SMS confirming that is a real person.\nWe're accept only values that matches the E.164 standard, that follows this pattern: [+][country code][local phone number].\n"}},"required":["firstName","lastName","email","phone"]},"PreRegistrationObject":{"type":"object","properties":{"name":{"type":"string","description":"The name of this preregistration. It'll be related as your company name too."},"website":{"type":"string","description":"A website that is related to this preregistration."},"taxID":{"$ref":"#/components/schemas/TaxIDObjectPayload"}},"required":["name","taxID"]},"PreRegistrationPayloadObject":{"type":"object","properties":{"preRegistration":{"$ref":"#/components/schemas/PreRegistrationObject"},"user":{"$ref":"#/components/schemas/PreRegistrationUserObject"}}},"AccountObjectPayload":{"type":"object","properties":{"clientId":{"type":"string","description":"The client ID from the company bank account that is related to this preregistration/company."}}},"CompanyObjectPayload":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the company that is related to this preregistration."},"name":{"type":"string","description":"The name of the company that is related to this preregistration."},"taxID":{"$ref":"#/components/schemas/TaxIDObjectPayload"}}},"PreRegistrationObjectPayload":{"type":"object","properties":{"name":{"type":"string","description":"When the preregistration will turn a company, this will be the name of the company that this preregistration is related."},"taxID":{"$ref":"#/components/schemas/TaxIDObjectPayload"}}},"PartnerApplicationPayload":{"type":"object","properties":{"name":{"type":"string","description":"The name that identifies your application."},"isActive":{"type":"boolean","description":"Current status of your application."},"type":{"$ref":"#/components/schemas/ApplicationEnumTypePayload"},"clientId":{"type":"string","description":"The ID of this client application."},"clientSecret":{"type":"string","description":"The secret of this client application."}}},"PaymentApprovePayload":{"type":"object","properties":{"correlationID":{"type":"string","description":"the correlation ID of the payment to be approved"}}},"PaymentCreatePayload":{"type":"object","properties":{"value":{"type":"number","description":"value of the requested payment in cents"},"destinationAlias":{"type":"string","description":"the pix key the payment should be sent to"},"correlationID":{"type":"string","description":"an unique identifier for your payment"},"comment":{"type":"string","description":"the comment that will be send alongisde your payment"},"sourceAccountId":{"type":"string","description":"an optional id for the source account of the payment, if not informed will assume the default account"}}},"Payment":{"type":"object","properties":{"value":{"type":"number","description":"value of the requested payment in cents"},"destinationAlias":{"type":"string","description":"the pix key the payment should be sent to"},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this payment"},"comment":{"type":"string","description":"the comment that will be send alongisde your payment"},"status":{"type":"string","description":"payment status","enum":["CREATED","FAILED","CONFIRMED","DENIED"]},"sourceAccountId":{"type":"string","description":"the id of the payment source account"}}},"PaymentTransaction":{"type":"object","properties":{"value":{"type":"number","description":"value of the transaction generated by the payment in cents"},"endToEndId":{"type":"string","description":"endToEndId of the transaction generated by the payment"},"time":{"type":"string","description":"time the transaction generated by the payment happened"}}},"PaymentDestination":{"type":"object","properties":{"name":{"type":"string","description":"the name of the payment destination"},"taxID":{"type":"string","description":"the tax id of the payment destination"},"pixKey":{"type":"string","description":"the pix key of the payment destination"},"bank":{"type":"string","description":"the payment destination bank name"},"branch":{"type":"string","description":"the payment destination bank branch"},"account":{"type":"string","description":"the payment destination bank account"}}},"PixQrCode":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"comment":{"type":"string"},"identifier":{"type":"string","description":"Custom identifier for EMV"},"brCode":{"type":"string","description":"EMV BRCode to be rendered as a Pix QRCode"},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this pix qrcode"},"paymentLinkID":{"type":"string","description":"Payment Link ID, used on payment link and to retrieve qrcode image"},"paymentLinkUrl":{"description":"Payment Link URL to be shared with customers"},"qrCodeImage":{"description":"QRCode image link URL"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"PixQrCodePayload":{"type":"object","properties":{"name":{"type":"string","description":"Name of this pix qrcode"},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this qrcode"},"value":{"type":"number","description":"Value in cents of this qrcode"},"comment":{"type":"string","description":"Comment to be added in infoPagador"},"identifier":{"type":"string","description":"Custom identifier for EMV"}},"required":["name","identifier"]},"Refund":{"type":"object","properties":{"value":{"type":"number"},"status":{"type":"string","enum":["IN_PROCESSING","REFUNDED","NOT_ACCOMPLISHED"]},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this refund"},"refundId":{"type":"string","description":"Unique refund ID for this pix refund"},"time":{"type":"string","description":"Time of this refund"},"comment":{"type":"string","description":"Comment of this refund"}}},"RefundPayload":{"type":"object","properties":{"value":{"type":"number"},"transactionEndToEndId":{"type":"string","description":"Your transaction ID, or endToEnd ID, to keep track of this refund"},"correlationID":{"type":"string","description":"Your correlation ID, unique identifier refund"},"comment":{"type":"string","description":"Comment of this refund. Maximum length of 140 characters.","maximum":140}}},"Start":{"type":"string","format":"date-time","title":"Start Date","description":"Start date used in the query. Complies with RFC 3339.","example":"2020-01-01T00:00:00Z"},"Subscription":{"type":"object","properties":{"globalID":{"type":"string","description":"The globalID of the subscription."},"value":{"type":"number","description":"Value in cents of the subscription"},"customer":{"type":"object","$ref":"#/components/schemas/Customer"},"dayGenerateCharge":{"type":"number","description":"Day of the month that the charges will be generated"}}},"SubscriptionPayload":{"type":"object","properties":{"customer":{"type":"object","description":"Customer of this subscription","properties":{"name":{"type":"string","description":"Customer name"},"email":{"type":"string","description":"Customer email"},"phone":{"type":"string","description":"Customer phone"},"taxID":{"type":"string","description":"Customer taxID (CPF or CNPJ)"},"address":{"type":"object","properties":{"zipcode":{"type":"string"},"street":{"type":"string"},"number":{"type":"string"},"neighborhood":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"complement":{"type":"string"},"country":{"type":"string"}}}}},"value":{"type":"number","description":"Value in cents of this subscription"},"comment":{"type":"string","description":"Comment to be added in infoPagador"},"additionalInfo":{"description":"Additional info of the charge","type":"array","items":{"type":"object","properties":{"key":{"description":"key of object","type":"string"},"value":{"description":"value of object","type":"string"}}}},"dayGenerateCharge":{"type":"number","description":"Day of the month that the charges will be generated. Maximun of 27.","minimum":0,"maximum":27,"default":5},"chargeType":{"type":"string","enum":["DYNAMIC","OVERDUE"],"description":"The charge type is used to determine whether charges generated by the subscription will have fines and interests","default":"DYNAMIC"},"dayDue":{"type":"number","minimum":3,"default":7,"description":"Days that the charge will take to expire from the generation day."}},"required":["customer","value"]},"Transaction":{"type":"object","properties":{"charge":{"type":"object","$ref":"#/components/schemas/Charge"},"value":{"type":"number"},"time":{"type":"string"},"endToEndID":{"type":"string"},"transactionID":{"type":"string"},"infoPagador":{"type":"string"},"endToEndId":{"type":"string"},"customer":{"type":"object","$ref":"#/components/schemas/Customer"},"withdraw":{"type":"object","$ref":"#/components/schemas/PixWithdrawTransaction"},"payer":{"type":"object","$ref":"#/components/schemas/Customer"},"type":{"type":"string","description":"Pix Transaction type","enum":["PAYMENT","WITHDRAW","REFUND","FEE"]},"globalID":{"description":"External ID of this transaction"},"pixQrCode":{"type":"object","$ref":"#/components/schemas/PixQrCode"}}},"PixWithdrawTransaction":{"type":"object","properties":{"value":{"type":"number"},"time":{"type":"string"},"endToEndID":{"type":"string"},"transactionID":{"type":"string"},"infoPagador":{"type":"string"},"endToEndId":{"type":"string"},"payer":{"type":"object","$ref":"#/components/schemas/Customer"},"type":{"type":"string"}}},"TransferCreatePayload":{"type":"object","properties":{"value":{"type":"number","description":"value of the transfer in cents"},"fromPixKey":{"type":"string","description":"the pix key of the account the value of the transfer will come out from"},"toPixKey":{"type":"string","description":"the pix key of the account the value of the transfer will go to"}}},"TransferTransaction":{"type":"object","properties":{"value":{"type":"number","description":"value of the transaction generated by the transfer"},"time":{"type":"string","description":"the time the transfer happened"},"correlationID":{"type":"string","description":"your correlation ID to keep track of this transfer"}}},"WebhookPayload":{"type":"object","properties":{"name":{"type":"string"},"event":{"type":"string","description":"The event to listen to. If omitted, the webhook will be registered to listen the OPENPIX:TRANSACTION_RECEIVED. Event called when a new pix transactions is received","$ref":"#/components/schemas/WebhookEventEnum"},"url":{"type":"string"},"authorization":{"type":"string"},"isActive":{"type":"boolean"}}},"Webhook":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/WebhookEventEnum"},"url":{"type":"string"},"authorization":{"type":"string"},"isActive":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"WebhookEventEnum":{"type":"string","description":"Available events to register a webhook to listen to. If no one selected anyone the default event will be OPENPIX:TRANSACTION_RECEIVED.\n\n* **OPENPIX:CHARGE_CREATED** - New charge created\n* **OPENPIX:CHARGE_COMPLETED** - Charge completed is when a charge is fully paid\n* **OPENPIX:CHARGE_EXPIRED** - Charge expired is when a charge is not fully paid and expired\n* **OPENPIX:TRANSACTION_RECEIVED** - New PIX transaction received\n* **OPENPIX:TRANSACTION_REFUND_RECEIVED** - New PIX transaction refund received or refunded\n* **OPENPIX:MOVEMENT_CONFIRMED** - Payment confirmed is when the pix transaction related to the payment gets confirmed\n* **OPENPIX:MOVEMENT_FAILED** - Payment failed is when the payment gets approved and a error occurs\n* **OPENPIX:MOVEMENT_REMOVED** - Payment was removed by a user\n","enum":["OPENPIX:CHARGE_CREATED","OPENPIX:CHARGE_COMPLETED","OPENPIX:CHARGE_EXPIRED","OPENPIX:TRANSACTION_RECEIVED","OPENPIX:TRANSACTION_REFUND_RECEIVED","OPENPIX:MOVEMENT_CONFIRMED","OPENPIX:MOVEMENT_FAILED","OPENPIX:MOVEMENT_REMOVED"]},"SubAccount":{"type":"object","properties":{"name":{"type":"string","description":"Name of the sub account"},"pixKey":{"type":"string","description":"The pix key for the sub account"},"balance":{"type":"number","description":"Number in cents that represent the balance of the sub account"}}},"transaction":{"type":"object","properties":{"status":{"type":"string","description":"The status of the transaction"},"value":{"type":"number","description":"The value of the transaction in cents"},"correlationID":{"type":"string","description":"The correlation ID of the transaction"},"destinationAlias":{"type":"string","description":"The pix key of the transaction"},"comment":{"type":"string","description":"The comment of the transaction"}}},"SubAccountPayload":{"type":"object","properties":{"pixKey":{"type":"string","description":"The pix key for the sub account"},"name":{"type":"string","description":"Name of the sub account"}}}},"securitySchemes":{"AppID":{"type":"apiKey","in":"header","name":"Authorization"}}},"tags":[{"name":"account","description":"Endpoint to manage Accounts\n"},{"name":"cashback-fidelity","description":"Endpoint to manage exclusive cashbacks\n"},{"name":"charge","description":"Endpoint to manage Charges\n"},{"name":"charge refund","description":"Endpoint to manage charge refunds\n"},{"name":"customer","description":"Endpoint to manage Customer\n"},{"name":"partner (request access)","description":"Partners integrate affiliated companies.
\nThey can register new companies, manage them, and earn money from them.\n"},{"name":"payment (request access)","description":"Endpoint to init a payment using a Pix Key.\n"},{"name":"pixQrCode","description":"Endpoint to manage static QRCodes\n"},{"name":"refund","description":"Endpoint to manage Refunds\n"},{"name":"subscription","description":"Endpoint to manage Subscriptions\n"},{"name":"transactions","description":"Endpoint to manage Transactions\n"},{"name":"transfer (request access)","description":"Endpoint to transfer values between sub accounts.\n"},{"name":"webhook","description":"Endpoint to manage Webhooks\n"},{"name":"sub account (request access)","description":"Endpoint to manage sub accounts.\n"}]} diff --git a/src/swaggers/woovi.yml b/src/swaggers/woovi.yml index 699283c..e57ab75 100644 --- a/src/swaggers/woovi.yml +++ b/src/swaggers/woovi.yml @@ -2792,7 +2792,6 @@ paths: SubAccount: name: test-sub-account pixKey: c4249323-b4ca-43f2-8139-8232aab09b93 - balance: 0 '400': description: An error message content: @@ -2973,6 +2972,12 @@ components: value: type: string description: value of object + enableCashbackPercentage: + type: boolean + description: true to enable cashback and false to disable. + enableCashbackExclusivePercentage: + type: boolean + description: true to enable fidelity cashback and false to disable. required: - correlationID - value @@ -3053,40 +3058,113 @@ components: country: type: string CustomerPayload: - type: object - properties: - name: - type: string - email: - type: string - phone: - type: string - taxID: - type: string - correlationID: - type: string - address: - type: object + description: + Customer field is not required. However, if you decide to send it, + you must send at least one of the following combinations, name + taxID + or name + email or name + phone. + oneOf: + - type: object properties: - zipcode: + name: type: string - street: + email: type: string - number: + phone: type: string - neighborhood: + taxID: type: string - city: + correlationID: type: string - state: + address: + type: object + properties: + zipcode: + type: string + street: + type: string + number: + type: string + neighborhood: + type: string + city: + type: string + state: + type: string + complement: + type: string + country: + type: string + required: + - name + - taxID + - type: object + properties: + name: type: string - complement: + email: type: string - country: + phone: type: string - required: - - name - - taxID + taxID: + type: string + correlationID: + type: string + address: + type: object + properties: + zipcode: + type: string + street: + type: string + number: + type: string + neighborhood: + type: string + city: + type: string + state: + type: string + complement: + type: string + country: + type: string + required: + - name + - email + - type: object + properties: + name: + type: string + email: + type: string + phone: + type: string + taxID: + type: string + correlationID: + type: string + address: + type: object + properties: + zipcode: + type: string + street: + type: string + number: + type: string + neighborhood: + type: string + city: + type: string + state: + type: string + complement: + type: string + country: + type: string + required: + - name + - phone End: type: string format: date-time diff --git a/static/wooviPostman.json b/static/wooviPostman.json index 66d83f7..32f92b9 100644 --- a/static/wooviPostman.json +++ b/static/wooviPostman.json @@ -1 +1 @@ -{"item":[{"name":"openpix","description":"","item":[{"name":"charge","description":"","item":[{"name":"brcode","description":"","item":[{"name":"image","description":"","item":[{"name":"{:id}.png?size=1024","description":"","item":[{"id":"521ff040-8b01-47d0-a378-f0c2a5b0b915","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":""}],"variable":[{"disabled":false,"description":{"content":"(Required) charge link payment ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"b3476c8d-6380-4347-8d5e-4684d4213099","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":""}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[],"cookie":[],"_postman_previewlanguage":"text"},{"id":"c64efdae-fbe7-476d-898d-d285d63227d1","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":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]}]}]}]},{"name":"api","description":"","item":[{"name":"v1","description":"","item":[{"name":"webhook","description":"","item":[{"name":"{id}","description":"","item":[{"id":"9d87a0ab-d1d3-4409-8447-e50914251d62","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":"","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{},"auth":null},"response":[{"id":"3b6f1560-4fbe-4e64-9b44-5afc4f259b85","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":""}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cb491fa7-fbfd-4f71-a140-87bcd55faad1","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":""}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\",\n \"status\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"6dc3309f-8ca4-48f8-bdda-5afd6690c088","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":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"13fe2c02-c4d4-4f3f-a4be-16d1232380da","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":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"webhooks\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"event\": \"OPENPIX:MOVEMENT_FAILED\",\n \"url\": \"\",\n \"authorization\": \"\",\n \"isActive\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"event\": \"OPENPIX:CHARGE_EXPIRED\",\n \"url\": \"\",\n \"authorization\": \"\",\n \"isActive\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n },\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n }\n ]\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7da0a635-ceb4-4406-a521-8c62ed3b83be","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":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"06619baa-534c-4ab4-ac6d-4687f11f38a9","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\": \"\",\n \"event\": \"OPENPIX:CHARGE_CREATED\",\n \"url\": \"\",\n \"authorization\": \"\",\n \"isActive\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"cd236921-dd2c-4804-9e71-f5b3da4f0728","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"webhook\": {\n \"name\": \"\",\n \"event\": \"OPENPIX:CHARGE_CREATED\",\n \"url\": \"\",\n \"authorization\": \"\",\n \"isActive\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"webhook\": {\n \"id\": \"\",\n \"name\": \"\",\n \"event\": \"OPENPIX:CHARGE_EXPIRED\",\n \"url\": \"\",\n \"authorization\": \"\",\n \"isActive\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ab7ecd95-27c6-465e-a1d9-cf2fc38f4a3f","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"webhook\": {\n \"name\": \"\",\n \"event\": \"OPENPIX:CHARGE_CREATED\",\n \"url\": \"\",\n \"authorization\": \"\",\n \"isActive\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"transfer","description":"","item":[{"id":"a6990d6b-04b3-4b87-a36c-2f9118510287","name":"Create a Transfer","request":{"name":"Create a Transfer","description":{"content":"Endpoint to to transfer values between sub 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\": \"\",\n \"fromPixKey\": \"\",\n \"toPixKey\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"9243f60f-64b1-4eaa-8753-3930e9ae48fc","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\",\n \"fromPixKey\": \"\",\n \"toPixKey\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"transaction\": {\n \"value\": \"\",\n \"time\": \"\",\n \"correlationID\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"87cb0ffe-7bba-4c66-b818-1f6aa401d913","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\",\n \"fromPixKey\": \"\",\n \"toPixKey\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"transaction","description":"","item":[{"name":"{id}","description":"","item":[{"id":"dc7ec2e9-fdb2-4bd1-9688-4a979292fdfd","name":"Get a Transaction","request":{"name":"Get a Transaction","description":{},"url":{"path":["api","v1","transaction",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"d8ee40fc-e85a-4769-ac6c-aac61c943634","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"transaction\": {\n \"charge\": {\n \"value\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"OVERDUE\",\n \"comment\": \"\",\n \"brCode\": \"\",\n \"status\": \"ACTIVE\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\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\": \"\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"pixKey\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"expiresIn\": \"\"\n },\n \"value\": \"\",\n \"time\": \"\",\n \"endToEndID\": \"\",\n \"transactionID\": \"\",\n \"infoPagador\": \"\",\n \"endToEndId\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"withdraw\": {\n \"value\": \"\",\n \"time\": \"\",\n \"endToEndID\": \"\",\n \"transactionID\": \"\",\n \"infoPagador\": \"\",\n \"endToEndId\": \"\",\n \"payer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"\"\n },\n \"payer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"REFUND\",\n \"globalID\": {\n \"description\": \"External ID of this transaction\"\n },\n \"pixQrCode\": {\n \"name\": \"\",\n \"value\": \"\",\n \"comment\": \"\",\n \"identifier\": \"\",\n \"brCode\": \"\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"087a4782-c565-40d4-8e4b-31fbd1ed17a6","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"1a911c96-cb7a-4adc-b964-a6834e4309d1","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":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":""},{"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":""},{"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":""},{"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":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"a138b580-e061-4b50-9013-12bacd011528","name":"A list of transactions","originalRequest":{"url":{"path":["api","v1","transaction"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":""},{"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":""},{"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":""},{"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":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"\",\n \"transactions\": [\n {\n \"charge\": {\n \"value\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"OVERDUE\",\n \"comment\": \"\",\n \"brCode\": \"\",\n \"status\": \"ACTIVE\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\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\": \"\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"pixKey\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"expiresIn\": \"\"\n },\n \"value\": \"\",\n \"time\": \"\",\n \"endToEndID\": \"\",\n \"transactionID\": \"\",\n \"infoPagador\": \"\",\n \"endToEndId\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"withdraw\": {\n \"value\": \"\",\n \"time\": \"\",\n \"endToEndID\": \"\",\n \"transactionID\": \"\",\n \"infoPagador\": \"\",\n \"endToEndId\": \"\",\n \"payer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"\"\n },\n \"payer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"PAYMENT\",\n \"globalID\": {\n \"description\": \"External ID of this transaction\"\n },\n \"pixQrCode\": {\n \"name\": \"\",\n \"value\": \"\",\n \"comment\": \"\",\n \"identifier\": \"\",\n \"brCode\": \"\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n },\n {\n \"charge\": {\n \"value\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"DYNAMIC\",\n \"comment\": \"\",\n \"brCode\": \"\",\n \"status\": \"COMPLETED\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\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\": \"\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"pixKey\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"expiresIn\": \"\"\n },\n \"value\": \"\",\n \"time\": \"\",\n \"endToEndID\": \"\",\n \"transactionID\": \"\",\n \"infoPagador\": \"\",\n \"endToEndId\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"withdraw\": {\n \"value\": \"\",\n \"time\": \"\",\n \"endToEndID\": \"\",\n \"transactionID\": \"\",\n \"infoPagador\": \"\",\n \"endToEndId\": \"\",\n \"payer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"\"\n },\n \"payer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"PAYMENT\",\n \"globalID\": {\n \"description\": \"External ID of this transaction\"\n },\n \"pixQrCode\": {\n \"name\": \"\",\n \"value\": \"\",\n \"comment\": \"\",\n \"identifier\": \"\",\n \"brCode\": \"\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n },\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n }\n ],\n \"skip\": \"\",\n \"limit\": \"\",\n \"totalCount\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4b19e6fb-c510-4862-8c6d-a22d776ea175","name":"An error message","originalRequest":{"url":{"path":["api","v1","transaction"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":""},{"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":""},{"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":""},{"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":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"subscriptions","description":"","item":[{"name":"{id}","description":"","item":[{"id":"9a6831e7-56fb-4a1c-8d47-b5bd04b76766","name":"Get one subscription","request":{"name":"Get one subscription","description":{},"url":{"path":["api","v1","subscriptions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"fd464ff1-1b5e-4f7e-b3a9-7bbb3b4e0da8","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"subscription\": {\n \"globalID\": \"\",\n \"value\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"dayGenerateCharge\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6b3526ec-1bac-4a86-9db5-3c93fde71cfc","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"5a1c4060-e552-4127-95e1-4300322f8329","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\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"value\": \"\",\n \"comment\": \"\",\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"dayGenerateCharge\": 5,\n \"chargeType\": \"DYNAMIC\",\n \"dayDue\": 7\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"406d521d-98cd-484c-8fcd-728ebf20a9ef","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"value\": \"\",\n \"comment\": \"\",\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\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\": \"\",\n \"value\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"dayGenerateCharge\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"47032424-9983-4361-b147-e2f7efa82cc5","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"value\": \"\",\n \"comment\": \"\",\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\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\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"subaccount","description":"","item":[{"name":"{id}","description":"","item":[{"name":"withdraw","description":"","item":[{"id":"7d757b04-c1a0-46fa-83bd-04d458ed855c","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":"","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{},"auth":null},"response":[{"id":"c31f125a-1c9e-4c2d-a2db-84f466794c60","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":""}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"withdraw\": {\n \"account\": {\n \"status\": \"\",\n \"value\": \"\",\n \"correlationID\": \"\",\n \"destinationAlias\": \"\",\n \"comment\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3e2a8d15-38c7-4182-9304-361b0c3e43bd","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":""}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"396856d0-8d60-47e7-91cb-43bb26176e70","name":"Get subaccount details","request":{"name":"Get subaccount details","description":{},"url":{"path":["api","v1","subaccount",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"cb94e0fc-8052-4642-8970-13e4b1640585","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"SubAccount\": {\n \"name\": \"\",\n \"pixKey\": \"\",\n \"balance\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ece5d600-eff3-4bd7-9a53-b74a3870b63e","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"19171d6c-7343-4b77-b2c4-bc44b2f6367a","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":"c84d978e-6f6c-4294-a667-66daa1ab6bfa","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"\",\n \"subaccounts\": [\n {\n \"payment\": {\n \"name\": \"\",\n \"pixKey\": \"\",\n \"balance\": \"\"\n }\n },\n {\n \"payment\": {\n \"name\": \"\",\n \"pixKey\": \"\",\n \"balance\": \"\"\n }\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n },\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n }\n ],\n \"skip\": \"\",\n \"limit\": \"\",\n \"totalCount\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d678cc82-c59a-4b08-8f3d-040c3cd9a205","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0feac8e6-8b14-4324-9c0b-d3d0f6cd4f12","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\": \"\",\n \"name\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"c9181b1c-68a6-4d02-b89e-c86b38b2e11d","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"pixKey\": \"\",\n \"name\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"SubAccount\": {\n \"name\": \"\",\n \"pixKey\": \"\",\n \"balance\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3546bb2e-cbe7-4e4f-af84-fd42e2c6ec4a","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"pixKey\": \"\",\n \"name\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"refund","description":"","item":[{"name":"{id}","description":"","item":[{"id":"ca321a30-e1d1-4f67-a2a5-ace33a622982","name":"Get one refund","request":{"name":"Get one refund","description":{},"url":{"path":["api","v1","refund",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"ffd102b0-916c-4eb6-bf8e-9c459cc5cd45","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"pixTransactionRefund\": {\n \"value\": \"\",\n \"status\": \"REFUNDED\",\n \"correlationID\": \"\",\n \"refundId\": \"\",\n \"time\": \"\",\n \"comment\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6196eb25-8fa7-4df0-a526-b79c97b1a0ee","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"f63a86d2-1ed4-4783-95ac-d3571476d252","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":"de38fefe-ced2-4b84-a333-9970060bbc94","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"refunds\": [\n {\n \"value\": \"\",\n \"status\": \"NOT_ACCOMPLISHED\",\n \"correlationID\": \"\",\n \"refundId\": \"\",\n \"time\": \"\",\n \"comment\": \"\"\n },\n {\n \"value\": \"\",\n \"status\": \"REFUNDED\",\n \"correlationID\": \"\",\n \"refundId\": \"\",\n \"time\": \"\",\n \"comment\": \"\"\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n },\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n }\n ],\n \"skip\": \"\",\n \"limit\": \"\",\n \"totalCount\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c390547c-ff91-4c96-86db-a70056693fd1","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"50d7d95b-55b4-4327-9c5f-3eafe398dd90","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\": \"\",\n \"transactionEndToEndId\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"e2a53b41-8a16-4843-bc2f-ad18a299fc40","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\",\n \"transactionEndToEndId\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"refund\": {\n \"value\": \"\",\n \"status\": \"REFUNDED\",\n \"correlationID\": \"\",\n \"refundId\": \"\",\n \"time\": \"\",\n \"comment\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d6a3fc7b-a340-4c2f-9c76-a5e1f41c2f27","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\",\n \"transactionEndToEndId\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"qrcode-static","description":"","item":[{"name":"{id}","description":"","item":[{"id":"7be459a7-620e-4243-8356-9039fd3d276b","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":"","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"9b8ab12b-445a-485d-a504-6c6ab2c75120","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"pixQrCode\": {\n \"name\": \"\",\n \"value\": \"\",\n \"comment\": \"\",\n \"identifier\": \"\",\n \"brCode\": \"\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e47b4b17-ae20-4b65-a088-659731c98e3c","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"9c24c75b-8e7d-460e-a4e6-119fae921459","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":"a19dcd75-96dd-4ba1-bc91-a203e6c6e1e5","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"pixQrCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"comment\": \"\",\n \"identifier\": \"\",\n \"brCode\": \"\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"comment\": \"\",\n \"identifier\": \"\",\n \"brCode\": \"\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n },\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n }\n ],\n \"skip\": \"\",\n \"limit\": \"\",\n \"totalCount\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"75d54395-c978-4dc4-9e75-aa285e9cc74d","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5191eed1-efa8-4f8e-a370-75637ce41d3d","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\": \"\",\n \"identifier\": \"\",\n \"correlationID\": \"\",\n \"value\": \"\",\n \"comment\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"e5a84aea-ec2e-46ad-bc6b-b522da328f93","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"identifier\": \"\",\n \"correlationID\": \"\",\n \"value\": \"\",\n \"comment\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"pixQrCode\": {\n \"name\": \"\",\n \"value\": \"\",\n \"comment\": \"\",\n \"identifier\": \"\",\n \"brCode\": \"\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n \"correlationID\": \"\",\n \"brCode\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b6b7bfd5-eff8-4cdc-ba4b-1c385bbc86d4","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"identifier\": \"\",\n \"correlationID\": \"\",\n \"value\": \"\",\n \"comment\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"payment","description":"","item":[{"name":"{id}","description":"","item":[{"id":"cb6cec7d-ff2e-4e77-9d86-000e06b3542c","name":"Get one Payment","request":{"name":"Get one Payment","description":{},"url":{"path":["api","v1","payment",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"9d1972f7-58c4-4c46-9fcd-e724f98dcb6c","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"payment\": {\n \"value\": \"\",\n \"destinationAlias\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\",\n \"status\": \"FAILED\",\n \"sourceAccountId\": \"\"\n },\n \"transaction\": {\n \"value\": \"\",\n \"endToEndId\": \"\",\n \"time\": \"\"\n },\n \"destination\": {\n \"name\": \"\",\n \"taxID\": \"\",\n \"pixKey\": \"\",\n \"bank\": \"\",\n \"branch\": \"\",\n \"account\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3168d29b-36f7-4643-a753-4545e0495e4d","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"approve","description":"","item":[{"id":"20e7a685-0c49-4128-ae0f-80fc777cb690","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\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"5df0152c-e55f-473b-9dec-f6440574cb36","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"payment\": {\n \"value\": \"\",\n \"destinationAlias\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\",\n \"status\": \"CREATED\",\n \"sourceAccountId\": \"\"\n },\n \"transaction\": {\n \"value\": \"\",\n \"endToEndId\": \"\",\n \"time\": \"\"\n },\n \"destination\": {\n \"name\": \"\",\n \"taxID\": \"\",\n \"pixKey\": \"\",\n \"bank\": \"\",\n \"branch\": \"\",\n \"account\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"38e20740-17cc-4e51-9ad5-f1c4bfb66cbe","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"cb8c0a77-7e5f-414d-bd0d-deca4aabf15f","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":"84d5b5ea-c039-4a1f-ae04-945e24e135e9","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"\",\n \"payments\": [\n {\n \"payment\": {\n \"value\": \"\",\n \"destinationAlias\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\",\n \"status\": \"FAILED\",\n \"sourceAccountId\": \"\"\n },\n \"transaction\": {\n \"value\": \"\",\n \"endToEndId\": \"\",\n \"time\": \"\"\n },\n \"destination\": {\n \"name\": \"\",\n \"taxID\": \"\",\n \"pixKey\": \"\",\n \"bank\": \"\",\n \"branch\": \"\",\n \"account\": \"\"\n }\n },\n {\n \"payment\": {\n \"value\": \"\",\n \"destinationAlias\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\",\n \"status\": \"CONFIRMED\",\n \"sourceAccountId\": \"\"\n },\n \"transaction\": {\n \"value\": \"\",\n \"endToEndId\": \"\",\n \"time\": \"\"\n },\n \"destination\": {\n \"name\": \"\",\n \"taxID\": \"\",\n \"pixKey\": \"\",\n \"bank\": \"\",\n \"branch\": \"\",\n \"account\": \"\"\n }\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n },\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n }\n ],\n \"skip\": \"\",\n \"limit\": \"\",\n \"totalCount\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"628118dd-3199-49df-9fde-b65258db27da","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4c380a42-2222-4cdc-bef4-9e9773772340","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\": \"\",\n \"destinationAlias\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\",\n \"sourceAccountId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"91662734-3e17-4e8c-9d11-2449e63b964d","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\",\n \"destinationAlias\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\",\n \"sourceAccountId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"payment\": {\n \"value\": \"\",\n \"destinationAlias\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\",\n \"status\": \"CONFIRMED\",\n \"sourceAccountId\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"21a679c7-0dce-4725-a618-b74319a7261a","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\",\n \"destinationAlias\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\",\n \"sourceAccountId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"partner","description":"","item":[{"name":"company","description":"","item":[{"name":"{taxID}","description":"","item":[{"id":"76bd6daa-347b-4b71-8926-03afc1f1cc4f","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":"","key":"taxID","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"6c8eba24-7546-435c-ae53-b5f2f2e1997b","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"preRegistration\": {\n \"preRegistration\": {\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n }\n },\n \"user\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n },\n \"company\": {\n \"id\": \"\",\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n }\n },\n \"account\": {\n \"clientId\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"98fc5474-8bcc-40df-8820-c57ffdafaf22","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"0cd29f0d-d2a2-4701-85a5-79b3b4289b2f","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":"5f68acc2-b62f-4d68-9b2c-5e8fc8a2c76c","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"preRegistrations\": [\n {\n \"preRegistration\": {\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n }\n },\n \"user\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n },\n \"company\": {\n \"id\": \"\",\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n }\n },\n \"account\": {\n \"clientId\": \"\"\n }\n },\n {\n \"preRegistration\": {\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n }\n },\n \"user\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n },\n \"company\": {\n \"id\": \"\",\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n }\n },\n \"account\": {\n \"clientId\": \"\"\n }\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n },\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n }\n ],\n \"skip\": \"\",\n \"limit\": \"\",\n \"totalCount\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e7441320-0164-43a5-9e09-8d71e9226b28","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f2079e63-5e73-460a-8c8c-1f3b503a1add","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\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n },\n \"website\": \"\"\n },\n \"user\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"4423b931-3b5b-49e0-84ea-69c7cebeacfc","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"preRegistration\": {\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n },\n \"website\": \"\"\n },\n \"user\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"preRegistration\": {\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n },\n \"website\": \"\"\n },\n \"user\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ebd923c6-6bba-4a7c-92da-ce1765d09469","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"preRegistration\": {\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n },\n \"website\": \"\"\n },\n \"user\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"preRegistration\": {\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n },\n \"website\": \"\"\n },\n \"user\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"70184db1-fed2-4c8e-8a6e-68a0b5ac3fba","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"preRegistration\": {\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n },\n \"website\": \"\"\n },\n \"user\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"991b52b7-be56-4f0b-ad90-fd9fa0d4e35c","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"preRegistration\": {\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n },\n \"website\": \"\"\n },\n \"user\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"application","description":"","item":[{"id":"30894501-1242-4334-81fb-cc56d4c76062","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\": \"\",\n \"type\": \"PLUGIN\"\n },\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"6bc33697-29b9-446a-bcdc-7f1deddbbcc6","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"application\": {\n \"name\": \"\",\n \"type\": \"PLUGIN\"\n },\n \"taxID\": {\n \"taxID\": \"\",\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\": \"\",\n \"isActive\": \"\",\n \"type\": \"PLUGIN\",\n \"clientId\": \"\",\n \"clientSecret\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"52c97ce2-9099-4445-acfa-797b940e1732","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"application\": {\n \"name\": \"\",\n \"type\": \"PLUGIN\"\n },\n \"taxID\": {\n \"taxID\": \"\",\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\": \"\",\n \"isActive\": \"\",\n \"type\": \"PLUGIN\",\n \"clientId\": \"\",\n \"clientSecret\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e9961be3-ca1d-42fd-9a1a-81d6fbbc751f","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"application\": {\n \"name\": \"\",\n \"type\": \"PLUGIN\"\n },\n \"taxID\": {\n \"taxID\": \"\",\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\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"21e35de3-23a0-4836-95ce-280bb9ed9ead","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"application\": {\n \"name\": \"\",\n \"type\": \"PLUGIN\"\n },\n \"taxID\": {\n \"taxID\": \"\",\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\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]},{"name":"customer","description":"","item":[{"name":"{id}","description":"","item":[{"id":"b7154fed-c0bf-409f-a7a9-d0d9d9f87009","name":"Get one customer","request":{"name":"Get one customer","description":{},"url":{"path":["api","v1","customer",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"1b359a13-51af-406d-b708-38fd9fdf27a9","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4471cd18-2fea-442f-bfee-26e00545204d","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"8c21d9a2-e937-412d-a7eb-75cc2d76cd90","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":"c81863b7-0095-4834-bd3e-199b5e0a389f","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"customers\": [\n {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n },\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n }\n ],\n \"skip\": \"\",\n \"limit\": \"\",\n \"totalCount\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ebbe606a-ca14-4bc2-8a87-a9f98c6b7379","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"2a653d84-fdb0-494f-831d-eb02874806d8","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\": \"\",\n \"taxID\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"5a79ecc7-dc83-48f2-b039-c0f82c82041d","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"taxID\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9c332b64-068f-49a0-b288-4c560a794f91","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"taxID\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"charge","description":"","item":[{"name":"{id}","description":"","item":[{"name":"refund","description":"","item":[{"id":"e055b182-d15c-4f59-9879-28965d6462e8","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":"","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"931bff62-ae24-4d20-852b-d966f8fa868f","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"refunds\": [\n {\n \"value\": \"\",\n \"status\": \"CONFIRMED\",\n \"correlationID\": \"\",\n \"endToEndId\": \"\",\n \"time\": \"\",\n \"comment\": \"\"\n },\n {\n \"value\": \"\",\n \"status\": \"IN_PROCESSING\",\n \"correlationID\": \"\",\n \"endToEndId\": \"\",\n \"time\": \"\",\n \"comment\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d198997a-f7b0-414f-ab30-86e5dc1e8bd6","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a1d1837b-177a-4e10-b9c0-6f6a27094106","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":"","key":"id","disabled":false}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"\",\n \"value\": \"\",\n \"comment\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"a25a849e-8d59-438e-8047-a4631a716305","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"\",\n \"value\": \"\",\n \"comment\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"refund\": {\n \"value\": \"\",\n \"status\": \"REJECTED\",\n \"correlationID\": \"\",\n \"endToEndId\": \"\",\n \"time\": \"\",\n \"comment\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5439bb52-f820-4f83-8fba-f2d8c01ba261","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"\",\n \"value\": \"\",\n \"comment\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"83f792d1-a738-41cb-9cec-f081ef00d3e1","name":"Delete a charge","request":{"name":"Delete a charge","description":{},"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{},"auth":null},"response":[{"id":"418221f9-e605-4cfb-8b01-0f78cf96000b","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":""}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"\",\n \"id\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3723703c-ea9a-4d17-98c4-ee002bfb6c5b","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":""}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"11c30ae3-d656-4d45-970a-2219436a9577","name":"Get one charge","request":{"name":"Get one charge","description":{},"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"2c7f6971-08a0-4cc6-8f38-7cdabfa648e3","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"charge\": {\n \"value\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"OVERDUE\",\n \"comment\": \"\",\n \"brCode\": \"\",\n \"status\": \"EXPIRED\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\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\": \"\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"pixKey\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"expiresIn\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cec62bb4-5604-457a-b9f2-c512797e1cd9","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"46f892f4-b35d-43aa-abeb-0f0907a10312","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":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"status","value":"EXPIRED"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"62674405-83bb-4716-a53c-6208db2c1644","name":"A list of charges","originalRequest":{"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"status","value":"EXPIRED"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"charges\": [\n {\n \"value\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"OVERDUE\",\n \"comment\": \"\",\n \"brCode\": \"\",\n \"status\": \"EXPIRED\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\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\": \"\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"pixKey\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"expiresIn\": \"\"\n },\n {\n \"value\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"OVERDUE\",\n \"comment\": \"\",\n \"brCode\": \"\",\n \"status\": \"EXPIRED\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\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\": \"\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"pixKey\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"expiresIn\": \"\"\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n },\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n }\n ],\n \"skip\": \"\",\n \"limit\": \"\",\n \"totalCount\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8eabfc1a-7762-473a-a945-cb598fe35af8","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"status","value":"EXPIRED"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"64d8cbea-bf4e-4536-b4c9-3cd438267295","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":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"\",\n \"value\": \"\",\n \"type\": \"OVERDUE\",\n \"comment\": \"\",\n \"identifier\": \"\",\n \"expiresIn\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"taxID\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"daysForDueDate\": \"\",\n \"daysAfterDueDate\": \"\",\n \"interests\": {\n \"value\": \"\"\n },\n \"fines\": {\n \"value\": \"\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"2638c402-3be0-4938-8383-de2e6781dc94","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":""}],"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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"\",\n \"value\": \"\",\n \"type\": \"OVERDUE\",\n \"comment\": \"\",\n \"identifier\": \"\",\n \"expiresIn\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"taxID\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"daysForDueDate\": \"\",\n \"daysAfterDueDate\": \"\",\n \"interests\": {\n \"value\": \"\"\n },\n \"fines\": {\n \"value\": \"\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\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\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"OVERDUE\",\n \"comment\": \"\",\n \"brCode\": \"\",\n \"status\": \"ACTIVE\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\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\": \"\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"pixKey\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"expiresIn\": \"\"\n },\n \"correlationID\": \"\",\n \"brCode\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"818be3e7-e073-4eb7-8d45-475c238e3755","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":""}],"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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"\",\n \"value\": \"\",\n \"type\": \"OVERDUE\",\n \"comment\": \"\",\n \"identifier\": \"\",\n \"expiresIn\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"taxID\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"daysForDueDate\": \"\",\n \"daysAfterDueDate\": \"\",\n \"interests\": {\n \"value\": \"\"\n },\n \"fines\": {\n \"value\": \"\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"cashback-fidelity","description":"","item":[{"name":"balance","description":"","item":[{"name":"{taxID}","description":"","item":[{"id":"f04350d1-2827-4737-a05e-bdb8e1c6e4e0","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":"","key":"taxID","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"735624bd-831f-4d80-905a-892bdca5b9b4","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"balance\": \"\",\n \"status\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"054a0fee-3338-494d-b5b6-6354230de4c0","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]},{"id":"f7250f6a-cc19-4c7f-8a36-83b8fe605774","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\": \"\",\n \"value\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"07f521e3-3c9c-4dc1-b422-beec0bd0ef17","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"taxID\": \"\",\n \"value\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"cashback\": {\n \"value\": \"\"\n },\n \"message\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"aa9ae2a6-4aea-4cf3-bddb-abef42ad3251","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"taxID\": \"\",\n \"value\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"cashback\": {\n \"value\": \"\"\n },\n \"message\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ec02d831-8fc9-48ad-a594-6d018cf773d0","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"taxID\": \"\",\n \"value\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"account","description":"","item":[{"name":"{accountId}","description":"","item":[{"name":"withdraw","description":"","item":[{"id":"44cb88da-31c8-46c6-a514-d43d3946015e","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":"","key":"accountId","disabled":false}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"795f320d-2003-4a91-9809-a5a730aee9d0","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\"\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\": \"\",\n \"isDefault\": \"\",\n \"balance\": {\n \"total\": \"\",\n \"blocked\": \"\",\n \"available\": \"\"\n }\n },\n \"transaction\": {\n \"endToEndId\": \"\",\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3f66297d-5d05-42f0-9a9b-654ad3776ffc","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"1485ccb1-b442-4f02-8a31-6f1576ad0744","name":"Get an Account","request":{"name":"Get an Account","description":{},"url":{"path":["api","v1","account",":accountId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","key":"accountId","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"5e43cd5c-e563-4dbf-b200-ba6d46dd056f","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"account\": {\n \"accountId\": \"\",\n \"isDefault\": \"\",\n \"balance\": {\n \"total\": \"\",\n \"blocked\": \"\",\n \"available\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"40391612-3001-47af-9f62-c69276e07a36","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"2f869cc9-fc78-453f-986e-d2299b70901e","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":"ae090d50-b405-412a-a841-272bbac23d68","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"accounts\": [\n {\n \"accountId\": \"\",\n \"isDefault\": \"\",\n \"balance\": {\n \"total\": \"\",\n \"blocked\": \"\",\n \"available\": \"\"\n }\n },\n {\n \"accountId\": \"\",\n \"isDefault\": \"\",\n \"balance\": {\n \"total\": \"\",\n \"blocked\": \"\",\n \"available\": \"\"\n }\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0e8da553-8eeb-492a-b5ea-3889f7e8211f","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]}]}],"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"{{apiKey}}","key":"value"},{"type":"any","value":"header","key":"in"}]},"event":[],"variable":[{"key":"baseUrl","value":"https://api.woovi.com"}],"info":{"_postman_id":"4a9b9b27-ad15-4c03-9668-bdcaa1f64f0b","name":"Woovi","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json","description":{"content":"A Woovi é uma Plataforma de Gestão de Pagamentos. Para utilizar nossa API você deve acessar __[https://api.woovi.com/](https://api.woovi.com/)__ e somente o mesmo. A Woovi não aceita subdominios para a API.\n\nVeja como configurar seu acesso a nossa API [aqui](https://developers.woovi.com/docs/apis/api-getting-started).","type":"text/plain"}}} \ No newline at end of file +{"item":[{"name":"api","description":"","item":[{"name":"v1","description":"","item":[{"name":"account","description":"","item":[{"name":"{accountId}","description":"","item":[{"id":"287a0adc-13d2-4a22-b164-5ddd3cf21fe4","name":"Get an Account","request":{"name":"Get an Account","description":{},"url":{"path":["api","v1","account",":accountId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","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":"d5c06dbb-7a33-4440-aad6-9087321da964","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"account\": {\n \"accountId\": \"\",\n \"isDefault\": \"\",\n \"balance\": {\n \"total\": \"\",\n \"blocked\": \"\",\n \"available\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"31f398b1-b7c1-499a-89e8-978b4075df5b","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"name":"withdraw","description":"","item":[{"id":"cf1f9a5f-a8b1-446f-afa4-4ee4fd7aca41","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":"","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\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"105839d4-36b5-4bea-bd0c-0ed0225a0044","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\"\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\": \"\",\n \"isDefault\": \"\",\n \"balance\": {\n \"total\": \"\",\n \"blocked\": \"\",\n \"available\": \"\"\n }\n },\n \"transaction\": {\n \"endToEndId\": \"\",\n \"value\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"eb4ead22-9e41-4d5b-86b5-9ac4eb341be8","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]},{"id":"9dad9e74-0a02-4464-ba7e-9d5f28176a96","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":"82e67e5f-5873-4eba-a8cd-778588b265e9","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"accounts\": [\n {\n \"accountId\": \"\",\n \"isDefault\": \"\",\n \"balance\": {\n \"total\": \"\",\n \"blocked\": \"\",\n \"available\": \"\"\n }\n },\n {\n \"accountId\": \"\",\n \"isDefault\": \"\",\n \"balance\": {\n \"total\": \"\",\n \"blocked\": \"\",\n \"available\": \"\"\n }\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"71199fbc-ecc3-4daf-bda7-e08c16b8cc36","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"cashback-fidelity","description":"","item":[{"name":"balance","description":"","item":[{"name":"{taxID}","description":"","item":[{"id":"f3cc1153-ccb0-4dff-8eaa-a5b68221f53d","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":"","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":"03ac9b55-b76e-4140-9e59-8c64ddf234d1","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"balance\": \"\",\n \"status\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6c82edcf-4d4e-4a70-b3ec-3eca399f37d7","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]},{"id":"a45fa9c5-380e-45f2-8787-90a060d2c8cc","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\": \"\",\n \"value\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"f7072e8c-1654-4987-9046-ef752f71b03b","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"taxID\": \"\",\n \"value\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"cashback\": {\n \"value\": \"\"\n },\n \"message\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"be7c09f4-db7e-4ab0-9b4f-7b89db9a135d","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"taxID\": \"\",\n \"value\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"cashback\": {\n \"value\": \"\"\n },\n \"message\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"89a3b606-9dac-47f4-b062-316e2e3ba32d","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"taxID\": \"\",\n \"value\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"charge","description":"","item":[{"name":"{id}","description":"","item":[{"id":"fcf3ec04-22a7-42ef-b191-21a4dabed3de","name":"Delete a charge","request":{"name":"Delete a charge","description":{},"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","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":"58904c34-5638-4d0f-b3b3-40744dea91e9","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":""}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"\",\n \"id\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"718103ab-431f-4ce1-89da-6053f0882497","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":""}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c3d63bf1-6395-4842-94dc-cd4a88a9dd3e","name":"Get one charge","request":{"name":"Get one charge","description":{},"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","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":"ac07b9bd-2ed7-4695-8519-6a328b14ea2c","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"charge\": {\n \"value\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"DYNAMIC\",\n \"comment\": \"\",\n \"brCode\": \"\",\n \"status\": \"COMPLETED\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\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\": \"\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"pixKey\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"expiresIn\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"477646c4-62e4-4cc1-b13e-35b8734e5410","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"name":"refund","description":"","item":[{"id":"93bb6038-6412-4c44-9213-192121707e6d","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":"","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":"62de5070-3d28-42e4-90ea-82272dbf368b","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"refunds\": [\n {\n \"value\": \"\",\n \"status\": \"REJECTED\",\n \"correlationID\": \"\",\n \"endToEndId\": \"\",\n \"time\": \"\",\n \"comment\": \"\"\n },\n {\n \"value\": \"\",\n \"status\": \"IN_PROCESSING\",\n \"correlationID\": \"\",\n \"endToEndId\": \"\",\n \"time\": \"\",\n \"comment\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ac45a78f-bc3f-4767-85fe-11a5a089c297","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c411df27-b543-4385-b39b-da89c5081b51","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":"","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\": \"\",\n \"value\": \"\",\n \"comment\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"d0cc9148-05f7-4d9a-98f2-497236aa686f","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"\",\n \"value\": \"\",\n \"comment\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"refund\": {\n \"value\": \"\",\n \"status\": \"CONFIRMED\",\n \"correlationID\": \"\",\n \"endToEndId\": \"\",\n \"time\": \"\",\n \"comment\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9ef95321-e8f2-40d2-bfe0-f689ed681218","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"\",\n \"value\": \"\",\n \"comment\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]},{"id":"6e613b5b-cded-44b0-adde-e37765772454","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":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"status","value":"EXPIRED"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"9cc0d4cf-e9f0-4656-ab6a-1203071bc401","name":"A list of charges","originalRequest":{"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"status","value":"EXPIRED"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"charges\": [\n {\n \"value\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"OVERDUE\",\n \"comment\": \"\",\n \"brCode\": \"\",\n \"status\": \"EXPIRED\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\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\": \"\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"pixKey\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"expiresIn\": \"\"\n },\n {\n \"value\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"OVERDUE\",\n \"comment\": \"\",\n \"brCode\": \"\",\n \"status\": \"COMPLETED\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\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\": \"\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"pixKey\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"expiresIn\": \"\"\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n },\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n }\n ],\n \"skip\": \"\",\n \"limit\": \"\",\n \"totalCount\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"05a2bcef-4b2f-48ab-a2b4-1ec7dbc9f601","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"status","value":"EXPIRED"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3f5c9259-cb65-4d01-bd43-d6b9028b1f2a","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":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"\",\n \"value\": \"\",\n \"type\": \"OVERDUE\",\n \"comment\": \"\",\n \"identifier\": \"\",\n \"expiresIn\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"taxID\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"daysForDueDate\": \"\",\n \"daysAfterDueDate\": \"\",\n \"interests\": {\n \"value\": \"\"\n },\n \"fines\": {\n \"value\": \"\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"enableCashbackPercentage\": \"\",\n \"enableCashbackExclusivePercentage\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"adbe17a5-4237-4f31-9afd-312f653e5eba","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":""}],"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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"\",\n \"value\": \"\",\n \"type\": \"OVERDUE\",\n \"comment\": \"\",\n \"identifier\": \"\",\n \"expiresIn\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"taxID\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"daysForDueDate\": \"\",\n \"daysAfterDueDate\": \"\",\n \"interests\": {\n \"value\": \"\"\n },\n \"fines\": {\n \"value\": \"\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"enableCashbackPercentage\": \"\",\n \"enableCashbackExclusivePercentage\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"charge\": {\n \"value\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"DYNAMIC\",\n \"comment\": \"\",\n \"brCode\": \"\",\n \"status\": \"ACTIVE\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\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\": \"\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"pixKey\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"expiresIn\": \"\"\n },\n \"correlationID\": \"\",\n \"brCode\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1abec489-0324-4621-972e-812d5951f57d","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":""}],"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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"\",\n \"value\": \"\",\n \"type\": \"OVERDUE\",\n \"comment\": \"\",\n \"identifier\": \"\",\n \"expiresIn\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"taxID\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"daysForDueDate\": \"\",\n \"daysAfterDueDate\": \"\",\n \"interests\": {\n \"value\": \"\"\n },\n \"fines\": {\n \"value\": \"\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"enableCashbackPercentage\": \"\",\n \"enableCashbackExclusivePercentage\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"customer","description":"","item":[{"name":"{id}","description":"","item":[{"id":"49bf2f92-494d-4c43-8557-93a09e1daaa0","name":"Get one customer","request":{"name":"Get one customer","description":{},"url":{"path":["api","v1","customer",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","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":"4a987ef7-4da4-4d87-aa11-8d296b10dd8c","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d8379364-fb23-44d4-9189-a9dbf76534f6","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"6a9a8d6b-5542-46cc-9017-ed19ce58a1b3","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":"b63800fe-c434-445d-a528-a1fac8b0739d","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"customers\": [\n {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n },\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n }\n ],\n \"skip\": \"\",\n \"limit\": \"\",\n \"totalCount\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ca8abf0a-bdf0-4a71-bfc7-7be16fed2748","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"773f30e5-2bf1-4ebb-8b90-4f7f3884b927","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\": \"\",\n \"taxID\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"27685d6c-8feb-49bb-b8aa-2d3302cf7cb6","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"taxID\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e43cc163-1be7-4bbb-8b0e-fd0b085bed0b","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"taxID\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"partner","description":"","item":[{"name":"application","description":"","item":[{"id":"3553608b-55bd-40ea-b913-3c2c61d7bae8","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\": \"\",\n \"type\": \"ORACLE\"\n },\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"3ed058f0-72fe-4ba2-90af-1ec2930f3c83","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"application\": {\n \"name\": \"\",\n \"type\": \"ORACLE\"\n },\n \"taxID\": {\n \"taxID\": \"\",\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\": \"\",\n \"isActive\": \"\",\n \"type\": \"PLUGIN\",\n \"clientId\": \"\",\n \"clientSecret\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b47a24e7-8639-4078-87b4-e32f7d3773fc","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"application\": {\n \"name\": \"\",\n \"type\": \"ORACLE\"\n },\n \"taxID\": {\n \"taxID\": \"\",\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\": \"\",\n \"isActive\": \"\",\n \"type\": \"PLUGIN\",\n \"clientId\": \"\",\n \"clientSecret\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"984b5065-8ef8-4782-b90c-27c293a495fc","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"application\": {\n \"name\": \"\",\n \"type\": \"ORACLE\"\n },\n \"taxID\": {\n \"taxID\": \"\",\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\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8cf6a92d-e53c-42bc-8120-25a7a4c23167","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"application\": {\n \"name\": \"\",\n \"type\": \"ORACLE\"\n },\n \"taxID\": {\n \"taxID\": \"\",\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\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"company","description":"","item":[{"name":"{taxID}","description":"","item":[{"id":"40b891b8-003b-44b4-a64d-bc98c0b7b0fa","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":"","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":"55099f07-bb99-4074-8ebb-2032748cc8e0","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"preRegistration\": {\n \"preRegistration\": {\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n }\n },\n \"user\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n },\n \"company\": {\n \"id\": \"\",\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n }\n },\n \"account\": {\n \"clientId\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3f98c5d4-6e20-4a0a-976d-16cc56801836","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"4a2ae6ff-b935-41fa-bb87-8e15056c5def","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":"056e70bd-73fb-4c65-adac-874d0e521ea8","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"preRegistrations\": [\n {\n \"preRegistration\": {\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n }\n },\n \"user\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n },\n \"company\": {\n \"id\": \"\",\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n }\n },\n \"account\": {\n \"clientId\": \"\"\n }\n },\n {\n \"preRegistration\": {\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n }\n },\n \"user\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n },\n \"company\": {\n \"id\": \"\",\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n }\n },\n \"account\": {\n \"clientId\": \"\"\n }\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n },\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n }\n ],\n \"skip\": \"\",\n \"limit\": \"\",\n \"totalCount\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"11041190-2923-40ff-b0c5-beea83faa99d","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"cb1ef482-08cd-4e55-8ec8-ce6eea315d69","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\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n },\n \"website\": \"\"\n },\n \"user\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"fd02406a-ecd8-4267-953f-c4185b583afe","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"preRegistration\": {\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n },\n \"website\": \"\"\n },\n \"user\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"preRegistration\": {\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n },\n \"website\": \"\"\n },\n \"user\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7be53f6e-20d0-4458-a380-534654ad0946","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"preRegistration\": {\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n },\n \"website\": \"\"\n },\n \"user\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"preRegistration\": {\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n },\n \"website\": \"\"\n },\n \"user\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ce9e4f0a-9a8e-4ac8-9fa5-ab52e6046910","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"preRegistration\": {\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n },\n \"website\": \"\"\n },\n \"user\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a9fb15d0-461b-4088-ab5c-f45363cd2d7e","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"preRegistration\": {\n \"name\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n },\n \"website\": \"\"\n },\n \"user\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]},{"name":"payment","description":"","item":[{"name":"approve","description":"","item":[{"id":"a3733ee4-f1a7-4e34-9cb6-c03936b55f24","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\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"ce15c4d2-92f4-4ec5-94e9-e177d0ae4bcd","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"payment\": {\n \"value\": \"\",\n \"destinationAlias\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\",\n \"status\": \"CONFIRMED\",\n \"sourceAccountId\": \"\"\n },\n \"transaction\": {\n \"value\": \"\",\n \"endToEndId\": \"\",\n \"time\": \"\"\n },\n \"destination\": {\n \"name\": \"\",\n \"taxID\": \"\",\n \"pixKey\": \"\",\n \"bank\": \"\",\n \"branch\": \"\",\n \"account\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e551bb99-489e-4c51-ace7-9c60bd54e567","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"correlationID\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"{id}","description":"","item":[{"id":"f0fd25cd-eef5-406a-9404-4d3c7f8f996e","name":"Get one Payment","request":{"name":"Get one Payment","description":{},"url":{"path":["api","v1","payment",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","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":"361a6318-8e9b-4e05-af4b-b241344824de","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"payment\": {\n \"value\": \"\",\n \"destinationAlias\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\",\n \"status\": \"CONFIRMED\",\n \"sourceAccountId\": \"\"\n },\n \"transaction\": {\n \"value\": \"\",\n \"endToEndId\": \"\",\n \"time\": \"\"\n },\n \"destination\": {\n \"name\": \"\",\n \"taxID\": \"\",\n \"pixKey\": \"\",\n \"bank\": \"\",\n \"branch\": \"\",\n \"account\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b4cf9d52-b4f6-47b3-a08a-94f33842dfe3","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"c0fa14d8-c591-4616-80b2-e294882c78e5","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":"199fc11a-a30f-4572-be30-9a9ec72a8cae","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"\",\n \"payments\": [\n {\n \"payment\": {\n \"value\": \"\",\n \"destinationAlias\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\",\n \"status\": \"CONFIRMED\",\n \"sourceAccountId\": \"\"\n },\n \"transaction\": {\n \"value\": \"\",\n \"endToEndId\": \"\",\n \"time\": \"\"\n },\n \"destination\": {\n \"name\": \"\",\n \"taxID\": \"\",\n \"pixKey\": \"\",\n \"bank\": \"\",\n \"branch\": \"\",\n \"account\": \"\"\n }\n },\n {\n \"payment\": {\n \"value\": \"\",\n \"destinationAlias\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\",\n \"status\": \"CREATED\",\n \"sourceAccountId\": \"\"\n },\n \"transaction\": {\n \"value\": \"\",\n \"endToEndId\": \"\",\n \"time\": \"\"\n },\n \"destination\": {\n \"name\": \"\",\n \"taxID\": \"\",\n \"pixKey\": \"\",\n \"bank\": \"\",\n \"branch\": \"\",\n \"account\": \"\"\n }\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n },\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n }\n ],\n \"skip\": \"\",\n \"limit\": \"\",\n \"totalCount\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"09269a93-173f-4fad-8e90-954f3172decd","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7ca1fa51-e753-4507-bea3-ca39742122c4","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\": \"\",\n \"destinationAlias\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\",\n \"sourceAccountId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"88f7f36c-0b0a-4511-827d-a24c9ad179b2","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\",\n \"destinationAlias\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\",\n \"sourceAccountId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"payment\": {\n \"value\": \"\",\n \"destinationAlias\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\",\n \"status\": \"DENIED\",\n \"sourceAccountId\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e7619b16-dcf2-477b-b159-56f5327707a7","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\",\n \"destinationAlias\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\",\n \"sourceAccountId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"qrcode-static","description":"","item":[{"name":"{id}","description":"","item":[{"id":"c66d3b69-1e71-4b76-b885-aed3214c9dee","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":"","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":"3fe52568-17d7-4af6-a840-330ed59149e3","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"pixQrCode\": {\n \"name\": \"\",\n \"value\": \"\",\n \"comment\": \"\",\n \"identifier\": \"\",\n \"brCode\": \"\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"943b5cdd-7c13-4df4-ad1f-de385196d9af","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"fb5db5d6-738c-4e69-ad3b-321ea9feebf8","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":"9a5df0cc-234c-4ce5-8b06-f9e3dc33bec4","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"pixQrCodes\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"comment\": \"\",\n \"identifier\": \"\",\n \"brCode\": \"\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"comment\": \"\",\n \"identifier\": \"\",\n \"brCode\": \"\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n },\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n }\n ],\n \"skip\": \"\",\n \"limit\": \"\",\n \"totalCount\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"15d1b386-3ccf-4ea5-8521-1211a6df05b8","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"49da1739-24b9-401f-b79e-c755effd50c7","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\": \"\",\n \"identifier\": \"\",\n \"correlationID\": \"\",\n \"value\": \"\",\n \"comment\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"eccd3e8e-a211-4878-ab1b-d398b957823c","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"identifier\": \"\",\n \"correlationID\": \"\",\n \"value\": \"\",\n \"comment\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"pixQrCode\": {\n \"name\": \"\",\n \"value\": \"\",\n \"comment\": \"\",\n \"identifier\": \"\",\n \"brCode\": \"\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n \"correlationID\": \"\",\n \"brCode\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9568ab94-39c6-411a-b0e1-1a55b3c52651","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"identifier\": \"\",\n \"correlationID\": \"\",\n \"value\": \"\",\n \"comment\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"refund","description":"","item":[{"name":"{id}","description":"","item":[{"id":"e03ccb80-ed60-43f8-995a-7d7c12845349","name":"Get one refund","request":{"name":"Get one refund","description":{},"url":{"path":["api","v1","refund",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","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":"220adf67-fc76-40a3-b14d-babf4e15e657","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"pixTransactionRefund\": {\n \"value\": \"\",\n \"status\": \"IN_PROCESSING\",\n \"correlationID\": \"\",\n \"refundId\": \"\",\n \"time\": \"\",\n \"comment\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"69d7a9b5-02c9-4438-9187-4716f7bee9ce","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"dd0304ba-e4bd-4169-8470-b973d856e9f1","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":"790a0cc1-7dc8-47e9-a626-9c60e7e3ae73","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"refunds\": [\n {\n \"value\": \"\",\n \"status\": \"REFUNDED\",\n \"correlationID\": \"\",\n \"refundId\": \"\",\n \"time\": \"\",\n \"comment\": \"\"\n },\n {\n \"value\": \"\",\n \"status\": \"NOT_ACCOMPLISHED\",\n \"correlationID\": \"\",\n \"refundId\": \"\",\n \"time\": \"\",\n \"comment\": \"\"\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n },\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n }\n ],\n \"skip\": \"\",\n \"limit\": \"\",\n \"totalCount\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9413fbde-cf9b-489b-bd6b-0a5433460f5a","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5f153dbd-bd8c-47ae-8d57-19f1e2550b01","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\": \"\",\n \"transactionEndToEndId\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"466610cc-658f-43df-9e66-9a66f8acc8a7","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\",\n \"transactionEndToEndId\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"refund\": {\n \"value\": \"\",\n \"status\": \"NOT_ACCOMPLISHED\",\n \"correlationID\": \"\",\n \"refundId\": \"\",\n \"time\": \"\",\n \"comment\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f66fbbe3-8fad-4da6-82eb-d56eb9fa88a1","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\",\n \"transactionEndToEndId\": \"\",\n \"correlationID\": \"\",\n \"comment\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"subscriptions","description":"","item":[{"name":"{id}","description":"","item":[{"id":"e3cea974-8d61-43e2-b38e-1924db1d5172","name":"Get one subscription","request":{"name":"Get one subscription","description":{},"url":{"path":["api","v1","subscriptions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","key":"id","disabled":false,"description":{"content":"(Required) The globalID of the subscription.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"db4299a9-4516-4707-b5d8-9f3cc019f388","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"subscription\": {\n \"globalID\": \"\",\n \"value\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"dayGenerateCharge\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"09228952-43ea-48f4-8f7a-7f7ba26f78b9","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"9f36ce1f-b13a-48a8-808f-d98337938bb5","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\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"value\": \"\",\n \"comment\": \"\",\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"dayGenerateCharge\": 5,\n \"chargeType\": \"DYNAMIC\",\n \"dayDue\": 7\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"10f38aad-07e8-4d6b-a9ce-6f3a176fe3dd","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"value\": \"\",\n \"comment\": \"\",\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\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\": \"\",\n \"value\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"dayGenerateCharge\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cd09a747-5cc9-47b7-9265-697ca16be40f","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"value\": \"\",\n \"comment\": \"\",\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\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\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"transaction","description":"","item":[{"name":"{id}","description":"","item":[{"id":"cfae81a7-795b-46c0-8996-1b70413042a9","name":"Get a Transaction","request":{"name":"Get a Transaction","description":{},"url":{"path":["api","v1","transaction",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","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":"824d660a-11d9-42f5-bdaa-2c4ff60b5df3","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"transaction\": {\n \"charge\": {\n \"value\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"DYNAMIC\",\n \"comment\": \"\",\n \"brCode\": \"\",\n \"status\": \"COMPLETED\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\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\": \"\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"pixKey\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"expiresIn\": \"\"\n },\n \"value\": \"\",\n \"time\": \"\",\n \"endToEndID\": \"\",\n \"transactionID\": \"\",\n \"infoPagador\": \"\",\n \"endToEndId\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"withdraw\": {\n \"value\": \"\",\n \"time\": \"\",\n \"endToEndID\": \"\",\n \"transactionID\": \"\",\n \"infoPagador\": \"\",\n \"endToEndId\": \"\",\n \"payer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"\"\n },\n \"payer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"REFUND\",\n \"globalID\": {\n \"description\": \"External ID of this transaction\"\n },\n \"pixQrCode\": {\n \"name\": \"\",\n \"value\": \"\",\n \"comment\": \"\",\n \"identifier\": \"\",\n \"brCode\": \"\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a51f537c-fdb3-498c-8255-714302c5481f","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"090749cb-fe87-4464-994e-24731f9abb2c","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":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":""},{"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":""},{"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":""},{"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":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"a4cd7025-4900-4404-bfc9-facb302258af","name":"A list of transactions","originalRequest":{"url":{"path":["api","v1","transaction"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":""},{"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":""},{"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":""},{"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":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"\",\n \"transactions\": [\n {\n \"charge\": {\n \"value\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"DYNAMIC\",\n \"comment\": \"\",\n \"brCode\": \"\",\n \"status\": \"ACTIVE\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\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\": \"\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"pixKey\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"expiresIn\": \"\"\n },\n \"value\": \"\",\n \"time\": \"\",\n \"endToEndID\": \"\",\n \"transactionID\": \"\",\n \"infoPagador\": \"\",\n \"endToEndId\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"withdraw\": {\n \"value\": \"\",\n \"time\": \"\",\n \"endToEndID\": \"\",\n \"transactionID\": \"\",\n \"infoPagador\": \"\",\n \"endToEndId\": \"\",\n \"payer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"\"\n },\n \"payer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"REFUND\",\n \"globalID\": {\n \"description\": \"External ID of this transaction\"\n },\n \"pixQrCode\": {\n \"name\": \"\",\n \"value\": \"\",\n \"comment\": \"\",\n \"identifier\": \"\",\n \"brCode\": \"\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n },\n {\n \"charge\": {\n \"value\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"DYNAMIC\",\n \"comment\": \"\",\n \"brCode\": \"\",\n \"status\": \"COMPLETED\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\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\": \"\",\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"pixKey\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"expiresIn\": \"\"\n },\n \"value\": \"\",\n \"time\": \"\",\n \"endToEndID\": \"\",\n \"transactionID\": \"\",\n \"infoPagador\": \"\",\n \"endToEndId\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"withdraw\": {\n \"value\": \"\",\n \"time\": \"\",\n \"endToEndID\": \"\",\n \"transactionID\": \"\",\n \"infoPagador\": \"\",\n \"endToEndId\": \"\",\n \"payer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"\"\n },\n \"payer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"\"\n },\n \"correlationID\": \"\",\n \"address\": {\n \"zipcode\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"complement\": \"\",\n \"country\": \"\"\n }\n },\n \"type\": \"PAYMENT\",\n \"globalID\": {\n \"description\": \"External ID of this transaction\"\n },\n \"pixQrCode\": {\n \"name\": \"\",\n \"value\": \"\",\n \"comment\": \"\",\n \"identifier\": \"\",\n \"brCode\": \"\",\n \"correlationID\": \"\",\n \"paymentLinkID\": \"\",\n \"paymentLinkUrl\": {\n \"description\": \"Payment Link URL to be shared with customers\"\n },\n \"qrCodeImage\": {\n \"description\": \"QRCode image link URL\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n },\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n }\n ],\n \"skip\": \"\",\n \"limit\": \"\",\n \"totalCount\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"63cb4a49-6de5-4e11-967a-fc1b4a6e872c","name":"An error message","originalRequest":{"url":{"path":["api","v1","transaction"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":""},{"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":""},{"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":""},{"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":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"transfer","description":"","item":[{"id":"eac84a82-c715-4c38-bbd0-4c591af2f4d1","name":"Create a Transfer","request":{"name":"Create a Transfer","description":{"content":"Endpoint to to transfer values between sub 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\": \"\",\n \"fromPixKey\": \"\",\n \"toPixKey\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"0a1b8b5a-d2c2-4554-b8cc-c825665b95f1","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\",\n \"fromPixKey\": \"\",\n \"toPixKey\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"transaction\": {\n \"value\": \"\",\n \"time\": \"\",\n \"correlationID\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e38cb015-068e-4355-87a8-1125a58375aa","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"value\": \"\",\n \"fromPixKey\": \"\",\n \"toPixKey\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"webhook","description":"","item":[{"name":"{id}","description":"","item":[{"id":"4b6fd3c5-9b8f-41d7-903b-167e5ab59307","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":"","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":"47f4ebcc-5b6a-407b-abb8-63663705f20a","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":""}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"014cd1ac-9a53-4cec-a4ec-d91853e70c24","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":""}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\",\n \"status\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"ff4c0fa1-a27b-43a6-be5e-ac733bb6acfd","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":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"8f463fb1-773d-4894-8007-98d49be8c44b","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":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"webhooks\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"event\": \"OPENPIX:MOVEMENT_FAILED\",\n \"url\": \"\",\n \"authorization\": \"\",\n \"isActive\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"event\": \"OPENPIX:TRANSACTION_REFUND_RECEIVED\",\n \"url\": \"\",\n \"authorization\": \"\",\n \"isActive\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n },\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n }\n ]\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"55da39ee-df00-4498-9700-7af5e811ec3c","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":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ea37ee17-afd7-4f1a-8757-057ef0bac1ec","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\": \"\",\n \"event\": \"OPENPIX:MOVEMENT_FAILED\",\n \"url\": \"\",\n \"authorization\": \"\",\n \"isActive\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"3157be76-0e73-4f42-bc64-0957fbcaf3e2","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"webhook\": {\n \"name\": \"\",\n \"event\": \"OPENPIX:MOVEMENT_FAILED\",\n \"url\": \"\",\n \"authorization\": \"\",\n \"isActive\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"webhook\": {\n \"id\": \"\",\n \"name\": \"\",\n \"event\": \"OPENPIX:MOVEMENT_REMOVED\",\n \"url\": \"\",\n \"authorization\": \"\",\n \"isActive\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"be88385b-c661-49d7-8d85-0354c93c61f8","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"webhook\": {\n \"name\": \"\",\n \"event\": \"OPENPIX:MOVEMENT_FAILED\",\n \"url\": \"\",\n \"authorization\": \"\",\n \"isActive\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"subaccount","description":"","item":[{"name":"{id}","description":"","item":[{"name":"withdraw","description":"","item":[{"id":"0f9cbfa8-df07-4962-b4d9-07874631fc7b","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":"","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":"230c4b8d-51bb-4ff3-8c52-9715f26dd791","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":""}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"withdraw\": {\n \"account\": {\n \"status\": \"\",\n \"value\": \"\",\n \"correlationID\": \"\",\n \"destinationAlias\": \"\",\n \"comment\": \"\"\n }\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6ba6a68a-e025-4f1a-8d3a-a247423e0f5e","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":""}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"278f6ba5-1fbf-410b-95de-320f75121ff6","name":"Get subaccount details","request":{"name":"Get subaccount details","description":{},"url":{"path":["api","v1","subaccount",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","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":"f533676b-3cbc-40c7-a099-5d1342ad9fa4","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"SubAccount\": {\n \"name\": \"\",\n \"pixKey\": \"\",\n \"balance\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"47a5f630-db66-4d74-9aad-e0bf2464240b","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"b4882638-0446-4267-8eb5-3fedebc182b0","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":"6c5f342d-20fd-4145-822c-2c05c0b5f964","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":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"status\": \"\",\n \"subaccounts\": [\n {\n \"payment\": {\n \"name\": \"\",\n \"pixKey\": \"\",\n \"balance\": \"\"\n }\n },\n {\n \"payment\": {\n \"name\": \"\",\n \"pixKey\": \"\",\n \"balance\": \"\"\n }\n }\n ],\n \"pageInfo\": {\n \"errors\": [\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n },\n {\n \"message\": \"\",\n \"data\": {\n \"skip\": \"\",\n \"limit\": \"\"\n }\n }\n ],\n \"skip\": \"\",\n \"limit\": \"\",\n \"totalCount\": \"\",\n \"hasPreviousPage\": \"\",\n \"hasNextPage\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"135a36ce-3c7c-4b5a-abaf-b0ed04b55c8e","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":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4b8f28de-96f0-4805-a7bb-fcd6b4fc5ca7","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\": \"\",\n \"name\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"97fa78c9-9f85-4d9a-bdaa-b5f742dfab29","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"pixKey\": \"\",\n \"name\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"SubAccount\": {\n \"name\": \"\",\n \"pixKey\": \"\",\n \"balance\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"732d2f6b-1347-45da-9b2b-909000872ed4","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":""}],"method":"POST","body":{"mode":"raw","raw":"{\n \"pixKey\": \"\",\n \"name\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\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":"45c7c075-04ae-4525-ad31-6d8ff0696430","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":""}],"variable":[{"disabled":false,"description":{"content":"(Required) charge link payment ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"a98efec5-8bdc-4a5b-a2b1-32ff8449bda5","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":""}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":""}],"method":"GET","body":{}},"status":"OK","code":200,"header":[],"cookie":[],"_postman_previewlanguage":"text"},{"id":"23037951-a612-4b14-8fe8-aa239279c1af","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":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":""}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n \"error\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]}]}]}]}],"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"{{apiKey}}","key":"value"},{"type":"any","value":"header","key":"in"}]},"event":[],"variable":[{"key":"baseUrl","value":"https://api.woovi.com"}],"info":{"_postman_id":"236b40af-8e21-4cfd-bde2-a1d6467c4a6a","name":"Woovi","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json","description":{"content":"A Woovi é uma Plataforma de Gestão de Pagamentos. Para utilizar nossa API você deve acessar __[https://api.woovi.com/](https://api.woovi.com/)__ e somente o mesmo. A Woovi não aceita subdominios para a API.\n\nVeja como configurar seu acesso a nossa API [aqui](https://developers.woovi.com/docs/apis/api-getting-started).","type":"text/plain"}}} \ No newline at end of file