diff --git a/src/swaggers/openpix.json b/src/swaggers/openpix.json
index 3261315f..9d3dce1b 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"}}}},"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"}}}}}}},"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/{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":{"refund":{"type":"object","$ref":"#/components/schemas/Refund"}},"example":{"refund":{"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"},"example":{"value":100,"customer":{"name":"Dan","taxID":"31324227036","email":"email0@example.com","phone":"5511999999999"},"dayGenerateCharge":15}}}},"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: {name: 'string', email: 'string', phone: 'string', taxID: 'string'},\n  value: 0,\n  dayGenerateCharge: 5\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\"},\"value\":0,\"dayGenerateCharge\":5}'"},{"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\\\"},\\\"value\\\":0,\\\"dayGenerateCharge\\\":5}\",\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\\\"},\\\"value\\\":0,\\\"dayGenerateCharge\\\":5}\"\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\\\"},\\\"value\\\":0,\\\"dayGenerateCharge\\\":5}\")\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\\\"},\\\"value\\\":0,\\\"dayGenerateCharge\\\":5}\");\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\\\"},\\\"value\\\":0,\\\"dayGenerateCharge\\\":5}\"\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/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"}]}}},"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"]},"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."}}},"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}}},"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)"}}},"value":{"type":"number","description":"Value in cents of this subscription"},"dayGenerateCharge":{"type":"number","description":"Day of the month that the charges will be generated. Maximun of 27.","minimum":0,"maximum":27,"default":5}},"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"}}},"WebhookPayload":{"type":"object","properties":{"name":{"type":"number"},"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":"number"},"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"]},"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"},"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"}},"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":"webhook","description":"Endpoint to manage Webhooks\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}));\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"}}}},"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"}}}}}}},"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/{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":{"refund":{"type":"object","$ref":"#/components/schemas/Refund"}},"example":{"refund":{"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"},"example":{"value":100,"customer":{"name":"Dan","taxID":"31324227036","email":"email0@example.com","phone":"5511999999999"},"dayGenerateCharge":15}}}},"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: {name: 'string', email: 'string', phone: 'string', taxID: 'string'},\n  value: 0,\n  dayGenerateCharge: 5\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\"},\"value\":0,\"dayGenerateCharge\":5}'"},{"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\\\"},\\\"value\\\":0,\\\"dayGenerateCharge\\\":5}\",\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\\\"},\\\"value\\\":0,\\\"dayGenerateCharge\\\":5}\"\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\\\"},\\\"value\\\":0,\\\"dayGenerateCharge\\\":5}\")\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\\\"},\\\"value\\\":0,\\\"dayGenerateCharge\\\":5}\");\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\\\"},\\\"value\\\":0,\\\"dayGenerateCharge\\\":5}\"\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"}]}}},"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"]},"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."}}},"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}}},"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)"}}},"value":{"type":"number","description":"Value in cents of this subscription"},"dayGenerateCharge":{"type":"number","description":"Day of the month that the charges will be generated. Maximun of 27.","minimum":0,"maximum":27,"default":5}},"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":"number"},"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":"number"},"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"]},"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"},"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"}},"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"}]}
diff --git a/src/swaggers/openpix.yml b/src/swaggers/openpix.yml
index 765daff2..514b98f6 100644
--- a/src/swaggers/openpix.yml
+++ b/src/swaggers/openpix.yml
@@ -1994,6 +1994,48 @@ paths:
                 properties:
                   error:
                     type: string
+  /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
   '/api/v1/webhook/{id}':
     delete:
       tags:
@@ -3145,6 +3187,32 @@ components:
           $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:
@@ -3266,6 +3334,9 @@ tags:
   - name: transactions
     description: |
       Endpoint to manage Transactions
+  - name: transfer (request access)
+    description: |
+      Endpoint to transfer values between sub accounts.
   - name: webhook
     description: |
       Endpoint to manage Webhooks
diff --git a/static/openpixPostman.json b/static/openpixPostman.json
index 8a88604a..2e42cbe2 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":"e487c4fc-87e4-4244-8f07-7b05a9e832af","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":"3309dfb6-523b-46c7-8b45-4c5c5a3b4ffb","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":"6797aab0-c665-461d-a68b-5346e835cbd8","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":"5d2cf1b9-9677-46ee-a2e7-1903202b82db","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":"3adfa8a5-c0ca-4998-97cf-f545025379d6","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":"19d49f7d-2a70-47fe-96ca-8d3b12d01ac0","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":"4bdffcc6-e6eb-47ae-a53c-1172db4c1950","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":"2eb56921-f6f2-498e-b07a-53550c71ba17","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\": \"<number>\",\n      \"event\": \"OPENPIX:MOVEMENT_REMOVED\",\n      \"url\": \"<string>\",\n      \"authorization\": \"<string>\",\n      \"isActive\": \"<boolean>\",\n      \"createdAt\": \"<string>\",\n      \"updatedAt\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<number>\",\n      \"event\": \"OPENPIX:TRANSACTION_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":"744b6e03-88bc-47f3-a33b-73d2d9a0fdd8","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":"92c470b5-fae5-478c-ac96-b955f1f9641c","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\": \"<number>\",\n    \"event\": \"OPENPIX:MOVEMENT_FAILED\",\n    \"url\": \"<string>\",\n    \"authorization\": \"<string>\",\n    \"isActive\": \"<boolean>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"87e69603-076d-4c26-9fa6-428953f38e67","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\": \"<number>\",\n    \"event\": \"OPENPIX:MOVEMENT_FAILED\",\n    \"url\": \"<string>\",\n    \"authorization\": \"<string>\",\n    \"isActive\": \"<boolean>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"webhook\": {\n    \"id\": \"<string>\",\n    \"name\": \"<number>\",\n    \"event\": \"OPENPIX:TRANSACTION_REFUND_RECEIVED\",\n    \"url\": \"<string>\",\n    \"authorization\": \"<string>\",\n    \"isActive\": \"<boolean>\",\n    \"createdAt\": \"<string>\",\n    \"updatedAt\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b964ce34-805f-45ec-b55b-06af9178c927","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\": \"<number>\",\n    \"event\": \"OPENPIX:MOVEMENT_FAILED\",\n    \"url\": \"<string>\",\n    \"authorization\": \"<string>\",\n    \"isActive\": \"<boolean>\"\n  }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"Bad Request","code":400,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"error\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}]},{"name":"transaction","description":"","item":[{"name":"{id}","description":"","item":[{"id":"a67e4332-5ed6-4ce7-ba2b-9e38c3ce7fbb","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":"2b3160b6-efab-4485-a89f-d528b1248fa9","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":"4031ce77-7a84-4a2d-91d2-2c39270e1bd2","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":"723f0172-5ed3-4d26-84ba-e9d7d18f523f","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":"ec5c20ee-f071-460f-b7bf-3f35448466e7","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\": \"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\": \"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  \"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":"fa4f2413-6a54-4239-80e9-bc1ba372ba9e","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":"421ae917-0ab3-4c6e-926a-9b289b1ed0d9","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":"0d10487c-f4a1-4bb2-9f42-b9ca8c24ed49","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":"ce93a361-c24d-4a23-b448-4b9ab73374f9","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":"b4d2d75c-8e4a-4ff4-a3d5-3e369571a6e5","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  },\n  \"value\": \"<number>\",\n  \"dayGenerateCharge\": 5\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"66dc1885-0169-46db-9566-19b72c66e879","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  },\n  \"value\": \"<number>\",\n  \"dayGenerateCharge\": 5\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":"6ac50e59-e88e-468b-8e45-ba137f39a201","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  },\n  \"value\": \"<number>\",\n  \"dayGenerateCharge\": 5\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":"27a7b93d-0409-4d45-abdd-7a773ebb1d37","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":"a68ba2eb-44bc-416d-9962-36ef1d7a33fa","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  \"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":"d287cdc6-4c81-4ef8-b5f3-a41d9e1b9e3f","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":"688c9475-2f8a-4d12-906f-d90895a68eb6","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":"877dd1a8-1214-4eaa-93b4-aeb965b09a51","name":"A list of refunds","originalRequest":{"url":{"path":["api","v1","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"refunds\": [\n    {\n      \"value\": \"<number>\",\n      \"status\": \"REFUNDED\",\n      \"correlationID\": \"<string>\",\n      \"refundId\": \"<string>\",\n      \"time\": \"<string>\",\n      \"comment\": \"<string>\"\n    },\n    {\n      \"value\": \"<number>\",\n      \"status\": \"IN_PROCESSING\",\n      \"correlationID\": \"<string>\",\n      \"refundId\": \"<string>\",\n      \"time\": \"<string>\",\n      \"comment\": \"<string>\"\n    }\n  ],\n  \"pageInfo\": {\n    \"errors\": [\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      },\n      {\n        \"message\": \"<string>\",\n        \"data\": {\n          \"skip\": \"<number>\",\n          \"limit\": \"<number>\"\n        }\n      }\n    ],\n    \"skip\": \"<number>\",\n    \"limit\": \"<number>\",\n    \"totalCount\": \"<number>\",\n    \"hasPreviousPage\": \"<boolean>\",\n    \"hasNextPage\": \"<boolean>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9ce81d13-a748-4563-8e5f-a1d719f1507e","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":"2e4ad95c-28e1-42b5-9dcf-2a5f6dcfe99b","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":"3c0fdd98-7167-41c1-89c3-68324aec0852","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":"69602451-e1dc-4b68-8542-aee688416f0b","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":"e7e30ab7-82d7-4e66-84fb-300ae04a5935","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":"fc133f1d-e64e-40ed-9450-e49fb9adb3ab","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":"15da3372-c4ae-4b4f-a26f-c7b567f7c240","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":"73be6968-59a6-41b3-bbb3-bfd82115aa3e","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":"7a8b6a6f-d5bc-4ebc-9456-7fc4da5a33cc","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":"d7ed417b-06f8-4551-8f67-e9bb249c2dac","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":"e5731f03-be1b-45bc-ac99-8334bdecab56","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":"a2c7fda7-05da-435a-a89a-24655a71a48d","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":"63af475e-8769-4ba3-8d3b-83e18c10d1f9","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":"a9d77f3d-ecac-4904-a054-192a323c95f2","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":"8f1ce58f-5fce-4e90-88d0-1d2e99ad0fe3","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\": \"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":"93e0d59d-e069-44fa-83d0-632d76f0b7c5","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":"b6fea5b5-1a45-47ee-874b-13fc6ca4c918","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":"71a08d79-19e6-4bcc-81c5-085aa18f2ec0","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\": \"DENIED\",\n        \"sourceAccountId\": \"<string>\"\n      },\n      \"transaction\": {\n        \"value\": \"<number>\",\n        \"endToEndId\": \"<string>\",\n        \"time\": \"<string>\"\n      },\n      \"destination\": {\n        \"name\": \"<string>\",\n        \"taxID\": \"<string>\",\n        \"pixKey\": \"<string>\",\n        \"bank\": \"<string>\",\n        \"branch\": \"<string>\",\n        \"account\": \"<string>\"\n      }\n    },\n    {\n      \"payment\": {\n        \"value\": \"<number>\",\n        \"destinationAlias\": \"<string>\",\n        \"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  \"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":"ea58d6bd-12bd-4f1f-a8bd-a2320e66f15c","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":"df23be09-24f2-471f-b384-98988b3eff7d","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":"06cef6cf-7c6c-4289-9374-dd3f8cb251ae","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":"dc1afb0d-3e2f-4961-b20f-33306141cff4","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":"f6784720-dbbd-408e-8157-849b0e08abad","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":"301ac765-b248-48a1-8878-b533b582866c","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":"6840ab4f-17fe-4169-9206-92bb3e7b221e","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":"966d82ea-2d59-4228-9ce4-55585e588a06","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":"0dddd95f-bd21-4f23-8bdb-219d503a36cd","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":"fc7bad8e-8fc9-416e-8a6c-7cea7825a923","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":"e5170c18-97e7-462a-89b9-2356ba33639a","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":"f2c1a766-0658-4387-813c-010ca7f54fd6","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":"a8a08477-eacd-465b-8aa2-844170a92f9c","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":"77f150c0-952a-49e9-aa9c-0054f93262ba","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":"00a92e18-feb4-4554-acb4-f3d4a92d1856","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":"05a8f46b-8b42-439f-a05c-26d6dd9e0033","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":"87f16301-ca25-485a-86d2-6f3598b2332d","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\": \"ORACLE\",\n    \"clientId\": \"<string>\",\n    \"clientSecret\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"d524f642-4090-4927-8c00-d62541cdcbf9","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\": \"ORACLE\",\n    \"clientId\": \"<string>\",\n    \"clientSecret\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1f0e7aa9-88e8-4994-8483-a3d61db39c3c","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":"2029aca7-0856-4115-b7f1-d6fcc756fec1","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":"890d6859-cd36-49b8-a3ed-e329ebd66b27","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":"bc53ef2a-0ae1-466d-9a3b-1d508495d99a","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":"7834e338-3f5c-4d6a-8e51-39e37df9ed00","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":"a2766074-1e05-40cb-b561-790437c9c278","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":"d99709dc-2a32-4c6f-a342-f70247d47c7e","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":"3aa31bbd-08ef-4601-8853-fa462a58abb3","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":"87b7fe39-4cfd-4ed1-9e17-840a6e63fd1a","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":"b9e19f36-bcaa-47cb-afc6-049bea031aed","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":"f2157a1e-a625-4405-9b13-350987aee595","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":"e335073d-5443-44f8-a8a8-2529d49cb90a","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":"5ded7bf2-8a9d-4b45-8630-502fc576809b","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\": \"REJECTED\",\n      \"correlationID\": \"<string>\",\n      \"endToEndId\": \"<string>\",\n      \"time\": \"<string>\",\n      \"comment\": \"<string>\"\n    },\n    {\n      \"value\": \"<number>\",\n      \"status\": \"CONFIRMED\",\n      \"correlationID\": \"<string>\",\n      \"endToEndId\": \"<string>\",\n      \"time\": \"<string>\",\n      \"comment\": \"<string>\"\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"175ddcff-1d4d-4bca-ba2f-324fc59bff2e","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":"17ab8f43-b43f-42be-821a-c07458c1b5f0","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":"91e6b224-1f19-4b66-afbf-6a481772059b","name":"The created Refund","originalRequest":{"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"correlationID\": \"<string>\",\n  \"value\": \"<number>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"refund\": {\n    \"value\": \"<number>\",\n    \"status\": \"CONFIRMED\",\n    \"correlationID\": \"<string>\",\n    \"endToEndId\": \"<string>\",\n    \"time\": \"<string>\",\n    \"comment\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"cd644592-2b56-445f-b1a8-db42653e1efa","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":"b03f7b3a-ab3e-4e2c-84f5-33f6b43bd70c","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":"44542bc1-43f9-4cfc-be99-5972d9b83b25","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":"ebf4e530-a4bc-40f0-9458-d4b505e13b59","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":"8c3d2e09-60d5-42f4-a582-bb0fd4509347","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":"83c33b4d-6eb8-461d-8feb-de976177427f","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":"e1d260c5-e99b-48fe-930c-88632605b9e6","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":"d595bb65-cde1-44cf-8186-2f6c05805ff5","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":"3b31c6f3-a3a9-4e7a-b4ac-e5417e5daeef","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\": \"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\": \"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":"97dbad23-ffbb-4f1c-b19f-29f30b9b11f6","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":"cece2422-13c0-4ad2-a042-530aaee2a138","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\": \"OVERDUE\",\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":"951db5d8-5e66-45f7-a76a-dc13c9e1fc9a","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\": \"OVERDUE\",\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\": \"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":"c9b7dea6-4316-4a51-8fe1-53951b44f93f","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\": \"OVERDUE\",\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":"00a08a7b-52ad-40db-b51f-89a7bf8b1a0f","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":"40fb35b7-d06a-4859-a8e3-fe2838c4e70d","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":"d0f6113b-04ee-41a3-95b3-34b231dc211d","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":"07aec6b1-b3de-4436-bf44-29125e68338b","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":"96be2930-4651-4c35-889b-133356335195","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":"72051217-d863-4f8e-92da-6ad8ad13aee6","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":"800088e3-8994-4b7f-b9ff-e108c1b03993","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":"9530b654-8cfa-4800-ad2f-519f86a9d090","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":"f1030fa3-a126-4eb6-bdcc-0eba6439edcd","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":"9c86881b-c501-448c-a628-89e92ec3d33e","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":"3932684e-07d1-4a55-902e-c6c11ba680b8","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":"7bf83186-74bc-40b7-a330-f10cbfc5544f","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":"47268eb0-3a27-46fe-9441-a868c2fc78e0","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":"25687c6b-5a5a-44ed-8522-2f186e64e7ac","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":"74427ed9-7cf5-4981-9059-9bfe485e3274","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":"60a6404b-fe32-4437-8ced-d3a54d046d34","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":"421391d3-3937-4977-8491-bb54a5fff16f","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":"openpix","description":"","item":[{"name":"charge","description":"","item":[{"name":"brcode","description":"","item":[{"name":"image","description":"","item":[{"name":"{:id}.png?size=1024","description":"","item":[{"id":"b89e8c9b-b608-49e2-88b3-73cb95df9bd4","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":"d20a0622-f8c2-4437-8d70-1536b42b379c","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":"dfe6480d-d86f-40b2-8895-b0db973148c2","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":"28fa6688-45cc-44e4-8d9d-ccc539a29dde","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":"f0c5368f-2761-4529-8be4-a3ee66f3fa47","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":"f29aa27c-7a98-4668-8b24-4314124a04ed","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":"f95c7c2e-70d2-4a7c-86b6-bcb722ac0907","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":"a0446afc-bbc3-49ae-bde4-3f8d6e5c718a","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\": \"<number>\",\n      \"event\": \"OPENPIX:CHARGE_COMPLETED\",\n      \"url\": \"<string>\",\n      \"authorization\": \"<string>\",\n      \"isActive\": \"<boolean>\",\n      \"createdAt\": \"<string>\",\n      \"updatedAt\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<number>\",\n      \"event\": \"OPENPIX:MOVEMENT_CONFIRMED\",\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":"33499a6a-c4b2-4adc-8234-1361b64e3aad","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":"581d582c-7cc9-4eac-be0d-443a2e1c7c96","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\": \"<number>\",\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":"13b3fb55-d67e-4547-89ed-13a6df10485a","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\": \"<number>\",\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\": \"<number>\",\n    \"event\": \"OPENPIX:CHARGE_COMPLETED\",\n    \"url\": \"<string>\",\n    \"authorization\": \"<string>\",\n    \"isActive\": \"<boolean>\",\n    \"createdAt\": \"<string>\",\n    \"updatedAt\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1385e792-eb49-4b05-996d-dcd0cd7ee233","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\": \"<number>\",\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":"1863b7a4-5917-49a1-87e9-db6325935cc9","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":"b3977a09-84da-445c-a414-e13f894fe51e","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":"3a621422-f6b1-4f46-8191-1c7d93ea09a2","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":"fc8cf0d2-6e55-481e-9eb2-acf6852e54f1","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":"770b6aa8-8db7-45e5-8e1f-7509dfbbdf9d","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":"923a58bc-1e38-4e43-9a44-ca255dc4739b","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":"5b334fbf-1515-400f-a2c6-ef8bd6f2d179","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":"ce81eb5d-f680-42d8-a8f1-3cd93e061fdc","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\": \"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      \"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      \"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\": \"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":"0eea8937-8e3e-4469-bec2-4cbbec56612c","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":"17ce5f2e-263c-4768-8476-e491a3048bc1","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":"b6940406-6eb0-444c-9015-ff0b2581111a","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":"aa3979e9-d819-47a0-a8c5-510a08c6f7b9","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":"f21a5451-b07d-4b7a-8591-6ef857f0ab64","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  },\n  \"value\": \"<number>\",\n  \"dayGenerateCharge\": 5\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"auth":null},"response":[{"id":"9f9e8a42-ae57-42ab-b3b4-9729a833cc11","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  },\n  \"value\": \"<number>\",\n  \"dayGenerateCharge\": 5\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":"bf71ec82-3e99-4e22-a3a1-ac41f81bc6fc","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  },\n  \"value\": \"<number>\",\n  \"dayGenerateCharge\": 5\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":"8228b821-d682-4195-9c25-6b5ff89725d4","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":"ef614a42-949c-4921-b250-59802c808bb4","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  \"refund\": {\n    \"value\": \"<number>\",\n    \"status\": \"REFUNDED\",\n    \"correlationID\": \"<string>\",\n    \"refundId\": \"<string>\",\n    \"time\": \"<string>\",\n    \"comment\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"51227a7d-e9ec-4658-89bd-12c61086e666","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":"33b78289-bbb6-42a2-86ca-6db96755dde9","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":"787cba23-40f7-4af6-9c07-bf1af95100d5","name":"A list of refunds","originalRequest":{"url":{"path":["api","v1","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"refunds\": [\n    {\n      \"value\": \"<number>\",\n      \"status\": \"IN_PROCESSING\",\n      \"correlationID\": \"<string>\",\n      \"refundId\": \"<string>\",\n      \"time\": \"<string>\",\n      \"comment\": \"<string>\"\n    },\n    {\n      \"value\": \"<number>\",\n      \"status\": \"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":"11838b98-56da-413b-a3a7-05e35d66944e","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":"204559e2-a220-4001-b07a-b2285c63974a","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":"6f8e738b-b2f7-4f53-9672-461ab0f8e20c","name":"The created Refund","originalRequest":{"url":{"path":["api","v1","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"value\": \"<number>\",\n  \"transactionEndToEndId\": \"<string>\",\n  \"correlationID\": \"<string>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"refund\": {\n    \"value\": \"<number>\",\n    \"status\": \"REFUNDED\",\n    \"correlationID\": \"<string>\",\n    \"refundId\": \"<string>\",\n    \"time\": \"<string>\",\n    \"comment\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1327f808-1099-48d0-925a-2bf25aad666a","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":"52ea8e17-0077-41e3-b799-52907c6025fa","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":"0ba30f65-a553-4abf-947d-cddb354d6839","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":"f69b8e8f-7a3f-406a-85e2-7e61ea23c087","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":"b8ce5b35-d77a-413f-9449-19a352156a92","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":"ef26ca26-7f44-4da1-aeed-fcf5fab35d39","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":"75ee2088-a681-427f-9ec3-a6addf33653b","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":"f4fcada0-71de-4687-a418-ea6802f93de0","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":"15181304-2e34-4672-ac4f-ae235205123b","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":"9afe9d4e-60d2-4b48-8e2f-88651614e32d","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":"43714b9f-f1f0-470d-a694-a56c9f7495aa","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":"4cdfe095-142d-440c-9ba4-9f5c40c641cf","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\": \"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":"a4cd827d-5608-4cac-9b9d-1507599bda59","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":"3f28b766-c33f-4b29-ae53-4738b7fca17a","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":"fe9cfd2d-c05c-4b7f-bdd4-415e553e6a0f","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\": \"DENIED\",\n        \"sourceAccountId\": \"<string>\"\n      },\n      \"transaction\": {\n        \"value\": \"<number>\",\n        \"endToEndId\": \"<string>\",\n        \"time\": \"<string>\"\n      },\n      \"destination\": {\n        \"name\": \"<string>\",\n        \"taxID\": \"<string>\",\n        \"pixKey\": \"<string>\",\n        \"bank\": \"<string>\",\n        \"branch\": \"<string>\",\n        \"account\": \"<string>\"\n      }\n    },\n    {\n      \"payment\": {\n        \"value\": \"<number>\",\n        \"destinationAlias\": \"<string>\",\n        \"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":"c24255db-668c-44e6-8de2-44b9c0835f7c","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":"2dd70d95-a1ec-4e74-b11b-4a2cb3d895f1","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":"255e795d-561c-4679-a1d8-af7e72cadd36","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":"c2a1af07-c924-42d3-8e1f-982407995d0e","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":"4976b8ce-6c34-4414-ba89-2e6aa6e97f92","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":"00095e11-a99e-4477-ae79-adaa3513ebe1","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":"2549cd35-bf2c-4da3-9a82-00a91a27bbfd","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":"5b4fb32e-a615-4504-8f87-911c5b3eede0","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":"70015149-44e3-432e-be07-19978b47dbee","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":"6eb0f683-280b-4580-8bef-2026d1d69ecb","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":"31eeec36-7fa3-472a-a017-ff28fa7fadc7","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":"2e26e169-e68a-49cd-9ceb-64317408a110","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":"a57a0330-1458-4c07-bd6e-05d70cef5263","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":"e45dbddd-28d2-4d86-9706-0eac796b8e43","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":"0146f9eb-ab79-4f83-acf6-93c1ec36e27d","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":"4dd0db5b-6936-47a2-9dd3-050b15593f89","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":"1d297590-b81c-4118-be86-8772c8700852","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\": \"API\",\n    \"clientId\": \"<string>\",\n    \"clientSecret\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9ee9bbc2-57be-4bcc-9c08-74bd7bf3a31f","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\": \"API\",\n    \"clientId\": \"<string>\",\n    \"clientSecret\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8ad1119f-ff75-4d0f-bb26-ce5550541040","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":"b8aaff49-d2bc-42fc-b3f2-898d71942284","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":"28e29c95-9c23-4e5d-b339-e6039e58604d","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":"bd130e58-2a70-410d-ba0f-5caf5d83751d","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":"a5f9093d-1fa0-45da-a360-ffeed0b9b2a0","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":"b83c2a1e-45d2-43d0-a31d-c219d4a47e44","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":"c88075bf-8708-45dd-bd68-5b18fefe4fe4","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":"3ad052e4-cced-4100-adbc-a328afd89ab1","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":"d1875c52-d84e-42f9-9f64-bc9e29c45208","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":"ae4e66b6-eb5c-42f2-8bba-7c849a6b88d0","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":"70fa2b94-6a2f-47cb-afbf-7aa2c962afeb","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":"8106b53a-6983-4206-b47e-8d656fa73756","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":"63f1e216-91e3-4680-9abc-ecf459537121","name":"A list of refunds","originalRequest":{"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"refunds\": [\n    {\n      \"value\": \"<number>\",\n      \"status\": \"IN_PROCESSING\",\n      \"correlationID\": \"<string>\",\n      \"endToEndId\": \"<string>\",\n      \"time\": \"<string>\",\n      \"comment\": \"<string>\"\n    },\n    {\n      \"value\": \"<number>\",\n      \"status\": \"REJECTED\",\n      \"correlationID\": \"<string>\",\n      \"endToEndId\": \"<string>\",\n      \"time\": \"<string>\",\n      \"comment\": \"<string>\"\n    }\n  ]\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8a63892a-8a95-43d2-8749-92169c70540d","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":"a3c6df2c-8164-4c3c-b505-d895bf65167c","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":"0ec823b9-8dc0-4488-aa99-fe79ead8be00","name":"The created Refund","originalRequest":{"url":{"path":["api","v1","charge",":id","refund"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"correlationID\": \"<string>\",\n  \"value\": \"<number>\",\n  \"comment\": \"<string>\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"refund\": {\n    \"value\": \"<number>\",\n    \"status\": \"CONFIRMED\",\n    \"correlationID\": \"<string>\",\n    \"endToEndId\": \"<string>\",\n    \"time\": \"<string>\",\n    \"comment\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"f9b9f777-5fcf-479a-8c8d-fe9023510fb4","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":"d6cf0fed-8412-40a9-8d4e-91020b066cf1","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":"c20de957-b0e2-4dbf-b037-6044798e9838","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":"b5bd9de5-7f2e-45a7-82fd-c943bb8e6ceb","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":"62387a34-4970-484e-bc84-681b96b68405","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":"e3fbd0b8-b8b2-48a2-82b9-2437211b14b2","name":"The charge retrieve using the given ID","originalRequest":{"url":{"path":["api","v1","charge",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"},{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"Authorization","value":"<API Key>"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"charge\": {\n    \"value\": \"<number>\",\n    \"customer\": {\n      \"name\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"taxID\": {\n        \"taxID\": \"<string>\",\n        \"type\": \"<string>\"\n      },\n      \"correlationID\": \"<string>\",\n      \"address\": {\n        \"zipcode\": \"<string>\",\n        \"street\": \"<string>\",\n        \"number\": \"<string>\",\n        \"neighborhood\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"complement\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    },\n    \"type\": \"OVERDUE\",\n    \"comment\": \"<string>\",\n    \"brCode\": \"<string>\",\n    \"status\": \"ACTIVE\",\n    \"correlationID\": \"<string>\",\n    \"paymentLinkID\": \"<string>\",\n    \"paymentLinkUrl\": {\n      \"description\": \"Payment Link URL to be shared with customers\"\n    },\n    \"globalID\": {\n      \"description\": \"External ID of this charge\"\n    },\n    \"transactionID\": {\n      \"description\": \"unique uuid used as the txid from Pix into the provider from your openpix account. This field link the charge with the transaction when paid.\"\n    },\n    \"identifier\": \"<string>\",\n    \"qrCodeImage\": {\n      \"description\": \"QRCode image link URL\"\n    },\n    \"additionalInfo\": [\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"pixKey\": \"<string>\",\n    \"createdAt\": \"<string>\",\n    \"updatedAt\": \"<string>\",\n    \"expiresIn\": \"<string>\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"0850b726-869f-44ea-bf11-d5d711639b80","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":"fbdd530f-11d7-46eb-9ef5-ac2c5f0e785f","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":"ACTIVE"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","body":{},"auth":null},"response":[{"id":"53ab42e3-e6ca-409c-8601-d9b36904a71d","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":"ACTIVE"}],"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\": \"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  \"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":"4351141f-f57f-411b-94d6-fcdb2d5b91b3","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":"ACTIVE"}],"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":"f82d1c60-da3d-45ab-a2ad-a41d266b6c10","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\": \"OVERDUE\",\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":"ec9f7a26-38b4-475b-adcd-c15f6735a44e","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\": \"OVERDUE\",\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\": \"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  \"correlationID\": \"<string>\",\n  \"brCode\": \"<string>\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a35f05bc-882f-4a66-8208-a6fa05559d56","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\": \"OVERDUE\",\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":"d37c3175-f553-4061-a2e0-3d6919e3a672","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":"e2c8b039-11e8-49ca-a03e-c7649657186b","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":"6a9ba3f7-0e85-439c-a8ee-48f98906ab8d","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":"e4cdb709-1d69-42b4-b7ae-d57f904653d9","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":"6ad53843-cd91-4465-b444-0c3ef060a61d","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":"22b7b56b-a7e9-4392-a56c-a384c9120cc7","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":"9007120f-755e-4ba9-9fbf-7fa9c5e57537","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":"420f7c00-0d58-4eaf-a68e-8f8fcc5d8496","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":"1a2e4057-8114-41ce-a83e-21509914ca9a","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":"d4ba08ae-c690-49c1-950a-db4b61c91689","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":"c530baec-2a36-40c4-a035-14321427122f","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":"07c6f6b4-c0a3-4862-bbbf-fd48797c82eb","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":"31b247af-4f4a-4910-95f4-b189c8276c12","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":"40d82b44-68f9-4c1d-9a91-94e673195d33","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":"e35e1fae-9d7b-4eea-8852-098cd7834ee0","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":"bfb3e45b-77a0-40c9-b113-4763b1d8202a","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":"2f5e57c3-6251-40f4-96e0-04b6b29be8d6","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