{"info":{"_postman_id":"0a84ae49-2fe7-4016-8261-c6bbcc9b03e6","name":"[IOPAY] Link de Pagamento V2","description":"<html><head></head><body><p>Collection oficial para integração com Links de Pagamento da IOPAY. Inclui criação, criação com banner, consulta, atualização, exclusão, listagem e consulta de transações. Todas as requisições usam autenticação Bearer herdada da collection.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"42214416","collectionId":"0a84ae49-2fe7-4016-8261-c6bbcc9b03e6","publishedId":"2sBYB4LSRS","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"58016E","highlight":"330A61"},"publishDate":"2026-09-28T21:21:24.000Z"},"item":[{"name":"Criar Link de Pagamento","event":[{"listen":"test","script":{"type":"text/javascript","exec":["if (pm.response.code === 201) {\n    const body = pm.response.json();\n    if (body.id) pm.environment.set('ID_LINK', body.id);\n}"]}}],"id":"c63a17dc-389e-4204-bda2-abd2f2503d01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"title\": \"Pedido #1001\",\n  \"description\": \"Compra de produtos diversos\",\n  \"status\": \"enabled\",\n  \"open_at\": null,\n  \"end_at\": null,\n\n  \"max_payments\": 1,\n  \"max_installment\": 3,\n  \"highlight_installment_condition\": true,\n\n  \"enabled_payment_methods\": {\n    \"credit\": true,\n    \"pix\": true,\n    \"boleto\": true\n  },\n\n  \"pass_interest_to_customer\": true,\n  \"customer_interest_starts_at_installment\": 1,\n\n  \"primary_color\": \"4099b4\",\n\n  \"items\": [\n    {\n      \"name\": \"Produto principal\",\n      \"amount\": 60000\n    }\n  ],\n\n  \"order_bump_items\": [\n    {\n      \"name\": \"Garantia estendida\",\n      \"amount\": 15000\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.iopay.com.br/api/v2/payment_link","description":"<p>Cria um Link de Pagamento.</p>\n<h3 id=\"valores\">Valores</h3>\n<ul>\n<li><p><code>items[\\*].amount</code> e <code>order_bump_items[\\*].amount</code> são informados em <strong>centavos</strong>.</p>\n</li>\n<li><p>O valor principal do link é calculado pela soma de <code>items</code>.</p>\n</li>\n<li><p>Order Bumps não entram no valor inicial do link.</p>\n</li>\n</ul>\n<h3 id=\"disponibilidade\">Disponibilidade</h3>\n<ul>\n<li><p><code>open_at</code> e <code>end_at</code> recebem timestamp Unix.</p>\n</li>\n<li><p>Use <code>null</code> ou omita quando não houver restrição.</p>\n</li>\n</ul>\n<h3 id=\"limite-e-parcelamento\">Limite e parcelamento</h3>\n<ul>\n<li><p><code>max_payments: -1</code> ou omitido = ilimitado.</p>\n</li>\n<li><p><code>max_payments: 1</code> = uma única venda.</p>\n</li>\n<li><p><code>max_installment</code> aceita de 1 a 12, respeitando a configuração da conta.</p>\n</li>\n<li><p><code>highlight_installment_condition</code> destaca a condição de parcelamento no checkout.</p>\n</li>\n</ul>\n<h3 id=\"meios-de-pagamento\">Meios de pagamento</h3>\n<p>Envie os métodos dentro de <code>enabled_payment_methods</code>.</p>\n<ul>\n<li><p><code>credit</code>, <code>pix</code>, <code>boleto</code></p>\n</li>\n<li><p><code>debit</code> não está disponível para Links de Pagamento.</p>\n</li>\n<li><p>Pelo menos um método precisa estar habilitado.</p>\n</li>\n<li><p>O método também precisa estar liberado para a conta autenticada.</p>\n</li>\n</ul>\n<h3 id=\"juros\">Juros</h3>\n<ul>\n<li><p><code>pass_interest_to_customer: true</code> repassa ao comprador a cobrança de juros do parcelamento.</p>\n</li>\n<li><p><code>customer_interest_starts_at_installment</code> define a partir de qual parcela o repasse começa e deve estar entre 1 e <code>max_installment</code>.</p>\n</li>\n</ul>\n<h3 id=\"aparência\">Aparência</h3>\n<ul>\n<li><p><code>primary_color</code> recebe uma cor hexadecimal com 6 caracteres, com ou sem <code>#</code>.</p>\n</li>\n<li><p>Se omitido ou <code>null</code>, o checkout usa o tema padrão de alta conversão.</p>\n</li>\n</ul>\n<h3 id=\"order-bump\">Order Bump</h3>\n<p>Use <code>order_bump_items</code> para produtos opcionais oferecidos no checkout.</p>\n<h3 id=\"split\">Split</h3>\n<p><code>split_rules</code> está disponível apenas para contas habilitadas para esse recurso.</p>\n<ul>\n<li><p><code>type: \"percents\"</code>: percentual entre 0.5 e 85, em passos de 0.5.</p>\n</li>\n<li><p><code>type: \"fixed\"</code>: valor em unidade monetária. Ex.: <code>25.50</code> = R$ 25,50.</p>\n</li>\n<li><p>Cada recebedor pode aparecer apenas uma vez.</p>\n</li>\n</ul>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"0a84ae49-2fe7-4016-8261-c6bbcc9b03e6","id":"0a84ae49-2fe7-4016-8261-c6bbcc9b03e6","name":"[IOPAY] Link de Pagamento V2","type":"collection"}},"urlObject":{"path":["v2","payment_link"],"host":["https://api.iopay.com.br/api"],"query":[],"variable":[]}},"response":[{"id":"ae7899f0-a022-44bf-b36f-48e75b7435f9","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{PRIVATE_BEARER_TOKEN}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"title\": \"Pedido #1001\",\n  \"description\": \"Compra de produtos diversos\",\n  \"status\": \"enabled\",\n  \"open_at\": null,\n  \"end_at\": null,\n\n  \"max_payments\": 1,\n  \"max_installment\": 3,\n  \"highlight_installment_condition\": true,\n\n  \"enabled_payment_methods\": {\n    \"credit\": true,\n    \"pix\": true,\n    \"boleto\": true\n  },\n\n  \"pass_interest_to_customer\": true,\n  \"customer_interest_starts_at_installment\": 1,\n\n  \"primary_color\": \"4099b4\",\n\n  \"items\": [\n    {\n      \"name\": \"Produto principal\",\n      \"amount\": 60000\n    }\n  ],\n\n  \"order_bump_items\": [\n    {\n      \"name\": \"Garantia estendida\",\n      \"amount\": 15000\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.iopay.com.br/api/v2/payment_link"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n  \"id\": \"7ec2d0dc-5fa8-4ec5-89e4-4ff990098762\",\n  \"io_seller_id\": \"953a51ba3120431d0f2efb4ef47680a6\",\n  \"iopay_link\": \"https://link.iopay.cloud/v3/link/7ec2d0dc-5fa8-4ec5-89e4-4ff990098762\",\n  \"title\": \"Pedido #1001\",\n  \"description\": \"Compra de produtos diversos\",\n  \"currency\": \"BRL\",\n  \"amount\": 60000,\n  \"status\": \"enabled\",\n  \"open_at\": null,\n  \"end_at\": null,\n  \"max_payments\": 1,\n  \"max_installment\": 3,\n  \"highlight_installment_condition\": true,\n  \"enabled_payment_methods\": {\n    \"credit\": true,\n    \"debit\": false,\n    \"pix\": true,\n    \"boleto\": true,\n    \"oxxo\": false,\n    \"stablecoin\": false\n  },\n  \"pass_interest_to_customer\": true,\n  \"customer_interest_starts_at_installment\": 1,\n  \"primary_color\": \"4099b4\",\n  \"banners\": {\n    \"left\": null,\n    \"right\": null\n  },\n  \"items\": [\n    {\n      \"id\": 101,\n      \"name\": \"Produto principal\",\n      \"amount\": 60000\n    }\n  ],\n  \"order_bump_items\": [\n    {\n      \"id\": 102,\n      \"name\": \"Garantia estendida\",\n      \"amount\": 15000\n    }\n  ],\n  \"split_rules\": [],\n  \"payments_count\": 0,\n  \"created_at\": \"2026-09-28T00:00:00.000000Z\",\n  \"updated_at\": \"2026-09-28T00:00:00.000000Z\"\n}"}],"_postman_id":"c63a17dc-389e-4204-bda2-abd2f2503d01"},{"name":"Criar Link com Banner","id":"0bc58039-4e51-4d03-ad79-dad1dfd6560e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"title","value":"Pedido com banner","type":"text"},{"key":"description","value":"Exemplo multipart com identidade visual","type":"text"},{"key":"status","value":"enabled","type":"text"},{"key":"max_payments","value":"1","type":"text"},{"key":"max_installment","value":"3","type":"text"},{"key":"highlight_installment_condition","value":"1","type":"text"},{"key":"enabled_payment_methods[credit]","value":"1","type":"text"},{"key":"enabled_payment_methods[pix]","value":"1","type":"text"},{"key":"enabled_payment_methods[boleto]","value":"1","type":"text"},{"key":"pass_interest_to_customer","value":"1","type":"text"},{"key":"customer_interest_starts_at_installment","value":"1","type":"text"},{"key":"primary_color","value":"4099b4","type":"text"},{"key":"items[0][name]","value":"Produto principal","type":"text"},{"key":"items[0][amount]","value":"60000","type":"text"},{"key":"order_bump_items[0][name]","value":"Garantia estendida","type":"text"},{"key":"order_bump_items[0][amount]","value":"15000","type":"text"},{"key":"banners[right]","type":"file","src":"/C:/Users/rarod/Downloads/89120a67-4f79-433f-92f1-a75c2c38908c-removebg-preview.png"}]},"url":"https://api.iopay.com.br/api/v2/payment_link","description":"<p>Cria um Link de Pagamento usando <code>multipart/form-data</code> e envia um banner opcional.</p>\n<p>Use <strong>apenas um</strong> dos campos:</p>\n<ul>\n<li><code>banners[left]</code></li>\n<li><code>banners[right]</code></li>\n</ul>\n<p>Formatos aceitos: JPEG, PNG e WebP.\nLimites: 5 MB, 4096×4096 e 16 MP.</p>\n<p>Não defina manualmente o header <code>Content-Type</code>; o Postman gera o <code>boundary</code> do multipart automaticamente.</p>\n<p>Os demais campos seguem as mesmas regras da criação em JSON. Arrays devem ser enviados usando notação de formulário, por exemplo:</p>\n<ul>\n<li><code>items[0][name]</code></li>\n<li><code>items[0][amount]</code></li>\n<li><code>enabled_payment_methods[credit]</code></li>\n</ul>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"0a84ae49-2fe7-4016-8261-c6bbcc9b03e6","id":"0a84ae49-2fe7-4016-8261-c6bbcc9b03e6","name":"[IOPAY] Link de Pagamento V2","type":"collection"}},"urlObject":{"path":["v2","payment_link"],"host":["https://api.iopay.com.br/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"0bc58039-4e51-4d03-ad79-dad1dfd6560e"},{"name":"Consultar Link pelo ID","id":"ab6c6419-0f5f-4158-8034-a634b5cdbabf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.iopay.com.br/api/v2/payment_link/{{ID_LINK}}","description":"<p>Retorna um Link de Pagamento pelo identificador.</p>\n<p>A resposta inclui:</p>\n<ul>\n<li>dados e status do link;</li>\n<li>URL pública do checkout;</li>\n<li>moeda e valor;</li>\n<li>limite de pagamentos e parcelamento;</li>\n<li>meios de pagamento habilitados;</li>\n<li>configuração de juros;</li>\n<li>aparência e banner;</li>\n<li>itens e Order Bumps;</li>\n<li>regras de split;</li>\n<li>quantidade de pagamentos realizados.</li>\n</ul>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"0a84ae49-2fe7-4016-8261-c6bbcc9b03e6","id":"0a84ae49-2fe7-4016-8261-c6bbcc9b03e6","name":"[IOPAY] Link de Pagamento V2","type":"collection"}},"urlObject":{"path":["v2","payment_link","{{ID_LINK}}"],"host":["https://api.iopay.com.br/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"ab6c6419-0f5f-4158-8034-a634b5cdbabf"},{"name":"Atualizar Link","id":"e6041321-c662-4b86-b1df-8b213c83c2d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Criação de site institucional — atualizado\",\n  \"status\": \"enabled\",\n  \"max_payments\": 3,\n  \"max_installment\": 6,\n  \"highlight_installment_condition\": true,\n  \"enabled_payment_methods\": {\n    \"credit\": true,\n    \"pix\": true,\n    \"boleto\": false\n  },\n  \"pass_interest_to_customer\": true,\n  \"customer_interest_starts_at_installment\": 2,\n  \"primary_color\": \"2563eb\",\n  \"items\": [\n    {\n      \"name\": \"Criação de site institucional\",\n      \"amount\": 65000\n    }\n  ],\n  \"order_bump_items\": []\n}","options":{"raw":{"language":"json"}}},"url":"https://api.iopay.com.br/api/v2/payment_link/{{ID_LINK}}","description":"<p>Atualiza parcialmente um Link de Pagamento.</p>\n<p>Somente os campos enviados são alterados.</p>\n<p>Regras importantes:</p>\n<ul>\n<li>Se <code>items</code> for enviado, os itens atuais são substituídos e o valor do link é recalculado.</li>\n<li><code>order_bump_items: []</code> remove todos os Order Bumps.</li>\n<li><code>split_rules: []</code> remove todas as regras de split.</li>\n<li><code>primary_color: null</code> restaura o tema padrão.</li>\n<li><code>open_at: null</code> ou <code>end_at: null</code> remove a respectiva restrição.</li>\n<li>Campos omitidos em <code>enabled_payment_methods</code> mantêm o valor atual.</li>\n</ul>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"0a84ae49-2fe7-4016-8261-c6bbcc9b03e6","id":"0a84ae49-2fe7-4016-8261-c6bbcc9b03e6","name":"[IOPAY] Link de Pagamento V2","type":"collection"}},"urlObject":{"path":["v2","payment_link","{{ID_LINK}}"],"host":["https://api.iopay.com.br/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"e6041321-c662-4b86-b1df-8b213c83c2d0"},{"name":"Deletar Link pelo ID","id":"e701d1ea-34fc-49aa-9e0a-0994fbd06b82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.iopay.com.br/api/v2/payment_link/{{ID_LINK}}","description":"<p>Exclui o Link de Pagamento informado.</p>\n<p>Em caso de sucesso, a API retorna:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n \"deleted\": true\n}\n</code></pre>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"0a84ae49-2fe7-4016-8261-c6bbcc9b03e6","id":"0a84ae49-2fe7-4016-8261-c6bbcc9b03e6","name":"[IOPAY] Link de Pagamento V2","type":"collection"}},"urlObject":{"path":["v2","payment_link","{{ID_LINK}}"],"host":["https://api.iopay.com.br/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"e701d1ea-34fc-49aa-9e0a-0994fbd06b82"},{"name":"Listar Links","id":"e49c808f-d668-4268-9e09-fd5a4e6b2c29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.iopay.com.br/api/v2/payment_link/list?page=1&limit=20","description":"<p>Lista os Links de Pagamento da conta autenticada.</p>\n<p>Filtros disponíveis:</p>\n<ul>\n<li><code>page</code>: página da listagem.</li>\n<li><code>limit</code>: quantidade por página, de 1 a 100.</li>\n<li><code>offset</code>: deslocamento adicional.</li>\n<li><code>sort</code>: <code>time-descending</code> ou <code>time-ascending</code>.</li>\n<li><code>status</code>: <code>enabled</code> ou <code>disabled</code>.</li>\n<li><code>date_range[gte]</code>: timestamp Unix inicial.</li>\n<li><code>date_range[lte]</code>: timestamp Unix final.</li>\n</ul>\n<p>A resposta informa <code>total</code>, <code>query_count</code> e <code>has_more</code> para paginação.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"0a84ae49-2fe7-4016-8261-c6bbcc9b03e6","id":"0a84ae49-2fe7-4016-8261-c6bbcc9b03e6","name":"[IOPAY] Link de Pagamento V2","type":"collection"}},"urlObject":{"path":["v2","payment_link","list"],"host":["https://api.iopay.com.br/api"],"query":[{"description":{"content":"<p>Página da listagem</p>\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"<p>1 a 100</p>\n","type":"text/plain"},"key":"limit","value":"20"},{"disabled":true,"description":{"content":"<p>Offset adicional</p>\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"<p>time-descending ou time-ascending</p>\n","type":"text/plain"},"key":"sort","value":"time-descending"},{"disabled":true,"description":{"content":"<p>enabled ou disabled</p>\n","type":"text/plain"},"key":"status","value":"enabled"},{"disabled":true,"description":{"content":"<p>Timestamp Unix mínimo de created_at</p>\n","type":"text/plain"},"key":"date_range[gte]","value":"1790553600"},{"disabled":true,"description":{"content":"<p>Timestamp Unix máximo de created_at</p>\n","type":"text/plain"},"key":"date_range[lte]","value":"1790639999"}],"variable":[]}},"response":[],"_postman_id":"e49c808f-d668-4268-9e09-fd5a4e6b2c29"},{"name":"Listar Transações dos Links","id":"d419161f-ba7f-4037-b488-5e4ddc8ceb30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.iopay.com.br/api/v2/payment_link/list/transactions?page=1&limit=20","description":"<p>Lista as transações originadas por Links de Pagamento da conta autenticada.</p>\n<p>Filtros disponíveis:</p>\n<ul>\n<li><code>page</code>: página da listagem.</li>\n<li><code>limit</code>: quantidade por página, de 1 a 100.</li>\n<li><code>id_link</code>: filtra por um Link de Pagamento específico.</li>\n<li><code>status</code>: aceita um ou mais status separados por vírgula.</li>\n<li><code>payment_type</code>: aceita um ou mais métodos separados por vírgula.</li>\n<li><code>sort</code>: <code>time-descending</code> ou <code>time-ascending</code>.</li>\n<li><code>date_range[gte]</code>: timestamp Unix inicial.</li>\n<li><code>date_range[lte]</code>: timestamp Unix final.</li>\n</ul>\n<p><code>amount</code> é retornado em unidade monetária como número decimal. Ex.: <code>2.02</code> = R$ 2,02.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"0a84ae49-2fe7-4016-8261-c6bbcc9b03e6","id":"0a84ae49-2fe7-4016-8261-c6bbcc9b03e6","name":"[IOPAY] Link de Pagamento V2","type":"collection"}},"urlObject":{"path":["v2","payment_link","list","transactions"],"host":["https://api.iopay.com.br/api"],"query":[{"description":{"content":"<p>Página</p>\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"<p>1 a 100</p>\n","type":"text/plain"},"key":"limit","value":"20"},{"disabled":true,"description":{"content":"<p>Filtrar por link</p>\n","type":"text/plain"},"key":"id_link","value":"{{ID_LINK}}"},{"disabled":true,"description":{"content":"<p>Status separados por vírgula</p>\n","type":"text/plain"},"key":"status","value":"succeeded,pending"},{"disabled":true,"description":{"content":"<p>Métodos separados por vírgula</p>\n","type":"text/plain"},"key":"payment_type","value":"pix,credit"},{"disabled":true,"description":{"content":"<p>time-descending ou time-ascending</p>\n","type":"text/plain"},"key":"sort","value":"time-descending"},{"disabled":true,"description":{"content":"<p>Timestamp Unix mínimo</p>\n","type":"text/plain"},"key":"date_range[gte]","value":"1790553600"},{"disabled":true,"description":{"content":"<p>Timestamp Unix máximo</p>\n","type":"text/plain"},"key":"date_range[lte]","value":"1790639999"}],"variable":[]}},"response":[],"_postman_id":"d419161f-ba7f-4037-b488-5e4ddc8ceb30"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{BEARER_TOKEN}}"}]}},"variable":[{"key":"BASE_URL","value":"https://api.iopay.com.br/api"}]}