Da conta corporativa ao acompanhamento dos gastos.
A API organiza a operação corporativa em recursos separados, mantendo conta, portadores, cartões, compras, faturas e análises dentro do mesmo contrato público.
Conta, saldo e limite.
Consulte o status da conta, disponibilidade e solicite recargas de limite.
Portadores e cartões.
Crie portadores, emita cartões virtuais ou físicos e aplique regras de uso.
Compras, faturas e análises.
Acompanhe gastos, centros de custo, faturas e agrupamentos analíticos.
Status da conta corporativa
A ativação não é feita pela API pública. O endpoint GET /corporate/cards/account permanece disponível em qualquer estado para consultar a situação atual do recurso.
Ativação ainda não solicitada.
Contrato atualizado precisa ser aceito na Conta IOPAY.
Solicitação em análise pela equipe IOPAY.
Operações da API disponíveis.
suspended indica recurso indisponível para a conta.Fluxo básico
Confirme que o recurso está active.
Defina identidade, limite, intervalo e centro de custo.
Escolha tipo, limite e restrição de estabelecimento quando aplicável.
Use compras, faturas, centros de custo e analytics.
Criar portador
{
"name": "NOME HOLDER",
"tax_id": "12345678909",
"amount": 1000,
"interval": "month",
"center_cost": "MeuCenterCost"
}Criar cartão
{
"holder_id": "{{holder_id}}",
"name": "Google Ads",
"limit": 100000,
"interval": "month",
"type": "virtual",
"merchant": "GOOGLE"
}merchant define uma restrição de estabelecimento, não o nome do cartão. Use name como identificação interna. Omitir merchant ou enviar null não define restrição por esse campo.Recursos e endpoints
| Área | Operações | Rota principal |
|---|---|---|
| Conta | Status, saldo, limite e recarga. | /corporate/cards/account · /balance · /recharge |
| Portadores | Listar, consultar, criar, atualizar e cancelar. | /corporate/cards/holders |
| Cartões por portador | Consultar cartões e compras de um holder. | /holders/{holder_id}/cards · /purchases |
| Cartões | Listar, consultar, criar, atualizar e consultar dados sensíveis. | /corporate/cards · /{card_id}/secrets |
| Compras | Listagem geral e por cartão/portador. | /corporate/cards/purchases |
| Centros de custo | Gastos agrupados e detalhe do centro. | /corporate/cards/cost-centers |
| Faturas | Listar, alterar vencimento e gerar pagamento. | /corporate/cards/invoices |
| Analytics | Resumo e agrupamentos de gastos. | /corporate/cards/analytics |
Limites, portadores e centros de custo
Limite por regra.
O holder recebe amount e intervalo day, week ou month.
Virtual ou físico.
Associe o cartão ao portador e defina limite, intervalo e restrição de merchant quando necessário.
Contexto para a operação.
Agrupe despesas e consulte compras, valores e cashback por centro de custo.
Resources e paginação
Respostas de sucesso identificam o recurso por resource. Listagens usam um envelope padronizado com items, limit, total, offset, has_more e query_count.
{
"resource": "list",
"sort": "time-descending",
"items": [],
"limit": 100,
"total": 0,
"offset": 0,
"has_more": false,
"query_count": 0
}limit e offset são suportados nas listagens. O limite padrão é 100 e o máximo é 1000. Em consultas compatíveis, ?refresh=true atualiza a base IOPAY com dados mais recentes do banco emissor antes da resposta.Faturas e análises de gastos
Vencimento e pagamento.
Liste faturas, configure o dia de vencimento entre 1 e 28 e gere os dados de pagamento da fatura, que podem incluir brcode e link.
Gastos consolidados.
Consulte total gasto, quantidade de compras, cashback e agrupamentos por categoria, centro de custo, portador e evolução mensal.
Dados do cartão
O endpoint GET /corporate/cards/{card_id}/secrets retorna PAN, CVV, validade e TTL quando necessário para a operação.
Collection pública
A collection reúne os 23 endpoints documentados, exemplos de sucesso e exemplos de erro para fluxos relevantes de conta, recarga, portadores e operação.