IOPAY→APIs
Developer platform

A API é o core.
A experiência continua sendo sua.

Construa pagamentos diretamente no seu produto. Uma API REST para customers, cartões, Pix, boleto e crédito com SDKs, webhooks e referências dedicadas para Transacional, Links de Pagamento, Sellers, Split de Pagamentos e Gestão de Gastos.

Começar pela API ↓ Abrir API Reference ↗
REST APISandboxNode.jsPHP / LaravelWebhooksPayment LinksSplit de Pagamentos
POST /api/v1/transaction/new/:CustomerID
nova transação por cartão de crédito
application/json
{
  "amount": 14990,
  "currency": "BRL",
  "description": "Pedido #102938",
  "id_card": "23082eb67cd54e7eb4c9cf8c760bd12f",
  "capture": 1,
  "statement_descriptor": "IOPAY STORE",
  "installment_plan": {
    "number_installments": 1
  },
  "io_seller_id": "<IO_SELLER_ID>",
  "payment_type": "credit",
  "reference_id": "102938"
}
application/json Transaction response 
{
  "success": {
    "id": "7f38b2c94e1a4d69a81f53b76d9c204e",
    "resource": "transaction",
    "status": "succeeded",
    "payment_type": "credit",
    "amount": "149.90",
    "captured": true,
    "currency": "BRL",
    "reference_id": "102938",
    "payment_method": {
      "resource": "card",
      "card_brand": "Visa",
      "last4_digits": "4242"
    },
    "installment_plan": {
      "mode": "interest_free",
      "number_installments": "1"
    },
    "created_at": "2026-10-06T20:09:48+00:00"
  }
}
Cartão sem recapturar dados.Use o id_card já associado ao customer e crie a transação.
Documentação IOPAY

APIs e Referências de Integração Documentadas e Organizadas

Expanda produtos e serviços de pagamento como serviço. Comece pela API Base e avance para a referência específica da sua implementação. Transacional, Links de Pagamento, Sellers, Split de Pagamentos, Consultas, Tokenização e Gestão de Gastos ficam organizados você chegar rapidamente à referência certa.

docs-api.iopay.com.br
Documentação pública
API Base

A fundação da sua integração.

Comece pela autenticação, configuração de ambiente, customers, cartões e tokenização. A camada transacional entra na etapa seguinte.

Abrir API Reference ↗
FoundationAPI Base
AUTHBearer tokenAcesso
POST/api/v1/customer/newCustomer
POST/api/v1/card/tokenize/tokenTokenize
ENVsandbox / productionAmbientes
API Transacional

Do pagamento criado ao ciclo completo da transação.

Concentre aqui as operações transacionais de Pix, cartão e boleto: criação, consulta, captura, cancelamento, estorno e acompanhamento de status.

Abrir API Transacional ↗
PaymentsAPI Transacional
POST/api/v1/transaction/new/:CustomerIDCriar
GET/api/v1/transaction/get/:idConsultar
CAPcaptura total ou parcialCaptura
VOIDcancelamento / estornoCiclo
Postman · Payment Links API V2

Transforme uma cobrança em uma URL.

A API V2 reúne criação, consulta, atualização, exclusão e listagem de links, além da consulta das transações geradas. Configure itens, meios de pagamento, parcelamento, juros, disponibilidade, Order Bump, identidade visual e Split quando habilitado.

Abrir documentação V2 ↗ Referência V1 ↗
Configuração V2Payment Link
ITEMtitle + items[]Cobrança
PAYcredit / pix / boletoMétodos
TIMEopen_at / end_at / max_paymentsDisponibilidade
CARDmax_installment + interestParcelamento
BUMPorder_bump_items[]Oferta adicional
BRANDprimary_color + bannersIdentidade
SPLITsplit_rules[]Distribuição
Postman · Sellers API

Participantes tratados como parte da arquitetura.

Consulte a referência específica para implementar recursos relacionados aos Sellers da plataforma e manter essa camada separada do core transacional.

Abrir Sellers no Postman ↗
Postman Public collection
Sellers APIparticipantes da plataforma
Postman · Split de Pagamentos

Split de Pagamentos com referência própria.

Use a collection dedicada para implementar regras de Split de Pagamentos em operações com múltiplos participantes, mantendo essa camada separada da API Base e da API Transacional.

Abrir Split de Pagamentos no Postman ↗
Postman Public collection
Split de Pagamentosregras de Split de Pagamentos
Gestão de Gastos & Cartões Corporativos

Controle corporativo conectado à plataforma.

Uma frente dedicada para emissão e gestão de cartões corporativos, definição de limites, políticas de uso, portadores e acompanhamento da operação de gastos.

