diff --git a/src/swaggers/openpix.json b/src/swaggers/openpix.json
index 80a5e21a..1b0691b4 100644
--- a/src/swaggers/openpix.json
+++ b/src/swaggers/openpix.json
@@ -1 +1 @@
-{"openapi":"3.0.3","info":{"title":"OpenPix","description":"A OpenPix é uma Plataforma de Gestão de Pagamentos. Para utilizar nossa API você deve acessar  __[https://api.openpix.com.br/](https://api.openpix.com.br/)__ e somente o mesmo. A OpenPix não aceita subdominios para a API.\n\nVeja como configurar seu acesso a nossa API [aqui](https://developers.openpix.com.br/docs/apis/api-getting-started).","version":"1.0.0"},"servers":[{"url":"https://api.openpix.com.br","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.openpix.com.br\",\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.openpix.com.br/api/v1/account/6290ccfd42831958a405debc \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/account/ \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/cashback-fidelity/balance/%7BtaxID%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/charge/%7Bid%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/charge/fe7834b4060c488a9b0f89811be5f5cf \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\n  \"port\": null,\n  \"path\": \"/api/v1/charge?return_existing=SOME_BOOLEAN_VALUE\",\n  \"headers\": {\n    \"content-type\": \"application/json\",\n    \"Authorization\": \"REPLACE_KEY_VALUE\"\n  }\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = [];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.write(JSON.stringify({\n  correlationID: 'string',\n  value: 0,\n  type: 'DYNAMIC',\n  comment: 'string',\n  identifier: 'string',\n  expiresIn: 0,\n  customer: {\n    name: 'string',\n    email: 'string',\n    phone: 'string',\n    taxID: 'string',\n    correlationID: 'string',\n    address: {\n      zipcode: 'string',\n      street: 'string',\n      number: 'string',\n      neighborhood: 'string',\n      city: 'string',\n      state: 'string',\n      complement: 'string',\n      country: 'string'\n    }\n  },\n  daysForDueDate: 0,\n  daysAfterDueDate: 0,\n  interests: {value: 0},\n  fines: {value: 0},\n  additionalInfo: [{key: 'string', value: 'string'}]\n}));\nreq.end();"},{"lang":"Shell + Curl","source":"curl --request POST \\\n  --url 'https://api.openpix.com.br/api/v1/charge?return_existing=SOME_BOOLEAN_VALUE' \\\n  --header 'Authorization: REPLACE_KEY_VALUE' \\\n  --header 'content-type: application/json' \\\n  --data '{\"correlationID\":\"string\",\"value\":0,\"type\":\"DYNAMIC\",\"comment\":\"string\",\"identifier\":\"string\",\"expiresIn\":0,\"customer\":{\"name\":\"string\",\"email\":\"string\",\"phone\":\"string\",\"taxID\":\"string\",\"correlationID\":\"string\",\"address\":{\"zipcode\":\"string\",\"street\":\"string\",\"number\":\"string\",\"neighborhood\":\"string\",\"city\":\"string\",\"state\":\"string\",\"complement\":\"string\",\"country\":\"string\"}},\"daysForDueDate\":0,\"daysAfterDueDate\":0,\"interests\":{\"value\":0},\"fines\":{\"value\":0},\"additionalInfo\":[{\"key\":\"string\",\"value\":\"string\"}]}'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/api/v1/charge?return_existing=SOME_BOOLEAN_VALUE\",\n  CURLOPT_RETURNTRANSFER => true,\n  CURLOPT_ENCODING => \"\",\n  CURLOPT_MAXREDIRS => 10,\n  CURLOPT_TIMEOUT => 30,\n  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n  CURLOPT_CUSTOMREQUEST => \"POST\",\n  CURLOPT_POSTFIELDS => \"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"type\\\":\\\"DYNAMIC\\\",\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\",\\\"expiresIn\\\":0,\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"daysForDueDate\\\":0,\\\"daysAfterDueDate\\\":0,\\\"interests\\\":{\\\"value\\\":0},\\\"fines\\\":{\\\"value\\\":0},\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}]}\",\n  CURLOPT_HTTPHEADER => [\n    \"Authorization: REPLACE_KEY_VALUE\",\n    \"content-type: application/json\"\n  ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n  echo \"cURL Error #:\" . $err;\n} else {\n  echo $response;\n}"},{"lang":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.openpix.com.br\")\n\npayload = \"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"type\\\":\\\"DYNAMIC\\\",\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\",\\\"expiresIn\\\":0,\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"daysForDueDate\\\":0,\\\"daysAfterDueDate\\\":0,\\\"interests\\\":{\\\"value\\\":0},\\\"fines\\\":{\\\"value\\\":0},\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}]}\"\n\nheaders = {\n    'content-type': \"application/json\",\n    'Authorization': \"REPLACE_KEY_VALUE\"\n    }\n\nconn.request(\"POST\", \"/api/v1/charge?return_existing=SOME_BOOLEAN_VALUE\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"Go + Native","source":"package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.openpix.com.br/api/v1/charge?return_existing=SOME_BOOLEAN_VALUE\"\n\n\tpayload := strings.NewReader(\"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"type\\\":\\\"DYNAMIC\\\",\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\",\\\"expiresIn\\\":0,\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"daysForDueDate\\\":0,\\\"daysAfterDueDate\\\":0,\\\"interests\\\":{\\\"value\\\":0},\\\"fines\\\":{\\\"value\\\":0},\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}]}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"Authorization\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"},{"lang":"Java + Okhttp","source":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"type\\\":\\\"DYNAMIC\\\",\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\",\\\"expiresIn\\\":0,\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"daysForDueDate\\\":0,\\\"daysAfterDueDate\\\":0,\\\"interests\\\":{\\\"value\\\":0},\\\"fines\\\":{\\\"value\\\":0},\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}]}\");\nRequest request = new Request.Builder()\n  .url(\"https://api.openpix.com.br/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.openpix.com.br/api/v1/charge?return_existing=SOME_BOOLEAN_VALUE\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"correlationID\\\":\\\"string\\\",\\\"value\\\":0,\\\"type\\\":\\\"DYNAMIC\\\",\\\"comment\\\":\\\"string\\\",\\\"identifier\\\":\\\"string\\\",\\\"expiresIn\\\":0,\\\"customer\\\":{\\\"name\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"taxID\\\":\\\"string\\\",\\\"correlationID\\\":\\\"string\\\",\\\"address\\\":{\\\"zipcode\\\":\\\"string\\\",\\\"street\\\":\\\"string\\\",\\\"number\\\":\\\"string\\\",\\\"neighborhood\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"state\\\":\\\"string\\\",\\\"complement\\\":\\\"string\\\",\\\"country\\\":\\\"string\\\"}},\\\"daysForDueDate\\\":0,\\\"daysAfterDueDate\\\":0,\\\"interests\\\":{\\\"value\\\":0},\\\"fines\\\":{\\\"value\\\":0},\\\"additionalInfo\\\":[{\\\"key\\\":\\\"string\\\",\\\"value\\\":\\\"string\\\"}]}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}},"/api/v1/charge/{id}/refund":{"get":{"tags":["charge refund"],"summary":"Get all refunds of a charge","description":"Endpoint to get all refunds of a charge","parameters":[{"name":"id","in":"path","description":"The correlation ID of the charge. You will need URI encoding if your correlation ID has characters outside the ASCII set or reserved characters (%, \\#, /).","required":true,"schema":{"type":"string"},"examples":{"uuid":{"value":"cf4012c9-b2ac-484d-8121-deedd1c6d8af"},"random-string":{"value":"fe7834b4060c488a9b0f89811be5f5cf"}}}],"responses":{"200":{"description":"A list of refunds","content":{"application/json":{"schema":{"type":"object","properties":{"refunds":{"type":"array","items":{"$ref":"#/components/schemas/ChargeRefund"}}},"example":{"refunds":[{"status":"IN_PROCESSING","value":10,"correlationID":"9134e286-6f71-427a-bf00-241681624586","endToEndId":"E23114447202304181826HJNwY577YDX","time":"2021-03-02T17:28:51.882Z"},{"status":"CONFIRMED","value":40,"correlationID":"589a378e-ab45-4f30-bd4d-4496c60f88cf","endToEndId":"E23114447202304181057pOhPMsp2pJZ","time":"2021-03-05T14:49:02.922Z","comment":"Comentário do reembolso"}]}}}}},"400":{"description":"An error message","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"x-codeSamples":[{"lang":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n  \"method\": \"GET\",\n  \"hostname\": \"api.openpix.com.br\",\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.openpix.com.br/api/v1/charge/%7Bid%7D/refund \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/customer/%7Bid%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/customer \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/partner/company/%7BtaxID%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/partner/company \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/payment/approve \\\n  --header 'Authorization: REPLACE_KEY_VALUE' \\\n  --header 'content-type: application/json' \\\n  --data '{\"correlationID\":\"string\"}'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/payment/%7Bid%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/payment \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/qrcode-static/%7Bid%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/qrcode-static \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/refund/%7Bid%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/refund \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/subscriptions/UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM= \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/transaction/%7Bid%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/transaction \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/webhook/%7Bid%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/webhook?url=SOME_STRING_VALUE' \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/openpix/charge/brcode/image/%7B:id%7D.png?size=1024' \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/subaccount/destination@test.com/withdraw \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/subaccount/%7Bid%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/subaccount \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/api/v1/subaccount\")\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"content-type\"] = 'application/json'\nrequest[\"Authorization\"] = 'REPLACE_KEY_VALUE'\nrequest.body = \"{\\\"pixKey\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\"}\"\n\nresponse = http.request(request)\nputs response.read_body"}]}}},"components":{"schemas":{"CompanyBankAccount":{"type":"object","properties":{"accountId":{"type":"string","description":"ID of the Account"},"isDefault":{"type":"boolean"},"balance":{"type":"object","properties":{"total":{"type":"number","description":"Total amount in cents"},"blocked":{"type":"number","description":"Blocked amount in cents"},"available":{"type":"number","description":"Available amount in cents"}}}}},"WithdrawTransaction":{"type":"object","properties":{"endToEndId":{"type":"string","description":"ID of the Withdraw Transaction"},"value":{"type":"string"}}},"Charge":{"type":"object","properties":{"value":{"type":"number"},"customer":{"type":"object","$ref":"#/components/schemas/Customer"},"type":{"type":"string","enum":["DYNAMIC","OVERDUE"],"description":"Charge type is used to determine whether a charge will have a deadline, fines and interests"},"comment":{"type":"string"},"brCode":{"type":"string","description":"EMV BRCode to be rendered as a QRCode"},"status":{"type":"string","enum":["ACTIVE","COMPLETED","EXPIRED"]},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this charge"},"paymentLinkID":{"type":"string","description":"Payment Link ID, used on payment link and to retrieve qrcode image"},"paymentLinkUrl":{"description":"Payment Link URL to be shared with customers"},"globalID":{"description":"External ID of this charge"},"transactionID":{"description":"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid."},"identifier":{"type":"string","description":"Custom identifier for EMV"},"qrCodeImage":{"description":"QRCode image link URL"},"additionalInfo":{"description":"Additional info of the charge","type":"array","items":{"type":"object","properties":{"key":{"description":"key of object","type":"string"},"value":{"description":"value of object","type":"string"}}}},"pixKey":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"expiresIn":{"type":"string"}}},"ChargePayload":{"type":"object","properties":{"correlationID":{"type":"string","description":"Your correlation ID to keep track of this charge"},"value":{"type":"number","description":"Value in cents of this charge"},"type":{"type":"string","enum":["DYNAMIC","OVERDUE"],"description":"Charge type is used to determine whether a charge will have a deadline, fines and interests"},"comment":{"type":"string","description":"Comment to be added in infoPagador"},"identifier":{"type":"string","description":"Custom identifier for EMV"},"expiresIn":{"type":"number","description":"Expires the charge in seconds (minimum is 15 minutes)"},"customer":{"type":"object","$ref":"#/components/schemas/CustomerPayload"},"daysForDueDate":{"type":"number","description":"Time in days until the charge hits the deadline so fines and interests start applying. This property is only considered for charges of type OVERDUE"},"daysAfterDueDate":{"type":"number","description":"Time in days that a charge is still payable after the deadline. This property is only considered for charges of type OVERDUE"},"interests":{"description":"Interests configuration. This property is only considered for charges of type OVERDUE","type":"object","properties":{"value":{"type":"number","description":"Value in basis points of interests to be applied daily after the charge hits the deadline"}}},"fines":{"description":"Fines configuration. This property is only considered for charges of type OVERDUE","type":"object","properties":{"value":{"type":"number","description":"Value in basis points of fines to be applied when the charge hits the deadline"}}},"additionalInfo":{"type":"array","description":"Additional info of the charge","items":{"type":"object","properties":{"key":{"type":"string","description":"key of object"},"value":{"type":"string","description":"value of object"}}}}},"required":["correlationID","value"]},"ChargeRefund":{"type":"object","properties":{"value":{"type":"number","description":"Value in cents of this refund"},"status":{"type":"string","enum":["IN_PROCESSING","CONFIRMED","REJECTED"]},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this refund"},"endToEndId":{"type":"string","description":"The endToEndId of this refund"},"time":{"type":"string","description":"Time of this refund"},"comment":{"type":"string","description":"Comment of this refund"}}},"ChargeRefundPayload":{"type":"object","properties":{"correlationID":{"type":"string","description":"Your correlation ID to keep track for this refund"},"value":{"type":"number","description":"Value in cents for this refund"},"comment":{"type":"string","description":"Comment for this refund. Maximum length of 140 characters.","maximum":140}},"required":["correlationID"]},"Customer":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"taxID":{"type":"object","properties":{"taxID":{"type":"string"},"type":{"type":"string"}}},"correlationID":{"type":"string"},"address":{"type":"object","properties":{"zipcode":{"type":"string"},"street":{"type":"string"},"number":{"type":"string"},"neighborhood":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"complement":{"type":"string"},"country":{"type":"string"}}}}},"CustomerPayload":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"taxID":{"type":"string"},"correlationID":{"type":"string"},"address":{"type":"object","properties":{"zipcode":{"type":"string"},"street":{"type":"string"},"number":{"type":"string"},"neighborhood":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"complement":{"type":"string"},"country":{"type":"string"}}}},"required":["name","taxID"]},"End":{"type":"string","format":"date-time","title":"End Date","description":"End date used in the query. Complies with RFC 3339.","example":"2020-12-01T17:00:00Z"},"ApplicationEnumTypePayload":{"type":"string","description":"Type of the application that you want to register. Each of this has some kind of permissions.","enum":["API","PLUGIN","ORACLE"]},"TaxIDObjectPayload":{"type":"object","properties":{"taxID":{"type":"string","description":"The tax identifier of your account holder. This should be a raw string with only digits."},"type":{"type":"string","enum":["BR:CNPJ"]}}},"PreRegistrationUserObject":{"type":"object","properties":{"firstName":{"type":"string","description":"The user's first name.\nIf the pre registration has been approved, this will be turn the company's first user first name.\n"},"lastName":{"type":"string","description":"The user's last name.\nIf the pre registration has been approved, this will be turn the company's first user last name.\n"},"email":{"type":"string","description":"The user's email.\nIt'll be the email that will entered in contact to validate that it's a real person (it's a step to approve the preregistration).\nAfter approving the preregistration, it'll be the company's user email.\n"},"phone":{"type":"string","description":"The user's phone number, need to be a validated phone number because it'll receive a SMS confirming that is a real person.\nWe're accept only values that matches the E.164 standard, that follows this pattern: [+][country code][local phone number].\n"}},"required":["firstName","lastName","email","phone"]},"PreRegistrationObject":{"type":"object","properties":{"name":{"type":"string","description":"The name of this preregistration. It'll be related as your company name too."},"website":{"type":"string","description":"A website that is related to this preregistration."},"taxID":{"$ref":"#/components/schemas/TaxIDObjectPayload"}},"required":["name","taxID"]},"PreRegistrationPayloadObject":{"type":"object","properties":{"preRegistration":{"$ref":"#/components/schemas/PreRegistrationObject"},"user":{"$ref":"#/components/schemas/PreRegistrationUserObject"}}},"AccountObjectPayload":{"type":"object","properties":{"clientId":{"type":"string","description":"The client ID from the company bank account that is related to this preregistration/company."}}},"CompanyObjectPayload":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the company that is related to this preregistration."},"name":{"type":"string","description":"The name of the company that is related to this preregistration."},"taxID":{"$ref":"#/components/schemas/TaxIDObjectPayload"}}},"PreRegistrationObjectPayload":{"type":"object","properties":{"name":{"type":"string","description":"When the preregistration will turn a company, this will be the name of the company that this preregistration is related."},"taxID":{"$ref":"#/components/schemas/TaxIDObjectPayload"}}},"PartnerApplicationPayload":{"type":"object","properties":{"name":{"type":"string","description":"The name that identifies your application."},"isActive":{"type":"boolean","description":"Current status of your application."},"type":{"$ref":"#/components/schemas/ApplicationEnumTypePayload"},"clientId":{"type":"string","description":"The ID of this client application."},"clientSecret":{"type":"string","description":"The secret of this client application."}}},"PaymentApprovePayload":{"type":"object","properties":{"correlationID":{"type":"string","description":"the correlation ID of the payment to be approved"}}},"PaymentCreatePayload":{"type":"object","properties":{"value":{"type":"number","description":"value of the requested payment in cents"},"destinationAlias":{"type":"string","description":"the pix key the payment should be sent to"},"correlationID":{"type":"string","description":"an unique identifier for your payment"},"comment":{"type":"string","description":"the comment that will be send alongisde your payment"},"sourceAccountId":{"type":"string","description":"an optional id for the source account of the payment, if not informed will assume the default account"}}},"Payment":{"type":"object","properties":{"value":{"type":"number","description":"value of the requested payment in cents"},"destinationAlias":{"type":"string","description":"the pix key the payment should be sent to"},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this payment"},"comment":{"type":"string","description":"the comment that will be send alongisde your payment"},"status":{"type":"string","description":"payment status","enum":["CREATED","FAILED","CONFIRMED","DENIED"]},"sourceAccountId":{"type":"string","description":"the id of the payment source account"}}},"PaymentTransaction":{"type":"object","properties":{"value":{"type":"number","description":"value of the transaction generated by the payment in cents"},"endToEndId":{"type":"string","description":"endToEndId of the transaction generated by the payment"},"time":{"type":"string","description":"time the transaction generated by the payment happened"}}},"PaymentDestination":{"type":"object","properties":{"name":{"type":"string","description":"the name of the payment destination"},"taxID":{"type":"string","description":"the tax id of the payment destination"},"pixKey":{"type":"string","description":"the pix key of the payment destination"},"bank":{"type":"string","description":"the payment destination bank name"},"branch":{"type":"string","description":"the payment destination bank branch"},"account":{"type":"string","description":"the payment destination bank account"}}},"PixQrCode":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"comment":{"type":"string"},"identifier":{"type":"string","description":"Custom identifier for EMV"},"brCode":{"type":"string","description":"EMV BRCode to be rendered as a Pix QRCode"},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this pix qrcode"},"paymentLinkID":{"type":"string","description":"Payment Link ID, used on payment link and to retrieve qrcode image"},"paymentLinkUrl":{"description":"Payment Link URL to be shared with customers"},"qrCodeImage":{"description":"QRCode image link URL"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"PixQrCodePayload":{"type":"object","properties":{"name":{"type":"string","description":"Name of this pix qrcode"},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this qrcode"},"value":{"type":"number","description":"Value in cents of this qrcode"},"comment":{"type":"string","description":"Comment to be added in infoPagador"},"identifier":{"type":"string","description":"Custom identifier for EMV"}},"required":["name","identifier"]},"Refund":{"type":"object","properties":{"value":{"type":"number"},"status":{"type":"string","enum":["IN_PROCESSING","REFUNDED","NOT_ACCOMPLISHED"]},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this refund"},"refundId":{"type":"string","description":"Unique refund ID for this pix refund"},"time":{"type":"string","description":"Time of this refund"},"comment":{"type":"string","description":"Comment of this refund"}}},"RefundPayload":{"type":"object","properties":{"value":{"type":"number"},"transactionEndToEndId":{"type":"string","description":"Your transaction ID, or endToEnd ID, to keep track of this refund"},"correlationID":{"type":"string","description":"Your correlation ID, unique identifier refund"},"comment":{"type":"string","description":"Comment of this refund. Maximum length of 140 characters.","maximum":140}}},"Start":{"type":"string","format":"date-time","title":"Start Date","description":"Start date used in the query. Complies with RFC 3339.","example":"2020-01-01T00:00:00Z"},"Subscription":{"type":"object","properties":{"globalID":{"type":"string","description":"The globalID of the subscription."},"value":{"type":"number","description":"Value in cents of the subscription"},"customer":{"type":"object","$ref":"#/components/schemas/Customer"},"dayGenerateCharge":{"type":"number","description":"Day of the month that the charges will be generated"}}},"SubscriptionPayload":{"type":"object","properties":{"customer":{"type":"object","description":"Customer of this subscription","properties":{"name":{"type":"string","description":"Customer name"},"email":{"type":"string","description":"Customer email"},"phone":{"type":"string","description":"Customer phone"},"taxID":{"type":"string","description":"Customer taxID (CPF or CNPJ)"},"address":{"type":"object","properties":{"zipcode":{"type":"string"},"street":{"type":"string"},"number":{"type":"string"},"neighborhood":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"complement":{"type":"string"},"country":{"type":"string"}}}}},"value":{"type":"number","description":"Value in cents of this subscription"},"comment":{"type":"string","description":"Comment to be added in infoPagador"},"additionalInfo":{"description":"Additional info of the charge","type":"array","items":{"type":"object","properties":{"key":{"description":"key of object","type":"string"},"value":{"description":"value of object","type":"string"}}}},"dayGenerateCharge":{"type":"number","description":"Day of the month that the charges will be generated. Maximun of 27.","minimum":0,"maximum":27,"default":5},"chargeType":{"type":"string","enum":["DYNAMIC","OVERDUE"],"description":"The charge type is used to determine whether charges generated by the subscription will have fines and interests","default":"DYNAMIC"},"dayDue":{"type":"number","minimum":3,"default":7,"description":"Days that the charge will take to expire from the generation day."}},"required":["customer","value"]},"Transaction":{"type":"object","properties":{"charge":{"type":"object","$ref":"#/components/schemas/Charge"},"value":{"type":"number"},"time":{"type":"string"},"endToEndID":{"type":"string"},"transactionID":{"type":"string"},"infoPagador":{"type":"string"},"endToEndId":{"type":"string"},"customer":{"type":"object","$ref":"#/components/schemas/Customer"},"withdraw":{"type":"object","$ref":"#/components/schemas/PixWithdrawTransaction"},"payer":{"type":"object","$ref":"#/components/schemas/Customer"},"type":{"type":"string","description":"Pix Transaction type","enum":["PAYMENT","WITHDRAW","REFUND","FEE"]},"globalID":{"description":"External ID of this transaction"},"pixQrCode":{"type":"object","$ref":"#/components/schemas/PixQrCode"}}},"PixWithdrawTransaction":{"type":"object","properties":{"value":{"type":"number"},"time":{"type":"string"},"endToEndID":{"type":"string"},"transactionID":{"type":"string"},"infoPagador":{"type":"string"},"endToEndId":{"type":"string"},"payer":{"type":"object","$ref":"#/components/schemas/Customer"},"type":{"type":"string"}}},"TransferCreatePayload":{"type":"object","properties":{"value":{"type":"number","description":"value of the transfer in cents"},"fromPixKey":{"type":"string","description":"the pix key of the account the value of the transfer will come out from"},"toPixKey":{"type":"string","description":"the pix key of the account the value of the transfer will go to"}}},"TransferTransaction":{"type":"object","properties":{"value":{"type":"number","description":"value of the transaction generated by the transfer"},"time":{"type":"string","description":"the time the transfer happened"},"correlationID":{"type":"string","description":"your correlation ID to keep track of this transfer"}}},"WebhookPayload":{"type":"object","properties":{"name":{"type":"string"},"event":{"type":"string","description":"The event to listen to. If omitted, the webhook will be registered to listen the OPENPIX:TRANSACTION_RECEIVED. Event called when a new pix transactions is received","$ref":"#/components/schemas/WebhookEventEnum"},"url":{"type":"string"},"authorization":{"type":"string"},"isActive":{"type":"boolean"}}},"Webhook":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/WebhookEventEnum"},"url":{"type":"string"},"authorization":{"type":"string"},"isActive":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"WebhookEventEnum":{"type":"string","description":"Available events to register a webhook to listen to. If no one selected anyone the default event will be OPENPIX:TRANSACTION_RECEIVED.\n\n* **OPENPIX:CHARGE_CREATED** - New charge created\n* **OPENPIX:CHARGE_COMPLETED** - Charge completed is when a charge is fully paid\n* **OPENPIX:CHARGE_EXPIRED** - Charge expired is when a charge is not fully paid and expired\n* **OPENPIX:TRANSACTION_RECEIVED** - New PIX transaction received\n* **OPENPIX:TRANSACTION_REFUND_RECEIVED** - New PIX transaction refund received or refunded\n* **OPENPIX:MOVEMENT_CONFIRMED** - Payment confirmed is when the pix transaction related to the payment gets confirmed\n* **OPENPIX:MOVEMENT_FAILED** - Payment failed is when the payment gets approved and a error occurs\n* **OPENPIX:MOVEMENT_REMOVED** - Payment was removed by a user\n","enum":["OPENPIX:CHARGE_CREATED","OPENPIX:CHARGE_COMPLETED","OPENPIX:CHARGE_EXPIRED","OPENPIX:TRANSACTION_RECEIVED","OPENPIX:TRANSACTION_REFUND_RECEIVED","OPENPIX:MOVEMENT_CONFIRMED","OPENPIX:MOVEMENT_FAILED","OPENPIX:MOVEMENT_REMOVED"]},"SubAccount":{"type":"object","properties":{"name":{"type":"string","description":"Name of the sub account"},"pixKey":{"type":"string","description":"The pix key for the sub account"},"balance":{"type":"number","description":"Number in cents that represent the balance of the sub account"}}},"transaction":{"type":"object","properties":{"status":{"type":"string","description":"The status of the transaction"},"value":{"type":"number","description":"The value of the transaction in cents"},"correlationID":{"type":"string","description":"The correlation ID of the transaction"},"destinationAlias":{"type":"string","description":"The pix key of the transaction"},"comment":{"type":"string","description":"The comment of the transaction"}}},"SubAccountPayload":{"type":"object","properties":{"pixKey":{"type":"string","description":"The pix key for the sub account"},"name":{"type":"string","description":"Name of the sub account"}}}},"securitySchemes":{"AppID":{"type":"apiKey","in":"header","name":"Authorization"}}},"tags":[{"name":"account","description":"Endpoint to manage Accounts\n"},{"name":"cashback-fidelity","description":"Endpoint to manage exclusive cashbacks\n"},{"name":"charge","description":"Endpoint to manage Charges\n"},{"name":"charge refund","description":"Endpoint to manage charge refunds\n"},{"name":"customer","description":"Endpoint to manage Customer\n"},{"name":"partner (request access)","description":"Partners integrate affiliated companies.<br/>\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":"OpenPix","description":"A OpenPix é uma Plataforma de Gestão de Pagamentos. Para utilizar nossa API você deve acessar  __[https://api.openpix.com.br/](https://api.openpix.com.br/)__ e somente o mesmo. A OpenPix não aceita subdominios para a API.\n\nVeja como configurar seu acesso a nossa API [aqui](https://developers.openpix.com.br/docs/apis/api-getting-started).","version":"1.0.0"},"servers":[{"url":"https://api.openpix.com.br","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.openpix.com.br\",\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.openpix.com.br/api/v1/account/6290ccfd42831958a405debc \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/account/ \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/cashback-fidelity/balance/%7BtaxID%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/charge/%7Bid%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/charge/fe7834b4060c488a9b0f89811be5f5cf \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/charge/%7Bid%7D/refund \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/customer/%7Bid%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/customer \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/partner/company/%7BtaxID%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/partner/company \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/payment/approve \\\n  --header 'Authorization: REPLACE_KEY_VALUE' \\\n  --header 'content-type: application/json' \\\n  --data '{\"correlationID\":\"string\"}'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/payment/%7Bid%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/payment \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/qrcode-static/%7Bid%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/qrcode-static \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/refund/%7Bid%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/refund \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/subscriptions/UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM= \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/transaction/%7Bid%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/transaction \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/webhook/%7Bid%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/webhook?url=SOME_STRING_VALUE' \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/openpix/charge/brcode/image/%7B:id%7D.png?size=1024' \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/subaccount/destination@test.com/withdraw \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/subaccount/%7Bid%7D \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/api/v1/subaccount \\\n  --header 'Authorization: REPLACE_KEY_VALUE'"},{"lang":"Php + Curl","source":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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.openpix.com.br\",\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.openpix.com.br/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":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.openpix.com.br/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.openpix.com.br\")\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.openpix.com.br/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.openpix.com.br/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.openpix.com.br/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":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"taxID":{"type":"string"},"correlationID":{"type":"string"},"address":{"type":"object","properties":{"zipcode":{"type":"string"},"street":{"type":"string"},"number":{"type":"string"},"neighborhood":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"complement":{"type":"string"},"country":{"type":"string"}}}},"required":["name","taxID"]},"End":{"type":"string","format":"date-time","title":"End Date","description":"End date used in the query. Complies with RFC 3339.","example":"2020-12-01T17:00:00Z"},"ApplicationEnumTypePayload":{"type":"string","description":"Type of the application that you want to register. Each of this has some kind of permissions.","enum":["API","PLUGIN","ORACLE"]},"TaxIDObjectPayload":{"type":"object","properties":{"taxID":{"type":"string","description":"The tax identifier of your account holder. This should be a raw string with only digits."},"type":{"type":"string","enum":["BR:CNPJ"]}}},"PreRegistrationUserObject":{"type":"object","properties":{"firstName":{"type":"string","description":"The user's first name.\nIf the pre registration has been approved, this will be turn the company's first user first name.\n"},"lastName":{"type":"string","description":"The user's last name.\nIf the pre registration has been approved, this will be turn the company's first user last name.\n"},"email":{"type":"string","description":"The user's email.\nIt'll be the email that will entered in contact to validate that it's a real person (it's a step to approve the preregistration).\nAfter approving the preregistration, it'll be the company's user email.\n"},"phone":{"type":"string","description":"The user's phone number, need to be a validated phone number because it'll receive a SMS confirming that is a real person.\nWe're accept only values that matches the E.164 standard, that follows this pattern: [+][country code][local phone number].\n"}},"required":["firstName","lastName","email","phone"]},"PreRegistrationObject":{"type":"object","properties":{"name":{"type":"string","description":"The name of this preregistration. It'll be related as your company name too."},"website":{"type":"string","description":"A website that is related to this preregistration."},"taxID":{"$ref":"#/components/schemas/TaxIDObjectPayload"}},"required":["name","taxID"]},"PreRegistrationPayloadObject":{"type":"object","properties":{"preRegistration":{"$ref":"#/components/schemas/PreRegistrationObject"},"user":{"$ref":"#/components/schemas/PreRegistrationUserObject"}}},"AccountObjectPayload":{"type":"object","properties":{"clientId":{"type":"string","description":"The client ID from the company bank account that is related to this preregistration/company."}}},"CompanyObjectPayload":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the company that is related to this preregistration."},"name":{"type":"string","description":"The name of the company that is related to this preregistration."},"taxID":{"$ref":"#/components/schemas/TaxIDObjectPayload"}}},"PreRegistrationObjectPayload":{"type":"object","properties":{"name":{"type":"string","description":"When the preregistration will turn a company, this will be the name of the company that this preregistration is related."},"taxID":{"$ref":"#/components/schemas/TaxIDObjectPayload"}}},"PartnerApplicationPayload":{"type":"object","properties":{"name":{"type":"string","description":"The name that identifies your application."},"isActive":{"type":"boolean","description":"Current status of your application."},"type":{"$ref":"#/components/schemas/ApplicationEnumTypePayload"},"clientId":{"type":"string","description":"The ID of this client application."},"clientSecret":{"type":"string","description":"The secret of this client application."}}},"PaymentApprovePayload":{"type":"object","properties":{"correlationID":{"type":"string","description":"the correlation ID of the payment to be approved"}}},"PaymentCreatePayload":{"type":"object","properties":{"value":{"type":"number","description":"value of the requested payment in cents"},"destinationAlias":{"type":"string","description":"the pix key the payment should be sent to"},"correlationID":{"type":"string","description":"an unique identifier for your payment"},"comment":{"type":"string","description":"the comment that will be send alongisde your payment"},"sourceAccountId":{"type":"string","description":"an optional id for the source account of the payment, if not informed will assume the default account"}}},"Payment":{"type":"object","properties":{"value":{"type":"number","description":"value of the requested payment in cents"},"destinationAlias":{"type":"string","description":"the pix key the payment should be sent to"},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this payment"},"comment":{"type":"string","description":"the comment that will be send alongisde your payment"},"status":{"type":"string","description":"payment status","enum":["CREATED","FAILED","CONFIRMED","DENIED"]},"sourceAccountId":{"type":"string","description":"the id of the payment source account"}}},"PaymentTransaction":{"type":"object","properties":{"value":{"type":"number","description":"value of the transaction generated by the payment in cents"},"endToEndId":{"type":"string","description":"endToEndId of the transaction generated by the payment"},"time":{"type":"string","description":"time the transaction generated by the payment happened"}}},"PaymentDestination":{"type":"object","properties":{"name":{"type":"string","description":"the name of the payment destination"},"taxID":{"type":"string","description":"the tax id of the payment destination"},"pixKey":{"type":"string","description":"the pix key of the payment destination"},"bank":{"type":"string","description":"the payment destination bank name"},"branch":{"type":"string","description":"the payment destination bank branch"},"account":{"type":"string","description":"the payment destination bank account"}}},"PixQrCode":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"comment":{"type":"string"},"identifier":{"type":"string","description":"Custom identifier for EMV"},"brCode":{"type":"string","description":"EMV BRCode to be rendered as a Pix QRCode"},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this pix qrcode"},"paymentLinkID":{"type":"string","description":"Payment Link ID, used on payment link and to retrieve qrcode image"},"paymentLinkUrl":{"description":"Payment Link URL to be shared with customers"},"qrCodeImage":{"description":"QRCode image link URL"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"PixQrCodePayload":{"type":"object","properties":{"name":{"type":"string","description":"Name of this pix qrcode"},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this qrcode"},"value":{"type":"number","description":"Value in cents of this qrcode"},"comment":{"type":"string","description":"Comment to be added in infoPagador"},"identifier":{"type":"string","description":"Custom identifier for EMV"}},"required":["name","identifier"]},"Refund":{"type":"object","properties":{"value":{"type":"number"},"status":{"type":"string","enum":["IN_PROCESSING","REFUNDED","NOT_ACCOMPLISHED"]},"correlationID":{"type":"string","description":"Your correlation ID to keep track of this refund"},"refundId":{"type":"string","description":"Unique refund ID for this pix refund"},"time":{"type":"string","description":"Time of this refund"},"comment":{"type":"string","description":"Comment of this refund"}}},"RefundPayload":{"type":"object","properties":{"value":{"type":"number"},"transactionEndToEndId":{"type":"string","description":"Your transaction ID, or endToEnd ID, to keep track of this refund"},"correlationID":{"type":"string","description":"Your correlation ID, unique identifier refund"},"comment":{"type":"string","description":"Comment of this refund. Maximum length of 140 characters.","maximum":140}}},"Start":{"type":"string","format":"date-time","title":"Start Date","description":"Start date used in the query. Complies with RFC 3339.","example":"2020-01-01T00:00:00Z"},"Subscription":{"type":"object","properties":{"globalID":{"type":"string","description":"The globalID of the subscription."},"value":{"type":"number","description":"Value in cents of the subscription"},"customer":{"type":"object","$ref":"#/components/schemas/Customer"},"dayGenerateCharge":{"type":"number","description":"Day of the month that the charges will be generated"}}},"SubscriptionPayload":{"type":"object","properties":{"customer":{"type":"object","description":"Customer of this subscription","properties":{"name":{"type":"string","description":"Customer name"},"email":{"type":"string","description":"Customer email"},"phone":{"type":"string","description":"Customer phone"},"taxID":{"type":"string","description":"Customer taxID (CPF or CNPJ)"},"address":{"type":"object","properties":{"zipcode":{"type":"string"},"street":{"type":"string"},"number":{"type":"string"},"neighborhood":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"complement":{"type":"string"},"country":{"type":"string"}}}}},"value":{"type":"number","description":"Value in cents of this subscription"},"comment":{"type":"string","description":"Comment to be added in infoPagador"},"additionalInfo":{"description":"Additional info of the charge","type":"array","items":{"type":"object","properties":{"key":{"description":"key of object","type":"string"},"value":{"description":"value of object","type":"string"}}}},"dayGenerateCharge":{"type":"number","description":"Day of the month that the charges will be generated. Maximun of 27.","minimum":0,"maximum":27,"default":5},"chargeType":{"type":"string","enum":["DYNAMIC","OVERDUE"],"description":"The charge type is used to determine whether charges generated by the subscription will have fines and interests","default":"DYNAMIC"},"dayDue":{"type":"number","minimum":3,"default":7,"description":"Days that the charge will take to expire from the generation day."}},"required":["customer","value"]},"Transaction":{"type":"object","properties":{"charge":{"type":"object","$ref":"#/components/schemas/Charge"},"value":{"type":"number"},"time":{"type":"string"},"endToEndID":{"type":"string"},"transactionID":{"type":"string"},"infoPagador":{"type":"string"},"endToEndId":{"type":"string"},"customer":{"type":"object","$ref":"#/components/schemas/Customer"},"withdraw":{"type":"object","$ref":"#/components/schemas/PixWithdrawTransaction"},"payer":{"type":"object","$ref":"#/components/schemas/Customer"},"type":{"type":"string","description":"Pix Transaction type","enum":["PAYMENT","WITHDRAW","REFUND","FEE"]},"globalID":{"description":"External ID of this transaction"},"pixQrCode":{"type":"object","$ref":"#/components/schemas/PixQrCode"}}},"PixWithdrawTransaction":{"type":"object","properties":{"value":{"type":"number"},"time":{"type":"string"},"endToEndID":{"type":"string"},"transactionID":{"type":"string"},"infoPagador":{"type":"string"},"endToEndId":{"type":"string"},"payer":{"type":"object","$ref":"#/components/schemas/Customer"},"type":{"type":"string"}}},"TransferCreatePayload":{"type":"object","properties":{"value":{"type":"number","description":"value of the transfer in cents"},"fromPixKey":{"type":"string","description":"the pix key of the account the value of the transfer will come out from"},"toPixKey":{"type":"string","description":"the pix key of the account the value of the transfer will go to"}}},"TransferTransaction":{"type":"object","properties":{"value":{"type":"number","description":"value of the transaction generated by the transfer"},"time":{"type":"string","description":"the time the transfer happened"},"correlationID":{"type":"string","description":"your correlation ID to keep track of this transfer"}}},"WebhookPayload":{"type":"object","properties":{"name":{"type":"string"},"event":{"type":"string","description":"The event to listen to. If omitted, the webhook will be registered to listen the OPENPIX:TRANSACTION_RECEIVED. Event called when a new pix transactions is received","$ref":"#/components/schemas/WebhookEventEnum"},"url":{"type":"string"},"authorization":{"type":"string"},"isActive":{"type":"boolean"}}},"Webhook":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/WebhookEventEnum"},"url":{"type":"string"},"authorization":{"type":"string"},"isActive":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"WebhookEventEnum":{"type":"string","description":"Available events to register a webhook to listen to. If no one selected anyone the default event will be OPENPIX:TRANSACTION_RECEIVED.\n\n* **OPENPIX:CHARGE_CREATED** - New charge created\n* **OPENPIX:CHARGE_COMPLETED** - Charge completed is when a charge is fully paid\n* **OPENPIX:CHARGE_EXPIRED** - Charge expired is when a charge is not fully paid and expired\n* **OPENPIX:TRANSACTION_RECEIVED** - New PIX transaction received\n* **OPENPIX:TRANSACTION_REFUND_RECEIVED** - New PIX transaction refund received or refunded\n* **OPENPIX:MOVEMENT_CONFIRMED** - Payment confirmed is when the pix transaction related to the payment gets confirmed\n* **OPENPIX:MOVEMENT_FAILED** - Payment failed is when the payment gets approved and a error occurs\n* **OPENPIX:MOVEMENT_REMOVED** - Payment was removed by a user\n","enum":["OPENPIX:CHARGE_CREATED","OPENPIX:CHARGE_COMPLETED","OPENPIX:CHARGE_EXPIRED","OPENPIX:TRANSACTION_RECEIVED","OPENPIX:TRANSACTION_REFUND_RECEIVED","OPENPIX:MOVEMENT_CONFIRMED","OPENPIX:MOVEMENT_FAILED","OPENPIX:MOVEMENT_REMOVED"]},"SubAccount":{"type":"object","properties":{"name":{"type":"string","description":"Name of the sub account"},"pixKey":{"type":"string","description":"The pix key for the sub account"},"balance":{"type":"number","description":"Number in cents that represent the balance of the sub account"}}},"transaction":{"type":"object","properties":{"status":{"type":"string","description":"The status of the transaction"},"value":{"type":"number","description":"The value of the transaction in cents"},"correlationID":{"type":"string","description":"The correlation ID of the transaction"},"destinationAlias":{"type":"string","description":"The pix key of the transaction"},"comment":{"type":"string","description":"The comment of the transaction"}}},"SubAccountPayload":{"type":"object","properties":{"pixKey":{"type":"string","description":"The pix key for the sub account"},"name":{"type":"string","description":"Name of the sub account"}}}},"securitySchemes":{"AppID":{"type":"apiKey","in":"header","name":"Authorization"}}},"tags":[{"name":"account","description":"Endpoint to manage Accounts\n"},{"name":"cashback-fidelity","description":"Endpoint to manage exclusive cashbacks\n"},{"name":"charge","description":"Endpoint to manage Charges\n"},{"name":"charge refund","description":"Endpoint to manage charge refunds\n"},{"name":"customer","description":"Endpoint to manage Customer\n"},{"name":"partner (request access)","description":"Partners integrate affiliated companies.<br/>\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/openpix.yml b/src/swaggers/openpix.yml
index 423e272a..c5c9ba89 100644
--- a/src/swaggers/openpix.yml
+++ b/src/swaggers/openpix.yml
@@ -2973,6 +2973,12 @@ components:
               value:
                 type: string
                 description: value of object
+        enableCashbackPercentage:
+          type: boolean
+          description: true to enable cashback and false to disable.
+        enableCashbackExclusivePercentage:
+          type: boolean
+          description: true to enable fidelity cashback and false to disable.
       required:
         - correlationID
         - value
diff --git a/static/openpixPostman.json b/static/openpixPostman.json
index c7b56679..8be7525d 100644
--- a/static/openpixPostman.json
+++ b/static/openpixPostman.json
@@ -1 +1 @@
-{"item":[{"name":"openpix","description":"","item":[{"name":"charge","description":"","item":[{"name":"brcode","description":"","item":[{"name":"image","description":"","item":[{"name":"{:id}.png?size=1024","description":"","item":[{"id":"e1291515-2b18-4e87-8d2d-1c79c1b18518","name":"Get an image of Qr Code from a Charge","request":{"name":"Get an image of Qr Code from a Charge","description":{},"url":{"path":["openpix","charge","brcode","image","{{:id}}.png"],"host":["{{baseUrl}}"],"query":[{"key":"size","value":"1024"},{"disabled":false,"description":{"content":"Size for the image. This size should be between 600 and 4096. if the size parameter was not passed, the default value will be 1024.","type":"text/plain"},"key":"size","value":"<string>"}],"variable":[{"disabled":false,"description":{"content":"(Required) charge link payment ID","type":"text/plain"},"type":"any","value":"<string>","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"45d37cfe-529b-43ef-b861-2e3ea86f0a75","name":"The Qr Code image as MIME type","originalRequest":{"url":{"path":["openpix","charge","brcode","image","{{:id}}.png"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Size for the image. This size should be between 600 and 4096. if the size parameter was not passed, the default value will be 1024.","type":"text/plain"},"key":"size","value":"<string>"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[],"cookie":[],"_postman_previewlanguage":"text"},{"id":"2a9de0cd-fbe8-4b92-a748-5520c23367a1","name":"An error message","originalRequest":{"url":{"path":["openpix","charge","brcode","image","{{:id}}.png"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Size for the image. This size should be between 600 and 4096. if the size parameter was not passed, the default value will be 1024.","type":"text/plain"},"key":"size","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]}]}]}]},{"name":"api","description":"","item":[{"name":"v1","description":"","item":[{"name":"webhook","description":"","item":[{"name":"{id}","description":"","item":[{"id":"01997b6e-533e-4d87-a4b1-3b2c8a7fd856","name":"Delete a Webhook","request":{"name":"Delete a Webhook","description":{"content":"Endpoint to delete a Webhook","type":"text/plain"},"url":{"path":["api","v1","webhook",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{},"auth":null},"response":[{"id":"0a7dfdb6-85c3-4bd2-939c-205917c76ea0","name":"Webhook ID and also the status code","originalRequest":{"url":{"path":["api","v1","webhook",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"status\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6730913a-5da6-4821-a541-fc1b35f936d0","name":"An error message","originalRequest":{"url":{"path":["api","v1","webhook",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\",\n  \"status\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"842117b9-2378-44eb-82bd-cccb0121ddad","name":"Get a list of webhooks","request":{"name":"Get a list of webhooks","description":{},"url":{"path":["api","v1","webhook"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"You can use the url to filter all webhooks","type":"text/plain"},"key":"url","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"b62546f6-ffbb-4f26-8956-86b3bacc260c","name":"A list of webhooks","originalRequest":{"url":{"path":["api","v1","webhook"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"You can use the url to filter all webhooks","type":"text/plain"},"key":"url","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"webhooks\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"event\": \"OPENPIX:TRANSACTION_REFUND_RECEIVED\",\n      \"url\": \"<string>\",\n      \"authorization\": \"<string>\",\n      \"isActive\": \"<boolean>\",\n      \"createdAt\": \"<string>\",\n      \"updatedAt\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"event\": \"OPENPIX:TRANSACTION_REFUND_RECEIVED\",\n      \"url\": \"<string>\",\n      \"authorization\": \"<string>\",\n      \"isActive\": \"<boolean>\",\n      \"createdAt\": \"<string>\",\n      \"updatedAt\": \"<string>\"\n    }\n  ],\n  \"pageInfo\": {\n    \"errors\": [\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      },\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      }\n    ]\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7996cbc7-5b00-4bfa-bdc1-7d8fdddc0a39","name":"An error message","originalRequest":{"url":{"path":["api","v1","webhook"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"You can use the url to filter all webhooks","type":"text/plain"},"key":"url","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1fd999d5-dc1f-4e0e-8e9c-c139a8dc92bb","name":"Create a new Webhook","request":{"name":"Create a new Webhook","description":{"content":"Endpoint to create a new Webhook","type":"text/plain"},"url":{"path":["api","v1","webhook"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"webhook\": {\n    \"name\": \"<string>\",\n    \"event\": \"OPENPIX:CHARGE_EXPIRED\",\n    \"url\": \"<string>\",\n    \"authorization\": \"<string>\",\n    \"isActive\": \"<boolean>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"b52de4e1-132e-40aa-9329-eaf11c82b9db","name":"Webhook created specific event when receives a new pix transaction","originalRequest":{"url":{"path":["api","v1","webhook"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"webhook\": {\n    \"name\": \"<string>\",\n    \"event\": \"OPENPIX:CHARGE_EXPIRED\",\n    \"url\": \"<string>\",\n    \"authorization\": \"<string>\",\n    \"isActive\": \"<boolean>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"webhook\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"event\": \"OPENPIX:CHARGE_CREATED\",\n    \"url\": \"<string>\",\n    \"authorization\": \"<string>\",\n    \"isActive\": \"<boolean>\",\n    \"createdAt\": \"<string>\",\n    \"updatedAt\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"18e4feb9-8f73-4a26-ae93-741a61ceb625","name":"An error message","originalRequest":{"url":{"path":["api","v1","webhook"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"webhook\": {\n    \"name\": \"<string>\",\n    \"event\": \"OPENPIX:CHARGE_EXPIRED\",\n    \"url\": \"<string>\",\n    \"authorization\": \"<string>\",\n    \"isActive\": \"<boolean>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"transfer","description":"","item":[{"id":"847de170-8370-4521-bcbf-66470704d1d9","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\": \"<number>\",\n  \"fromPixKey\": \"<string>\",\n  \"toPixKey\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"41d01f74-dfd6-44d1-80a7-3db08cb2a189","name":"Transfer transaction information","originalRequest":{"url":{"path":["api","v1","transfer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\",\n  \"fromPixKey\": \"<string>\",\n  \"toPixKey\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"transaction\": {\n    \"value\": \"<number>\",\n    \"time\": \"<string>\",\n    \"correlationID\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"08216f7d-fa19-4041-b190-7db5aa258ff2","name":"An error message","originalRequest":{"url":{"path":["api","v1","transfer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\",\n  \"fromPixKey\": \"<string>\",\n  \"toPixKey\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"transaction","description":"","item":[{"name":"{id}","description":"","item":[{"id":"268d62e3-d4ff-47e7-863e-17deb888fe7c","name":"Get a Transaction","request":{"name":"Get a Transaction","description":{},"url":{"path":["api","v1","transaction",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"671c9ac8-7bd8-4af0-8e1c-67106a6d991f","name":"The transaction retrieve using the given ID","originalRequest":{"url":{"path":["api","v1","transaction",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"transaction\": {\n    \"charge\": {\n      \"value\": \"<number>\",\n      \"customer\": {\n        \"name\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"<string>\"\n        },\n        \"correlationID\": \"<string>\",\n        \"address\": {\n          \"zipcode\": \"<string>\",\n          \"street\": \"<string>\",\n          \"number\": \"<string>\",\n          \"neighborhood\": \"<string>\",\n          \"city\": \"<string>\",\n          \"state\": \"<string>\",\n          \"complement\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      },\n      \"type\": \"OVERDUE\",\n      \"comment\": \"<string>\",\n      \"brCode\": \"<string>\",\n      \"status\": \"COMPLETED\",\n      \"correlationID\": \"<string>\",\n      \"paymentLinkID\": \"<string>\",\n      \"paymentLinkUrl\": {\n        \"description\": \"Payment Link URL to be shared with customers\"\n      },\n      \"globalID\": {\n        \"description\": \"External ID of this charge\"\n      },\n      \"transactionID\": {\n        \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n      },\n      \"identifier\": \"<string>\",\n      \"qrCodeImage\": {\n        \"description\": \"QRCode image link URL\"\n      },\n      \"additionalInfo\": [\n        {\n          \"key\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"key\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"pixKey\": \"<string>\",\n      \"createdAt\": \"<string>\",\n      \"updatedAt\": \"<string>\",\n      \"expiresIn\": \"<string>\"\n    },\n    \"value\": \"<number>\",\n    \"time\": \"<string>\",\n    \"endToEndID\": \"<string>\",\n    \"transactionID\": \"<string>\",\n    \"infoPagador\": \"<string>\",\n    \"endToEndId\": \"<string>\",\n    \"customer\": {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"<string>\"\n      },\n      \"correlationID\": \"<string>\",\n      \"address\": {\n        \"zipcode\": \"<string>\",\n        \"street\": \"<string>\",\n        \"number\": \"<string>\",\n        \"neighborhood\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"complement\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    },\n    \"withdraw\": {\n      \"value\": \"<number>\",\n      \"time\": \"<string>\",\n      \"endToEndID\": \"<string>\",\n      \"transactionID\": \"<string>\",\n      \"infoPagador\": \"<string>\",\n      \"endToEndId\": \"<string>\",\n      \"payer\": {\n        \"name\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"<string>\"\n        },\n        \"correlationID\": \"<string>\",\n        \"address\": {\n          \"zipcode\": \"<string>\",\n          \"street\": \"<string>\",\n          \"number\": \"<string>\",\n          \"neighborhood\": \"<string>\",\n          \"city\": \"<string>\",\n          \"state\": \"<string>\",\n          \"complement\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      },\n      \"type\": \"<string>\"\n    },\n    \"payer\": {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"<string>\"\n      },\n      \"correlationID\": \"<string>\",\n      \"address\": {\n        \"zipcode\": \"<string>\",\n        \"street\": \"<string>\",\n        \"number\": \"<string>\",\n        \"neighborhood\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"complement\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    },\n    \"type\": \"REFUND\",\n    \"globalID\": {\n      \"description\": \"External ID of this transaction\"\n    },\n    \"pixQrCode\": {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"comment\": \"<string>\",\n      \"identifier\": \"<string>\",\n      \"brCode\": \"<string>\",\n      \"correlationID\": \"<string>\",\n      \"paymentLinkID\": \"<string>\",\n      \"paymentLinkUrl\": {\n        \"description\": \"Payment Link URL to be shared with customers\"\n      },\n      \"qrCodeImage\": {\n        \"description\": \"QRCode image link URL\"\n      },\n      \"createdAt\": \"<string>\",\n      \"updatedAt\": \"<string>\"\n    }\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5b0c2bf9-9373-4876-beec-fa41cafee1e6","name":"An error message","originalRequest":{"url":{"path":["api","v1","transaction",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"fa322b4a-16b1-404f-9784-0d2b4e01cd2b","name":"Get a list of transactions","request":{"name":"Get a list of transactions","description":{},"url":{"path":["api","v1","transaction"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"},{"disabled":false,"description":{"content":"You can use the charge ID or correlation ID or transaction ID of charge to get a list of transactions related of this transaction","type":"text/plain"},"key":"charge","value":"<string>"},{"disabled":false,"description":{"content":"You can use the QrCode static ID or correlation ID or identifier field of QrCode static to get a list of QrCode related of this transaction","type":"text/plain"},"key":"pixQrCode","value":"<string>"},{"disabled":false,"description":{"content":"You can use the ID or EndToEndId of a withdrawal transaction to get all transactions related to the withdrawal","type":"text/plain"},"key":"withdrawal","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"57567f7e-88d2-476a-82ea-cb5ff7a1edea","name":"A list of transactions","originalRequest":{"url":{"path":["api","v1","transaction"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"},{"disabled":false,"description":{"content":"You can use the charge ID or correlation ID or transaction ID of charge to get a list of transactions related of this transaction","type":"text/plain"},"key":"charge","value":"<string>"},{"disabled":false,"description":{"content":"You can use the QrCode static ID or correlation ID or identifier field of QrCode static to get a list of QrCode related of this transaction","type":"text/plain"},"key":"pixQrCode","value":"<string>"},{"disabled":false,"description":{"content":"You can use the ID or EndToEndId of a withdrawal transaction to get all transactions related to the withdrawal","type":"text/plain"},"key":"withdrawal","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"status\": \"<string>\",\n  \"transactions\": [\n    {\n      \"charge\": {\n        \"value\": \"<number>\",\n        \"customer\": {\n          \"name\": \"<string>\",\n          \"email\": \"<string>\",\n          \"phone\": \"<string>\",\n          \"taxID\": {\n            \"taxID\": \"<string>\",\n            \"type\": \"<string>\"\n          },\n          \"correlationID\": \"<string>\",\n          \"address\": {\n            \"zipcode\": \"<string>\",\n            \"street\": \"<string>\",\n            \"number\": \"<string>\",\n            \"neighborhood\": \"<string>\",\n            \"city\": \"<string>\",\n            \"state\": \"<string>\",\n            \"complement\": \"<string>\",\n            \"country\": \"<string>\"\n          }\n        },\n        \"type\": \"DYNAMIC\",\n        \"comment\": \"<string>\",\n        \"brCode\": \"<string>\",\n        \"status\": \"COMPLETED\",\n        \"correlationID\": \"<string>\",\n        \"paymentLinkID\": \"<string>\",\n        \"paymentLinkUrl\": {\n          \"description\": \"Payment Link URL to be shared with customers\"\n        },\n        \"globalID\": {\n          \"description\": \"External ID of this charge\"\n        },\n        \"transactionID\": {\n          \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n        },\n        \"identifier\": \"<string>\",\n        \"qrCodeImage\": {\n          \"description\": \"QRCode image link URL\"\n        },\n        \"additionalInfo\": [\n          {\n            \"key\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"key\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"pixKey\": \"<string>\",\n        \"createdAt\": \"<string>\",\n        \"updatedAt\": \"<string>\",\n        \"expiresIn\": \"<string>\"\n      },\n      \"value\": \"<number>\",\n      \"time\": \"<string>\",\n      \"endToEndID\": \"<string>\",\n      \"transactionID\": \"<string>\",\n      \"infoPagador\": \"<string>\",\n      \"endToEndId\": \"<string>\",\n      \"customer\": {\n        \"name\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"<string>\"\n        },\n        \"correlationID\": \"<string>\",\n        \"address\": {\n          \"zipcode\": \"<string>\",\n          \"street\": \"<string>\",\n          \"number\": \"<string>\",\n          \"neighborhood\": \"<string>\",\n          \"city\": \"<string>\",\n          \"state\": \"<string>\",\n          \"complement\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      },\n      \"withdraw\": {\n        \"value\": \"<number>\",\n        \"time\": \"<string>\",\n        \"endToEndID\": \"<string>\",\n        \"transactionID\": \"<string>\",\n        \"infoPagador\": \"<string>\",\n        \"endToEndId\": \"<string>\",\n        \"payer\": {\n          \"name\": \"<string>\",\n          \"email\": \"<string>\",\n          \"phone\": \"<string>\",\n          \"taxID\": {\n            \"taxID\": \"<string>\",\n            \"type\": \"<string>\"\n          },\n          \"correlationID\": \"<string>\",\n          \"address\": {\n            \"zipcode\": \"<string>\",\n            \"street\": \"<string>\",\n            \"number\": \"<string>\",\n            \"neighborhood\": \"<string>\",\n            \"city\": \"<string>\",\n            \"state\": \"<string>\",\n            \"complement\": \"<string>\",\n            \"country\": \"<string>\"\n          }\n        },\n        \"type\": \"<string>\"\n      },\n      \"payer\": {\n        \"name\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"<string>\"\n        },\n        \"correlationID\": \"<string>\",\n        \"address\": {\n          \"zipcode\": \"<string>\",\n          \"street\": \"<string>\",\n          \"number\": \"<string>\",\n          \"neighborhood\": \"<string>\",\n          \"city\": \"<string>\",\n          \"state\": \"<string>\",\n          \"complement\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      },\n      \"type\": \"REFUND\",\n      \"globalID\": {\n        \"description\": \"External ID of this transaction\"\n      },\n      \"pixQrCode\": {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\",\n        \"comment\": \"<string>\",\n        \"identifier\": \"<string>\",\n        \"brCode\": \"<string>\",\n        \"correlationID\": \"<string>\",\n        \"paymentLinkID\": \"<string>\",\n        \"paymentLinkUrl\": {\n          \"description\": \"Payment Link URL to be shared with customers\"\n        },\n        \"qrCodeImage\": {\n          \"description\": \"QRCode image link URL\"\n        },\n        \"createdAt\": \"<string>\",\n        \"updatedAt\": \"<string>\"\n      }\n    },\n    {\n      \"charge\": {\n        \"value\": \"<number>\",\n        \"customer\": {\n          \"name\": \"<string>\",\n          \"email\": \"<string>\",\n          \"phone\": \"<string>\",\n          \"taxID\": {\n            \"taxID\": \"<string>\",\n            \"type\": \"<string>\"\n          },\n          \"correlationID\": \"<string>\",\n          \"address\": {\n            \"zipcode\": \"<string>\",\n            \"street\": \"<string>\",\n            \"number\": \"<string>\",\n            \"neighborhood\": \"<string>\",\n            \"city\": \"<string>\",\n            \"state\": \"<string>\",\n            \"complement\": \"<string>\",\n            \"country\": \"<string>\"\n          }\n        },\n        \"type\": \"OVERDUE\",\n        \"comment\": \"<string>\",\n        \"brCode\": \"<string>\",\n        \"status\": \"ACTIVE\",\n        \"correlationID\": \"<string>\",\n        \"paymentLinkID\": \"<string>\",\n        \"paymentLinkUrl\": {\n          \"description\": \"Payment Link URL to be shared with customers\"\n        },\n        \"globalID\": {\n          \"description\": \"External ID of this charge\"\n        },\n        \"transactionID\": {\n          \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n        },\n        \"identifier\": \"<string>\",\n        \"qrCodeImage\": {\n          \"description\": \"QRCode image link URL\"\n        },\n        \"additionalInfo\": [\n          {\n            \"key\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"key\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"pixKey\": \"<string>\",\n        \"createdAt\": \"<string>\",\n        \"updatedAt\": \"<string>\",\n        \"expiresIn\": \"<string>\"\n      },\n      \"value\": \"<number>\",\n      \"time\": \"<string>\",\n      \"endToEndID\": \"<string>\",\n      \"transactionID\": \"<string>\",\n      \"infoPagador\": \"<string>\",\n      \"endToEndId\": \"<string>\",\n      \"customer\": {\n        \"name\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"<string>\"\n        },\n        \"correlationID\": \"<string>\",\n        \"address\": {\n          \"zipcode\": \"<string>\",\n          \"street\": \"<string>\",\n          \"number\": \"<string>\",\n          \"neighborhood\": \"<string>\",\n          \"city\": \"<string>\",\n          \"state\": \"<string>\",\n          \"complement\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      },\n      \"withdraw\": {\n        \"value\": \"<number>\",\n        \"time\": \"<string>\",\n        \"endToEndID\": \"<string>\",\n        \"transactionID\": \"<string>\",\n        \"infoPagador\": \"<string>\",\n        \"endToEndId\": \"<string>\",\n        \"payer\": {\n          \"name\": \"<string>\",\n          \"email\": \"<string>\",\n          \"phone\": \"<string>\",\n          \"taxID\": {\n            \"taxID\": \"<string>\",\n            \"type\": \"<string>\"\n          },\n          \"correlationID\": \"<string>\",\n          \"address\": {\n            \"zipcode\": \"<string>\",\n            \"street\": \"<string>\",\n            \"number\": \"<string>\",\n            \"neighborhood\": \"<string>\",\n            \"city\": \"<string>\",\n            \"state\": \"<string>\",\n            \"complement\": \"<string>\",\n            \"country\": \"<string>\"\n          }\n        },\n        \"type\": \"<string>\"\n      },\n      \"payer\": {\n        \"name\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"<string>\"\n        },\n        \"correlationID\": \"<string>\",\n        \"address\": {\n          \"zipcode\": \"<string>\",\n          \"street\": \"<string>\",\n          \"number\": \"<string>\",\n          \"neighborhood\": \"<string>\",\n          \"city\": \"<string>\",\n          \"state\": \"<string>\",\n          \"complement\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      },\n      \"type\": \"WITHDRAW\",\n      \"globalID\": {\n        \"description\": \"External ID of this transaction\"\n      },\n      \"pixQrCode\": {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\",\n        \"comment\": \"<string>\",\n        \"identifier\": \"<string>\",\n        \"brCode\": \"<string>\",\n        \"correlationID\": \"<string>\",\n        \"paymentLinkID\": \"<string>\",\n        \"paymentLinkUrl\": {\n          \"description\": \"Payment Link URL to be shared with customers\"\n        },\n        \"qrCodeImage\": {\n          \"description\": \"QRCode image link URL\"\n        },\n        \"createdAt\": \"<string>\",\n        \"updatedAt\": \"<string>\"\n      }\n    }\n  ],\n  \"pageInfo\": {\n    \"errors\": [\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      },\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      }\n    ],\n    \"skip\": \"<number>\",\n    \"limit\": \"<number>\",\n    \"totalCount\": \"<number>\",\n    \"hasPreviousPage\": \"<boolean>\",\n    \"hasNextPage\": \"<boolean>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c7d12e04-bd2d-4d67-bb2a-377b5513357d","name":"An error message","originalRequest":{"url":{"path":["api","v1","transaction"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"},{"disabled":false,"description":{"content":"You can use the charge ID or correlation ID or transaction ID of charge to get a list of transactions related of this transaction","type":"text/plain"},"key":"charge","value":"<string>"},{"disabled":false,"description":{"content":"You can use the QrCode static ID or correlation ID or identifier field of QrCode static to get a list of QrCode related of this transaction","type":"text/plain"},"key":"pixQrCode","value":"<string>"},{"disabled":false,"description":{"content":"You can use the ID or EndToEndId of a withdrawal transaction to get all transactions related to the withdrawal","type":"text/plain"},"key":"withdrawal","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"subscriptions","description":"","item":[{"name":"{id}","description":"","item":[{"id":"a0767602-8d2f-44e2-bcec-6a4b6880efe8","name":"Get one subscription","request":{"name":"Get one subscription","description":{},"url":{"path":["api","v1","subscriptions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"80ce29cf-758b-444f-bf06-e87dc6ef50b3","name":"The subscription retrieved using the given ID","originalRequest":{"url":{"path":["api","v1","subscriptions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"subscription\": {\n    \"globalID\": \"<string>\",\n    \"value\": \"<number>\",\n    \"customer\": {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"<string>\"\n      },\n      \"correlationID\": \"<string>\",\n      \"address\": {\n        \"zipcode\": \"<string>\",\n        \"street\": \"<string>\",\n        \"number\": \"<string>\",\n        \"neighborhood\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"complement\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    },\n    \"dayGenerateCharge\": \"<number>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f156bd59-3f42-40fd-8906-fbc3d8afe999","name":"An error message","originalRequest":{"url":{"path":["api","v1","subscriptions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"657f146a-4104-4246-99da-0c886b8d4b95","name":"Create a new Subscription","request":{"name":"Create a new Subscription","description":{"content":"Endpoint to create a new Subcription","type":"text/plain"},"url":{"path":["api","v1","subscriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"taxID\": \"<string>\",\n    \"address\": {\n      \"zipcode\": \"<string>\",\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"country\": \"<string>\"\n    }\n  },\n  \"value\": \"<number>\",\n  \"comment\": \"<string>\",\n  \"additionalInfo\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"dayGenerateCharge\": 5,\n  \"chargeType\": \"DYNAMIC\",\n  \"dayDue\": 7\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"ebcf6f42-831f-4997-81f5-eec67ca5a913","name":"The subscription created","originalRequest":{"url":{"path":["api","v1","subscriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"taxID\": \"<string>\",\n    \"address\": {\n      \"zipcode\": \"<string>\",\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"country\": \"<string>\"\n    }\n  },\n  \"value\": \"<number>\",\n  \"comment\": \"<string>\",\n  \"additionalInfo\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"dayGenerateCharge\": 5,\n  \"chargeType\": \"DYNAMIC\",\n  \"dayDue\": 7\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"subscription\": {\n    \"globalID\": \"<string>\",\n    \"value\": \"<number>\",\n    \"customer\": {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"<string>\"\n      },\n      \"correlationID\": \"<string>\",\n      \"address\": {\n        \"zipcode\": \"<string>\",\n        \"street\": \"<string>\",\n        \"number\": \"<string>\",\n        \"neighborhood\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"complement\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    },\n    \"dayGenerateCharge\": \"<number>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2cf48612-fcee-4d6b-8e74-1dc17ca2c668","name":"An error message","originalRequest":{"url":{"path":["api","v1","subscriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"taxID\": \"<string>\",\n    \"address\": {\n      \"zipcode\": \"<string>\",\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"country\": \"<string>\"\n    }\n  },\n  \"value\": \"<number>\",\n  \"comment\": \"<string>\",\n  \"additionalInfo\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"dayGenerateCharge\": 5,\n  \"chargeType\": \"DYNAMIC\",\n  \"dayDue\": 7\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"subaccount","description":"","item":[{"name":"{id}","description":"","item":[{"name":"withdraw","description":"","item":[{"id":"47501700-fe3e-4cd8-b361-4c34ed69a1e8","name":"Withdraw from a Sub Account","request":{"name":"Withdraw from a Sub Account","description":{"content":"Withdraw from a Sub Account and return the withdrawal transaction information","type":"text/plain"},"url":{"path":["api","v1","subaccount",":id","withdraw"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{},"auth":null},"response":[{"id":"a3144e50-8a38-48ea-8a2f-99cd7a9b6fec","name":"Withdrawal Transaction information","originalRequest":{"url":{"path":["api","v1","subaccount",":id","withdraw"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"withdraw\": {\n    \"account\": {\n      \"status\": \"<string>\",\n      \"value\": \"<number>\",\n      \"correlationID\": \"<string>\",\n      \"destinationAlias\": \"<string>\",\n      \"comment\": \"<string>\"\n    }\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d6c70674-e7b4-44db-8242-c3784e415f71","name":"An error message","originalRequest":{"url":{"path":["api","v1","subaccount",":id","withdraw"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"65b9c322-41e9-47ae-8d9c-af2d98e3fb45","name":"Get subaccount details","request":{"name":"Get subaccount details","description":{},"url":{"path":["api","v1","subaccount",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"5be9f324-f456-4c47-b846-10e86d37f997","name":"The Subccount retrieve using the given pix key","originalRequest":{"url":{"path":["api","v1","subaccount",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"SubAccount\": {\n    \"name\": \"<string>\",\n    \"pixKey\": \"<string>\",\n    \"balance\": \"<number>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"465f1b24-4a49-4453-a317-d785ac5bfe8a","name":"An error message","originalRequest":{"url":{"path":["api","v1","subaccount",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"ed9909b5-8845-49ed-8fcb-bf04394848df","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":"74345e77-a3e1-4a03-b8e1-ad66cc892169","name":"A list of subaccounts","originalRequest":{"url":{"path":["api","v1","subaccount"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"status\": \"<string>\",\n  \"subaccounts\": [\n    {\n      \"payment\": {\n        \"name\": \"<string>\",\n        \"pixKey\": \"<string>\",\n        \"balance\": \"<number>\"\n      }\n    },\n    {\n      \"payment\": {\n        \"name\": \"<string>\",\n        \"pixKey\": \"<string>\",\n        \"balance\": \"<number>\"\n      }\n    }\n  ],\n  \"pageInfo\": {\n    \"errors\": [\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      },\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      }\n    ],\n    \"skip\": \"<number>\",\n    \"limit\": \"<number>\",\n    \"totalCount\": \"<number>\",\n    \"hasPreviousPage\": \"<boolean>\",\n    \"hasNextPage\": \"<boolean>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"203b7cf9-02dd-43c3-af33-9928ba1d4b13","name":"An error message","originalRequest":{"url":{"path":["api","v1","subaccount"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d060141c-eb31-4008-b2d2-18a57b1d531d","name":"Create a subaccount","request":{"name":"Create a subaccount","description":{},"url":{"path":["api","v1","subaccount"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"pixKey\": \"<string>\",\n  \"name\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"17e02a4b-6ecd-45bd-931f-6dfe7979edde","name":"The Subccount created or retrieved if exists using the given pix key","originalRequest":{"url":{"path":["api","v1","subaccount"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"pixKey\": \"<string>\",\n  \"name\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"SubAccount\": {\n    \"name\": \"<string>\",\n    \"pixKey\": \"<string>\",\n    \"balance\": \"<number>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b1024c0b-e951-4044-bdc3-a725f868453d","name":"An error message","originalRequest":{"url":{"path":["api","v1","subaccount"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"pixKey\": \"<string>\",\n  \"name\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"refund","description":"","item":[{"name":"{id}","description":"","item":[{"id":"8b38ad05-1eb3-49a1-8aa9-ca71aaaedc9b","name":"Get one refund","request":{"name":"Get one refund","description":{},"url":{"path":["api","v1","refund",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"33658cdd-6029-48a3-822f-45740f5d385d","name":"The refund retrieve using the given ID","originalRequest":{"url":{"path":["api","v1","refund",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"pixTransactionRefund\": {\n    \"value\": \"<number>\",\n    \"status\": \"NOT_ACCOMPLISHED\",\n    \"correlationID\": \"<string>\",\n    \"refundId\": \"<string>\",\n    \"time\": \"<string>\",\n    \"comment\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"60c10db1-41b1-4cb2-bc89-c111d0e7482c","name":"An error message","originalRequest":{"url":{"path":["api","v1","refund",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"37425ae7-a579-4eff-a317-3b9096bb1148","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":"bcaf4a96-7247-4421-875a-eb543d318565","name":"A list of refunds","originalRequest":{"url":{"path":["api","v1","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"refunds\": [\n    {\n      \"value\": \"<number>\",\n      \"status\": \"REFUNDED\",\n      \"correlationID\": \"<string>\",\n      \"refundId\": \"<string>\",\n      \"time\": \"<string>\",\n      \"comment\": \"<string>\"\n    },\n    {\n      \"value\": \"<number>\",\n      \"status\": \"NOT_ACCOMPLISHED\",\n      \"correlationID\": \"<string>\",\n      \"refundId\": \"<string>\",\n      \"time\": \"<string>\",\n      \"comment\": \"<string>\"\n    }\n  ],\n  \"pageInfo\": {\n    \"errors\": [\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      },\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      }\n    ],\n    \"skip\": \"<number>\",\n    \"limit\": \"<number>\",\n    \"totalCount\": \"<number>\",\n    \"hasPreviousPage\": \"<boolean>\",\n    \"hasNextPage\": \"<boolean>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a873bd94-c25b-47f8-870e-c37b18177e3e","name":"An error message","originalRequest":{"url":{"path":["api","v1","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b972efef-7d8b-41c0-ab39-58018c1130c1","name":"Create a new refund","request":{"name":"Create a new refund","description":{"content":"Endpoint to create a new refund for a customer","type":"text/plain"},"url":{"path":["api","v1","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\",\n  \"transactionEndToEndId\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"191a1fbe-6e3e-491d-b108-caba7cd5b689","name":"The created Refund","originalRequest":{"url":{"path":["api","v1","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\",\n  \"transactionEndToEndId\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"refund\": {\n    \"value\": \"<number>\",\n    \"status\": \"IN_PROCESSING\",\n    \"correlationID\": \"<string>\",\n    \"refundId\": \"<string>\",\n    \"time\": \"<string>\",\n    \"comment\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1dfb3078-375d-4b28-bf82-1b95b204c7fd","name":"An error message","originalRequest":{"url":{"path":["api","v1","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\",\n  \"transactionEndToEndId\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"qrcode-static","description":"","item":[{"name":"{id}","description":"","item":[{"id":"ff3b03b9-790b-41d1-8222-29a4ce6342c9","name":"Get one Pix QrCode","request":{"name":"Get one Pix QrCode","description":{},"url":{"path":["api","v1","qrcode-static",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"55e956b5-ae3f-432b-a5ce-9ef2215b553e","name":"The pixQrCode retrieve using the given ID","originalRequest":{"url":{"path":["api","v1","qrcode-static",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"pixQrCode\": {\n    \"name\": \"<string>\",\n    \"value\": \"<string>\",\n    \"comment\": \"<string>\",\n    \"identifier\": \"<string>\",\n    \"brCode\": \"<string>\",\n    \"correlationID\": \"<string>\",\n    \"paymentLinkID\": \"<string>\",\n    \"paymentLinkUrl\": {\n      \"description\": \"Payment Link URL to be shared with customers\"\n    },\n    \"qrCodeImage\": {\n      \"description\": \"QRCode image link URL\"\n    },\n    \"createdAt\": \"<string>\",\n    \"updatedAt\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"573b620e-a1ec-49c4-9d37-4d7d05966636","name":"An error message","originalRequest":{"url":{"path":["api","v1","qrcode-static",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"3674eb93-a1a8-4499-a5a5-8ddd58c29c03","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":"c06db334-fa15-4825-a8bd-2f675f785b5b","name":"A list of pixQrCodes","originalRequest":{"url":{"path":["api","v1","qrcode-static"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"pixQrCodes\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"comment\": \"<string>\",\n      \"identifier\": \"<string>\",\n      \"brCode\": \"<string>\",\n      \"correlationID\": \"<string>\",\n      \"paymentLinkID\": \"<string>\",\n      \"paymentLinkUrl\": {\n        \"description\": \"Payment Link URL to be shared with customers\"\n      },\n      \"qrCodeImage\": {\n        \"description\": \"QRCode image link URL\"\n      },\n      \"createdAt\": \"<string>\",\n      \"updatedAt\": \"<string>\"\n    },\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"comment\": \"<string>\",\n      \"identifier\": \"<string>\",\n      \"brCode\": \"<string>\",\n      \"correlationID\": \"<string>\",\n      \"paymentLinkID\": \"<string>\",\n      \"paymentLinkUrl\": {\n        \"description\": \"Payment Link URL to be shared with customers\"\n      },\n      \"qrCodeImage\": {\n        \"description\": \"QRCode image link URL\"\n      },\n      \"createdAt\": \"<string>\",\n      \"updatedAt\": \"<string>\"\n    }\n  ],\n  \"pageInfo\": {\n    \"errors\": [\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      },\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      }\n    ],\n    \"skip\": \"<number>\",\n    \"limit\": \"<number>\",\n    \"totalCount\": \"<number>\",\n    \"hasPreviousPage\": \"<boolean>\",\n    \"hasNextPage\": \"<boolean>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"12dcacd9-756d-4d2f-bff8-acd64edaec56","name":"An error message","originalRequest":{"url":{"path":["api","v1","qrcode-static"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"72e41180-0471-47f1-bdd6-007c7aa3fc5c","name":"Create a new Pix QrCode Static","request":{"name":"Create a new Pix QrCode Static","description":{"content":"Endpoint to create a new Pix QrCode Static","type":"text/plain"},"url":{"path":["api","v1","qrcode-static"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"identifier\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"value\": \"<number>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"9cde4894-22cf-42c2-95c9-f024045425c9","name":"PixQrCode ID and also the generated Dynamic BR Code to be rendered as a QRCode","originalRequest":{"url":{"path":["api","v1","qrcode-static"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"identifier\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"value\": \"<number>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"pixQrCode\": {\n    \"name\": \"<string>\",\n    \"value\": \"<string>\",\n    \"comment\": \"<string>\",\n    \"identifier\": \"<string>\",\n    \"brCode\": \"<string>\",\n    \"correlationID\": \"<string>\",\n    \"paymentLinkID\": \"<string>\",\n    \"paymentLinkUrl\": {\n      \"description\": \"Payment Link URL to be shared with customers\"\n    },\n    \"qrCodeImage\": {\n      \"description\": \"QRCode image link URL\"\n    },\n    \"createdAt\": \"<string>\",\n    \"updatedAt\": \"<string>\"\n  },\n  \"correlationID\": \"<string>\",\n  \"brCode\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"15e7c65f-e720-494f-b3bb-441526e40bb4","name":"An error message","originalRequest":{"url":{"path":["api","v1","qrcode-static"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"identifier\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"value\": \"<number>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"payment","description":"","item":[{"name":"{id}","description":"","item":[{"id":"a237a075-9017-4a65-a617-02db7f4715e4","name":"Get one Payment","request":{"name":"Get one Payment","description":{},"url":{"path":["api","v1","payment",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"53cca4c9-40c5-4b9e-8ef6-df59c45176b8","name":"The payment retrieved using the given ID","originalRequest":{"url":{"path":["api","v1","payment",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"payment\": {\n    \"value\": \"<number>\",\n    \"destinationAlias\": \"<string>\",\n    \"correlationID\": \"<string>\",\n    \"comment\": \"<string>\",\n    \"status\": \"CREATED\",\n    \"sourceAccountId\": \"<string>\"\n  },\n  \"transaction\": {\n    \"value\": \"<number>\",\n    \"endToEndId\": \"<string>\",\n    \"time\": \"<string>\"\n  },\n  \"destination\": {\n    \"name\": \"<string>\",\n    \"taxID\": \"<string>\",\n    \"pixKey\": \"<string>\",\n    \"bank\": \"<string>\",\n    \"branch\": \"<string>\",\n    \"account\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d578d8f8-718e-4ea6-9815-0af53d2d5bc9","name":"An error message","originalRequest":{"url":{"path":["api","v1","payment",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"approve","description":"","item":[{"id":"68b9e82a-9e45-4fe1-aefd-8eb2c027558c","name":"Approve a Payment Request","request":{"name":"Approve a Payment Request","description":{"content":"Endpoint to approve a payment","type":"text/plain"},"url":{"path":["api","v1","payment","approve"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"correlationID\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"d78d56b8-b604-41fd-a5fa-9908729c6aa5","name":"The approved payment","originalRequest":{"url":{"path":["api","v1","payment","approve"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"correlationID\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"payment\": {\n    \"value\": \"<number>\",\n    \"destinationAlias\": \"<string>\",\n    \"correlationID\": \"<string>\",\n    \"comment\": \"<string>\",\n    \"status\": \"DENIED\",\n    \"sourceAccountId\": \"<string>\"\n  },\n  \"transaction\": {\n    \"value\": \"<number>\",\n    \"endToEndId\": \"<string>\",\n    \"time\": \"<string>\"\n  },\n  \"destination\": {\n    \"name\": \"<string>\",\n    \"taxID\": \"<string>\",\n    \"pixKey\": \"<string>\",\n    \"bank\": \"<string>\",\n    \"branch\": \"<string>\",\n    \"account\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d88a9275-e88a-40bf-8de5-34a26d79a955","name":"An error message","originalRequest":{"url":{"path":["api","v1","payment","approve"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"correlationID\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"5963f5da-cac8-44c4-b5c4-f8a7b8ec4fe7","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":"2b7e0da7-6675-4862-a343-93b24b3cb3ba","name":"A list of payments","originalRequest":{"url":{"path":["api","v1","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"status\": \"<string>\",\n  \"payments\": [\n    {\n      \"payment\": {\n        \"value\": \"<number>\",\n        \"destinationAlias\": \"<string>\",\n        \"correlationID\": \"<string>\",\n        \"comment\": \"<string>\",\n        \"status\": \"CONFIRMED\",\n        \"sourceAccountId\": \"<string>\"\n      },\n      \"transaction\": {\n        \"value\": \"<number>\",\n        \"endToEndId\": \"<string>\",\n        \"time\": \"<string>\"\n      },\n      \"destination\": {\n        \"name\": \"<string>\",\n        \"taxID\": \"<string>\",\n        \"pixKey\": \"<string>\",\n        \"bank\": \"<string>\",\n        \"branch\": \"<string>\",\n        \"account\": \"<string>\"\n      }\n    },\n    {\n      \"payment\": {\n        \"value\": \"<number>\",\n        \"destinationAlias\": \"<string>\",\n        \"correlationID\": \"<string>\",\n        \"comment\": \"<string>\",\n        \"status\": \"DENIED\",\n        \"sourceAccountId\": \"<string>\"\n      },\n      \"transaction\": {\n        \"value\": \"<number>\",\n        \"endToEndId\": \"<string>\",\n        \"time\": \"<string>\"\n      },\n      \"destination\": {\n        \"name\": \"<string>\",\n        \"taxID\": \"<string>\",\n        \"pixKey\": \"<string>\",\n        \"bank\": \"<string>\",\n        \"branch\": \"<string>\",\n        \"account\": \"<string>\"\n      }\n    }\n  ],\n  \"pageInfo\": {\n    \"errors\": [\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      },\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      }\n    ],\n    \"skip\": \"<number>\",\n    \"limit\": \"<number>\",\n    \"totalCount\": \"<number>\",\n    \"hasPreviousPage\": \"<boolean>\",\n    \"hasNextPage\": \"<boolean>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"016fb8ea-de44-413e-9fd5-c2353dbdb4af","name":"An error message","originalRequest":{"url":{"path":["api","v1","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0af73070-4c2c-4b2c-b808-9c32ed2815b7","name":"Create a Payment Request","request":{"name":"Create a Payment Request","description":{"content":"Endpoint to request a payment","type":"text/plain"},"url":{"path":["api","v1","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\",\n  \"destinationAlias\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"comment\": \"<string>\",\n  \"sourceAccountId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"e73c175f-3481-4a0d-ae76-76fb7d811c57","name":"Payment destination account information","originalRequest":{"url":{"path":["api","v1","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\",\n  \"destinationAlias\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"comment\": \"<string>\",\n  \"sourceAccountId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"payment\": {\n    \"value\": \"<number>\",\n    \"destinationAlias\": \"<string>\",\n    \"correlationID\": \"<string>\",\n    \"comment\": \"<string>\",\n    \"status\": \"FAILED\",\n    \"sourceAccountId\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cd4e6587-ce03-45a0-88cb-fd07548ce00d","name":"An error message","originalRequest":{"url":{"path":["api","v1","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\",\n  \"destinationAlias\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"comment\": \"<string>\",\n  \"sourceAccountId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"partner","description":"","item":[{"name":"company","description":"","item":[{"name":"{taxID}","description":"","item":[{"id":"20bb0729-78a6-44f7-a57f-f46fc484c9c1","name":"Get an specific preregistration via taxID param.","request":{"name":"Get an specific preregistration via taxID param.","description":{},"url":{"path":["api","v1","partner","company",":taxID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"taxID","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"4a242b3d-0cca-4524-a776-31f6d3e4f902","name":"The preregistration retrieved by the tax ID.","originalRequest":{"url":{"path":["api","v1","partner","company",":taxID"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"preRegistration\": {\n    \"preRegistration\": {\n      \"name\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"BR:CNPJ\"\n      }\n    },\n    \"user\": {\n      \"firstName\": \"<string>\",\n      \"lastName\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\"\n    },\n    \"company\": {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"BR:CNPJ\"\n      }\n    },\n    \"account\": {\n      \"clientId\": \"<string>\"\n    }\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fbec0dc6-b1dd-4749-af54-73d9443cff5c","name":"An error message","originalRequest":{"url":{"path":["api","v1","partner","company",":taxID"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"bdba4f66-fd20-451e-8cc6-fb554bb795f7","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":"f92675ff-1a1d-4707-8851-675be4de9532","name":"A list with preregistrations.","originalRequest":{"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"preRegistrations\": [\n    {\n      \"preRegistration\": {\n        \"name\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"BR:CNPJ\"\n        }\n      },\n      \"user\": {\n        \"firstName\": \"<string>\",\n        \"lastName\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\"\n      },\n      \"company\": {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"BR:CNPJ\"\n        }\n      },\n      \"account\": {\n        \"clientId\": \"<string>\"\n      }\n    },\n    {\n      \"preRegistration\": {\n        \"name\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"BR:CNPJ\"\n        }\n      },\n      \"user\": {\n        \"firstName\": \"<string>\",\n        \"lastName\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\"\n      },\n      \"company\": {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"BR:CNPJ\"\n        }\n      },\n      \"account\": {\n        \"clientId\": \"<string>\"\n      }\n    }\n  ],\n  \"pageInfo\": {\n    \"errors\": [\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      },\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      }\n    ],\n    \"skip\": \"<number>\",\n    \"limit\": \"<number>\",\n    \"totalCount\": \"<number>\",\n    \"hasPreviousPage\": \"<boolean>\",\n    \"hasNextPage\": \"<boolean>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ea982463-5f79-485a-b749-06ba991a9cd6","name":"An error message","originalRequest":{"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"3fc80d6c-28f9-49a8-b752-9ca743403c3a","name":"Create a pre registration with a partner reference (your company)","request":{"name":"Create a pre registration with a partner reference (your company)","description":{"content":"As a partner company, you can create a new pre registration referencing your\ncompany as a partner.\n","type":"text/plain"},"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"preRegistration\": {\n    \"name\": \"<string>\",\n    \"taxID\": {\n      \"taxID\": \"<string>\",\n      \"type\": \"BR:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"9f73a277-6774-45a2-adbe-588a573e6c46","name":"Payload with a pre registration data.\nBeing the taxID our idempotence key, if you do the request with the same taxID multiple times,\nevery time you'll receive the same data from our endpoint.\n","originalRequest":{"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"preRegistration\": {\n    \"name\": \"<string>\",\n    \"taxID\": {\n      \"taxID\": \"<string>\",\n      \"type\": \"BR:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"preRegistration\": {\n    \"name\": \"<string>\",\n    \"taxID\": {\n      \"taxID\": \"<string>\",\n      \"type\": \"BR:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ffaad6d8-db9f-4cdb-8c2e-f8fb203328dc","name":"A new preregistration that is related to you has been created.","originalRequest":{"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"preRegistration\": {\n    \"name\": \"<string>\",\n    \"taxID\": {\n      \"taxID\": \"<string>\",\n      \"type\": \"BR:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"preRegistration\": {\n    \"name\": \"<string>\",\n    \"taxID\": {\n      \"taxID\": \"<string>\",\n      \"type\": \"BR:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8f728749-8db9-40f2-bb37-cc56a3d9b2fe","name":"An error message","originalRequest":{"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"preRegistration\": {\n    \"name\": \"<string>\",\n    \"taxID\": {\n      \"taxID\": \"<string>\",\n      \"type\": \"BR:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"92a17fb9-a8f2-42b6-900a-2d1f220c4ce3","name":"You are unauthorized to use this endpoint.","originalRequest":{"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"preRegistration\": {\n    \"name\": \"<string>\",\n    \"taxID\": {\n      \"taxID\": \"<string>\",\n      \"type\": \"BR:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"application","description":"","item":[{"id":"269154b8-89df-4d59-a3a1-0de71b2365b8","name":"Create a new application to some of your preregistration's company.","request":{"name":"Create a new application to some of your preregistration's company.","description":{"content":"As a partner company, you can create a new application to some of your companies.\nThe application should give access to our API to this companies, so they can use\nit too.\n","type":"text/plain"},"url":{"path":["api","v1","partner","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"application\": {\n    \"name\": \"<string>\",\n    \"type\": \"ORACLE\"\n  },\n  \"taxID\": {\n    \"taxID\": \"<string>\",\n    \"type\": \"BR:CNPJ\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"52e09344-bc3e-49ed-9020-7a1e33839cbf","name":"Our \"idempotence output\", if you get this HTTP code, it's an application\nthat already has been registered.\n","originalRequest":{"url":{"path":["api","v1","partner","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"application\": {\n    \"name\": \"<string>\",\n    \"type\": \"ORACLE\"\n  },\n  \"taxID\": {\n    \"taxID\": \"<string>\",\n    \"type\": \"BR:CNPJ\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"application\": {\n    \"name\": \"<string>\",\n    \"isActive\": \"<boolean>\",\n    \"type\": \"PLUGIN\",\n    \"clientId\": \"<string>\",\n    \"clientSecret\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4481642b-cad9-401f-9f8d-16275860f19c","name":"A new application has been registered. It'll be identified by the name that you give to it\nand by the company that has been referenced.\n","originalRequest":{"url":{"path":["api","v1","partner","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"application\": {\n    \"name\": \"<string>\",\n    \"type\": \"ORACLE\"\n  },\n  \"taxID\": {\n    \"taxID\": \"<string>\",\n    \"type\": \"BR:CNPJ\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"application\": {\n    \"name\": \"<string>\",\n    \"isActive\": \"<boolean>\",\n    \"type\": \"PLUGIN\",\n    \"clientId\": \"<string>\",\n    \"clientSecret\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f35de536-7e6e-4a7d-8555-de4f50641739","name":"An error message","originalRequest":{"url":{"path":["api","v1","partner","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"application\": {\n    \"name\": \"<string>\",\n    \"type\": \"ORACLE\"\n  },\n  \"taxID\": {\n    \"taxID\": \"<string>\",\n    \"type\": \"BR:CNPJ\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a2166e00-1314-453c-83c0-8ab97070e57d","name":"You are unauthorized to use this endpoint.","originalRequest":{"url":{"path":["api","v1","partner","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"application\": {\n    \"name\": \"<string>\",\n    \"type\": \"ORACLE\"\n  },\n  \"taxID\": {\n    \"taxID\": \"<string>\",\n    \"type\": \"BR:CNPJ\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]},{"name":"customer","description":"","item":[{"name":"{id}","description":"","item":[{"id":"fbbb74ab-a591-417d-811d-a2b4de3241bb","name":"Get one customer","request":{"name":"Get one customer","description":{},"url":{"path":["api","v1","customer",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"511a2627-f5b8-4be0-b57b-5039571bc4cf","name":"The customer retrieve using the given ID","originalRequest":{"url":{"path":["api","v1","customer",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"taxID\": {\n      \"taxID\": \"<string>\",\n      \"type\": \"<string>\"\n    },\n    \"correlationID\": \"<string>\",\n    \"address\": {\n      \"zipcode\": \"<string>\",\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"country\": \"<string>\"\n    }\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"778cfe8e-c365-4f87-808e-0ca5f7a8e3cf","name":"An error message","originalRequest":{"url":{"path":["api","v1","customer",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"18b8dba6-f7ea-42f2-9b2e-0db06a4d7d0b","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":"5f1a7a81-4714-4aed-bab2-c974715205ba","name":"A list of customers","originalRequest":{"url":{"path":["api","v1","customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"customers\": [\n    {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"<string>\"\n      },\n      \"correlationID\": \"<string>\",\n      \"address\": {\n        \"zipcode\": \"<string>\",\n        \"street\": \"<string>\",\n        \"number\": \"<string>\",\n        \"neighborhood\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"complement\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    },\n    {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"<string>\"\n      },\n      \"correlationID\": \"<string>\",\n      \"address\": {\n        \"zipcode\": \"<string>\",\n        \"street\": \"<string>\",\n        \"number\": \"<string>\",\n        \"neighborhood\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"complement\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    }\n  ],\n  \"pageInfo\": {\n    \"errors\": [\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      },\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      }\n    ],\n    \"skip\": \"<number>\",\n    \"limit\": \"<number>\",\n    \"totalCount\": \"<number>\",\n    \"hasPreviousPage\": \"<boolean>\",\n    \"hasNextPage\": \"<boolean>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8b3029f6-aaa6-4476-8ae4-67cfef38bcd2","name":"An error message","originalRequest":{"url":{"path":["api","v1","customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d492fcb4-dca2-4089-9289-a1e1d16cd937","name":"Create a new Customer","request":{"name":"Create a new Customer","description":{"content":"Endpoint to create a new Customer","type":"text/plain"},"url":{"path":["api","v1","customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"taxID\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"address\": {\n    \"zipcode\": \"<string>\",\n    \"street\": \"<string>\",\n    \"number\": \"<string>\",\n    \"neighborhood\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"complement\": \"<string>\",\n    \"country\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"8df12634-105a-49a0-9469-05de898bbd10","name":"Customer ID","originalRequest":{"url":{"path":["api","v1","customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"taxID\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"address\": {\n    \"zipcode\": \"<string>\",\n    \"street\": \"<string>\",\n    \"number\": \"<string>\",\n    \"neighborhood\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"complement\": \"<string>\",\n    \"country\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"taxID\": {\n      \"taxID\": \"<string>\",\n      \"type\": \"<string>\"\n    },\n    \"correlationID\": \"<string>\",\n    \"address\": {\n      \"zipcode\": \"<string>\",\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"country\": \"<string>\"\n    }\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"560424bf-5b5b-4107-9ad9-ae28acf438dd","name":"An error message","originalRequest":{"url":{"path":["api","v1","customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"taxID\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"address\": {\n    \"zipcode\": \"<string>\",\n    \"street\": \"<string>\",\n    \"number\": \"<string>\",\n    \"neighborhood\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"complement\": \"<string>\",\n    \"country\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"charge","description":"","item":[{"name":"{id}","description":"","item":[{"name":"refund","description":"","item":[{"id":"63eca02a-c692-419b-a7dd-e6016365994e","name":"Get all refunds of a charge","request":{"name":"Get all refunds of a charge","description":{"content":"Endpoint to get all refunds of a charge","type":"text/plain"},"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"c1e32fd4-252f-4e96-a426-f464006b06d7","name":"A list of refunds","originalRequest":{"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"refunds\": [\n    {\n      \"value\": \"<number>\",\n      \"status\": \"IN_PROCESSING\",\n      \"correlationID\": \"<string>\",\n      \"endToEndId\": \"<string>\",\n      \"time\": \"<string>\",\n      \"comment\": \"<string>\"\n    },\n    {\n      \"value\": \"<number>\",\n      \"status\": \"IN_PROCESSING\",\n      \"correlationID\": \"<string>\",\n      \"endToEndId\": \"<string>\",\n      \"time\": \"<string>\",\n      \"comment\": \"<string>\"\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"322d4df5-ddbd-4802-9e4d-761b92ce914d","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ff0b0ce8-f235-49d8-b4e6-7d557a6783bb","name":"Create a new refund for a charge","request":{"name":"Create a new refund for a charge","description":{"content":"Endpoint to create a new refund for a charge","type":"text/plain"},"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"correlationID\": \"<string>\",\n  \"value\": \"<number>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"70eda18d-bc51-4068-9366-9f6acc663fa2","name":"The created Refund","originalRequest":{"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"correlationID\": \"<string>\",\n  \"value\": \"<number>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"refund\": {\n    \"value\": \"<number>\",\n    \"status\": \"IN_PROCESSING\",\n    \"correlationID\": \"<string>\",\n    \"endToEndId\": \"<string>\",\n    \"time\": \"<string>\",\n    \"comment\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"541afc7a-114e-4d36-b393-d838730875d2","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"correlationID\": \"<string>\",\n  \"value\": \"<number>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"7c16f42e-499a-4673-bba3-e11e8320953a","name":"Delete a charge","request":{"name":"Delete a charge","description":{},"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{},"auth":null},"response":[{"id":"ff1d72d1-2385-4b4d-a022-801ddd0e789a","name":"The charge deleted","originalRequest":{"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"status\": \"<string>\",\n  \"id\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b789c5ac-9e8c-4b2a-9952-7bbe1bfb25ee","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5a16d70d-eb24-4c2f-a379-8b37bb685a3a","name":"Get one charge","request":{"name":"Get one charge","description":{},"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"d73227cb-6f84-40b8-a081-2c06ee251f9c","name":"The charge retrieve using the given ID","originalRequest":{"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"charge\": {\n    \"value\": \"<number>\",\n    \"customer\": {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"<string>\"\n      },\n      \"correlationID\": \"<string>\",\n      \"address\": {\n        \"zipcode\": \"<string>\",\n        \"street\": \"<string>\",\n        \"number\": \"<string>\",\n        \"neighborhood\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"complement\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    },\n    \"type\": \"DYNAMIC\",\n    \"comment\": \"<string>\",\n    \"brCode\": \"<string>\",\n    \"status\": \"COMPLETED\",\n    \"correlationID\": \"<string>\",\n    \"paymentLinkID\": \"<string>\",\n    \"paymentLinkUrl\": {\n      \"description\": \"Payment Link URL to be shared with customers\"\n    },\n    \"globalID\": {\n      \"description\": \"External ID of this charge\"\n    },\n    \"transactionID\": {\n      \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n    },\n    \"identifier\": \"<string>\",\n    \"qrCodeImage\": {\n      \"description\": \"QRCode image link URL\"\n    },\n    \"additionalInfo\": [\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"pixKey\": \"<string>\",\n    \"createdAt\": \"<string>\",\n    \"updatedAt\": \"<string>\",\n    \"expiresIn\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"212f8b94-6d77-4587-a263-b4fc3ce520ef","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"14b3a925-232c-4615-9df8-36cd43c786b5","name":"Get a list of charges","request":{"name":"Get a list of charges","description":{},"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"status","value":"COMPLETED"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"b85b7a0b-0c43-41cc-a01f-76c74363d6fa","name":"A list of charges","originalRequest":{"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"status","value":"COMPLETED"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"charges\": [\n    {\n      \"value\": \"<number>\",\n      \"customer\": {\n        \"name\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"<string>\"\n        },\n        \"correlationID\": \"<string>\",\n        \"address\": {\n          \"zipcode\": \"<string>\",\n          \"street\": \"<string>\",\n          \"number\": \"<string>\",\n          \"neighborhood\": \"<string>\",\n          \"city\": \"<string>\",\n          \"state\": \"<string>\",\n          \"complement\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      },\n      \"type\": \"OVERDUE\",\n      \"comment\": \"<string>\",\n      \"brCode\": \"<string>\",\n      \"status\": \"EXPIRED\",\n      \"correlationID\": \"<string>\",\n      \"paymentLinkID\": \"<string>\",\n      \"paymentLinkUrl\": {\n        \"description\": \"Payment Link URL to be shared with customers\"\n      },\n      \"globalID\": {\n        \"description\": \"External ID of this charge\"\n      },\n      \"transactionID\": {\n        \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n      },\n      \"identifier\": \"<string>\",\n      \"qrCodeImage\": {\n        \"description\": \"QRCode image link URL\"\n      },\n      \"additionalInfo\": [\n        {\n          \"key\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"key\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"pixKey\": \"<string>\",\n      \"createdAt\": \"<string>\",\n      \"updatedAt\": \"<string>\",\n      \"expiresIn\": \"<string>\"\n    },\n    {\n      \"value\": \"<number>\",\n      \"customer\": {\n        \"name\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"<string>\"\n        },\n        \"correlationID\": \"<string>\",\n        \"address\": {\n          \"zipcode\": \"<string>\",\n          \"street\": \"<string>\",\n          \"number\": \"<string>\",\n          \"neighborhood\": \"<string>\",\n          \"city\": \"<string>\",\n          \"state\": \"<string>\",\n          \"complement\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      },\n      \"type\": \"DYNAMIC\",\n      \"comment\": \"<string>\",\n      \"brCode\": \"<string>\",\n      \"status\": \"EXPIRED\",\n      \"correlationID\": \"<string>\",\n      \"paymentLinkID\": \"<string>\",\n      \"paymentLinkUrl\": {\n        \"description\": \"Payment Link URL to be shared with customers\"\n      },\n      \"globalID\": {\n        \"description\": \"External ID of this charge\"\n      },\n      \"transactionID\": {\n        \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n      },\n      \"identifier\": \"<string>\",\n      \"qrCodeImage\": {\n        \"description\": \"QRCode image link URL\"\n      },\n      \"additionalInfo\": [\n        {\n          \"key\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"key\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"pixKey\": \"<string>\",\n      \"createdAt\": \"<string>\",\n      \"updatedAt\": \"<string>\",\n      \"expiresIn\": \"<string>\"\n    }\n  ],\n  \"pageInfo\": {\n    \"errors\": [\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      },\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      }\n    ],\n    \"skip\": \"<number>\",\n    \"limit\": \"<number>\",\n    \"totalCount\": \"<number>\",\n    \"hasPreviousPage\": \"<boolean>\",\n    \"hasNextPage\": \"<boolean>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"380d28a6-391d-4cd0-acbb-de3bd0868e36","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"status","value":"COMPLETED"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8814e570-0af1-4e75-9e67-746ae368916e","name":"Create a new Charge","request":{"name":"Create a new Charge","description":{"content":"Endpoint to create a new Charge for a customer","type":"text/plain"},"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Make the endpoint idempotent, will return an existent charge if already has a one with the correlationID","type":"text/plain"},"key":"return_existing","value":"<boolean>"}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"correlationID\": \"<string>\",\n  \"value\": \"<number>\",\n  \"type\": \"DYNAMIC\",\n  \"comment\": \"<string>\",\n  \"identifier\": \"<string>\",\n  \"expiresIn\": \"<number>\",\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"taxID\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"correlationID\": \"<string>\",\n    \"address\": {\n      \"zipcode\": \"<string>\",\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"country\": \"<string>\"\n    }\n  },\n  \"daysForDueDate\": \"<number>\",\n  \"daysAfterDueDate\": \"<number>\",\n  \"interests\": {\n    \"value\": \"<number>\"\n  },\n  \"fines\": {\n    \"value\": \"<number>\"\n  },\n  \"additionalInfo\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"44975b54-54bb-4249-958c-014012730b54","name":"Charge ID and also the generated Dynamic BR Code to be rendered as a QRCode","originalRequest":{"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Make the endpoint idempotent, will return an existent charge if already has a one with the correlationID","type":"text/plain"},"key":"return_existing","value":"<boolean>"}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"correlationID\": \"<string>\",\n  \"value\": \"<number>\",\n  \"type\": \"DYNAMIC\",\n  \"comment\": \"<string>\",\n  \"identifier\": \"<string>\",\n  \"expiresIn\": \"<number>\",\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"taxID\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"correlationID\": \"<string>\",\n    \"address\": {\n      \"zipcode\": \"<string>\",\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"country\": \"<string>\"\n    }\n  },\n  \"daysForDueDate\": \"<number>\",\n  \"daysAfterDueDate\": \"<number>\",\n  \"interests\": {\n    \"value\": \"<number>\"\n  },\n  \"fines\": {\n    \"value\": \"<number>\"\n  },\n  \"additionalInfo\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"charge\": {\n    \"value\": \"<number>\",\n    \"customer\": {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"<string>\"\n      },\n      \"correlationID\": \"<string>\",\n      \"address\": {\n        \"zipcode\": \"<string>\",\n        \"street\": \"<string>\",\n        \"number\": \"<string>\",\n        \"neighborhood\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"complement\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    },\n    \"type\": \"OVERDUE\",\n    \"comment\": \"<string>\",\n    \"brCode\": \"<string>\",\n    \"status\": \"ACTIVE\",\n    \"correlationID\": \"<string>\",\n    \"paymentLinkID\": \"<string>\",\n    \"paymentLinkUrl\": {\n      \"description\": \"Payment Link URL to be shared with customers\"\n    },\n    \"globalID\": {\n      \"description\": \"External ID of this charge\"\n    },\n    \"transactionID\": {\n      \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n    },\n    \"identifier\": \"<string>\",\n    \"qrCodeImage\": {\n      \"description\": \"QRCode image link URL\"\n    },\n    \"additionalInfo\": [\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"pixKey\": \"<string>\",\n    \"createdAt\": \"<string>\",\n    \"updatedAt\": \"<string>\",\n    \"expiresIn\": \"<string>\"\n  },\n  \"correlationID\": \"<string>\",\n  \"brCode\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"01a1c5e3-37df-4ff0-a6e2-8af31e89638e","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Make the endpoint idempotent, will return an existent charge if already has a one with the correlationID","type":"text/plain"},"key":"return_existing","value":"<boolean>"}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"correlationID\": \"<string>\",\n  \"value\": \"<number>\",\n  \"type\": \"DYNAMIC\",\n  \"comment\": \"<string>\",\n  \"identifier\": \"<string>\",\n  \"expiresIn\": \"<number>\",\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"taxID\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"correlationID\": \"<string>\",\n    \"address\": {\n      \"zipcode\": \"<string>\",\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"country\": \"<string>\"\n    }\n  },\n  \"daysForDueDate\": \"<number>\",\n  \"daysAfterDueDate\": \"<number>\",\n  \"interests\": {\n    \"value\": \"<number>\"\n  },\n  \"fines\": {\n    \"value\": \"<number>\"\n  },\n  \"additionalInfo\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"cashback-fidelity","description":"","item":[{"name":"balance","description":"","item":[{"name":"{taxID}","description":"","item":[{"id":"e86b0559-74b6-400a-8a2d-eb4e6e6b341d","name":"Get the exclusive cashback amount an user still has to receive by taxID.","request":{"name":"Get the exclusive cashback amount an user still has to receive by taxID.","description":{},"url":{"path":["api","v1","cashback-fidelity","balance",":taxID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"taxID","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"46258d7d-cc57-4847-897e-3f1c285a5384","name":"Amount the user still has to receive.","originalRequest":{"url":{"path":["api","v1","cashback-fidelity","balance",":taxID"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"balance\": \"<number>\",\n  \"status\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"660d364c-a8de-480d-95ab-e1867b6fdf68","name":"An error message","originalRequest":{"url":{"path":["api","v1","cashback-fidelity","balance",":taxID"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]},{"id":"da57dcb2-4416-425c-b974-364def53b596","name":"Get or create cashback for a customer.","request":{"name":"Get or create cashback for a customer.","description":{"content":"Create a new cashback exclusive for the customer with a given taxID. If the customer already has a pending excluisve cashback, this endpoint will return it instead.","type":"text/plain"},"url":{"path":["api","v1","cashback-fidelity"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"taxID\": \"<string>\",\n  \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"6e4a152b-ef71-4b7e-9380-d239c3344789","name":"Didn't create a new cashback, returning previously existing cashback information instead.","originalRequest":{"url":{"path":["api","v1","cashback-fidelity"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"taxID\": \"<string>\",\n  \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"cashback\": {\n    \"value\": \"<number>\"\n  },\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"32fcbb55-2e12-4c6c-b600-1858611bc19a","name":"New cashback created successfully","originalRequest":{"url":{"path":["api","v1","cashback-fidelity"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"taxID\": \"<string>\",\n  \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"cashback\": {\n    \"value\": \"<number>\"\n  },\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d48d4959-7f13-47a2-a7c0-722cbe566ce3","name":"An error message","originalRequest":{"url":{"path":["api","v1","cashback-fidelity"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"taxID\": \"<string>\",\n  \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"account","description":"","item":[{"name":"{accountId}","description":"","item":[{"name":"withdraw","description":"","item":[{"id":"451ac132-918c-4981-9782-5bb6402b86d8","name":"Withdraw from an Account","request":{"name":"Withdraw from an Account","description":{"content":"An additional fee may be charged depending on the minimum free withdrawal amount. See more about at https://developers.openpix.com.br/docs/FAQ/faq-virtual-account/#onde-posso-consultar-as-taxas-da-minha-conta-virtual","type":"text/plain"},"url":{"path":["api","v1","account",":accountId","withdraw"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"accountId","disabled":false}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"a4bd0f53-4da0-4613-89c5-33d2d7445df8","name":"Withdraw and Acccount information","originalRequest":{"url":{"path":["api","v1","account",":accountId","withdraw"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"withdraw\": {\n    \"account\": {\n      \"accountId\": \"<string>\",\n      \"isDefault\": \"<boolean>\",\n      \"balance\": {\n        \"total\": \"<number>\",\n        \"blocked\": \"<number>\",\n        \"available\": \"<number>\"\n      }\n    },\n    \"transaction\": {\n      \"endToEndId\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2b595471-4de4-4aa5-a8d1-bc2b4acf85ed","name":"An error message","originalRequest":{"url":{"path":["api","v1","account",":accountId","withdraw"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"ec36eab1-9af0-4798-b42a-1187513783d5","name":"Get an Account","request":{"name":"Get an Account","description":{},"url":{"path":["api","v1","account",":accountId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"accountId","disabled":false}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"90c8b20e-7e33-432c-b3dc-3181edf7646b","name":"The Account retrieve using the given Account ID","originalRequest":{"url":{"path":["api","v1","account",":accountId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"account\": {\n    \"accountId\": \"<string>\",\n    \"isDefault\": \"<boolean>\",\n    \"balance\": {\n      \"total\": \"<number>\",\n      \"blocked\": \"<number>\",\n      \"available\": \"<number>\"\n    }\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"582ad253-8eb0-491c-ae4b-7c45364147f9","name":"An error message","originalRequest":{"url":{"path":["api","v1","account",":accountId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"f725eaa4-495b-4f12-9472-8feb777863bf","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":"e4d2c2c3-c920-4b16-ad34-deda1f80c9b3","name":"A list of Accounts","originalRequest":{"url":{"path":["api","v1","account",""],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"accounts\": [\n    {\n      \"accountId\": \"<string>\",\n      \"isDefault\": \"<boolean>\",\n      \"balance\": {\n        \"total\": \"<number>\",\n        \"blocked\": \"<number>\",\n        \"available\": \"<number>\"\n      }\n    },\n    {\n      \"accountId\": \"<string>\",\n      \"isDefault\": \"<boolean>\",\n      \"balance\": {\n        \"total\": \"<number>\",\n        \"blocked\": \"<number>\",\n        \"available\": \"<number>\"\n      }\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"26840bb5-1884-415a-8ec1-13555d20c373","name":"An error message","originalRequest":{"url":{"path":["api","v1","account",""],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]}]}],"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"{{apiKey}}","key":"value"},{"type":"any","value":"header","key":"in"}]},"event":[],"variable":[{"key":"baseUrl","value":"https://api.openpix.com.br"}],"info":{"_postman_id":"5b5b841e-1efd-45d4-988c-d14ea84aa1b1","name":"OpenPix","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json","description":{"content":"A OpenPix é uma Plataforma de Gestão de Pagamentos. Para utilizar nossa API você deve acessar  __[https://api.openpix.com.br/](https://api.openpix.com.br/)__ e somente o mesmo. A OpenPix não aceita subdominios para a API.\n\nVeja como configurar seu acesso a nossa API [aqui](https://developers.openpix.com.br/docs/apis/api-getting-started).","type":"text/plain"}}}
\ No newline at end of file
+{"item":[{"name":"api","description":"","item":[{"name":"v1","description":"","item":[{"name":"account","description":"","item":[{"name":"{accountId}","description":"","item":[{"id":"25dfbcb4-a51c-4ae5-88dc-0eee7d63bb03","name":"Get an Account","request":{"name":"Get an Account","description":{},"url":{"path":["api","v1","account",":accountId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"accountId","disabled":false,"description":{"content":"(Required) ID of the Account","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"c8e17dbc-6753-4b6d-8250-a02f81db8087","name":"The Account retrieve using the given Account ID","originalRequest":{"url":{"path":["api","v1","account",":accountId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"account\": {\n    \"accountId\": \"<string>\",\n    \"isDefault\": \"<boolean>\",\n    \"balance\": {\n      \"total\": \"<number>\",\n      \"blocked\": \"<number>\",\n      \"available\": \"<number>\"\n    }\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7ffcf491-a4b1-4964-b49f-54e2e4236b6f","name":"An error message","originalRequest":{"url":{"path":["api","v1","account",":accountId"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"name":"withdraw","description":"","item":[{"id":"ab3ede1b-93d7-4e34-a3c4-f4f90fd59c59","name":"Withdraw from an Account","request":{"name":"Withdraw from an Account","description":{"content":"An additional fee may be charged depending on the minimum free withdrawal amount. See more about at https://developers.openpix.com.br/docs/FAQ/faq-virtual-account/#onde-posso-consultar-as-taxas-da-minha-conta-virtual","type":"text/plain"},"url":{"path":["api","v1","account",":accountId","withdraw"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"accountId","disabled":false,"description":{"content":"(Required) ID of the Account","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"c0a55601-9276-4514-bbba-1bbcb7b40f82","name":"Withdraw and Acccount information","originalRequest":{"url":{"path":["api","v1","account",":accountId","withdraw"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"withdraw\": {\n    \"account\": {\n      \"accountId\": \"<string>\",\n      \"isDefault\": \"<boolean>\",\n      \"balance\": {\n        \"total\": \"<number>\",\n        \"blocked\": \"<number>\",\n        \"available\": \"<number>\"\n      }\n    },\n    \"transaction\": {\n      \"endToEndId\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"22fe0ae3-0208-4e20-aa2e-da35b258f5f8","name":"An error message","originalRequest":{"url":{"path":["api","v1","account",":accountId","withdraw"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]},{"id":"848da96e-1d3e-40c0-a7d5-48c4b3e0df7f","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":"f8a031b6-73be-48bf-9c96-dfbb8311d5be","name":"A list of Accounts","originalRequest":{"url":{"path":["api","v1","account",""],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"accounts\": [\n    {\n      \"accountId\": \"<string>\",\n      \"isDefault\": \"<boolean>\",\n      \"balance\": {\n        \"total\": \"<number>\",\n        \"blocked\": \"<number>\",\n        \"available\": \"<number>\"\n      }\n    },\n    {\n      \"accountId\": \"<string>\",\n      \"isDefault\": \"<boolean>\",\n      \"balance\": {\n        \"total\": \"<number>\",\n        \"blocked\": \"<number>\",\n        \"available\": \"<number>\"\n      }\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"16f6d2c8-2919-4a49-8d22-41e989820361","name":"An error message","originalRequest":{"url":{"path":["api","v1","account",""],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"cashback-fidelity","description":"","item":[{"name":"balance","description":"","item":[{"name":"{taxID}","description":"","item":[{"id":"55dfd9ae-1991-4fcf-8320-9dd9cceb781b","name":"Get the exclusive cashback amount an user still has to receive by taxID.","request":{"name":"Get the exclusive cashback amount an user still has to receive by taxID.","description":{},"url":{"path":["api","v1","cashback-fidelity","balance",":taxID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"taxID","disabled":false,"description":{"content":"(Required) The raw tax ID from the customer you want to get the balance.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"24252ebe-aab0-4610-935f-004d94fb6038","name":"Amount the user still has to receive.","originalRequest":{"url":{"path":["api","v1","cashback-fidelity","balance",":taxID"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"balance\": \"<number>\",\n  \"status\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2d47d606-7bc3-4217-9c1c-52cb9ff394bb","name":"An error message","originalRequest":{"url":{"path":["api","v1","cashback-fidelity","balance",":taxID"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]},{"id":"9749136a-c6a5-4d95-85c7-6384885a27bc","name":"Get or create cashback for a customer.","request":{"name":"Get or create cashback for a customer.","description":{"content":"Create a new cashback exclusive for the customer with a given taxID. If the customer already has a pending excluisve cashback, this endpoint will return it instead.","type":"text/plain"},"url":{"path":["api","v1","cashback-fidelity"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"taxID\": \"<string>\",\n  \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"90bac045-4c70-44eb-a57b-06cf93349680","name":"Didn't create a new cashback, returning previously existing cashback information instead.","originalRequest":{"url":{"path":["api","v1","cashback-fidelity"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"taxID\": \"<string>\",\n  \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"cashback\": {\n    \"value\": \"<number>\"\n  },\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f202b4aa-0bc3-4398-b548-8b61f4298b24","name":"New cashback created successfully","originalRequest":{"url":{"path":["api","v1","cashback-fidelity"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"taxID\": \"<string>\",\n  \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"cashback\": {\n    \"value\": \"<number>\"\n  },\n  \"message\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"56eeb5bf-e2f6-4f26-a077-067152177c69","name":"An error message","originalRequest":{"url":{"path":["api","v1","cashback-fidelity"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"taxID\": \"<string>\",\n  \"value\": \"<number>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"charge","description":"","item":[{"name":"{id}","description":"","item":[{"id":"618d93c0-5a94-4aaf-a3e2-21c3a85ff308","name":"Delete a charge","request":{"name":"Delete a charge","description":{},"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) charge ID or correlation ID. You will need URI encoding if your correlation ID has characters outside the ASCII set or reserved characters (%, \\#, /).","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{},"auth":null},"response":[{"id":"57189078-8ade-42c9-bed1-027cd843a3ff","name":"The charge deleted","originalRequest":{"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"status\": \"<string>\",\n  \"id\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9af04c10-0acb-4578-b76a-f96d49dde2dc","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ec8c2687-7108-4f4b-bc9a-5319d003035d","name":"Get one charge","request":{"name":"Get one charge","description":{},"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) charge ID or correlation ID. You will need URI encoding if your correlation ID has characters outside the ASCII set or reserved characters (%, \\#, /).","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"a5cd064d-6bde-4acc-8362-8656a421f46f","name":"The charge retrieve using the given ID","originalRequest":{"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"charge\": {\n    \"value\": \"<number>\",\n    \"customer\": {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"<string>\"\n      },\n      \"correlationID\": \"<string>\",\n      \"address\": {\n        \"zipcode\": \"<string>\",\n        \"street\": \"<string>\",\n        \"number\": \"<string>\",\n        \"neighborhood\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"complement\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    },\n    \"type\": \"DYNAMIC\",\n    \"comment\": \"<string>\",\n    \"brCode\": \"<string>\",\n    \"status\": \"COMPLETED\",\n    \"correlationID\": \"<string>\",\n    \"paymentLinkID\": \"<string>\",\n    \"paymentLinkUrl\": {\n      \"description\": \"Payment Link URL to be shared with customers\"\n    },\n    \"globalID\": {\n      \"description\": \"External ID of this charge\"\n    },\n    \"transactionID\": {\n      \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n    },\n    \"identifier\": \"<string>\",\n    \"qrCodeImage\": {\n      \"description\": \"QRCode image link URL\"\n    },\n    \"additionalInfo\": [\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"pixKey\": \"<string>\",\n    \"createdAt\": \"<string>\",\n    \"updatedAt\": \"<string>\",\n    \"expiresIn\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"95c276f5-e917-4be2-bdfd-f30c1d4db11e","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"name":"refund","description":"","item":[{"id":"6dd62c10-0b25-4840-b73e-dde7394993fc","name":"Get all refunds of a charge","request":{"name":"Get all refunds of a charge","description":{"content":"Endpoint to get all refunds of a charge","type":"text/plain"},"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) The correlation ID of the charge. You will need URI encoding if your correlation ID has characters outside the ASCII set or reserved characters (%, \\#, /).","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"8a866553-19a0-4a20-b9f5-65c992ec9bf9","name":"A list of refunds","originalRequest":{"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"refunds\": [\n    {\n      \"value\": \"<number>\",\n      \"status\": \"CONFIRMED\",\n      \"correlationID\": \"<string>\",\n      \"endToEndId\": \"<string>\",\n      \"time\": \"<string>\",\n      \"comment\": \"<string>\"\n    },\n    {\n      \"value\": \"<number>\",\n      \"status\": \"REJECTED\",\n      \"correlationID\": \"<string>\",\n      \"endToEndId\": \"<string>\",\n      \"time\": \"<string>\",\n      \"comment\": \"<string>\"\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a881afe6-1107-4c21-a581-300c769de5d2","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d2768fe2-f2f5-42ea-962b-ff84589f036d","name":"Create a new refund for a charge","request":{"name":"Create a new refund for a charge","description":{"content":"Endpoint to create a new refund for a charge","type":"text/plain"},"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) The correlation ID of the charge. You will need URI encoding if your correlation ID has characters outside the ASCII set or reserved characters (%, \\#, /).","type":"text/plain"}}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"correlationID\": \"<string>\",\n  \"value\": \"<number>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"3cfcca83-9053-4a13-86db-06d6b1d5158f","name":"The created Refund","originalRequest":{"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"correlationID\": \"<string>\",\n  \"value\": \"<number>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"refund\": {\n    \"value\": \"<number>\",\n    \"status\": \"IN_PROCESSING\",\n    \"correlationID\": \"<string>\",\n    \"endToEndId\": \"<string>\",\n    \"time\": \"<string>\",\n    \"comment\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f36f5ab4-5ad3-48e2-8bd8-7b5cebe47205","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"correlationID\": \"<string>\",\n  \"value\": \"<number>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]},{"id":"d30b547c-5079-44e3-a3d7-502e41652eed","name":"Get a list of charges","request":{"name":"Get a list of charges","description":{},"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"status","value":"EXPIRED"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"6ae8c334-36b2-43de-b44b-a21adac4dd51","name":"A list of charges","originalRequest":{"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"status","value":"EXPIRED"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"charges\": [\n    {\n      \"value\": \"<number>\",\n      \"customer\": {\n        \"name\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"<string>\"\n        },\n        \"correlationID\": \"<string>\",\n        \"address\": {\n          \"zipcode\": \"<string>\",\n          \"street\": \"<string>\",\n          \"number\": \"<string>\",\n          \"neighborhood\": \"<string>\",\n          \"city\": \"<string>\",\n          \"state\": \"<string>\",\n          \"complement\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      },\n      \"type\": \"DYNAMIC\",\n      \"comment\": \"<string>\",\n      \"brCode\": \"<string>\",\n      \"status\": \"ACTIVE\",\n      \"correlationID\": \"<string>\",\n      \"paymentLinkID\": \"<string>\",\n      \"paymentLinkUrl\": {\n        \"description\": \"Payment Link URL to be shared with customers\"\n      },\n      \"globalID\": {\n        \"description\": \"External ID of this charge\"\n      },\n      \"transactionID\": {\n        \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n      },\n      \"identifier\": \"<string>\",\n      \"qrCodeImage\": {\n        \"description\": \"QRCode image link URL\"\n      },\n      \"additionalInfo\": [\n        {\n          \"key\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"key\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"pixKey\": \"<string>\",\n      \"createdAt\": \"<string>\",\n      \"updatedAt\": \"<string>\",\n      \"expiresIn\": \"<string>\"\n    },\n    {\n      \"value\": \"<number>\",\n      \"customer\": {\n        \"name\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"<string>\"\n        },\n        \"correlationID\": \"<string>\",\n        \"address\": {\n          \"zipcode\": \"<string>\",\n          \"street\": \"<string>\",\n          \"number\": \"<string>\",\n          \"neighborhood\": \"<string>\",\n          \"city\": \"<string>\",\n          \"state\": \"<string>\",\n          \"complement\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      },\n      \"type\": \"DYNAMIC\",\n      \"comment\": \"<string>\",\n      \"brCode\": \"<string>\",\n      \"status\": \"ACTIVE\",\n      \"correlationID\": \"<string>\",\n      \"paymentLinkID\": \"<string>\",\n      \"paymentLinkUrl\": {\n        \"description\": \"Payment Link URL to be shared with customers\"\n      },\n      \"globalID\": {\n        \"description\": \"External ID of this charge\"\n      },\n      \"transactionID\": {\n        \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n      },\n      \"identifier\": \"<string>\",\n      \"qrCodeImage\": {\n        \"description\": \"QRCode image link URL\"\n      },\n      \"additionalInfo\": [\n        {\n          \"key\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"key\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"pixKey\": \"<string>\",\n      \"createdAt\": \"<string>\",\n      \"updatedAt\": \"<string>\",\n      \"expiresIn\": \"<string>\"\n    }\n  ],\n  \"pageInfo\": {\n    \"errors\": [\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      },\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      }\n    ],\n    \"skip\": \"<number>\",\n    \"limit\": \"<number>\",\n    \"totalCount\": \"<number>\",\n    \"hasPreviousPage\": \"<boolean>\",\n    \"hasNextPage\": \"<boolean>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b147eaec-19c6-4a3d-bc36-0702feb0fde8","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"status","value":"EXPIRED"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"d0ca98a1-62d1-467b-9cd5-3c8d7a48f277","name":"Create a new Charge","request":{"name":"Create a new Charge","description":{"content":"Endpoint to create a new Charge for a customer","type":"text/plain"},"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Make the endpoint idempotent, will return an existent charge if already has a one with the correlationID","type":"text/plain"},"key":"return_existing","value":"<boolean>"}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"correlationID\": \"<string>\",\n  \"value\": \"<number>\",\n  \"type\": \"DYNAMIC\",\n  \"comment\": \"<string>\",\n  \"identifier\": \"<string>\",\n  \"expiresIn\": \"<number>\",\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"taxID\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"correlationID\": \"<string>\",\n    \"address\": {\n      \"zipcode\": \"<string>\",\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"country\": \"<string>\"\n    }\n  },\n  \"daysForDueDate\": \"<number>\",\n  \"daysAfterDueDate\": \"<number>\",\n  \"interests\": {\n    \"value\": \"<number>\"\n  },\n  \"fines\": {\n    \"value\": \"<number>\"\n  },\n  \"additionalInfo\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"enableCashbackPercentage\": \"<boolean>\",\n  \"enableCashbackExclusivePercentage\": \"<boolean>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"a0073e7e-b575-41df-9878-3a25b82ffacb","name":"Charge ID and also the generated Dynamic BR Code to be rendered as a QRCode","originalRequest":{"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Make the endpoint idempotent, will return an existent charge if already has a one with the correlationID","type":"text/plain"},"key":"return_existing","value":"<boolean>"}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"correlationID\": \"<string>\",\n  \"value\": \"<number>\",\n  \"type\": \"DYNAMIC\",\n  \"comment\": \"<string>\",\n  \"identifier\": \"<string>\",\n  \"expiresIn\": \"<number>\",\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"taxID\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"correlationID\": \"<string>\",\n    \"address\": {\n      \"zipcode\": \"<string>\",\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"country\": \"<string>\"\n    }\n  },\n  \"daysForDueDate\": \"<number>\",\n  \"daysAfterDueDate\": \"<number>\",\n  \"interests\": {\n    \"value\": \"<number>\"\n  },\n  \"fines\": {\n    \"value\": \"<number>\"\n  },\n  \"additionalInfo\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"enableCashbackPercentage\": \"<boolean>\",\n  \"enableCashbackExclusivePercentage\": \"<boolean>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"charge\": {\n    \"value\": \"<number>\",\n    \"customer\": {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"<string>\"\n      },\n      \"correlationID\": \"<string>\",\n      \"address\": {\n        \"zipcode\": \"<string>\",\n        \"street\": \"<string>\",\n        \"number\": \"<string>\",\n        \"neighborhood\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"complement\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    },\n    \"type\": \"OVERDUE\",\n    \"comment\": \"<string>\",\n    \"brCode\": \"<string>\",\n    \"status\": \"COMPLETED\",\n    \"correlationID\": \"<string>\",\n    \"paymentLinkID\": \"<string>\",\n    \"paymentLinkUrl\": {\n      \"description\": \"Payment Link URL to be shared with customers\"\n    },\n    \"globalID\": {\n      \"description\": \"External ID of this charge\"\n    },\n    \"transactionID\": {\n      \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n    },\n    \"identifier\": \"<string>\",\n    \"qrCodeImage\": {\n      \"description\": \"QRCode image link URL\"\n    },\n    \"additionalInfo\": [\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"pixKey\": \"<string>\",\n    \"createdAt\": \"<string>\",\n    \"updatedAt\": \"<string>\",\n    \"expiresIn\": \"<string>\"\n  },\n  \"correlationID\": \"<string>\",\n  \"brCode\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"ccc56eb5-65a8-4061-961e-a23d894588c9","name":"An error message","originalRequest":{"url":{"path":["api","v1","charge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Make the endpoint idempotent, will return an existent charge if already has a one with the correlationID","type":"text/plain"},"key":"return_existing","value":"<boolean>"}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"correlationID\": \"<string>\",\n  \"value\": \"<number>\",\n  \"type\": \"DYNAMIC\",\n  \"comment\": \"<string>\",\n  \"identifier\": \"<string>\",\n  \"expiresIn\": \"<number>\",\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"taxID\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"correlationID\": \"<string>\",\n    \"address\": {\n      \"zipcode\": \"<string>\",\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"country\": \"<string>\"\n    }\n  },\n  \"daysForDueDate\": \"<number>\",\n  \"daysAfterDueDate\": \"<number>\",\n  \"interests\": {\n    \"value\": \"<number>\"\n  },\n  \"fines\": {\n    \"value\": \"<number>\"\n  },\n  \"additionalInfo\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"enableCashbackPercentage\": \"<boolean>\",\n  \"enableCashbackExclusivePercentage\": \"<boolean>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"customer","description":"","item":[{"name":"{id}","description":"","item":[{"id":"99104359-6ca8-40ed-8654-f83b04e01aa1","name":"Get one customer","request":{"name":"Get one customer","description":{},"url":{"path":["api","v1","customer",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) correlation ID","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"b3007e44-182f-419d-8355-1c6c27230335","name":"The customer retrieve using the given ID","originalRequest":{"url":{"path":["api","v1","customer",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"taxID\": {\n      \"taxID\": \"<string>\",\n      \"type\": \"<string>\"\n    },\n    \"correlationID\": \"<string>\",\n    \"address\": {\n      \"zipcode\": \"<string>\",\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"country\": \"<string>\"\n    }\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"966ff204-f459-41f0-82b1-cc48b4b33966","name":"An error message","originalRequest":{"url":{"path":["api","v1","customer",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"431226ae-1479-4cfa-9d9f-fbcfc62cebba","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":"cea8876f-7cbb-4d5d-859c-cdeae1c6769f","name":"A list of customers","originalRequest":{"url":{"path":["api","v1","customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"customers\": [\n    {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"<string>\"\n      },\n      \"correlationID\": \"<string>\",\n      \"address\": {\n        \"zipcode\": \"<string>\",\n        \"street\": \"<string>\",\n        \"number\": \"<string>\",\n        \"neighborhood\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"complement\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    },\n    {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"<string>\"\n      },\n      \"correlationID\": \"<string>\",\n      \"address\": {\n        \"zipcode\": \"<string>\",\n        \"street\": \"<string>\",\n        \"number\": \"<string>\",\n        \"neighborhood\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"complement\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    }\n  ],\n  \"pageInfo\": {\n    \"errors\": [\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      },\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      }\n    ],\n    \"skip\": \"<number>\",\n    \"limit\": \"<number>\",\n    \"totalCount\": \"<number>\",\n    \"hasPreviousPage\": \"<boolean>\",\n    \"hasNextPage\": \"<boolean>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"822985bf-3fb8-4a13-8c9e-4f792ead2923","name":"An error message","originalRequest":{"url":{"path":["api","v1","customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"b434bebc-2c28-48eb-8d09-48b79784299e","name":"Create a new Customer","request":{"name":"Create a new Customer","description":{"content":"Endpoint to create a new Customer","type":"text/plain"},"url":{"path":["api","v1","customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"taxID\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"address\": {\n    \"zipcode\": \"<string>\",\n    \"street\": \"<string>\",\n    \"number\": \"<string>\",\n    \"neighborhood\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"complement\": \"<string>\",\n    \"country\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"0edc132d-b97f-4f2e-9b81-d2a4c573c574","name":"Customer ID","originalRequest":{"url":{"path":["api","v1","customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"taxID\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"address\": {\n    \"zipcode\": \"<string>\",\n    \"street\": \"<string>\",\n    \"number\": \"<string>\",\n    \"neighborhood\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"complement\": \"<string>\",\n    \"country\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"taxID\": {\n      \"taxID\": \"<string>\",\n      \"type\": \"<string>\"\n    },\n    \"correlationID\": \"<string>\",\n    \"address\": {\n      \"zipcode\": \"<string>\",\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"country\": \"<string>\"\n    }\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2069cb57-8dc5-4741-b5dd-cab577bf96f7","name":"An error message","originalRequest":{"url":{"path":["api","v1","customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"taxID\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"address\": {\n    \"zipcode\": \"<string>\",\n    \"street\": \"<string>\",\n    \"number\": \"<string>\",\n    \"neighborhood\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"complement\": \"<string>\",\n    \"country\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"partner","description":"","item":[{"name":"application","description":"","item":[{"id":"6efabf4d-4310-463b-9e87-ab472318ff01","name":"Create a new application to some of your preregistration's company.","request":{"name":"Create a new application to some of your preregistration's company.","description":{"content":"As a partner company, you can create a new application to some of your companies.\nThe application should give access to our API to this companies, so they can use\nit too.\n","type":"text/plain"},"url":{"path":["api","v1","partner","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"application\": {\n    \"name\": \"<string>\",\n    \"type\": \"API\"\n  },\n  \"taxID\": {\n    \"taxID\": \"<string>\",\n    \"type\": \"BR:CNPJ\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"de9b0eab-8123-409e-8992-55e3afd4c7bb","name":"Our \"idempotence output\", if you get this HTTP code, it's an application\nthat already has been registered.\n","originalRequest":{"url":{"path":["api","v1","partner","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"application\": {\n    \"name\": \"<string>\",\n    \"type\": \"API\"\n  },\n  \"taxID\": {\n    \"taxID\": \"<string>\",\n    \"type\": \"BR:CNPJ\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"application\": {\n    \"name\": \"<string>\",\n    \"isActive\": \"<boolean>\",\n    \"type\": \"API\",\n    \"clientId\": \"<string>\",\n    \"clientSecret\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"98e5837a-e5b5-4f42-9c47-eef130fa075a","name":"A new application has been registered. It'll be identified by the name that you give to it\nand by the company that has been referenced.\n","originalRequest":{"url":{"path":["api","v1","partner","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"application\": {\n    \"name\": \"<string>\",\n    \"type\": \"API\"\n  },\n  \"taxID\": {\n    \"taxID\": \"<string>\",\n    \"type\": \"BR:CNPJ\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"application\": {\n    \"name\": \"<string>\",\n    \"isActive\": \"<boolean>\",\n    \"type\": \"API\",\n    \"clientId\": \"<string>\",\n    \"clientSecret\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3a87bcee-9cfd-4567-a558-a59c6abd9669","name":"An error message","originalRequest":{"url":{"path":["api","v1","partner","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"application\": {\n    \"name\": \"<string>\",\n    \"type\": \"API\"\n  },\n  \"taxID\": {\n    \"taxID\": \"<string>\",\n    \"type\": \"BR:CNPJ\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d2d86a4f-0a69-4c5f-a45a-c37f9dbc2553","name":"You are unauthorized to use this endpoint.","originalRequest":{"url":{"path":["api","v1","partner","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"application\": {\n    \"name\": \"<string>\",\n    \"type\": \"API\"\n  },\n  \"taxID\": {\n    \"taxID\": \"<string>\",\n    \"type\": \"BR:CNPJ\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"company","description":"","item":[{"name":"{taxID}","description":"","item":[{"id":"443a6222-1d5e-4671-87fd-003f422e231a","name":"Get an specific preregistration via taxID param.","request":{"name":"Get an specific preregistration via taxID param.","description":{},"url":{"path":["api","v1","partner","company",":taxID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"taxID","disabled":false,"description":{"content":"(Required) The raw tax ID from the preregistration that you want to get.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"712f9d4d-046c-40ca-9f9e-7a1414ec06b5","name":"The preregistration retrieved by the tax ID.","originalRequest":{"url":{"path":["api","v1","partner","company",":taxID"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"preRegistration\": {\n    \"preRegistration\": {\n      \"name\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"BR:CNPJ\"\n      }\n    },\n    \"user\": {\n      \"firstName\": \"<string>\",\n      \"lastName\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\"\n    },\n    \"company\": {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"BR:CNPJ\"\n      }\n    },\n    \"account\": {\n      \"clientId\": \"<string>\"\n    }\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2a5a8c5f-be44-490b-8ac4-9998a140ef9b","name":"An error message","originalRequest":{"url":{"path":["api","v1","partner","company",":taxID"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"12242bf3-7574-44f9-951c-d166d2aa7558","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":"b6eae03b-f137-4eff-be4b-5dd0cb77c1cd","name":"A list with preregistrations.","originalRequest":{"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"preRegistrations\": [\n    {\n      \"preRegistration\": {\n        \"name\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"BR:CNPJ\"\n        }\n      },\n      \"user\": {\n        \"firstName\": \"<string>\",\n        \"lastName\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\"\n      },\n      \"company\": {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"BR:CNPJ\"\n        }\n      },\n      \"account\": {\n        \"clientId\": \"<string>\"\n      }\n    },\n    {\n      \"preRegistration\": {\n        \"name\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"BR:CNPJ\"\n        }\n      },\n      \"user\": {\n        \"firstName\": \"<string>\",\n        \"lastName\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\"\n      },\n      \"company\": {\n        \"id\": \"<string>\",\n        \"name\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"BR:CNPJ\"\n        }\n      },\n      \"account\": {\n        \"clientId\": \"<string>\"\n      }\n    }\n  ],\n  \"pageInfo\": {\n    \"errors\": [\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      },\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      }\n    ],\n    \"skip\": \"<number>\",\n    \"limit\": \"<number>\",\n    \"totalCount\": \"<number>\",\n    \"hasPreviousPage\": \"<boolean>\",\n    \"hasNextPage\": \"<boolean>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"074071bd-5d18-45f2-b491-2827dcd272f2","name":"An error message","originalRequest":{"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"8c229aca-4650-482f-957b-63d65ab28efe","name":"Create a pre registration with a partner reference (your company)","request":{"name":"Create a pre registration with a partner reference (your company)","description":{"content":"As a partner company, you can create a new pre registration referencing your\ncompany as a partner.\n","type":"text/plain"},"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"preRegistration\": {\n    \"name\": \"<string>\",\n    \"taxID\": {\n      \"taxID\": \"<string>\",\n      \"type\": \"BR:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"1df8356b-e573-4765-965b-a88d3ad02e32","name":"Payload with a pre registration data.\nBeing the taxID our idempotence key, if you do the request with the same taxID multiple times,\nevery time you'll receive the same data from our endpoint.\n","originalRequest":{"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"preRegistration\": {\n    \"name\": \"<string>\",\n    \"taxID\": {\n      \"taxID\": \"<string>\",\n      \"type\": \"BR:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"preRegistration\": {\n    \"name\": \"<string>\",\n    \"taxID\": {\n      \"taxID\": \"<string>\",\n      \"type\": \"BR:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8bad0e07-eb2c-431d-b5f5-86346e5213e0","name":"A new preregistration that is related to you has been created.","originalRequest":{"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"preRegistration\": {\n    \"name\": \"<string>\",\n    \"taxID\": {\n      \"taxID\": \"<string>\",\n      \"type\": \"BR:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Created","code":201,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"preRegistration\": {\n    \"name\": \"<string>\",\n    \"taxID\": {\n      \"taxID\": \"<string>\",\n      \"type\": \"BR:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"92187ed5-22b0-4d8a-8a09-716766cb4e85","name":"An error message","originalRequest":{"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"preRegistration\": {\n    \"name\": \"<string>\",\n    \"taxID\": {\n      \"taxID\": \"<string>\",\n      \"type\": \"BR:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"96448241-e257-4e36-8d56-aed0da21a83b","name":"You are unauthorized to use this endpoint.","originalRequest":{"url":{"path":["api","v1","partner","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"preRegistration\": {\n    \"name\": \"<string>\",\n    \"taxID\": {\n      \"taxID\": \"<string>\",\n      \"type\": \"BR:CNPJ\"\n    },\n    \"website\": \"<string>\"\n  },\n  \"user\": {\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]},{"name":"payment","description":"","item":[{"name":"approve","description":"","item":[{"id":"00e6cddf-d585-4a23-be93-552ccd0682a9","name":"Approve a Payment Request","request":{"name":"Approve a Payment Request","description":{"content":"Endpoint to approve a payment","type":"text/plain"},"url":{"path":["api","v1","payment","approve"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"correlationID\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"876961ad-fc2d-4844-af73-ec24472242d3","name":"The approved payment","originalRequest":{"url":{"path":["api","v1","payment","approve"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"correlationID\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"payment\": {\n    \"value\": \"<number>\",\n    \"destinationAlias\": \"<string>\",\n    \"correlationID\": \"<string>\",\n    \"comment\": \"<string>\",\n    \"status\": \"FAILED\",\n    \"sourceAccountId\": \"<string>\"\n  },\n  \"transaction\": {\n    \"value\": \"<number>\",\n    \"endToEndId\": \"<string>\",\n    \"time\": \"<string>\"\n  },\n  \"destination\": {\n    \"name\": \"<string>\",\n    \"taxID\": \"<string>\",\n    \"pixKey\": \"<string>\",\n    \"bank\": \"<string>\",\n    \"branch\": \"<string>\",\n    \"account\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e8b6613a-3cf5-45e4-a4de-cdeccbabaf0b","name":"An error message","originalRequest":{"url":{"path":["api","v1","payment","approve"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"correlationID\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"{id}","description":"","item":[{"id":"7ae917af-dfbd-485f-b79f-847605c99a06","name":"Get one Payment","request":{"name":"Get one Payment","description":{},"url":{"path":["api","v1","payment",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) payment ID or correlation ID","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"525c7eea-50d6-41f8-8e55-da4c8d11a74a","name":"The payment retrieved using the given ID","originalRequest":{"url":{"path":["api","v1","payment",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"payment\": {\n    \"value\": \"<number>\",\n    \"destinationAlias\": \"<string>\",\n    \"correlationID\": \"<string>\",\n    \"comment\": \"<string>\",\n    \"status\": \"CONFIRMED\",\n    \"sourceAccountId\": \"<string>\"\n  },\n  \"transaction\": {\n    \"value\": \"<number>\",\n    \"endToEndId\": \"<string>\",\n    \"time\": \"<string>\"\n  },\n  \"destination\": {\n    \"name\": \"<string>\",\n    \"taxID\": \"<string>\",\n    \"pixKey\": \"<string>\",\n    \"bank\": \"<string>\",\n    \"branch\": \"<string>\",\n    \"account\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9268c58c-31eb-445b-be17-dad57ccf4bc9","name":"An error message","originalRequest":{"url":{"path":["api","v1","payment",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"8226c737-0efa-4741-97b7-d899b71e644e","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":"220bfb50-c79c-4bb4-9688-84880172756d","name":"A list of payments","originalRequest":{"url":{"path":["api","v1","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"status\": \"<string>\",\n  \"payments\": [\n    {\n      \"payment\": {\n        \"value\": \"<number>\",\n        \"destinationAlias\": \"<string>\",\n        \"correlationID\": \"<string>\",\n        \"comment\": \"<string>\",\n        \"status\": \"CREATED\",\n        \"sourceAccountId\": \"<string>\"\n      },\n      \"transaction\": {\n        \"value\": \"<number>\",\n        \"endToEndId\": \"<string>\",\n        \"time\": \"<string>\"\n      },\n      \"destination\": {\n        \"name\": \"<string>\",\n        \"taxID\": \"<string>\",\n        \"pixKey\": \"<string>\",\n        \"bank\": \"<string>\",\n        \"branch\": \"<string>\",\n        \"account\": \"<string>\"\n      }\n    },\n    {\n      \"payment\": {\n        \"value\": \"<number>\",\n        \"destinationAlias\": \"<string>\",\n        \"correlationID\": \"<string>\",\n        \"comment\": \"<string>\",\n        \"status\": \"CONFIRMED\",\n        \"sourceAccountId\": \"<string>\"\n      },\n      \"transaction\": {\n        \"value\": \"<number>\",\n        \"endToEndId\": \"<string>\",\n        \"time\": \"<string>\"\n      },\n      \"destination\": {\n        \"name\": \"<string>\",\n        \"taxID\": \"<string>\",\n        \"pixKey\": \"<string>\",\n        \"bank\": \"<string>\",\n        \"branch\": \"<string>\",\n        \"account\": \"<string>\"\n      }\n    }\n  ],\n  \"pageInfo\": {\n    \"errors\": [\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      },\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      }\n    ],\n    \"skip\": \"<number>\",\n    \"limit\": \"<number>\",\n    \"totalCount\": \"<number>\",\n    \"hasPreviousPage\": \"<boolean>\",\n    \"hasNextPage\": \"<boolean>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"6504eb16-7a17-4a4c-a9d2-a513c766b2ff","name":"An error message","originalRequest":{"url":{"path":["api","v1","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fba65649-ad4f-4937-b094-a6c60d7b1094","name":"Create a Payment Request","request":{"name":"Create a Payment Request","description":{"content":"Endpoint to request a payment","type":"text/plain"},"url":{"path":["api","v1","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\",\n  \"destinationAlias\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"comment\": \"<string>\",\n  \"sourceAccountId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"5e52d402-7d3e-465d-807e-fc951b310c0c","name":"Payment destination account information","originalRequest":{"url":{"path":["api","v1","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\",\n  \"destinationAlias\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"comment\": \"<string>\",\n  \"sourceAccountId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"payment\": {\n    \"value\": \"<number>\",\n    \"destinationAlias\": \"<string>\",\n    \"correlationID\": \"<string>\",\n    \"comment\": \"<string>\",\n    \"status\": \"CREATED\",\n    \"sourceAccountId\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"fa2082aa-3c2f-4a0d-8be9-d2395fecaaf5","name":"An error message","originalRequest":{"url":{"path":["api","v1","payment"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\",\n  \"destinationAlias\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"comment\": \"<string>\",\n  \"sourceAccountId\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"qrcode-static","description":"","item":[{"name":"{id}","description":"","item":[{"id":"2286926f-37e7-4b0f-b741-598ed7ab8cdf","name":"Get one Pix QrCode","request":{"name":"Get one Pix QrCode","description":{},"url":{"path":["api","v1","qrcode-static",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) pixQrCode ID, correlation ID or emv identifier","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"f8bc5095-0c9c-4ad6-a6c1-3d22a3b6210f","name":"The pixQrCode retrieve using the given ID","originalRequest":{"url":{"path":["api","v1","qrcode-static",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"pixQrCode\": {\n    \"name\": \"<string>\",\n    \"value\": \"<string>\",\n    \"comment\": \"<string>\",\n    \"identifier\": \"<string>\",\n    \"brCode\": \"<string>\",\n    \"correlationID\": \"<string>\",\n    \"paymentLinkID\": \"<string>\",\n    \"paymentLinkUrl\": {\n      \"description\": \"Payment Link URL to be shared with customers\"\n    },\n    \"qrCodeImage\": {\n      \"description\": \"QRCode image link URL\"\n    },\n    \"createdAt\": \"<string>\",\n    \"updatedAt\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b9e0c83f-58ca-4909-8739-99239c7f4768","name":"An error message","originalRequest":{"url":{"path":["api","v1","qrcode-static",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"eafd6e3b-c283-4ef6-a67f-422a9f13b152","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":"278b78fe-32c9-40e1-8c8b-9996ef1f2b15","name":"A list of pixQrCodes","originalRequest":{"url":{"path":["api","v1","qrcode-static"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"pixQrCodes\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"comment\": \"<string>\",\n      \"identifier\": \"<string>\",\n      \"brCode\": \"<string>\",\n      \"correlationID\": \"<string>\",\n      \"paymentLinkID\": \"<string>\",\n      \"paymentLinkUrl\": {\n        \"description\": \"Payment Link URL to be shared with customers\"\n      },\n      \"qrCodeImage\": {\n        \"description\": \"QRCode image link URL\"\n      },\n      \"createdAt\": \"<string>\",\n      \"updatedAt\": \"<string>\"\n    },\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"comment\": \"<string>\",\n      \"identifier\": \"<string>\",\n      \"brCode\": \"<string>\",\n      \"correlationID\": \"<string>\",\n      \"paymentLinkID\": \"<string>\",\n      \"paymentLinkUrl\": {\n        \"description\": \"Payment Link URL to be shared with customers\"\n      },\n      \"qrCodeImage\": {\n        \"description\": \"QRCode image link URL\"\n      },\n      \"createdAt\": \"<string>\",\n      \"updatedAt\": \"<string>\"\n    }\n  ],\n  \"pageInfo\": {\n    \"errors\": [\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      },\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      }\n    ],\n    \"skip\": \"<number>\",\n    \"limit\": \"<number>\",\n    \"totalCount\": \"<number>\",\n    \"hasPreviousPage\": \"<boolean>\",\n    \"hasNextPage\": \"<boolean>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"eff893ac-3e23-4d13-8ebe-8a00618b6cd9","name":"An error message","originalRequest":{"url":{"path":["api","v1","qrcode-static"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"6af51b68-43f2-453a-8ffd-7fc43f730e54","name":"Create a new Pix QrCode Static","request":{"name":"Create a new Pix QrCode Static","description":{"content":"Endpoint to create a new Pix QrCode Static","type":"text/plain"},"url":{"path":["api","v1","qrcode-static"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"identifier\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"value\": \"<number>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"af87895e-4864-4b1f-a9bf-6e0ee2275d00","name":"PixQrCode ID and also the generated Dynamic BR Code to be rendered as a QRCode","originalRequest":{"url":{"path":["api","v1","qrcode-static"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"identifier\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"value\": \"<number>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"pixQrCode\": {\n    \"name\": \"<string>\",\n    \"value\": \"<string>\",\n    \"comment\": \"<string>\",\n    \"identifier\": \"<string>\",\n    \"brCode\": \"<string>\",\n    \"correlationID\": \"<string>\",\n    \"paymentLinkID\": \"<string>\",\n    \"paymentLinkUrl\": {\n      \"description\": \"Payment Link URL to be shared with customers\"\n    },\n    \"qrCodeImage\": {\n      \"description\": \"QRCode image link URL\"\n    },\n    \"createdAt\": \"<string>\",\n    \"updatedAt\": \"<string>\"\n  },\n  \"correlationID\": \"<string>\",\n  \"brCode\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"51ddbf93-31f0-42c1-979b-86193f8d7016","name":"An error message","originalRequest":{"url":{"path":["api","v1","qrcode-static"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"name\": \"<string>\",\n  \"identifier\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"value\": \"<number>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"refund","description":"","item":[{"name":"{id}","description":"","item":[{"id":"41841000-a411-4922-b9c3-01d239253482","name":"Get one refund","request":{"name":"Get one refund","description":{},"url":{"path":["api","v1","refund",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) refund ID or correlation ID","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"687ff7fb-86d2-405f-9459-f19ea774b8f9","name":"The refund retrieve using the given ID","originalRequest":{"url":{"path":["api","v1","refund",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"pixTransactionRefund\": {\n    \"value\": \"<number>\",\n    \"status\": \"REFUNDED\",\n    \"correlationID\": \"<string>\",\n    \"refundId\": \"<string>\",\n    \"time\": \"<string>\",\n    \"comment\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2fccf35d-4527-4f9e-b8de-193403869a79","name":"An error message","originalRequest":{"url":{"path":["api","v1","refund",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"b95497d9-e5ca-47b0-b246-8247cbdff3bd","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":"219ae87a-dc7f-4495-a224-e68e2295fd71","name":"A list of refunds","originalRequest":{"url":{"path":["api","v1","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"refunds\": [\n    {\n      \"value\": \"<number>\",\n      \"status\": \"NOT_ACCOMPLISHED\",\n      \"correlationID\": \"<string>\",\n      \"refundId\": \"<string>\",\n      \"time\": \"<string>\",\n      \"comment\": \"<string>\"\n    },\n    {\n      \"value\": \"<number>\",\n      \"status\": \"IN_PROCESSING\",\n      \"correlationID\": \"<string>\",\n      \"refundId\": \"<string>\",\n      \"time\": \"<string>\",\n      \"comment\": \"<string>\"\n    }\n  ],\n  \"pageInfo\": {\n    \"errors\": [\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      },\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      }\n    ],\n    \"skip\": \"<number>\",\n    \"limit\": \"<number>\",\n    \"totalCount\": \"<number>\",\n    \"hasPreviousPage\": \"<boolean>\",\n    \"hasNextPage\": \"<boolean>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d0f9b41f-cd27-4cf2-ab26-2535d50a6e86","name":"An error message","originalRequest":{"url":{"path":["api","v1","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"7a4e14c8-cf06-4086-b429-2097720142a2","name":"Create a new refund","request":{"name":"Create a new refund","description":{"content":"Endpoint to create a new refund for a customer","type":"text/plain"},"url":{"path":["api","v1","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\",\n  \"transactionEndToEndId\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"b2f0eff6-4102-440c-997e-3370422b3396","name":"The created Refund","originalRequest":{"url":{"path":["api","v1","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\",\n  \"transactionEndToEndId\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"refund\": {\n    \"value\": \"<number>\",\n    \"status\": \"NOT_ACCOMPLISHED\",\n    \"correlationID\": \"<string>\",\n    \"refundId\": \"<string>\",\n    \"time\": \"<string>\",\n    \"comment\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4adbd2bc-f050-4034-87d1-c81b1b3735f8","name":"An error message","originalRequest":{"url":{"path":["api","v1","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\",\n  \"transactionEndToEndId\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"subscriptions","description":"","item":[{"name":"{id}","description":"","item":[{"id":"42290972-f783-4772-aadb-e9cc19b0db22","name":"Get one subscription","request":{"name":"Get one subscription","description":{},"url":{"path":["api","v1","subscriptions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) The globalID of the subscription.","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"e1b4dbf2-8fba-4b73-b37d-d0465c42ea6c","name":"The subscription retrieved using the given ID","originalRequest":{"url":{"path":["api","v1","subscriptions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"subscription\": {\n    \"globalID\": \"<string>\",\n    \"value\": \"<number>\",\n    \"customer\": {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"<string>\"\n      },\n      \"correlationID\": \"<string>\",\n      \"address\": {\n        \"zipcode\": \"<string>\",\n        \"street\": \"<string>\",\n        \"number\": \"<string>\",\n        \"neighborhood\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"complement\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    },\n    \"dayGenerateCharge\": \"<number>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f91489e8-6e9e-4db6-9487-4c1085ee5cfa","name":"An error message","originalRequest":{"url":{"path":["api","v1","subscriptions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"10f7dcce-b90a-4231-85c2-e8b2b5e29808","name":"Create a new Subscription","request":{"name":"Create a new Subscription","description":{"content":"Endpoint to create a new Subcription","type":"text/plain"},"url":{"path":["api","v1","subscriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"taxID\": \"<string>\",\n    \"address\": {\n      \"zipcode\": \"<string>\",\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"country\": \"<string>\"\n    }\n  },\n  \"value\": \"<number>\",\n  \"comment\": \"<string>\",\n  \"additionalInfo\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"dayGenerateCharge\": 5,\n  \"chargeType\": \"DYNAMIC\",\n  \"dayDue\": 7\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"a7cd5d9f-642f-4910-b010-3367e6c32b04","name":"The subscription created","originalRequest":{"url":{"path":["api","v1","subscriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"taxID\": \"<string>\",\n    \"address\": {\n      \"zipcode\": \"<string>\",\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"country\": \"<string>\"\n    }\n  },\n  \"value\": \"<number>\",\n  \"comment\": \"<string>\",\n  \"additionalInfo\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"dayGenerateCharge\": 5,\n  \"chargeType\": \"DYNAMIC\",\n  \"dayDue\": 7\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"subscription\": {\n    \"globalID\": \"<string>\",\n    \"value\": \"<number>\",\n    \"customer\": {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"<string>\"\n      },\n      \"correlationID\": \"<string>\",\n      \"address\": {\n        \"zipcode\": \"<string>\",\n        \"street\": \"<string>\",\n        \"number\": \"<string>\",\n        \"neighborhood\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"complement\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    },\n    \"dayGenerateCharge\": \"<number>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d4e7e84b-7895-4a42-8942-c729dbdee531","name":"An error message","originalRequest":{"url":{"path":["api","v1","subscriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"taxID\": \"<string>\",\n    \"address\": {\n      \"zipcode\": \"<string>\",\n      \"street\": \"<string>\",\n      \"number\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"complement\": \"<string>\",\n      \"country\": \"<string>\"\n    }\n  },\n  \"value\": \"<number>\",\n  \"comment\": \"<string>\",\n  \"additionalInfo\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"dayGenerateCharge\": 5,\n  \"chargeType\": \"DYNAMIC\",\n  \"dayDue\": 7\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"transaction","description":"","item":[{"name":"{id}","description":"","item":[{"id":"417e9378-c618-4c6f-882f-148e7a84c68d","name":"Get a Transaction","request":{"name":"Get a Transaction","description":{},"url":{"path":["api","v1","transaction",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) you can use the transaction id from openpix or the endToEndId of transaction from bank","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"fffa3209-499d-492a-878b-2f7ae69680de","name":"The transaction retrieve using the given ID","originalRequest":{"url":{"path":["api","v1","transaction",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"transaction\": {\n    \"charge\": {\n      \"value\": \"<number>\",\n      \"customer\": {\n        \"name\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"<string>\"\n        },\n        \"correlationID\": \"<string>\",\n        \"address\": {\n          \"zipcode\": \"<string>\",\n          \"street\": \"<string>\",\n          \"number\": \"<string>\",\n          \"neighborhood\": \"<string>\",\n          \"city\": \"<string>\",\n          \"state\": \"<string>\",\n          \"complement\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      },\n      \"type\": \"DYNAMIC\",\n      \"comment\": \"<string>\",\n      \"brCode\": \"<string>\",\n      \"status\": \"ACTIVE\",\n      \"correlationID\": \"<string>\",\n      \"paymentLinkID\": \"<string>\",\n      \"paymentLinkUrl\": {\n        \"description\": \"Payment Link URL to be shared with customers\"\n      },\n      \"globalID\": {\n        \"description\": \"External ID of this charge\"\n      },\n      \"transactionID\": {\n        \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n      },\n      \"identifier\": \"<string>\",\n      \"qrCodeImage\": {\n        \"description\": \"QRCode image link URL\"\n      },\n      \"additionalInfo\": [\n        {\n          \"key\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"key\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"pixKey\": \"<string>\",\n      \"createdAt\": \"<string>\",\n      \"updatedAt\": \"<string>\",\n      \"expiresIn\": \"<string>\"\n    },\n    \"value\": \"<number>\",\n    \"time\": \"<string>\",\n    \"endToEndID\": \"<string>\",\n    \"transactionID\": \"<string>\",\n    \"infoPagador\": \"<string>\",\n    \"endToEndId\": \"<string>\",\n    \"customer\": {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"<string>\"\n      },\n      \"correlationID\": \"<string>\",\n      \"address\": {\n        \"zipcode\": \"<string>\",\n        \"street\": \"<string>\",\n        \"number\": \"<string>\",\n        \"neighborhood\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"complement\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    },\n    \"withdraw\": {\n      \"value\": \"<number>\",\n      \"time\": \"<string>\",\n      \"endToEndID\": \"<string>\",\n      \"transactionID\": \"<string>\",\n      \"infoPagador\": \"<string>\",\n      \"endToEndId\": \"<string>\",\n      \"payer\": {\n        \"name\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"<string>\"\n        },\n        \"correlationID\": \"<string>\",\n        \"address\": {\n          \"zipcode\": \"<string>\",\n          \"street\": \"<string>\",\n          \"number\": \"<string>\",\n          \"neighborhood\": \"<string>\",\n          \"city\": \"<string>\",\n          \"state\": \"<string>\",\n          \"complement\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      },\n      \"type\": \"<string>\"\n    },\n    \"payer\": {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"<string>\"\n      },\n      \"correlationID\": \"<string>\",\n      \"address\": {\n        \"zipcode\": \"<string>\",\n        \"street\": \"<string>\",\n        \"number\": \"<string>\",\n        \"neighborhood\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"complement\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    },\n    \"type\": \"FEE\",\n    \"globalID\": {\n      \"description\": \"External ID of this transaction\"\n    },\n    \"pixQrCode\": {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"comment\": \"<string>\",\n      \"identifier\": \"<string>\",\n      \"brCode\": \"<string>\",\n      \"correlationID\": \"<string>\",\n      \"paymentLinkID\": \"<string>\",\n      \"paymentLinkUrl\": {\n        \"description\": \"Payment Link URL to be shared with customers\"\n      },\n      \"qrCodeImage\": {\n        \"description\": \"QRCode image link URL\"\n      },\n      \"createdAt\": \"<string>\",\n      \"updatedAt\": \"<string>\"\n    }\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d7af1be7-6186-46d1-b062-1b3bf72f1531","name":"An error message","originalRequest":{"url":{"path":["api","v1","transaction",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"28e24f79-cf86-4f0d-b0b0-c2e3df404327","name":"Get a list of transactions","request":{"name":"Get a list of transactions","description":{},"url":{"path":["api","v1","transaction"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"},{"disabled":false,"description":{"content":"You can use the charge ID or correlation ID or transaction ID of charge to get a list of transactions related of this transaction","type":"text/plain"},"key":"charge","value":"<string>"},{"disabled":false,"description":{"content":"You can use the QrCode static ID or correlation ID or identifier field of QrCode static to get a list of QrCode related of this transaction","type":"text/plain"},"key":"pixQrCode","value":"<string>"},{"disabled":false,"description":{"content":"You can use the ID or EndToEndId of a withdrawal transaction to get all transactions related to the withdrawal","type":"text/plain"},"key":"withdrawal","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"7b65fcb9-945e-4d6a-9fd8-db3c0c48e974","name":"A list of transactions","originalRequest":{"url":{"path":["api","v1","transaction"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"},{"disabled":false,"description":{"content":"You can use the charge ID or correlation ID or transaction ID of charge to get a list of transactions related of this transaction","type":"text/plain"},"key":"charge","value":"<string>"},{"disabled":false,"description":{"content":"You can use the QrCode static ID or correlation ID or identifier field of QrCode static to get a list of QrCode related of this transaction","type":"text/plain"},"key":"pixQrCode","value":"<string>"},{"disabled":false,"description":{"content":"You can use the ID or EndToEndId of a withdrawal transaction to get all transactions related to the withdrawal","type":"text/plain"},"key":"withdrawal","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"status\": \"<string>\",\n  \"transactions\": [\n    {\n      \"charge\": {\n        \"value\": \"<number>\",\n        \"customer\": {\n          \"name\": \"<string>\",\n          \"email\": \"<string>\",\n          \"phone\": \"<string>\",\n          \"taxID\": {\n            \"taxID\": \"<string>\",\n            \"type\": \"<string>\"\n          },\n          \"correlationID\": \"<string>\",\n          \"address\": {\n            \"zipcode\": \"<string>\",\n            \"street\": \"<string>\",\n            \"number\": \"<string>\",\n            \"neighborhood\": \"<string>\",\n            \"city\": \"<string>\",\n            \"state\": \"<string>\",\n            \"complement\": \"<string>\",\n            \"country\": \"<string>\"\n          }\n        },\n        \"type\": \"OVERDUE\",\n        \"comment\": \"<string>\",\n        \"brCode\": \"<string>\",\n        \"status\": \"COMPLETED\",\n        \"correlationID\": \"<string>\",\n        \"paymentLinkID\": \"<string>\",\n        \"paymentLinkUrl\": {\n          \"description\": \"Payment Link URL to be shared with customers\"\n        },\n        \"globalID\": {\n          \"description\": \"External ID of this charge\"\n        },\n        \"transactionID\": {\n          \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n        },\n        \"identifier\": \"<string>\",\n        \"qrCodeImage\": {\n          \"description\": \"QRCode image link URL\"\n        },\n        \"additionalInfo\": [\n          {\n            \"key\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"key\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"pixKey\": \"<string>\",\n        \"createdAt\": \"<string>\",\n        \"updatedAt\": \"<string>\",\n        \"expiresIn\": \"<string>\"\n      },\n      \"value\": \"<number>\",\n      \"time\": \"<string>\",\n      \"endToEndID\": \"<string>\",\n      \"transactionID\": \"<string>\",\n      \"infoPagador\": \"<string>\",\n      \"endToEndId\": \"<string>\",\n      \"customer\": {\n        \"name\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"<string>\"\n        },\n        \"correlationID\": \"<string>\",\n        \"address\": {\n          \"zipcode\": \"<string>\",\n          \"street\": \"<string>\",\n          \"number\": \"<string>\",\n          \"neighborhood\": \"<string>\",\n          \"city\": \"<string>\",\n          \"state\": \"<string>\",\n          \"complement\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      },\n      \"withdraw\": {\n        \"value\": \"<number>\",\n        \"time\": \"<string>\",\n        \"endToEndID\": \"<string>\",\n        \"transactionID\": \"<string>\",\n        \"infoPagador\": \"<string>\",\n        \"endToEndId\": \"<string>\",\n        \"payer\": {\n          \"name\": \"<string>\",\n          \"email\": \"<string>\",\n          \"phone\": \"<string>\",\n          \"taxID\": {\n            \"taxID\": \"<string>\",\n            \"type\": \"<string>\"\n          },\n          \"correlationID\": \"<string>\",\n          \"address\": {\n            \"zipcode\": \"<string>\",\n            \"street\": \"<string>\",\n            \"number\": \"<string>\",\n            \"neighborhood\": \"<string>\",\n            \"city\": \"<string>\",\n            \"state\": \"<string>\",\n            \"complement\": \"<string>\",\n            \"country\": \"<string>\"\n          }\n        },\n        \"type\": \"<string>\"\n      },\n      \"payer\": {\n        \"name\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"<string>\"\n        },\n        \"correlationID\": \"<string>\",\n        \"address\": {\n          \"zipcode\": \"<string>\",\n          \"street\": \"<string>\",\n          \"number\": \"<string>\",\n          \"neighborhood\": \"<string>\",\n          \"city\": \"<string>\",\n          \"state\": \"<string>\",\n          \"complement\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      },\n      \"type\": \"PAYMENT\",\n      \"globalID\": {\n        \"description\": \"External ID of this transaction\"\n      },\n      \"pixQrCode\": {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\",\n        \"comment\": \"<string>\",\n        \"identifier\": \"<string>\",\n        \"brCode\": \"<string>\",\n        \"correlationID\": \"<string>\",\n        \"paymentLinkID\": \"<string>\",\n        \"paymentLinkUrl\": {\n          \"description\": \"Payment Link URL to be shared with customers\"\n        },\n        \"qrCodeImage\": {\n          \"description\": \"QRCode image link URL\"\n        },\n        \"createdAt\": \"<string>\",\n        \"updatedAt\": \"<string>\"\n      }\n    },\n    {\n      \"charge\": {\n        \"value\": \"<number>\",\n        \"customer\": {\n          \"name\": \"<string>\",\n          \"email\": \"<string>\",\n          \"phone\": \"<string>\",\n          \"taxID\": {\n            \"taxID\": \"<string>\",\n            \"type\": \"<string>\"\n          },\n          \"correlationID\": \"<string>\",\n          \"address\": {\n            \"zipcode\": \"<string>\",\n            \"street\": \"<string>\",\n            \"number\": \"<string>\",\n            \"neighborhood\": \"<string>\",\n            \"city\": \"<string>\",\n            \"state\": \"<string>\",\n            \"complement\": \"<string>\",\n            \"country\": \"<string>\"\n          }\n        },\n        \"type\": \"OVERDUE\",\n        \"comment\": \"<string>\",\n        \"brCode\": \"<string>\",\n        \"status\": \"ACTIVE\",\n        \"correlationID\": \"<string>\",\n        \"paymentLinkID\": \"<string>\",\n        \"paymentLinkUrl\": {\n          \"description\": \"Payment Link URL to be shared with customers\"\n        },\n        \"globalID\": {\n          \"description\": \"External ID of this charge\"\n        },\n        \"transactionID\": {\n          \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n        },\n        \"identifier\": \"<string>\",\n        \"qrCodeImage\": {\n          \"description\": \"QRCode image link URL\"\n        },\n        \"additionalInfo\": [\n          {\n            \"key\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"key\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"pixKey\": \"<string>\",\n        \"createdAt\": \"<string>\",\n        \"updatedAt\": \"<string>\",\n        \"expiresIn\": \"<string>\"\n      },\n      \"value\": \"<number>\",\n      \"time\": \"<string>\",\n      \"endToEndID\": \"<string>\",\n      \"transactionID\": \"<string>\",\n      \"infoPagador\": \"<string>\",\n      \"endToEndId\": \"<string>\",\n      \"customer\": {\n        \"name\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"<string>\"\n        },\n        \"correlationID\": \"<string>\",\n        \"address\": {\n          \"zipcode\": \"<string>\",\n          \"street\": \"<string>\",\n          \"number\": \"<string>\",\n          \"neighborhood\": \"<string>\",\n          \"city\": \"<string>\",\n          \"state\": \"<string>\",\n          \"complement\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      },\n      \"withdraw\": {\n        \"value\": \"<number>\",\n        \"time\": \"<string>\",\n        \"endToEndID\": \"<string>\",\n        \"transactionID\": \"<string>\",\n        \"infoPagador\": \"<string>\",\n        \"endToEndId\": \"<string>\",\n        \"payer\": {\n          \"name\": \"<string>\",\n          \"email\": \"<string>\",\n          \"phone\": \"<string>\",\n          \"taxID\": {\n            \"taxID\": \"<string>\",\n            \"type\": \"<string>\"\n          },\n          \"correlationID\": \"<string>\",\n          \"address\": {\n            \"zipcode\": \"<string>\",\n            \"street\": \"<string>\",\n            \"number\": \"<string>\",\n            \"neighborhood\": \"<string>\",\n            \"city\": \"<string>\",\n            \"state\": \"<string>\",\n            \"complement\": \"<string>\",\n            \"country\": \"<string>\"\n          }\n        },\n        \"type\": \"<string>\"\n      },\n      \"payer\": {\n        \"name\": \"<string>\",\n        \"email\": \"<string>\",\n        \"phone\": \"<string>\",\n        \"taxID\": {\n          \"taxID\": \"<string>\",\n          \"type\": \"<string>\"\n        },\n        \"correlationID\": \"<string>\",\n        \"address\": {\n          \"zipcode\": \"<string>\",\n          \"street\": \"<string>\",\n          \"number\": \"<string>\",\n          \"neighborhood\": \"<string>\",\n          \"city\": \"<string>\",\n          \"state\": \"<string>\",\n          \"complement\": \"<string>\",\n          \"country\": \"<string>\"\n        }\n      },\n      \"type\": \"FEE\",\n      \"globalID\": {\n        \"description\": \"External ID of this transaction\"\n      },\n      \"pixQrCode\": {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\",\n        \"comment\": \"<string>\",\n        \"identifier\": \"<string>\",\n        \"brCode\": \"<string>\",\n        \"correlationID\": \"<string>\",\n        \"paymentLinkID\": \"<string>\",\n        \"paymentLinkUrl\": {\n          \"description\": \"Payment Link URL to be shared with customers\"\n        },\n        \"qrCodeImage\": {\n          \"description\": \"QRCode image link URL\"\n        },\n        \"createdAt\": \"<string>\",\n        \"updatedAt\": \"<string>\"\n      }\n    }\n  ],\n  \"pageInfo\": {\n    \"errors\": [\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      },\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      }\n    ],\n    \"skip\": \"<number>\",\n    \"limit\": \"<number>\",\n    \"totalCount\": \"<number>\",\n    \"hasPreviousPage\": \"<boolean>\",\n    \"hasNextPage\": \"<boolean>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8c9c5ff7-58f4-4b5d-aba6-427695d7475a","name":"An error message","originalRequest":{"url":{"path":["api","v1","transaction"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"start","value":"<dateTime>"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"end","value":"<dateTime>"},{"disabled":false,"description":{"content":"You can use the charge ID or correlation ID or transaction ID of charge to get a list of transactions related of this transaction","type":"text/plain"},"key":"charge","value":"<string>"},{"disabled":false,"description":{"content":"You can use the QrCode static ID or correlation ID or identifier field of QrCode static to get a list of QrCode related of this transaction","type":"text/plain"},"key":"pixQrCode","value":"<string>"},{"disabled":false,"description":{"content":"You can use the ID or EndToEndId of a withdrawal transaction to get all transactions related to the withdrawal","type":"text/plain"},"key":"withdrawal","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"transfer","description":"","item":[{"id":"2138743d-bbe8-48fe-be4e-33505c52c70f","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\": \"<number>\",\n  \"fromPixKey\": \"<string>\",\n  \"toPixKey\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"bff23d95-1e4c-46ea-a8c0-00f96dde4c1c","name":"Transfer transaction information","originalRequest":{"url":{"path":["api","v1","transfer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\",\n  \"fromPixKey\": \"<string>\",\n  \"toPixKey\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"transaction\": {\n    \"value\": \"<number>\",\n    \"time\": \"<string>\",\n    \"correlationID\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"21eaaf87-6b59-47ac-bc4c-0d70159a53c8","name":"An error message","originalRequest":{"url":{"path":["api","v1","transfer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\",\n  \"fromPixKey\": \"<string>\",\n  \"toPixKey\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"webhook","description":"","item":[{"name":"{id}","description":"","item":[{"id":"74a69d47-5163-4b27-acd3-73f9e113e199","name":"Delete a Webhook","request":{"name":"Delete a Webhook","description":{"content":"Endpoint to delete a Webhook","type":"text/plain"},"url":{"path":["api","v1","webhook",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) webhook ID","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{},"auth":null},"response":[{"id":"6b090354-18d5-4950-ae82-1791dc432b2d","name":"Webhook ID and also the status code","originalRequest":{"url":{"path":["api","v1","webhook",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"status\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d2c47533-53e4-42c5-801d-fe24dd393081","name":"An error message","originalRequest":{"url":{"path":["api","v1","webhook",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"DELETE","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\",\n  \"status\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"fd0c14ef-c3c1-4349-9ccf-01b8cf0fdf16","name":"Get a list of webhooks","request":{"name":"Get a list of webhooks","description":{},"url":{"path":["api","v1","webhook"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"You can use the url to filter all webhooks","type":"text/plain"},"key":"url","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"25776c08-3924-476d-9d87-4f41fe7ced20","name":"A list of webhooks","originalRequest":{"url":{"path":["api","v1","webhook"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"You can use the url to filter all webhooks","type":"text/plain"},"key":"url","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"webhooks\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"event\": \"OPENPIX:TRANSACTION_RECEIVED\",\n      \"url\": \"<string>\",\n      \"authorization\": \"<string>\",\n      \"isActive\": \"<boolean>\",\n      \"createdAt\": \"<string>\",\n      \"updatedAt\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"event\": \"OPENPIX:CHARGE_CREATED\",\n      \"url\": \"<string>\",\n      \"authorization\": \"<string>\",\n      \"isActive\": \"<boolean>\",\n      \"createdAt\": \"<string>\",\n      \"updatedAt\": \"<string>\"\n    }\n  ],\n  \"pageInfo\": {\n    \"errors\": [\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      },\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      }\n    ]\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"907d933d-eb23-4148-8ea2-24256bb9c79d","name":"An error message","originalRequest":{"url":{"path":["api","v1","webhook"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"You can use the url to filter all webhooks","type":"text/plain"},"key":"url","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"42271a85-bec2-4e91-9938-de636b77ad9e","name":"Create a new Webhook","request":{"name":"Create a new Webhook","description":{"content":"Endpoint to create a new Webhook","type":"text/plain"},"url":{"path":["api","v1","webhook"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"webhook\": {\n    \"name\": \"<string>\",\n    \"event\": \"OPENPIX:CHARGE_COMPLETED\",\n    \"url\": \"<string>\",\n    \"authorization\": \"<string>\",\n    \"isActive\": \"<boolean>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"5e7e127c-5659-4e67-b000-442b0ffe9c5f","name":"Webhook created specific event when receives a new pix transaction","originalRequest":{"url":{"path":["api","v1","webhook"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"webhook\": {\n    \"name\": \"<string>\",\n    \"event\": \"OPENPIX:CHARGE_COMPLETED\",\n    \"url\": \"<string>\",\n    \"authorization\": \"<string>\",\n    \"isActive\": \"<boolean>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"webhook\": {\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"event\": \"OPENPIX:CHARGE_CREATED\",\n    \"url\": \"<string>\",\n    \"authorization\": \"<string>\",\n    \"isActive\": \"<boolean>\",\n    \"createdAt\": \"<string>\",\n    \"updatedAt\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0485c731-3ccf-481b-8561-bbcb79a9c473","name":"An error message","originalRequest":{"url":{"path":["api","v1","webhook"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"webhook\": {\n    \"name\": \"<string>\",\n    \"event\": \"OPENPIX:CHARGE_COMPLETED\",\n    \"url\": \"<string>\",\n    \"authorization\": \"<string>\",\n    \"isActive\": \"<boolean>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"subaccount","description":"","item":[{"name":"{id}","description":"","item":[{"name":"withdraw","description":"","item":[{"id":"58576c06-c942-45fe-8c76-91836061ff2a","name":"Withdraw from a Sub Account","request":{"name":"Withdraw from a Sub Account","description":{"content":"Withdraw from a Sub Account and return the withdrawal transaction information","type":"text/plain"},"url":{"path":["api","v1","subaccount",":id","withdraw"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) pix key registered to the subaccount","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","body":{},"auth":null},"response":[{"id":"b8299eb9-cf43-4bd8-962b-a7810be68cfb","name":"Withdrawal Transaction information","originalRequest":{"url":{"path":["api","v1","subaccount",":id","withdraw"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"withdraw\": {\n    \"account\": {\n      \"status\": \"<string>\",\n      \"value\": \"<number>\",\n      \"correlationID\": \"<string>\",\n      \"destinationAlias\": \"<string>\",\n      \"comment\": \"<string>\"\n    }\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"bb8f76a2-63a8-40c6-a4f7-a5ce16041e3e","name":"An error message","originalRequest":{"url":{"path":["api","v1","subaccount",":id","withdraw"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"612d0366-5910-41d1-99cd-2a5a9964cd43","name":"Get subaccount details","request":{"name":"Get subaccount details","description":{},"url":{"path":["api","v1","subaccount",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<string>","key":"id","disabled":false,"description":{"content":"(Required) pix key registered to the subaccount","type":"text/plain"}}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"3867efc9-5c16-41ff-b559-374f26d7ba93","name":"The Subccount retrieve using the given pix key","originalRequest":{"url":{"path":["api","v1","subaccount",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"SubAccount\": {\n    \"name\": \"<string>\",\n    \"pixKey\": \"<string>\",\n    \"balance\": \"<number>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"05f5100f-9412-4621-8e95-266206b9a40f","name":"An error message","originalRequest":{"url":{"path":["api","v1","subaccount",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"id":"1afad591-6459-416c-97a3-79e98eef0d74","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":"fa100a6f-7a39-4615-aa73-90dbc9631e9f","name":"A list of subaccounts","originalRequest":{"url":{"path":["api","v1","subaccount"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"status\": \"<string>\",\n  \"subaccounts\": [\n    {\n      \"payment\": {\n        \"name\": \"<string>\",\n        \"pixKey\": \"<string>\",\n        \"balance\": \"<number>\"\n      }\n    },\n    {\n      \"payment\": {\n        \"name\": \"<string>\",\n        \"pixKey\": \"<string>\",\n        \"balance\": \"<number>\"\n      }\n    }\n  ],\n  \"pageInfo\": {\n    \"errors\": [\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      },\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      }\n    ],\n    \"skip\": \"<number>\",\n    \"limit\": \"<number>\",\n    \"totalCount\": \"<number>\",\n    \"hasPreviousPage\": \"<boolean>\",\n    \"hasNextPage\": \"<boolean>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0b10800d-abc7-49a5-ae96-189a98d6f962","name":"An error message","originalRequest":{"url":{"path":["api","v1","subaccount"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"71ac5a25-c4f5-4a6b-bca8-ac0540270c03","name":"Create a subaccount","request":{"name":"Create a subaccount","description":{},"url":{"path":["api","v1","subaccount"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"pixKey\": \"<string>\",\n  \"name\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"461b447f-3ce8-4d75-838e-0e107be62217","name":"The Subccount created or retrieved if exists using the given pix key","originalRequest":{"url":{"path":["api","v1","subaccount"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"pixKey\": \"<string>\",\n  \"name\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"SubAccount\": {\n    \"name\": \"<string>\",\n    \"pixKey\": \"<string>\",\n    \"balance\": \"<number>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"2fcc406b-38ff-4056-b05b-535bd80f999b","name":"An error message","originalRequest":{"url":{"path":["api","v1","subaccount"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"pixKey\": \"<string>\",\n  \"name\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]}]},{"name":"openpix","description":"","item":[{"name":"charge","description":"","item":[{"name":"brcode","description":"","item":[{"name":"image","description":"","item":[{"name":"{:id}.png?size=1024","description":"","item":[{"id":"2ee33d19-2014-4897-8436-d5959eebff77","name":"Get an image of Qr Code from a Charge","request":{"name":"Get an image of Qr Code from a Charge","description":{},"url":{"path":["openpix","charge","brcode","image","{{:id}}.png"],"host":["{{baseUrl}}"],"query":[{"key":"size","value":"1024"},{"disabled":false,"description":{"content":"Size for the image. This size should be between 600 and 4096. if the size parameter was not passed, the default value will be 1024.","type":"text/plain"},"key":"size","value":"<string>"}],"variable":[{"disabled":false,"description":{"content":"(Required) charge link payment ID","type":"text/plain"},"type":"any","value":"<string>","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"76434722-8569-47b5-a6d0-4a73c8a240f6","name":"The Qr Code image as MIME type","originalRequest":{"url":{"path":["openpix","charge","brcode","image","{{:id}}.png"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Size for the image. This size should be between 600 and 4096. if the size parameter was not passed, the default value will be 1024.","type":"text/plain"},"key":"size","value":"<string>"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[],"cookie":[],"_postman_previewlanguage":"text"},{"id":"0453b4f6-c2e4-464f-8d2a-917547d865b8","name":"An error message","originalRequest":{"url":{"path":["openpix","charge","brcode","image","{{:id}}.png"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Size for the image. This size should be between 600 and 4096. if the size parameter was not passed, the default value will be 1024.","type":"text/plain"},"key":"size","value":"<string>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]}]}]}]}]}],"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"{{apiKey}}","key":"value"},{"type":"any","value":"header","key":"in"}]},"event":[],"variable":[{"key":"baseUrl","value":"https://api.openpix.com.br"}],"info":{"_postman_id":"a36a44b6-f2fd-4d20-97e1-5ed1142d563e","name":"OpenPix","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json","description":{"content":"A OpenPix é uma Plataforma de Gestão de Pagamentos. Para utilizar nossa API você deve acessar  __[https://api.openpix.com.br/](https://api.openpix.com.br/)__ e somente o mesmo. A OpenPix não aceita subdominios para a API.\n\nVeja como configurar seu acesso a nossa API [aqui](https://developers.openpix.com.br/docs/apis/api-getting-started).","type":"text/plain"}}}
\ No newline at end of file