diff --git a/src/swaggers/woovi.json b/src/swaggers/woovi.json index 4dbcfe3..9ef51ce 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 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":1,"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":{"name":"my-qr-code","correlationID":"9134e286-6f71-427a-bf00-241681624586","value":100,"comment":"good"}}}},"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({name: 'string', correlationID: 'string', value: 0, comment: 'string'}));\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\"}'"},{"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\\\"}\",\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\\\"}\"\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\\\"}\")\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\\\"}\");\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\\\"}\"\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"},"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"}},"required":["name"]},"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":1,"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 cccda2a..c475c0a 100644 --- a/src/swaggers/woovi.yml +++ b/src/swaggers/woovi.yml @@ -15,7 +15,7 @@ servers: security: - AppID: [] paths: - "/api/v1/account/{accountId}": + '/api/v1/account/{accountId}': get: tags: - account @@ -29,7 +29,7 @@ paths: type: string example: 6290ccfd42831958a405debc responses: - "200": + '200': description: The Account retrieve using the given Account ID content: application/json: @@ -38,7 +38,7 @@ paths: properties: account: type: object - $ref: "#/components/schemas/CompanyBankAccount" + $ref: '#/components/schemas/CompanyBankAccount' example: account: accountId: 6290ccfd42831958a405debc @@ -47,7 +47,7 @@ paths: total: 129430 blocked: 0 available: 129430 - "400": + '400': description: An error message content: application/json: @@ -62,7 +62,7 @@ paths: - account summary: Get a list of Accounts responses: - "200": + '200': description: A list of Accounts content: application/json: @@ -72,7 +72,7 @@ paths: accounts: type: array items: - $ref: "#/components/schemas/CompanyBankAccount" + $ref: '#/components/schemas/CompanyBankAccount' example: accounts: - accountId: 6290ccfd42831958a405debc @@ -87,7 +87,7 @@ paths: total: 130 blocked: 100 available: 30 - "400": + '400': description: An error message content: application/json: @@ -96,12 +96,13 @@ paths: properties: error: type: string - "/api/v1/account/{accountId}/withdraw": + '/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 + 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: @@ -125,7 +126,7 @@ paths: example: value: 7000 responses: - "200": + '200': description: Withdraw and Acccount information content: application/json: @@ -137,10 +138,10 @@ paths: properties: account: type: object - $ref: "#/components/schemas/CompanyBankAccount" + $ref: '#/components/schemas/CompanyBankAccount' transaction: type: object - $ref: "#/components/schemas/WithdrawTransaction" + $ref: '#/components/schemas/WithdrawTransaction' example: withdraw: account: @@ -153,7 +154,7 @@ paths: transaction: endToEndId: E23114447202205191817cx6VMrbwtw6 transaction: 7000 - "400": + '400': description: An error message content: application/json: @@ -162,7 +163,7 @@ paths: properties: error: type: string - "/api/v1/cashback-fidelity/balance/{taxID}": + '/api/v1/cashback-fidelity/balance/{taxID}': get: tags: - cashback-fidelity @@ -176,9 +177,9 @@ paths: type: string examples: taxID: - value: "60151449000182" + value: '60151449000182' responses: - "200": + '200': description: Amount the user still has to receive. content: application/json: @@ -189,7 +190,7 @@ paths: type: number status: type: string - "400": + '400': description: An error message content: application/json: @@ -224,8 +225,9 @@ paths: value: 100 taxID: 11111111111 responses: - "200": - description: Didn't create a new cashback, returning previously existing + '200': + description: + Didn't create a new cashback, returning previously existing cashback information instead. content: application/json: @@ -242,7 +244,7 @@ paths: message: type: string description: String explaining what happened - "201": + '201': description: New cashback created successfully content: application/json: @@ -259,7 +261,7 @@ paths: message: type: string description: String explaining what happened - "400": + '400': description: An error message content: application/json: @@ -268,7 +270,7 @@ paths: properties: error: type: string - "/api/v1/charge/{id}": + '/api/v1/charge/{id}': delete: tags: - charge @@ -276,7 +278,8 @@ paths: parameters: - name: id in: path - description: charge ID or correlation ID. You will need URI encoding if your + 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 @@ -288,7 +291,7 @@ paths: correlationID: value: fe7834b4060c488a9b0f89811be5f5cf responses: - "200": + '200': description: The charge deleted content: application/json: @@ -303,7 +306,7 @@ paths: example: status: OK id: fe7834b4060c488a9b0f89811be5f5cf - "400": + '400': description: An error message content: application/json: @@ -319,7 +322,8 @@ paths: parameters: - name: id in: path - description: charge ID or correlation ID. You will need URI encoding if your + 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 @@ -327,7 +331,7 @@ paths: type: string example: fe7834b4060c488a9b0f89811be5f5cf responses: - "200": + '200': description: The charge retrieve using the given ID content: application/json: @@ -336,16 +340,16 @@ paths: properties: charge: type: object - $ref: "#/components/schemas/Charge" + $ref: '#/components/schemas/Charge' example: charge: status: ACTIVE customer: name: Dan email: email0@example.com - phone: "5511999999999" + phone: '5511999999999' taxID: - taxID: "31324227036" + taxID: '31324227036' type: BR:CPF value: 100 comment: good @@ -354,20 +358,21 @@ paths: 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 + brCode: + 000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA additionalInfo: - key: Product value: Pencil - key: Invoice - value: "18476" + value: '18476' - key: Order - value: "302" + 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": + '400': description: An error message content: application/json: @@ -385,11 +390,11 @@ paths: - in: query name: start schema: - $ref: "#/components/schemas/Start" + $ref: '#/components/schemas/Start' - in: query name: end schema: - $ref: "#/components/schemas/End" + $ref: '#/components/schemas/End' - name: status in: query schema: @@ -399,7 +404,7 @@ paths: - COMPLETED - EXPIRED responses: - "200": + '200': description: A list of charges content: application/json: @@ -409,7 +414,7 @@ paths: charges: type: array items: - $ref: "#/components/schemas/Charge" + $ref: '#/components/schemas/Charge' pageInfo: type: object properties: @@ -449,9 +454,9 @@ paths: customer: name: Dan email: email0@example.com - phone: "5511999999999" + phone: '5511999999999' taxID: - taxID: "31324227036" + taxID: '31324227036' type: BR:CPF value: 100 comment: good @@ -459,20 +464,21 @@ paths: 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 + brCode: + 000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA additionalInfo: - key: Product value: Pencil - key: Invoice - value: "18476" + value: '18476' - key: Order - value: "302" + 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": + '400': description: An error message content: application/json: @@ -488,7 +494,8 @@ paths: parameters: - in: query name: return_existing - description: Make the endpoint idempotent, will return an existent charge if + description: + Make the endpoint idempotent, will return an existent charge if already has a one with the correlationID required: false schema: @@ -504,7 +511,7 @@ paths: application/json: schema: type: object - $ref: "#/components/schemas/ChargePayload" + $ref: '#/components/schemas/ChargePayload' examples: Charge: value: @@ -513,16 +520,16 @@ paths: comment: good customer: name: Dan - taxID: "31324227036" + taxID: '31324227036' email: email0@example.com - phone: "5511999999999" + phone: '5511999999999' additionalInfo: - key: Product value: Pencil - key: Invoice - value: "18476" + value: '18476' - key: Order - value: "302" + value: '302' Charge with Interests and Fines: value: type: OVERDUE @@ -537,13 +544,13 @@ paths: value: 20 customer: name: Dan - taxID: "31324227036" + taxID: '31324227036' email: email0@example.com - phone: "5511999999999" + phone: '5511999999999' address: - zipcode: "30421322" + zipcode: '30421322' street: Street - number: "100" + number: '100' neighborhood: Neighborhood city: Belo Horizonte state: MG @@ -553,12 +560,13 @@ paths: - key: Product value: Pencil - key: Invoice - value: "18476" + value: '18476' - key: Order - value: "302" + value: '302' responses: - "200": - description: Charge ID and also the generated Dynamic BR Code to be rendered as + '200': + description: + Charge ID and also the generated Dynamic BR Code to be rendered as a QRCode content: application/json: @@ -566,7 +574,7 @@ paths: type: object properties: charge: - $ref: "#/components/schemas/Charge" + $ref: '#/components/schemas/Charge' correlationID: type: string brCode: @@ -577,9 +585,9 @@ paths: customer: name: Dan email: email0@example.com - phone: "5511999999999" + phone: '5511999999999' taxID: - taxID: "31324227036" + taxID: '31324227036' type: BR:CPF value: 100 comment: good @@ -591,16 +599,17 @@ paths: 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 + brCode: + 000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA additionalInfo: - key: Product value: Pencil - key: Invoice - value: "18476" + value: '18476' - key: Order - value: "302" - "400": + value: '302' + '400': description: An error message content: application/json: @@ -609,7 +618,7 @@ paths: properties: error: type: string - "/api/v1/charge/{id}/refund": + '/api/v1/charge/{id}/refund': get: tags: - charge refund @@ -618,7 +627,8 @@ paths: parameters: - name: id in: path - description: The correlation ID of the charge. You will need URI encoding if + 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 @@ -630,7 +640,7 @@ paths: random-string: value: fe7834b4060c488a9b0f89811be5f5cf responses: - "200": + '200': description: A list of refunds content: application/json: @@ -640,7 +650,7 @@ paths: refunds: type: array items: - $ref: "#/components/schemas/ChargeRefund" + $ref: '#/components/schemas/ChargeRefund' example: refunds: - status: IN_PROCESSING @@ -654,7 +664,7 @@ paths: endToEndId: E23114447202304181057pOhPMsp2pJZ time: 2021-03-05T14:49:02.922Z comment: Comentário do reembolso - "400": + '400': description: An error message content: application/json: @@ -671,7 +681,8 @@ paths: parameters: - name: id in: path - description: The correlation ID of the charge. You will need URI encoding if + 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 @@ -689,13 +700,13 @@ paths: application/json: schema: type: object - $ref: "#/components/schemas/ChargeRefundPayload" + $ref: '#/components/schemas/ChargeRefundPayload' example: correlationID: a273e72c-9547-4c75-a213-3b0a2735b8d5 value: 100 comment: Comentário do reembolso responses: - "200": + '200': description: The created Refund content: application/json: @@ -703,7 +714,7 @@ paths: type: object properties: refund: - $ref: "#/components/schemas/ChargeRefund" + $ref: '#/components/schemas/ChargeRefund' example: refund: status: IN_PROCESSING @@ -712,7 +723,7 @@ paths: endToEndId: E23114447202304181826HJNwY577YDX time: 2023-03-02T17:28:51.882Z comment: Comentário do reembolso - "400": + '400': description: An error message content: application/json: @@ -721,7 +732,7 @@ paths: properties: error: type: string - "/api/v1/customer/{id}": + '/api/v1/customer/{id}': get: tags: - customer @@ -737,7 +748,7 @@ paths: correlationID: value: fe7834b4060c488a9b0f89811be5f5cf responses: - "200": + '200': description: The customer retrieve using the given ID content: application/json: @@ -746,17 +757,17 @@ paths: properties: customer: type: object - $ref: "#/components/schemas/Customer" + $ref: '#/components/schemas/Customer' example: customer: name: Dan email: email0@example.com - phone: "5511999999999" + phone: '5511999999999' taxID: - taxID: "31324227036" + taxID: '31324227036' type: BR:CPF correlationID: fe7834b4060c488a9b0f89811be5f5cf - "400": + '400': description: An error message content: application/json: @@ -771,7 +782,7 @@ paths: - customer summary: Get a list of customers responses: - "200": + '200': description: A list of customers content: application/json: @@ -781,7 +792,7 @@ paths: customers: type: array items: - $ref: "#/components/schemas/Customer" + $ref: '#/components/schemas/Customer' pageInfo: type: object properties: @@ -820,11 +831,11 @@ paths: customer: name: Dan email: email0@example.com - phone: "5511999999999" + phone: '5511999999999' taxID: - taxID: "31324227036" + taxID: '31324227036' type: BR:CPF - "400": + '400': description: An error message content: application/json: @@ -845,24 +856,24 @@ paths: application/json: schema: type: object - $ref: "#/components/schemas/CustomerPayload" + $ref: '#/components/schemas/CustomerPayload' example: name: Dan - taxID: "31324227036" + taxID: '31324227036' email: email0@example.com - phone: "5511999999999" + phone: '5511999999999' correlationID: 9134e286-6f71-427a-bf00-241681624586 address: - zipcode: "30421322" + zipcode: '30421322' street: Street - number: "100" + number: '100' neighborhood: Neighborhood city: Belo Horizonte state: MG complement: APTO country: BR responses: - "200": + '200': description: Customer ID content: application/json: @@ -870,25 +881,25 @@ paths: type: object properties: customer: - $ref: "#/components/schemas/Customer" + $ref: '#/components/schemas/Customer' example: customer: name: Dan email: email0@example.com - phone: "5511999999999" + phone: '5511999999999' taxID: - taxID: "31324227036" + taxID: '31324227036' type: BR:CPF address: - zipcode: "30421322" + zipcode: '30421322' street: Street - number: "100" + number: '100' neighborhood: Neighborhood city: Belo Horizonte state: MG complement: APTO country: BR - "400": + '400': description: An error message content: application/json: @@ -924,12 +935,12 @@ paths: type: string description: The name you want to give your application type: - $ref: "#/components/schemas/ApplicationEnumTypePayload" + $ref: '#/components/schemas/ApplicationEnumTypePayload' required: - name - type taxID: - $ref: "#/components/schemas/TaxIDObjectPayload" + $ref: '#/components/schemas/TaxIDObjectPayload' required: - taxID - type @@ -938,10 +949,10 @@ paths: name: MyAPIAccess type: API taxID: - taxID: "65914571000187" + taxID: '65914571000187' type: BR:CNPJ responses: - "200": + '200': description: > Our "idempotence output", if you get this HTTP code, it's an application @@ -953,8 +964,8 @@ paths: type: object properties: application: - $ref: "#/components/schemas/PartnerApplicationPayload" - "201": + $ref: '#/components/schemas/PartnerApplicationPayload' + '201': description: > A new application has been registered. It'll be identified by the name that you give to it @@ -966,8 +977,8 @@ paths: type: object properties: application: - $ref: "#/components/schemas/PartnerApplicationPayload" - "400": + $ref: '#/components/schemas/PartnerApplicationPayload' + '400': description: An error message content: application/json: @@ -976,7 +987,7 @@ paths: properties: error: type: string - "403": + '403': description: You are unauthorized to use this endpoint. content: application/json: @@ -985,7 +996,7 @@ paths: properties: error: type: string - "/api/v1/partner/company/{taxID}": + '/api/v1/partner/company/{taxID}': get: tags: - partner (request access) @@ -999,9 +1010,9 @@ paths: type: string examples: taxID: - value: "60151449000182" + value: '60151449000182' responses: - "200": + '200': description: The preregistration retrieved by the tax ID. content: application/json: @@ -1012,17 +1023,17 @@ paths: type: object properties: preRegistration: - $ref: "#/components/schemas/PreRegistrationObjectPayload" + $ref: '#/components/schemas/PreRegistrationObjectPayload' user: - $ref: "#/components/schemas/PreRegistrationUserObject" + $ref: '#/components/schemas/PreRegistrationUserObject' company: - $ref: "#/components/schemas/CompanyObjectPayload" + $ref: '#/components/schemas/CompanyObjectPayload' account: - $ref: "#/components/schemas/AccountObjectPayload" + $ref: '#/components/schemas/AccountObjectPayload' required: - preRegistration - user - "400": + '400': description: An error message content: application/json: @@ -1037,7 +1048,7 @@ paths: - partner (request access) summary: Get every preregistration that is managed by you. responses: - "200": + '200': description: A list with preregistrations. content: application/json: @@ -1050,13 +1061,13 @@ paths: type: object properties: preRegistration: - $ref: "#/components/schemas/PreRegistrationObjectPayload" + $ref: '#/components/schemas/PreRegistrationObjectPayload' user: - $ref: "#/components/schemas/PreRegistrationUserObject" + $ref: '#/components/schemas/PreRegistrationUserObject' company: - $ref: "#/components/schemas/CompanyObjectPayload" + $ref: '#/components/schemas/CompanyObjectPayload' account: - $ref: "#/components/schemas/AccountObjectPayload" + $ref: '#/components/schemas/AccountObjectPayload' required: - preRegistration - user @@ -1087,7 +1098,7 @@ paths: type: boolean hasNextPage: type: boolean - "400": + '400': description: An error message content: application/json: @@ -1112,21 +1123,21 @@ paths: application/json: schema: type: object - $ref: "#/components/schemas/PreRegistrationPayloadObject" + $ref: '#/components/schemas/PreRegistrationPayloadObject' example: preRegistration: name: Example LLC taxID: - taxID: "11111111111111" + taxID: '11111111111111' type: BR:CNPJ website: examplellc.com user: firstName: John lastName: Doe email: johndoe@examplellc.com - phone: "+5511912345678" + phone: '+5511912345678' responses: - "200": + '200': description: > Payload with a pre registration data. @@ -1136,14 +1147,14 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/PreRegistrationPayloadObject" - "201": + $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": + $ref: '#/components/schemas/PreRegistrationPayloadObject' + '400': description: An error message content: application/json: @@ -1152,7 +1163,7 @@ paths: properties: error: type: string - "403": + '403': description: You are unauthorized to use this endpoint. content: application/json: @@ -1174,11 +1185,11 @@ paths: application/json: schema: type: object - $ref: "#/components/schemas/PaymentApprovePayload" + $ref: '#/components/schemas/PaymentApprovePayload' example: correlationID: payment1 responses: - "200": + '200': description: The approved payment content: application/json: @@ -1187,13 +1198,13 @@ paths: properties: payment: type: object - $ref: "#/components/schemas/Payment" + $ref: '#/components/schemas/Payment' transaction: type: object - $ref: "#/components/schemas/PaymentTransaction" + $ref: '#/components/schemas/PaymentTransaction' destination: type: object - $ref: "#/components/schemas/PaymentDestination" + $ref: '#/components/schemas/PaymentDestination' example: payment: value: 100 @@ -1208,12 +1219,12 @@ paths: time: 2023-03-20T13:14:17.000Z destination: name: Dan - taxID: "31324227036" + taxID: '31324227036' pixKey: c4249323-b4ca-43f2-8139-8232aab09b93 bank: A Bank - branch: "1" - account: "123456" - "400": + branch: '1' + account: '123456' + '400': description: An error message content: application/json: @@ -1222,7 +1233,7 @@ paths: properties: error: type: string - "/api/v1/payment/{id}": + '/api/v1/payment/{id}': get: tags: - payment (request access) @@ -1240,7 +1251,7 @@ paths: correlationID: value: fe7834b4060c488a9b0f89811be5f5cf responses: - "200": + '200': description: The payment retrieved using the given ID content: application/json: @@ -1249,13 +1260,13 @@ paths: properties: payment: type: object - $ref: "#/components/schemas/Payment" + $ref: '#/components/schemas/Payment' transaction: type: object - $ref: "#/components/schemas/PaymentTransaction" + $ref: '#/components/schemas/PaymentTransaction' destination: type: object - $ref: "#/components/schemas/PaymentDestination" + $ref: '#/components/schemas/PaymentDestination' example: payment: value: 100 @@ -1270,12 +1281,12 @@ paths: time: 2023-03-20T13:14:17.000Z destination: name: Dan - taxID: "31324227036" + taxID: '31324227036' pixKey: c4249323-b4ca-43f2-8139-8232aab09b93 bank: A Bank - branch: "1" - account: "123456" - "400": + branch: '1' + account: '123456' + '400': description: An error message content: application/json: @@ -1290,7 +1301,7 @@ paths: - payment (request access) summary: Get a list of payments responses: - "200": + '200': description: A list of payments content: application/json: @@ -1306,13 +1317,13 @@ paths: properties: payment: type: object - $ref: "#/components/schemas/Payment" + $ref: '#/components/schemas/Payment' transaction: type: object - $ref: "#/components/schemas/PaymentTransaction" + $ref: '#/components/schemas/PaymentTransaction' destination: type: object - $ref: "#/components/schemas/PaymentDestination" + $ref: '#/components/schemas/PaymentDestination' pageInfo: type: object properties: @@ -1361,12 +1372,12 @@ paths: time: 2023-03-20T13:14:17.000Z destination: name: Dan - taxID: "31324227036" + taxID: '31324227036' pixKey: c4249323-b4ca-43f2-8139-8232aab09b93 bank: A Bank - branch: "1" - account: "123456" - "400": + branch: '1' + account: '123456' + '400': description: An error message content: application/json: @@ -1387,7 +1398,7 @@ paths: application/json: schema: type: object - $ref: "#/components/schemas/PaymentCreatePayload" + $ref: '#/components/schemas/PaymentCreatePayload' example: value: 100 destinationAlias: c4249323-b4ca-43f2-8139-8232aab09b93 @@ -1395,7 +1406,7 @@ paths: correlationID: payment1 sourceAccountId: my-source-account-id responses: - "200": + '200': description: Payment destination account information content: application/json: @@ -1403,7 +1414,7 @@ paths: type: object properties: payment: - $ref: "#/components/schemas/Payment" + $ref: '#/components/schemas/Payment' example: payment: value: 100 @@ -1412,7 +1423,7 @@ paths: comment: payment comment correlationID: payment1 sourceAccountId: my-source-account-id - "400": + '400': description: An error message content: application/json: @@ -1421,7 +1432,7 @@ paths: properties: error: type: string - "/api/v1/qrcode-static/{id}": + '/api/v1/qrcode-static/{id}': get: tags: - pixQrCode @@ -1441,7 +1452,7 @@ paths: identifier: value: zr7833b4060c488a9b0f89811 responses: - "200": + '200': description: The pixQrCode retrieve using the given ID content: application/json: @@ -1450,7 +1461,7 @@ paths: properties: pixQrCode: type: object - $ref: "#/components/schemas/PixQrCode" + $ref: '#/components/schemas/PixQrCode' example: pixQrCode: name: pix qrcode static @@ -1461,11 +1472,12 @@ paths: 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 + 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": + '400': description: An error message content: application/json: @@ -1480,7 +1492,7 @@ paths: - pixQrCode summary: Get a list of Pix QrCodes responses: - "200": + '200': description: A list of pixQrCodes content: application/json: @@ -1490,7 +1502,7 @@ paths: pixQrCodes: type: array items: - $ref: "#/components/schemas/PixQrCode" + $ref: '#/components/schemas/PixQrCode' pageInfo: type: object properties: @@ -1534,11 +1546,12 @@ paths: 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 + 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": + '400': description: An error message content: application/json: @@ -1559,15 +1572,16 @@ paths: application/json: schema: type: object - $ref: "#/components/schemas/PixQrCodePayload" + $ref: '#/components/schemas/PixQrCodePayload' example: + name: my-qr-code 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 + '200': + description: + PixQrCode ID and also the generated Dynamic BR Code to be rendered as a QRCode content: application/json: @@ -1575,7 +1589,7 @@ paths: type: object properties: pixQrCode: - $ref: "#/components/schemas/PixQrCode" + $ref: '#/components/schemas/PixQrCode' correlationID: type: string brCode: @@ -1591,9 +1605,10 @@ paths: 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 + brCode: + 000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA - "400": + '400': description: An error message content: application/json: @@ -1602,7 +1617,7 @@ paths: properties: error: type: string - "/api/v1/refund/{id}": + '/api/v1/refund/{id}': get: tags: - refund @@ -1620,7 +1635,7 @@ paths: correlationID: value: fe7834b4060c488a9b0f89811be5f5cf responses: - "200": + '200': description: The refund retrieve using the given ID content: application/json: @@ -1629,7 +1644,7 @@ paths: properties: pixTransactionRefund: type: object - $ref: "#/components/schemas/Refund" + $ref: '#/components/schemas/Refund' example: pixTransactionRefund: value: 100 @@ -1637,7 +1652,7 @@ paths: refundId: 11bf5b37e0b842e08dcfdc8c4aefc000 returnIdentification: D09089356202108032000a543e325902 comment: Comentário do reembolso - "400": + '400': description: An error message content: application/json: @@ -1652,7 +1667,7 @@ paths: - refund summary: Get a list of refunds responses: - "200": + '200': description: A list of refunds content: application/json: @@ -1662,7 +1677,7 @@ paths: refunds: type: array items: - $ref: "#/components/schemas/Refund" + $ref: '#/components/schemas/Refund' pageInfo: type: object properties: @@ -1704,7 +1719,7 @@ paths: refundId: 9134e2866f71427abf00241681624586 time: 2021-03-02T17:28:51.882Z comment: Comentário do reembolso - "400": + '400': description: An error message content: application/json: @@ -1725,14 +1740,14 @@ paths: application/json: schema: type: object - $ref: "#/components/schemas/RefundPayload" + $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": + '200': description: The created Refund content: application/json: @@ -1740,7 +1755,7 @@ paths: type: object properties: refund: - $ref: "#/components/schemas/Refund" + $ref: '#/components/schemas/Refund' example: refund: status: IN_PROCESSING @@ -1749,7 +1764,7 @@ paths: refundId: 9134e2866f71427abf00241681624586 time: 2021-03-02T17:28:51.882Z comment: Comentário do reembolso - "400": + '400': description: An error message content: application/json: @@ -1758,7 +1773,7 @@ paths: properties: error: type: string - "/api/v1/subscriptions/{id}": + '/api/v1/subscriptions/{id}': get: tags: - subscription @@ -1772,7 +1787,7 @@ paths: type: string example: UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM= responses: - "200": + '200': description: The subscription retrieved using the given ID content: application/json: @@ -1781,20 +1796,20 @@ paths: properties: subscription: type: object - $ref: "#/components/schemas/Subscription" + $ref: '#/components/schemas/Subscription' example: subscription: globalID: UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM= customer: name: Dan email: email0@example.com - phone: "5511999999999" + phone: '5511999999999' taxID: - taxID: "31324227036" + taxID: '31324227036' type: BR:CPF value: 100 dayGenerateCharge: 5 - "400": + '400': description: An error message content: application/json: @@ -1816,29 +1831,29 @@ paths: application/json: schema: type: object - $ref: "#/components/schemas/SubscriptionPayload" + $ref: '#/components/schemas/SubscriptionPayload' examples: Subscription: value: value: 100 customer: name: Dan - taxID: "31324227036" + taxID: '31324227036' email: email0@example.com - phone: "5511999999999" + phone: '5511999999999' dayGenerateCharge: 15 Subscription with Interests and Fines: value: value: 100 customer: name: Dan - taxID: "31324227036" + taxID: '31324227036' email: email0@example.com - phone: "5511999999999" + phone: '5511999999999' address: - zipcode: "30421322" + zipcode: '30421322' street: Street - number: "100" + number: '100' neighborhood: Neighborhood city: Belo Horizonte state: MG @@ -1847,7 +1862,7 @@ paths: dayGenerateCharge: 15 chargeType: OVERDUE responses: - "200": + '200': description: The subscription created content: application/json: @@ -1855,20 +1870,20 @@ paths: type: object properties: subscription: - $ref: "#/components/schemas/Subscription" + $ref: '#/components/schemas/Subscription' example: subscription: globalID: UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM= customer: name: Dan email: email0@example.com - phone: "5511999999999" + phone: '5511999999999' taxID: - taxID: "31324227036" + taxID: '31324227036' type: BR:CPF value: 100 dayGenerateCharge: 5 - "400": + '400': description: An error message content: application/json: @@ -1877,7 +1892,7 @@ paths: properties: error: type: string - "/api/v1/transaction/{id}": + '/api/v1/transaction/{id}': get: tags: - transactions @@ -1885,13 +1900,14 @@ paths: parameters: - name: id in: path - description: you can use the transaction id from openpix or the endToEndId of + description: + you can use the transaction id from openpix or the endToEndId of transaction from bank required: true schema: type: string responses: - "200": + '200': description: The transaction retrieve using the given ID content: application/json: @@ -1900,23 +1916,23 @@ paths: properties: transaction: type: object - $ref: "#/components/schemas/Transaction" + $ref: '#/components/schemas/Transaction' example: transaction: customer: name: Dan email: email0@example.com - phone: "5511999999999" + phone: '5511999999999' taxID: - taxID: "31324227036" + taxID: '31324227036' type: BR:CPF correlationID: 9134e286-6f71-427a-bf00-241681624586 payer: name: Dan email: email0@example.com - phone: "5511999999999" + phone: '5511999999999' taxID: - taxID: "31324227036" + taxID: '31324227036' type: BR:CPF correlationID: 9134e286-6f71-427a-bf00-241681624586 charge: @@ -1938,7 +1954,7 @@ paths: type: PAYMENT endToEndId: E18236120202012032010s0133872GZA globalID: UGl4VHJhbnNhY3Rpb246NzE5MWYxYjAyMDQ2YmY1ZjUzZGNmYTBi - "400": + '400': description: An error message content: application/json: @@ -1952,21 +1968,23 @@ paths: - in: query name: start schema: - $ref: "#/components/schemas/Start" + $ref: '#/components/schemas/Start' - in: query name: end schema: - $ref: "#/components/schemas/End" + $ref: '#/components/schemas/End' - in: query name: charge - description: You can use the charge ID or correlation ID or transaction ID of + 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 + 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: @@ -1974,7 +1992,8 @@ paths: example: Q2hhcmdlOjYwM2U3NDlhNDI1NjAyYmJiZjRlN2JlZA - in: query name: withdrawal - description: You can use the ID or EndToEndId of a withdrawal transaction to get + description: + You can use the ID or EndToEndId of a withdrawal transaction to get all transactions related to the withdrawal schema: type: string @@ -1984,7 +2003,7 @@ paths: - transactions summary: Get a list of transactions responses: - "200": + '200': description: A list of transactions content: application/json: @@ -1996,7 +2015,7 @@ paths: transactions: type: array items: - $ref: "#/components/schemas/Transaction" + $ref: '#/components/schemas/Transaction' pageInfo: type: object properties: @@ -2035,17 +2054,17 @@ paths: customer: name: Dan email: email0@example.com - phone: "5511999999999" + phone: '5511999999999' taxID: - taxID: "31324227036" + taxID: '31324227036' type: BR:CPF correlationID: 9134e286-6f71-427a-bf00-241681624586 payer: name: Dan email: email0@example.com - phone: "5511999999999" + phone: '5511999999999' taxID: - taxID: "31324227036" + taxID: '31324227036' type: BR:CPF correlationID: 9134e286-6f71-427a-bf00-241681624586 charge: @@ -2065,7 +2084,7 @@ paths: time: 2021-03-03T12:33:00.536Z transactionID: transactionID endToEndId: E18236120202012032010s0133872GZA - "400": + '400': description: An error message content: application/json: @@ -2087,13 +2106,13 @@ paths: application/json: schema: type: object - $ref: "#/components/schemas/TransferCreatePayload" + $ref: '#/components/schemas/TransferCreatePayload' example: value: 100 fromPixKey: from@openpix.com.br toPixKey: to@openpix.com.br responses: - "200": + '200': description: Transfer transaction information content: application/json: @@ -2101,13 +2120,13 @@ paths: type: object properties: transaction: - $ref: "#/components/schemas/TransferTransaction" + $ref: '#/components/schemas/TransferTransaction' example: transaction: value: 100 time: 2023-06-22T15:33:27.165Z, correlationID: c782e0ac-833d-4a89-9e73-9b60b2b41d3a - "400": + '400': description: An error message content: application/json: @@ -2116,7 +2135,7 @@ paths: properties: error: type: string - "/api/v1/webhook/{id}": + '/api/v1/webhook/{id}': delete: tags: - webhook @@ -2135,7 +2154,7 @@ paths: id: value: fe7834b4060c488a9b0f89811be5f5cf responses: - "200": + '200': description: Webhook ID and also the status code content: application/json: @@ -2144,7 +2163,7 @@ paths: properties: status: type: string - "400": + '400': description: An error message content: application/json: @@ -2168,7 +2187,7 @@ paths: - webhook summary: Get a list of webhooks responses: - "200": + '200': description: A list of webhooks content: application/json: @@ -2178,7 +2197,7 @@ paths: webhooks: type: array items: - $ref: "#/components/schemas/Webhook" + $ref: '#/components/schemas/Webhook' pageInfo: type: object properties: @@ -2220,7 +2239,7 @@ paths: isActive: true createdAt: 2021-03-02T22:29:10.720Z updatedAt: 2021-03-02T22:29:10.720Z - "400": + '400': description: An error message content: application/json: @@ -2244,7 +2263,7 @@ paths: properties: webhook: type: object - $ref: "#/components/schemas/WebhookPayload" + $ref: '#/components/schemas/WebhookPayload' example: webhook: name: webhookName @@ -2253,7 +2272,7 @@ paths: authorization: openpix isActive: true responses: - "200": + '200': description: Webhook created specific event when receives a new pix transaction content: application/json: @@ -2262,7 +2281,7 @@ paths: properties: webhook: type: object - $ref: "#/components/schemas/Webhook" + $ref: '#/components/schemas/Webhook' example: webhook: id: V2ViaG9vazo2MDNlYmUxZWRlYjkzNWU4NmQyMmNmMTg= @@ -2273,7 +2292,7 @@ paths: event: OPENPIX:TRANSACTION_RECEIVED createdAt: 2021-03-02T22:29:10.720Z updatedAt: 2021-03-02T22:29:10.720Z - "400": + '400': description: An error message content: application/json: @@ -2284,7 +2303,7 @@ paths: type: string callbacks: receivedPix: - "{$request.body#/webhook.url}": + '{$request.body#/webhook.url}': post: description: > Pix - O callback vai ser acionado sempre que um Pix for recebido @@ -2297,22 +2316,22 @@ paths: properties: charge: type: object - $ref: "#/components/schemas/Charge" + $ref: '#/components/schemas/Charge' pix: type: object properties: pixQrCode: type: object - $ref: "#/components/schemas/PixQrCode" + $ref: '#/components/schemas/PixQrCode' charge: type: object - $ref: "#/components/schemas/Charge" + $ref: '#/components/schemas/Charge' customer: type: object - $ref: "#/components/schemas/Customer" + $ref: '#/components/schemas/Customer' payer: type: object - $ref: "#/components/schemas/Customer" + $ref: '#/components/schemas/Customer' time: type: string value: @@ -2342,14 +2361,15 @@ paths: customer: name: Julio email: email0@example.com - phone: "5511999999999" + phone: '5511999999999' taxID: - taxID: "31928282008" + 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 + 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 @@ -2359,24 +2379,25 @@ paths: status: COMPLETED customer: 604002035cce3b60132343cb correlationID: 9134e286-6f71-427a-bf00-241681624586 - brCode: 000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao + 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" + phone: '5511999999999' taxID: - taxID: "31928282008" + taxID: '31928282008' type: BR:CPF correlationID: 9134e286-6f71-427a-bf00-241681624586 payer: name: Julio email: email0@example.com - phone: "5511999999999" + phone: '5511999999999' taxID: - taxID: "31928282008" + taxID: '31928282008' type: BR:CPF correlationID: 9134e286-6f71-427a-bf00-241681624586 time: 2020-09-09T20:15:00.358Z @@ -2386,15 +2407,15 @@ paths: raw: endToEndId: 9134e2866f71427abf00241681624586 txid: 9134e2866f71427abf00241681624586 - valor: "99.99" + valor: '99.99' horario: 2020-09-09T20:15:00.358Z infoPagador: conta pixQrCode: null responses: - "200": + '200': description: Notificação recebida com sucesso receivedPixDetached: - "{$request.body#/webhook.url}": + '{$request.body#/webhook.url}': post: description: > Pix Avulso - O callback vai ser acionado sempre que um Pix for @@ -2412,16 +2433,16 @@ paths: properties: pixQrCode: type: object - $ref: "#/components/schemas/PixQrCode" + $ref: '#/components/schemas/PixQrCode' charge: type: object - $ref: "#/components/schemas/Charge" + $ref: '#/components/schemas/Charge' customer: type: object - $ref: "#/components/schemas/Customer" + $ref: '#/components/schemas/Customer' payer: type: object - $ref: "#/components/schemas/Customer" + $ref: '#/components/schemas/Customer' time: type: string value: @@ -2458,14 +2479,14 @@ paths: raw: endToEndId: 9134e2866f71427abf00241681624586 txid: 9134e2866f71427abf00241681624586 - valor: "99.99" + valor: '99.99' horario: 2020-09-09T20:15:00.358Z infoPagador: conta responses: - "200": + '200': description: Notificação recebida com sucesso receivedPixQrCode: - "{$request.body#/webhook.url}": + '{$request.body#/webhook.url}': post: description: > Pix QrCode - O callback vai ser acionado sempre que um Pix @@ -2483,13 +2504,13 @@ paths: properties: pixQrCode: type: object - $ref: "#/components/schemas/PixQrCode" + $ref: '#/components/schemas/PixQrCode' charge: type: object - $ref: "#/components/schemas/Charge" + $ref: '#/components/schemas/Charge' payer: type: object - $ref: "#/components/schemas/Customer" + $ref: '#/components/schemas/Customer' time: type: string value: @@ -2513,7 +2534,7 @@ paths: type: string pixQrCode: type: object - $ref: "#/components/schemas/PixQrCode" + $ref: '#/components/schemas/PixQrCode' example: charge: null pix: @@ -2527,7 +2548,8 @@ paths: 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 + brCode: + 000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA customer: null time: 2020-09-09T20:15:00.358Z @@ -2537,13 +2559,13 @@ paths: raw: endToEndId: 9134e2866f71427abf00241681624586 txid: 9134e2866f71427abf00241681624586 - valor: "99.99" + valor: '99.99' horario: 2020-09-09T20:15:00.358Z infoPagador: conta responses: - "200": + '200': description: Notificação recebida com sucesso - "/openpix/charge/brcode/image/{:id}.png?size=1024": + '/openpix/charge/brcode/image/{:id}.png?size=1024': get: tags: - charge @@ -2560,7 +2582,8 @@ paths: value: fe7834b4060c488a9b0f89811be5f5cf - in: query name: size - description: Size for the image. This size should be between 600 and 4096. if + 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: @@ -2569,9 +2592,9 @@ paths: size: value: 768 responses: - "200": + '200': description: The Qr Code image as MIME type - "400": + '400': description: An error message content: application/json: @@ -2580,12 +2603,13 @@ paths: properties: error: type: string - "/api/v1/subaccount/{id}/withdraw": + '/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 + description: + Withdraw from a Sub Account and return the withdrawal transaction information parameters: - name: id @@ -2596,7 +2620,7 @@ paths: type: string example: destination@test.com responses: - "200": + '200': description: Withdrawal Transaction information content: application/json: @@ -2608,7 +2632,7 @@ paths: properties: account: type: object - $ref: "#/components/schemas/transaction" + $ref: '#/components/schemas/transaction' example: transaction: status: CREATED @@ -2616,7 +2640,7 @@ paths: correlationID: TESTING1323 destinationAlias: pixKeyTest@test.com comment: testing-transaction - "400": + '400': description: An error message content: application/json: @@ -2625,7 +2649,7 @@ paths: properties: error: type: string - "/api/v1/subaccount/{id}": + '/api/v1/subaccount/{id}': get: tags: - sub account (request access) @@ -2641,7 +2665,7 @@ paths: id: value: c4249323-b4ca-43f2-8139-8232aab09b93 responses: - "200": + '200': description: The Subccount retrieve using the given pix key content: application/json: @@ -2650,13 +2674,13 @@ paths: properties: SubAccount: type: object - $ref: "#/components/schemas/SubAccount" + $ref: '#/components/schemas/SubAccount' example: SubAccount: name: test-sub-account pixKey: c4249323-b4ca-43f2-8139-8232aab09b93 balance: 100 - "400": + '400': description: An error message content: application/json: @@ -2671,7 +2695,7 @@ paths: - sub account (request access) summary: Get a list of subaccounts responses: - "200": + '200': description: A list of subaccounts content: application/json: @@ -2687,7 +2711,7 @@ paths: properties: payment: type: object - $ref: "#/components/schemas/SubAccount" + $ref: '#/components/schemas/SubAccount' pageInfo: type: object properties: @@ -2727,7 +2751,7 @@ paths: totalCount: 20 hasPreviousPage: false hasNextPage: true - "400": + '400': description: An error message content: application/json: @@ -2747,14 +2771,14 @@ paths: application/json: schema: type: object - $ref: "#/components/schemas/SubAccountPayload" + $ref: '#/components/schemas/SubAccountPayload' examples: SubAccount: value: pixKey: 9134e286-6f71-427a-bf00-241681624587 name: Test Account responses: - "200": + '200': description: The Subccount created or retrieved if exists using the given pix key content: application/json: @@ -2763,12 +2787,12 @@ paths: properties: SubAccount: type: object - $ref: "#/components/schemas/SubAccount" + $ref: '#/components/schemas/SubAccount' example: SubAccount: name: test-sub-account pixKey: c4249323-b4ca-43f2-8139-8232aab09b93 - "400": + '400': description: An error message content: application/json: @@ -2814,13 +2838,14 @@ components: type: number customer: type: object - $ref: "#/components/schemas/Customer" + $ref: '#/components/schemas/Customer' type: type: string enum: - DYNAMIC - OVERDUE - description: Charge type is used to determine whether a charge will have a + description: + Charge type is used to determine whether a charge will have a deadline, fines and interests comment: type: string @@ -2844,7 +2869,8 @@ components: globalID: description: External ID of this charge transactionID: - description: unique uuid used as the txid from Pix into the provider from your + 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: @@ -2886,7 +2912,8 @@ components: enum: - DYNAMIC - OVERDUE - description: Charge type is used to determine whether a charge will have a + description: + Charge type is used to determine whether a charge will have a deadline, fines and interests comment: type: string @@ -2899,33 +2926,39 @@ components: description: Expires the charge in seconds (minimum is 15 minutes) customer: type: object - $ref: "#/components/schemas/CustomerPayload" + $ref: '#/components/schemas/CustomerPayload' daysForDueDate: type: number - description: Time in days until the charge hits the deadline so fines and + 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. + 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 + 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 + 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 + 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 + description: + Value in basis points of fines to be applied when the charge hits the deadline additionalInfo: type: array @@ -3025,7 +3058,8 @@ components: country: type: string CustomerPayload: - description: Customer field is not required. However, if you decide to send it, + 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: @@ -3139,7 +3173,8 @@ components: example: 2020-12-01T17:00:00Z ApplicationEnumTypePayload: type: string - description: Type of the application that you want to register. Each of this has + description: + Type of the application that you want to register. Each of this has some kind of permissions. enum: - API @@ -3150,7 +3185,8 @@ components: properties: taxID: type: string - description: The tax identifier of your account holder. This should be a raw + description: + The tax identifier of your account holder. This should be a raw string with only digits. type: type: string @@ -3196,13 +3232,14 @@ components: properties: name: type: string - description: The name of this preregistration. It'll be related as your company + 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" + $ref: '#/components/schemas/TaxIDObjectPayload' required: - name - taxID @@ -3210,15 +3247,16 @@ components: type: object properties: preRegistration: - $ref: "#/components/schemas/PreRegistrationObject" + $ref: '#/components/schemas/PreRegistrationObject' user: - $ref: "#/components/schemas/PreRegistrationUserObject" + $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 + description: + The client ID from the company bank account that is related to this preregistration/company. CompanyObjectPayload: type: object @@ -3230,16 +3268,17 @@ components: type: string description: The name of the company that is related to this preregistration. taxID: - $ref: "#/components/schemas/TaxIDObjectPayload" + $ref: '#/components/schemas/TaxIDObjectPayload' PreRegistrationObjectPayload: type: object properties: name: type: string - description: When the preregistration will turn a company, this will be the name + 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" + $ref: '#/components/schemas/TaxIDObjectPayload' PartnerApplicationPayload: type: object properties: @@ -3250,7 +3289,7 @@ components: type: boolean description: Current status of your application. type: - $ref: "#/components/schemas/ApplicationEnumTypePayload" + $ref: '#/components/schemas/ApplicationEnumTypePayload' clientId: type: string description: The ID of this client application. @@ -3280,7 +3319,8 @@ components: 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 + description: + an optional id for the source account of the payment, if not informed will assume the default account Payment: type: object @@ -3350,9 +3390,6 @@ components: 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 @@ -3385,12 +3422,8 @@ components: 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: @@ -3446,7 +3479,7 @@ components: description: Value in cents of the subscription customer: type: object - $ref: "#/components/schemas/Customer" + $ref: '#/components/schemas/Customer' dayGenerateCharge: type: number description: Day of the month that the charges will be generated @@ -3517,7 +3550,8 @@ components: enum: - DYNAMIC - OVERDUE - description: The charge type is used to determine whether charges generated by + description: + The charge type is used to determine whether charges generated by the subscription will have fines and interests default: DYNAMIC dayDue: @@ -3533,7 +3567,7 @@ components: properties: charge: type: object - $ref: "#/components/schemas/Charge" + $ref: '#/components/schemas/Charge' value: type: number time: @@ -3548,13 +3582,13 @@ components: type: string customer: type: object - $ref: "#/components/schemas/Customer" + $ref: '#/components/schemas/Customer' withdraw: type: object - $ref: "#/components/schemas/PixWithdrawTransaction" + $ref: '#/components/schemas/PixWithdrawTransaction' payer: type: object - $ref: "#/components/schemas/Customer" + $ref: '#/components/schemas/Customer' type: type: string description: Pix Transaction type @@ -3567,7 +3601,7 @@ components: description: External ID of this transaction pixQrCode: type: object - $ref: "#/components/schemas/PixQrCode" + $ref: '#/components/schemas/PixQrCode' PixWithdrawTransaction: type: object properties: @@ -3585,7 +3619,7 @@ components: type: string payer: type: object - $ref: "#/components/schemas/Customer" + $ref: '#/components/schemas/Customer' type: type: string TransferCreatePayload: @@ -3596,7 +3630,8 @@ components: 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 + description: + the pix key of the account the value of the transfer will come out from toPixKey: type: string @@ -3620,10 +3655,11 @@ components: type: string event: type: string - description: The event to listen to. If omitted, the webhook will be registered + 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" + $ref: '#/components/schemas/WebhookEventEnum' url: type: string authorization: @@ -3639,7 +3675,7 @@ components: type: string event: type: string - $ref: "#/components/schemas/WebhookEventEnum" + $ref: '#/components/schemas/WebhookEventEnum' url: type: string authorization: diff --git a/static/wooviPostman.json b/static/wooviPostman.json index 75e9ad8..24d32a1 100644 --- a/static/wooviPostman.json +++ b/static/wooviPostman.json @@ -1 +1 @@ -{"item":[{"name":"api","description":"","item":[{"name":"v1","description":"","item":[{"name":"account","description":"","item":[{"name":"{accountId}","description":"","item":[{"id":"97f14d13-b564-4af1-9abf-168a7dc2e351","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":"83d2e3b9-288a-441a-a86c-b327a483b8ad","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":"6bf73482-5829-4dc0-a0ba-b0441fb9bb0e","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":"c4e0e25a-73ff-4633-a42b-2aeac85b9521","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":"534db826-b47e-4d1a-a351-f302685109b5","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":"4ac9cea8-c985-4047-908d-dc175952e196","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":"f3335c8b-626c-4f9d-92a7-287a0b2a026a","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":"664ec411-5e64-4247-9796-15dc8364772b","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":"79b7ff36-cef4-4549-86b9-c5a82d12a843","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":"cf2f3a3b-c1e6-4a80-a5db-4eb2841ce825","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":"b592b246-df31-4b32-b8a5-a9749957fb09","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":"dc615ff7-13d6-4967-addb-7d5ccd09b5c4","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":"e134c267-c7ef-413b-afb7-255d33e50976","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":"5891d52d-f835-4c68-bd9a-cd7fc5a9f5b3","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":"fa51f074-40f6-4cb5-a9c8-aed4ce94ee0d","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":"57503611-d4ab-446a-bf9d-a11cc8ef3ca3","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":"827825f3-9c09-4ea9-b5ca-ac63a982a5ea","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":"e8d4b538-cdbf-446c-a871-e8fa871e1cc6","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":"ea04bfba-d6dd-44da-87bd-a78997189531","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":"347cb6ee-0da3-4450-b087-32896fd3ae24","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":"7788f700-90e5-4bc1-9197-65b1ddf84882","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\": \"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}","cookie":[],"_postman_previewlanguage":"json"},{"id":"433699ca-3df3-4fb2-97c1-2156d4e1c0dd","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":"24e22a2e-f57b-4432-bf97-f7edc10d0569","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":"ba796441-e3f5-483c-9f79-4ab4ed4449d8","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\": \"IN_PROCESSING\",\n \"correlationID\": \"\",\n \"endToEndId\": \"\",\n \"time\": \"\",\n \"comment\": \"\"\n },\n {\n \"value\": \"\",\n \"status\": \"REJECTED\",\n \"correlationID\": \"\",\n \"endToEndId\": \"\",\n \"time\": \"\",\n \"comment\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"629e6d02-e6aa-41a4-9d04-dfc42d27e03b","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":"2fabe0f4-5261-4fc4-a87f-b8b02c8cc437","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":"6702d015-8f41-4880-b4f4-e6e8390ac2fb","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":"6c3fbe55-ebbb-4c1e-9532-51ffd940f435","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":"65aa4921-b8f8-43f1-8c33-90c196ba7e1e","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":"1b7e3c03-6401-4a1b-94da-69da6628fe9c","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\": \"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 {\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":"48ee5ae2-3a16-4081-ad35-63aaf84b62e7","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":"44800a35-d124-41fa-b847-6d1c188ac5c5","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\": \"DYNAMIC\",\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":"a46485e2-d4c7-4b7d-ab46-76a5e855a0aa","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\": \"DYNAMIC\",\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\": \"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 \"correlationID\": \"\",\n \"brCode\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c05ea125-b406-40ca-8cc3-f1ee6726d754","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\": \"DYNAMIC\",\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":"7135567f-9e60-41f0-ba43-8c2f5141d422","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":"562cf5b4-b993-43e9-9788-fced3168bdab","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":"04c8f4ae-a8eb-4395-bb6b-c25e94d69a97","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":"48dc8645-6307-414c-8442-3df8e6e59d19","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":"bc356a5d-844a-44f4-b4d8-a82df097b89f","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":"00f507bc-2559-4713-93c5-de8308b55d23","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":"0ab10594-f45e-4817-ad25-1ab9187cb9a8","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":"99d5e5ac-7be4-4ece-bcc3-f53dacfe1d53","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":"92e41985-6ed1-4cc9-b378-34f1ba8f29d5","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":"f834c21e-5c69-45c3-8994-a0cbc3d68d06","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":"40f91cb0-d127-4c4b-9eec-1f1c7417070e","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\": \"ORACLE\",\n \"clientId\": \"\",\n \"clientSecret\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1d338d4a-c2ad-4737-a5f4-f4ab78fc88b0","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\": \"ORACLE\",\n \"clientId\": \"\",\n \"clientSecret\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"21d2df99-c53f-4246-b27c-67c66566aa66","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":"361d8fd7-d467-44ed-8b07-d82317501799","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":"company","description":"","item":[{"name":"{taxID}","description":"","item":[{"id":"8b0acaf7-181c-42df-86d9-b2aa0b8334b1","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":"4b0a1c8c-54cc-4839-b77e-3abd25b6caf6","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":"55ce3971-6037-4196-9337-f4d7d402ea71","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":"315c87ac-19d9-4287-8691-0554539f31b5","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":"80809475-6c4e-455f-8d9c-595ed17e2eca","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":"1e877bee-bfad-4867-8996-30d6a778688e","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":"29299655-7bb3-4353-a941-a5a5efd7b9ba","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":"cffbb985-944b-4a06-a84f-74bce3a0798d","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":"941bd75d-3df2-439d-9671-9d7b19e898aa","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":"e3bc94d1-2e69-4d96-8206-5425eaa99c5d","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":"3bd22037-9f0d-47ef-928e-4f57316e567e","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":"80cbb7b6-c448-4b67-8bd1-bdf5a141e470","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":"b7ee97ce-17e3-45c4-a5a0-166eda1ebff9","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\": \"DENIED\",\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":"c3fb66f4-03b3-40f1-8bb1-0f40758242cb","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":"4f0f2ef7-e3fd-497c-a4c1-88d05cdeeb05","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":"280f21f2-add2-44b9-9455-6bb14ca2ad28","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":"97f03172-2f32-49eb-b97d-aa9dc3e75152","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":"b621f4bd-1f05-4512-8049-07da2c7daa1e","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":"8c0ffe5a-3de1-4812-bce8-4a8fce4ae709","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\": \"DENIED\",\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":"c13306f2-e10e-4ce6-8aa5-08c57977225b","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":"20b9f41f-a580-48d8-becf-d9096f56ae5a","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":"888db580-55f8-44fa-a44b-151b1c87f9f0","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\": \"FAILED\",\n \"sourceAccountId\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6dfe2bea-34b6-4794-80c5-6894062c4c0a","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":"557d6b42-b622-48cb-af14-4c125032997b","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":"6115fb74-719d-4058-8240-b26c71993ad9","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":"1d5803ba-c36f-427a-84a1-748bfdcbd265","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":"a4f6ee6a-cf64-4ee4-a088-2b94d4c9937d","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":"e433e1ce-7da0-4319-bda1-ed7f5958e358","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":"6e0b0cd3-c750-4359-95c6-2a16e7152bee","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":"b713ad92-c267-4e63-8a87-75f1946486bf","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":"ef6e3e25-0a7e-497a-9011-68459d1bf528","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":"3f33ce11-1e1a-4726-8601-87529606f9d6","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":"5057217b-4daa-4f23-830d-2d890b1fd71a","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":"219f0029-eff7-4e5a-a0e1-c4c92d45af50","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":"a132841f-a25d-4d97-8bda-7cdba8c2f5ba","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":"b3b1dccd-78c6-4560-adf9-a6ad24c02c99","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":"c7ddcfb5-fd78-4349-8f21-404733cb1938","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\": \"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":"89f4e666-995a-40e4-9d63-a30256a9f6b9","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":"c153b409-4156-4b0c-937f-65f38623f387","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":"2881a9d0-b192-4c2f-88d0-4697f57e6180","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\": \"IN_PROCESSING\",\n \"correlationID\": \"\",\n \"refundId\": \"\",\n \"time\": \"\",\n \"comment\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9b17b600-8b7f-42d4-96b9-1338a9c7c95c","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":"3af785be-b8c3-490b-87c8-536f55fe9176","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":"9bc611e5-c509-4586-8939-d8abde26db0d","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":"647ffa7b-1457-4728-adb1-c0a856fa0bdb","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":"17ca0870-af89-4ae2-ad00-2601ad958444","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":"0d9a1328-f38f-4559-a744-719c000adb81","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":"124f5197-1b60-4398-86e2-6c276bdabeda","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":"6db7138c-7c64-403e-b5e1-988f4a50302d","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":"ca7be3e6-9c5f-4bd1-8f47-3f10dbba6288","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\": \"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\": \"WITHDRAW\",\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":"067ec171-4c0a-473a-a058-a4ca6340b291","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":"133873b1-016c-4515-bd1e-edad07918636","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":"ee570675-d308-4541-b44c-7a2b106fcf46","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\": \"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 {\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\": \"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\": \"WITHDRAW\",\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":"78ac4598-1bf2-45a3-b222-bb97b65572f7","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":"d53d19b7-8fe5-40e5-9789-a6cc2b4e4320","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":"87f665ae-0690-4e1d-8b91-560f47198ffc","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":"7457e9a8-930f-489a-9659-2821334bdb9e","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":"97cd2e0e-e07b-455f-8030-5892c7461e1c","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":"4fb59c8d-cf1c-4f1a-a15a-cada48bf06ba","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":"3af911ce-e948-46a7-be86-c07c821f9de0","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":"3fdc3b74-26b6-40b1-8510-e27b50bbd194","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":"05b2fa44-e836-437e-bec4-25d708b1bfbf","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:CHARGE_EXPIRED\",\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":"aea1c5be-093b-4aac-9f97-d63db2de3da5","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":"7ef8f0a7-0ef3-4885-87a1-dd033cf33a14","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:TRANSACTION_REFUND_RECEIVED\",\n \"url\": \"\",\n \"authorization\": \"\",\n \"isActive\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"6afb3567-b4fa-4728-b0c1-1bc016351aab","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:TRANSACTION_REFUND_RECEIVED\",\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":"fe482ec6-e1e3-4e4b-b221-ea7cd9215ace","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:TRANSACTION_REFUND_RECEIVED\",\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":"6706e314-800c-4349-a813-fd0308e1c1d9","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":"5e946926-1c15-406d-9b77-034db5a2f62a","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":"a60de287-f552-4dd9-836d-076b9f3c42a9","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":"4f7fb04a-b2a1-4025-b3eb-b3e6c0bccf09","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":"d926c7a2-3ba1-4cc8-b2c4-d7028da929e4","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":"7dfd6b98-7ffd-489d-83e4-d07d213a8a30","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":"3aeaf478-e898-44cd-9188-dabe596fcff9","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":"e5b22638-a01a-4b10-82f7-b5d81ea8dd7e","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":"7ccbf25c-1830-4ebf-aea6-d9bc3f404216","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":"f4b04b03-23b3-45ca-a013-af41ad8b2827","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":"d34581e9-3af5-4578-afc2-fafec9107b8c","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":"9ea24689-4ab5-408e-b203-bfa2a64613e1","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":"3f63e69e-7d6a-43fe-b29d-172bd16eda86","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":"ea06d9d4-bfb6-433c-a1d2-fa0fa92192b6","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":"aae72226-2f52-4c59-a7e0-bd3d8d257e1f","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":"9f7555c1-1295-4453-aff3-d211004b63e6","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":"2183c5b8-dcd0-439a-acfb-04f3a7c1aaa0","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":"2fd6c293-c42b-4754-b268-53826a3a216e","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":"d17ce437-7664-40b6-9f91-c73c2f609deb","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":"dc3904f3-77c7-462c-8924-74257cab8934","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":"af842e0c-be90-4a47-83f8-5d392d539d54","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":"2fa5a5c9-ca9d-4e6f-bd38-ccc933597ef3","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":"9add955d-6f14-456c-843b-a7b0452bd77d","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":"ebe4a1c3-552a-443e-a4bc-06db07510eae","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":"d87be729-26b5-4da7-9593-e985d2c9a235","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":"da074a28-bdce-4211-8576-beda7333dd05","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":"18dc2b13-e761-4247-93cc-636903211f9f","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":"d894be5d-ba40-4eb0-93cb-4b220d14c5ee","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":"8765d01d-6a24-4483-89e9-66d9ec314aa3","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":"e200107a-e912-4b8e-b4f5-e70cd2ad68a4","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":"98cfb33e-a50d-4b6f-aa20-06c5a0ecb3ed","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":"a9de2bfd-b001-49e2-8237-0369420fe26f","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":"a7d0b6b7-efad-4c2d-94c8-91f868c221e2","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":"0e1de7db-bb22-45e1-a327-db398d524577","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":"a5c761c7-2b0b-4bdd-9e1d-194cb0506f78","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":"8a29090e-a5a0-46b9-815e-59ee09829a93","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":"2cdbae6a-26a6-40ac-ae1d-8f61eadf7cbb","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\": \"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":"7a07c425-f565-46ba-aa40-790631b0ad34","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":"108bb297-f518-4b77-8cde-d8ec949eb0e7","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":"cb90f03a-ef53-48a4-a3a4-9ae40f3d61cd","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\": \"CONFIRMED\",\n \"correlationID\": \"\",\n \"endToEndId\": \"\",\n \"time\": \"\",\n \"comment\": \"\"\n }\n ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"723600a8-7496-4c37-bb74-5b85d076e77e","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":"c5074372-d1e7-4a9a-802a-3df5c9669f92","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":"ea9d8a15-9681-408b-a506-69c4af73499c","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\": \"IN_PROCESSING\",\n \"correlationID\": \"\",\n \"endToEndId\": \"\",\n \"time\": \"\",\n \"comment\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7f051119-8978-477d-a508-ef3d371bde93","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":"7f879b4b-eaa1-4128-a778-dcc441a35d3f","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":"20bc29e9-3f88-48c7-b88e-b82e1092cabb","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\": \"DYNAMIC\",\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":"e3cef6c6-dfc9-44fd-b780-57f8270a8f98","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":"1a59e349-f09c-4c58-88df-1089f61dc3b9","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":"3f422957-c001-4fbb-9a79-712baa15b180","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\": \"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 \"correlationID\": \"\",\n \"brCode\": \"\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"caac28be-c8a8-4bca-8ada-9cfa56d6e6dd","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":"c82b7752-0f4d-44c8-8cc8-cf7c39a56086","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":"8082c192-e135-4ac0-82cf-1e0a81e4806a","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":"7a23c9bb-413b-46ba-b27b-635603df5f5f","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":"25ef7b19-566b-4bb5-8253-949586eeedde","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":"c62ad928-9b4c-4b54-b1df-835bc17a602a","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":"4bb14305-1fce-4ed2-b678-a3988c35ffe6","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":"1e3a0a31-4469-4523-92d5-2355eaf6fb53","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":"0e44792e-ea6a-4208-84f0-c7a2b58a0a65","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":"c9ac0201-bed3-45ec-9830-634f99ed56ac","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":"16557065-104d-4413-8ff0-ecbd2375f312","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\": \"API\"\n },\n \"taxID\": {\n \"taxID\": \"\",\n \"type\": \"BR:CNPJ\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"1d638aa8-f661-4baf-8a71-b96d3c3e59c3","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\": \"API\"\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":"228514ec-65d0-494b-8159-a7d1a06175cb","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\": \"API\"\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":"c6ab1d3a-5540-4500-8c5b-4ba2198aa784","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\": \"API\"\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":"a7a20e54-0c39-47e5-977f-d189f3acc677","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\": \"API\"\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":"d7900626-0da9-4198-80b8-dea8d893e518","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":"a9ce87df-9150-46ec-aadc-7368bcf1a8eb","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":"4fe6d09b-e8ca-4d28-8871-c27a2aca76b3","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":"a2dcbd4b-2b99-468b-9804-171bdfbe6053","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":"0478d5ec-e4ac-47cc-a6d0-5d26b0ccade4","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":"f1971c83-409d-4fcb-9563-c4fb2f19b2d4","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":"5c93680a-999a-4c06-8615-b9eefd324c93","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":"ee578fa9-c98e-4b99-8eed-05550c74cc30","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":"560ae4af-f038-42dd-a78d-c4ac8abc27a3","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":"9db00e05-3e33-4aa1-a644-ce8465f21189","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":"0148ecc5-f966-44a6-b844-dcdf1ae00481","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":"085be4ce-cbb6-4f2c-8ac8-30207b48a759","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":"a650b2b2-e2d0-4eb2-9f34-7ccc94f3fba0","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\": \"DENIED\",\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":"62710e27-e852-430e-b2fc-231db661c153","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":"eb5d0413-d7e2-48ba-ae96-a99525e06f61","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":"81233538-4aad-44fb-9cad-4eef91cb2132","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\": \"DENIED\",\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":"b8b62520-7fd7-4643-8df8-b4d1a9bf65d3","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":"db27acc8-3e13-4a1b-9a88-7c46d25070d0","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":"e87ea432-0650-4f7c-b61f-4c98f7710b5c","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\": \"DENIED\",\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":"9fbe7d0d-38f8-49d2-86a2-2aa5a1f05b6d","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":"2abd5dae-f060-4486-a850-c7ce63f9f764","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":"9cc231dc-f609-494a-95b2-d0246d7c8214","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\": \"FAILED\",\n \"sourceAccountId\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9ea216a8-c96e-4b74-a51d-f1e4a3b24bed","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":"56dcb6b7-a43b-44e1-9632-110f473fca6d","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":"25072d64-ad92-4967-8b53-12287337ef45","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":"35c5c0f5-5481-4733-8390-2c50784177f5","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":"f204b3ee-43f5-446b-bccb-6f8a115a360d","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":"6831f78c-293a-4b91-b914-4e0c246d7331","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":"70dbb8db-a2bc-484a-9c20-1f9a6be6e09a","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":"724a785b-35cc-4b8b-b6cd-26a33c586cd4","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":"ffa1ea0f-d48b-44bd-b1be-c6978b87860f","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":"ba9d1edb-2f0b-428a-9b8e-b956f490326a","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":"bb4f3533-526e-41f1-96ac-4b74efa5e263","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":"d412f814-5afc-4476-9b94-cfce9e05fb2e","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\": \"NOT_ACCOMPLISHED\",\n \"correlationID\": \"\",\n \"refundId\": \"\",\n \"time\": \"\",\n \"comment\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ebeaf3d2-7e23-4092-b2d0-92844f4f6d2e","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":"b289f581-e1be-4ce6-bcb1-0dc4b0f9b012","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":"591785cc-28d9-47bc-b79d-58853311b9a8","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\": \"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":"14de8758-5f86-44ff-9d96-5046b72b8ea0","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":"c440845e-07bc-4d75-987d-32a0ff5c967e","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":"04034495-0344-4434-9cc7-edfb17d01597","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":"5960dc04-49fa-4754-8fea-578ec2eba5a2","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":"ab0ae8e5-e862-47db-894c-8d0bfab6220d","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":"085f2288-15f7-476e-bb21-f32be50e2180","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":"62bdaeb8-3999-4357-af1d-2bfb4ef5dfd2","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":"f20801e6-0355-4dad-a793-d52a2727d0ff","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":"a09c13b3-f8cc-402b-b28e-b709de614fb0","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":"391d6f50-7e6b-48b5-b36d-6292a5f72a78","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":"fa2388f6-f828-44c6-9296-90133908bc61","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":"1401658f-9a0b-44c4-92c6-5c66865a32b8","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\": \"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\": \"WITHDRAW\",\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":"e0ee3631-1032-4d1a-8df0-d5ea461bd79c","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":"7494ab0c-fbfb-41d1-93e9-121015a33127","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":"27d361c6-118a-41b6-a481-7a27f76c955c","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\": \"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\": \"FEE\",\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\": \"FEE\",\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":"acb5f3a0-ea7e-40e1-ae6f-837ef6b11241","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":"12eb416f-3d7c-4fa2-8bc3-d39d02c25c56","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":"cd3c4bc2-da38-4699-9cd0-f6266e699ee2","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":"9fbffebe-f85d-4d23-aca7-15517e48e330","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":"eba39a5d-7056-4b3a-bad7-1274ef1f3d3c","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":"d30a1193-f95f-459d-baf7-a43277ade05a","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":"b08a56fc-0201-4b1f-b056-7c2a3d063776","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":"df02527c-16a5-4079-9747-fb3de8482427","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":"fdea5b44-152a-4e53-9fca-05922b39999e","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_REMOVED\",\n \"url\": \"\",\n \"authorization\": \"\",\n \"isActive\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"event\": \"OPENPIX:TRANSACTION_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":"3bdf843a-678f-4250-935b-88df3439f1c5","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":"8140ef38-c6ad-4985-b3b2-bd7eabb50907","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_REMOVED\",\n \"url\": \"\",\n \"authorization\": \"\",\n \"isActive\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"7f4f7388-ffd7-4804-8905-1f08fa375524","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_REMOVED\",\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_CONFIRMED\",\n \"url\": \"\",\n \"authorization\": \"\",\n \"isActive\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"11a512f0-365a-4054-bd9d-d0a14a2a72c8","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_REMOVED\",\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":"fa7b9792-d46d-4549-a08d-7cc6d77d71f8","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":"d898be44-76c4-4ea8-ab0a-e9a7b5881392","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":"017d45fe-d8f0-4f1a-8743-3d6ff4f6b101","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":"d994a92d-71ec-480e-9cf0-172a231ae20a","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":"ce9b2d97-f144-4e30-a1ef-3f8c859cdd25","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":"a9a7a611-a18b-4243-a6ed-aee6a960c620","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":"58722470-9c17-4761-9b17-15a80f938da0","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":"caa64507-2b51-4ccb-bd28-7a4836ab6d0e","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":"bd889a72-ea43-4952-9d7c-723ea84cea6c","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":"f6c0c394-5291-4032-b4ce-f5ec9f62b2b4","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":"9d381d7f-6e04-4f92-b1cb-2a78433f1202","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":"10fa2814-ca5e-47d0-b778-f0933074e709","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":"e121ced0-9469-41e5-987e-a2e61826ed73","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":"cc02541a-88d9-4f43-875c-fee52612ede2","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":"3e5cf8f8-b4fa-4689-b7b7-bfff03e4af2f","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":"35144a05-14c5-452d-a8a8-c23eccc491c2","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