Abrir Gestão de Gastos ↗
CorporateCartões Corporativos
CARDemissão e gestão por empresaCartões
RULElimites e políticas de usoControle
TEAMportadores e centros de custoEquipe
VIEWvisão consolidada de gastosOperação
Quickstart

Do primeiro request
à primeira cobrança.
Em três passos.

Configure a autenticação, crie o customer e gere uma cobrança Pix usando o mesmo fluxo que sua aplicação levará para produção.

Primeira integração

Um caminho curto para entender a estrutura da API antes de explorar os demais recursos.

Abrir API Reference ↗
01
Passo ativoAutenticar requests
Passo 01 · Acesso

Autenticar requests

Toda integração começa com o ambiente certo e um token válido no header Authorization.

Bearer tokenSandboxProdução
Objetivo

Sua aplicação passa a falar com a API IOPAY de forma autenticada.

Retorno esperado

A partir daqui, você já consegue chamar as próximas rotas da integração.

Onde entra

No início de qualquer integração, antes de criar customers ou transações.

Checklist
  • Escolher sandbox ou produção.
  • Adicionar Authorization: Bearer seu_token.
  • Enviar Content-Type: application/json.
Exemplo de autenticação
Docs ↗
curl --request GET \
  --url https://api.iopay.com.br/api/v1/customer/get/:customerId \
  --header 'Authorization: Bearer seu_token' \
  --header 'Content-Type: application/json'
Próximo passo

Com a autenticação pronta, o próximo passo é criar o comprador que vai receber a cobrança.

Authorization: Bearer seu_token





Meios de pagamento

Uma integração.Cada pagamento,
sua própria jornada.

Pix, cartão e boleto vivem no core transacional. Links de Pagamento levam a mesma infraestrutura para vendas assistidas, cobranças remotas e canais sem checkout próprio.

PIX

Pix

Criação de cobranças instantâneas, QR Code e acompanhamento de confirmação por evento.

Ideal para checkout, cobranças remotas e fluxos de pagamento imediato.
CC

Cartões

Crédito à vista ou parcelado, tokenização e jornadas de recompra ou recorrência.

Permite combinar checkout próprio com os fluxos de autorização da operação.
BLT

Boleto

Emissão e acompanhamento de cobranças para jornadas que exigem pagamento por título.

Estado da cobrança pode ser integrado aos processos internos da empresa.
LNK

Links de Pagamento

Crie cobranças hospedadas e compartilháveis por API para vender fora do checkout tradicional.

CRM, WhatsApp, inside sales, atendimento e jornadas assistidas.


Webhooks & eventos

Seu sistema não precisa perguntar.
A Iopay avisa em segundos.

HTTP POST Tempo real Sem polling

A IOPAY recebe a atualização do pagamento, processa o novo estado e envia o webhook ao seu endpoint. Pouca fricção, fluxo claro e sistemas sincronizados.

Conte com a camada de webhooks e eventos resilientes da Iopay com reentrega automática em casos de indisponibilidade do seu servidor.

01 · Origem O pagamento muda.

Novo estado na infraestrutura.

→→→→→→→→→→→→→→
03 · Seu sistema O webhook chega. Sempre.

Seu endpoint recebe a request POST da Iopay e você processa e reage como quiser. Seu sistema toma as medidas após um pagamento criado, aprovado, falhado, estornado ou cancelado parcialmente. Com a confimação seu sistema tem tudo para liberar o pedido, alimentar CRM & ERPs, Interagir com SAP, integrar fullfilment e nota fiscal.

SDKs IOPAY

SDKs para Java, Javascript, Node.js e
PHP / Laravel.

Use os clients públicos da IOPAY em Node.js e PHP / Laravel ou integre diretamente pela API REST em qualquer linguagem. Menos boilerplate para começar, sem perder acesso ao contrato HTTP da plataforma.

SDK oficial · Node.js

Integração pronta para aplicações JavaScript.

Client público com autenticação, ambientes, tokenização, customers e operações transacionais principais.

Ver no GitHub ↗
Instalação 
npm install
@iopay-payments/iopay-api-sdk-nodejs

// depois, use o client IOPAY no projeto
SDK oficial · PHP

Composer para PHP ou Projetos Laravel.

O pacote oficial iopay-payments/sdk-php pode ser instalado via Composer e usado pelo autoload do projeto, inclusive em aplicações Laravel.

Ver no GitHub ↗ Packagist ↗
Instalação via Composer 
composer require
iopay-payments/sdk-php

// disponível no vendor/autoload.php do projeto
REST API · qualquer stack

Use HTTP direto quando quiser controle total.

Python, Go, Java, .NET, Ruby ou qualquer outra stack podem consumir a API IOPAY diretamente via HTTPS, usando os mesmos endpoints e contratos publicados.

Abrir API Reference ↗
Exemplo universal 
curl --request GET \\
  --url https://api.iopay.com.br/api/v1/customer/get/:CustomerID \\
  --header 'Authorization: Bearer seu_token' \\
  --header 'Content-Type: application/json'
Operação

Integração e operação precisam falar a mesma língua.

Depois do deploy, engenharia, produto, financeiro e atendimento precisam enxergar o mesmo pagamento. O portal IOPAY complementa a API com visão transacional, recebíveis, credenciais, relatórios e acompanhamento operacional.

01Transações Consulte status, cliente, método, valor e referências da operação.
02Recebíveis Acompanhe a visão financeira associada às vendas processadas.
03Credenciais Centralize os dados necessários para os ambientes de integração.
04Relatórios Dê suporte a rotinas de operação e conciliação sem depender apenas do time de engenharia.
Operação IOPAYVisão consolidada
TRANSAÇÕES883
APROVAÇÃO60,4%
TPVR$ 2,58M
TransaçãoMétodoStatusValor
0b527...9a6creditAprovadaR$ 1.002
44d23...9044pixPendenteR$ 3.482
34fad...29e7creditAprovadaR$ 5.444
Segurança & arquitetura como core e princício de fundação

APIs e Arquitetura pensadas para operar
pagamentos com controle, segurança e visão.

Credenciais, segregação de ambientes, tokenização e controles de segurança fazem parte da arquitetura do produto e reduzem a exposição desnecessária de dados sensíveis.

01Credenciais segregadas

Separe desenvolvimento, testes e produção com credenciais adequadas a cada ambiente.

02Tokenização

Reduza a circulação de dados sensíveis em jornadas de recompra, recorrência e one-click.

03PCI DSS 4.0.1

Controles de segurança e proteção do ambiente de pagamentos aplicados à infraestrutura IOPAY.

04Eventos e rastreabilidade

Use identificadores, status e webhooks para acompanhar o ciclo da transação e responder a exceções.

Casos de uso

Arquitetura para diferentes
modelos de negócio.

A Developer Platform IOPAY foi desenhada para produtos que precisam incorporar pagamentos à própria experiência do e-commerce ao SaaS, marketplace, ERP e venda assistida.

E-commerce

Checkout próprio.

Controle a experiência do comprador enquanto a IOPAY executa a camada de pagamentos e eventos.

Ver e-commerce →
SaaS & recorrência

Recompra e cobrança contínua.

Combine tokenização, customers, eventos e lógica da sua aplicação para jornadas recorrentes.

Ver documentação →
Marketplaces

Sellers e Split de Pagamentos.

Leve o contexto dos Sellers e as regras de Split de Pagamentos para o fluxo da transação.

Ver marketplaces →
ERP & financeiro

Pagamentos conectados à operação.

Integre cobranças e eventos a processos internos de conciliação, atendimento e financeiro.

Falar com especialista →
Inside sales

Cobrança dentro do funil.

Gere links ou transações a partir do CRM e devolva status para venda, onboarding e financeiro.

Ver links →
White-label

Infraestrutura sob sua experiência.

Combine APIs e recursos de plataforma para oferecer jornadas de pagamento integradas à sua marca.

Ver white-label →



Conteúdo técnico

Para levar a sua integração
da primeira chamada à produção.

Quatro leituras do blog IOPAY selecionadas para quem está desenhando integrações de pagamento, eventos assíncronos, segurança e developer experience.

Arquitetura & produção

Como integrar pagamentos ao seu sistema via API

Do sandbox ao go-live: estados, idempotência, retries, filas, observabilidade, conciliação e tratamento de exceções em produção.

Ler artigo↗
 Webhooks & eventos

Webhooks de pagamento: segurança, idempotência e retries

Como receber eventos com segurança, lidar com duplicidade, atrasos, reenvios e manter o estado da aplicação consistente.

Ler artigo↗
 Developer experience

SDK ou API REST para pagamentos: qual escolher?

Compare velocidade de implementação, nível de controle, versionamento, manutenção, observabilidade e portabilidade entre as abordagens.

Ler artigo↗
 API security

Segurança de APIs de pagamento

Autenticação, secrets, rate limiting, idempotência, autorização e controles essenciais para proteger uma integração financeira.

Ler artigo↗
Ver mais sobre APIs ↗
Integração e APIs IO

Da primeira chamada à produção. Conte com a melhor arquitetura de soluções de pagamentos

Explore a documentação, teste sua integração e leve pagamentos para dentro do seu produto com a infraestrutura IOPAY.

Abra sua conta ↗API Reference