IOPAY→APIs
Plataforma de desarrollo

La API es el núcleo.
La experiencia sigue siendo tuya.

Construye pagos directamente en su producto. Un API REST para clientes, tarjetas, Pix, boleto y crédito con SDKs, webhooks y referencias dedicadas a Transacional, Enlaces de Pago, Sellers, Split de Pagos y Gestión de Gastos.

Comience con la API ↓ Abre la API de referencia —
API RESTSandboxNode.jsPHP / LaravelWebhooksEnlaces de PagoSplit de Pagos
POST /api/v1/transaction/new/:CustomerID
Nuevo pago por tarjeta 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 Respuesta a las transacciones 
{
  "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"
  }
}
Tarjeta sin recoger datos.Utilice el id_card ya asociado a customer y cree la transacción.
Documentación IOPAY

APIs y Referencias de integración documentadas y organizadas

Expande productos y servicios de pago como servicio. Comience con la base API y avance a la referencia específica de su implementación. Transacional, Enlaces de Pago, Sellers, Split de Pagos, Consulta, Tokenización y Gestión de Gastos se organizan se llega rápidamente a la referencia correcta.

docs-api.iopay.com.br
Documentación pública
API Base

El fundamento de su integración.

Comienza con la autenticación, configuración de entorno, clientes, tarjetas y tokenización. La capa transaccional entra en el siguiente paso.

Abre la API de referencia —
FundaciónAPI Base
AUTHBearer tokenAcceso
POSTv1/customer/newCliente
POSTv1/card/tokenize/tokenEl producto se comercializa en el mercado.
ENVsandbox / productionEntornos
API Transaccional

El pago creado para el ciclo completo de la transacción.

En este punto se concentran las operaciones transaccionales de Pix, tarjeta y boleto: creación, consulta, captura, cancelación, devolución y seguimiento de estado.

Abre la API Transacional —
PagosAPI Transaccional
POSTv1/transaction/new/:CustomerIDCrear
GETv1/transaction/get/:idConsultar
CAPcaptura total ou parcialCaptura de las personas
VOIDcancelamento / estornoCiclo
Postman · Payment Links API V2

Convierte una facturación en una URL.

El API V2 incluye la creación, consulta, actualización, exclusión y listaje de enlaces, además de la consulta de las transacciones generadas. Configure artículos, medios de pago, parcelamiento, intereses, disponibilidad, Order Bump, identidad visual y Split cuando esté habilitado.

Abre la documentación V2 — Referencia V1 —
Configuración V2Link de pago
ITEMtitle + items[]Cobro
PAYcredit / pix / boletoMétodos
TIMEopen_at / end_at / max_paymentsDisponibilidad
CARDmax_installment + interestCuotas
BUMPorder_bump_items[]Oferta adicional
BRANDprimary_color + bannersIdentidad
SPLITsplit_rules[]Distribución
Postman · Sellers API

Participantes tratados como parte de la arquitectura.

Consulte la referencia específica para implementar recursos relacionados con el Sellers de la plataforma y mantener esta capa separada del núcleo transaccional.

Abre Sellers No Postman ↗
Postman Colección pública
Sellers APIparticipantes de la plataforma
Postman · Split de Pagos

Split de pagos con referencia propia.

Utilice la colección dedicada para implementar reglas de Split de Pagos en operaciones con múltiples participantes, manteniendo esta capa separada de la base de API y API Transaccional.

Abre Split de Pagos No Postman ↗
Postman Colección pública
Split de PagosLas normas de la Split de Pagos
Gestión de Gastos y Tarjetas Corporativas

Control corporativo conectado a la plataforma.

Un frente dedicado a la emisión y gestión de tarjetas corporativas, la definición de límites, políticas de uso, portadores y el seguimiento de la operación de gastos.

Abre la gestión de gastos —
Las empresasTarjetas Corporativas
CARDemissão e gestão por empresaTarjetas
RULElimites e políticas de usoControl
TEAMportadores e centros de custoEquipo
VIEWvisão consolidada de gastosOperación
¡Curso de inicio!

De la primera solicitud
a la primera cobranza.
En tres pasos.

Configure la autenticación, cree customer y gestione una facturación Pix usando el mismo flujo que su aplicación llevará a la producción.

Primera integración

Un camino corto para entender la estructura de API antes de explorar los demás recursos.

Abre la API de referencia —
01
Pasos activosAutenticar las solicitudes
Paso 01 · Acceso

Autenticar las solicitudes

Toda integración comienza con el entorno correcto y un token válido en el encabezado Autorization.

Bearer tokenSandboxProducción
Objetivo

Su aplicación se pone a hablar con API IOPAY de forma autenticada.

Retorno esperado

A partir de aquí, ya puedes llamar las próximas rutas de integración.

Dónde entra

Al comienzo de cualquier integración, antes de crear clientes o transacciones.

Lista de control
  • Elegir entre sandbox o producción.
  • Añadir Autorizamiento: portador seu_token.
  • Enviar contenido Tipo: aplicación/json.
Ejemplo de autenticación
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'
Siguiente paso

Con la autenticación lista, el siguiente paso es crear el comprador que recibirá la cobranza.

Authorization: Bearer seu_token





Medios de pago

Una integración.Cada pago,
su propio viaje.

Pix, tarjeta y boleto viven en el núcleo transaccional. Enlaces de Pago lleva la misma infraestructura para ventas asistidas, cobros remotos y canales sin propio checkout.

PIX

Pix

Creación de cobros instantáneos, QR Code y seguimiento de confirmación por evento.

Ideal para cheques, cobros remotos y flujos de pago inmediato.
CC

Tarjetas

Crédito en un pago o parcelado, tokenización y jornadas de recompra o recurrencia.

Permite combinar el checkout propio con los flujos de autorización de la operación.
BLT

Boleto

Emisión y seguimiento de las cobranzas por jornadas que requieran un pago por título.

El estado de cobro puede integrarse en los procesos internos de la empresa.
LNK

Enlaces de Pago

Crea cobros alojados y compartidos por API para vender fuera del checkout tradicional.

CRM, WhatsApp, ventas internas, servicio y flujos de pago atendidos.


Webhooks y eventos

Su sistema no tiene que preguntar.
Iopay nos lo avisará en segundos.

HTTP POST Tiempo real No hay encuestas

IOPAY recibe la actualización del pago, procesa el nuevo estado y envía webhook a su punto de entrada. Bajo fricción, flujo claro y sistemas sincronizados.

Cuente con la capa de webhooks y eventos resistentes de Iopay con devolución automática en caso de que su servidor no esté disponible.

01 · Origen El pago cambia.

Nuevo estado de la infraestructura.

→→→→→→→→→→→→→→
03 · Su sistema El webhook llega. Siempre lo hice.

Su punto de entrada recibe la petición POST de Iopay y usted procesa y reacciona como quiera. Su sistema toma medidas después de que un pago haya sido creado, aprobado, fallido, desviado o parcialmente cancelado. Con la confimación su sistema tiene todo para liberar la solicitud, alimentar CRM & ERPs, interactuar con SAP, integrar fullfilment y nota fiscal.

SDKs IOPAY

SDKs para Java, JavaScript, Node.js y
PHP / Laravel.

Utilice los clientes públicos de IOPAY en Node.js y PHP / Laravel o integre directamente por API REST en cualquier lenguaje. Menos boilerplate para empezar, sin perder acceso al contrato HTTP de la plataforma.

SDK oficial · Node.js

Integración lista para aplicaciones JavaScript.

Cliente público con autenticación, entornos, tokenización, clientes y operaciones transaccionales principales.

Ver en GitHub —
Instalación 
npm install
@iopay-payments/iopay-api-sdk-nodejs

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

Componer para PHP o proyectos Laravel.

El paquete oficial iopay-payments/sdk-php se puede instalar a través de Composer y utilizar por el autoload del proyecto, incluso en aplicaciones Laravel.

Ver en GitHub — Packagist —
Instalación por medio de Composer 
composer require
iopay-payments/sdk-php

// disponível no vendor/autoload.php do projeto
REST API · cualquier estaca

Utilice HTTP directo cuando quiera tener control total.

Python, Go, Java, .NET, Ruby o cualquier otra pila pueden consumir API IOPAY directamente a través de HTTPS, utilizando los mismos endpoints y contratos publicados.

Abre la API de referencia —
Ejemplo 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'
Operación

La integración y la operación deben hablar el mismo idioma.

Después de la implementación, la ingeniería, el producto, las finanzas y el servicio deben ver el mismo pago. El portal IOPAY complementa a API con visión transaccional, entradas, credenciales, informes y seguimiento operativo.

01Transacciones Consulte el estado, el cliente, el método, el valor y las referencias de la operación.
02Cuentas por cobrar Realice una evaluación de la situación financiera de las ventas procesadas.
03Credenciales Centralizar los datos necesarios para los entornos de integración.
04Informes Apoye las rutinas de operación y conciliación sin depender solo del equipo de ingeniería.
Operación IOPAYVisión consolidada
TRANSACCIONES883
APROBACIÓN60,4%
TPVR$ 2,58 millones
TransacciónMétodoEstatus de la empresaImporte
0b527...9a6creditApprovedadoR$ 1.002
44d23...9044pixPenteadoR$ 3.482
34fad...29e7creditApprovedadoR$ 5.444
Seguridad & arquitectura como núcleo y principio de base

APIs y arquitectura diseñada para operar
pagos con control, seguridad y visión.

Los controles de seguridad, los segregaciones de entornos, los tokenización y los controles de seguridad son parte de la arquitectura del producto y reducen la exposición innecesaria a datos sensibles.

01Cédulas segregadas

Separar el desarrollo, las pruebas y la producción con credenciales adecuadas para cada entorno.

02Tokenización

Reducir la circulación de datos sensibles en flujos de pago de recompra, recurrencia y un solo clic.

03PCI DSS 4.0.1

Los controles de seguridad y protección del medio ambiente de pagos aplicados a la infraestructura IOPAY.

04Eventos y rastreabilidad

Utilice identificadores, estado y webhooks para seguir el ciclo de la transacción y responder a las excepciones.

Casos de uso

Arquitectura para diferentes
modelos de negocio.

La plataforma de desarrolladores IOPAY fue diseñada para productos que necesitan incorporar pagos a la propia experiencia de comercio electrónico a SaaS, marketplace, ERP y venta asistida.

Saas & recurrencia

Recuperación y cobro continuo.

Combina tokenización, clientes, eventos y lógica de su aplicación para flujos de pago recurrentes.

Ver documentación →
Marketplaces

Sellers y Split de Pagos.

Tome el contexto de Sellers y las reglas de Split de Pagos para el flujo de la transacción.

Ver los mercados →
ERP y finanzas

Pagos relacionados con la operación.

Integrar cobros y eventos en procesos internos de conciliación, atención y finanzas.

Hablar con un experto
Entradas de ventas

Recaudación dentro del túnel.

Gerencia de enlaces o transacciones desde el CRM y devuelve el estado para ventas, onboarding y finanzas.

Ver enlaces →
White-label

Infraestructura bajo su experiencia.

Combine APIs y las funciones de la plataforma para ofrecer jornadas de pago integradas a su marca.

Ver white-label →



Contenido técnico

Para llevar a su integración
desde la primera llamada a la producción.

Cuatro lecturas del blog IOPAY seleccionadas para quienes están diseñando integraciones de pago, eventos asíncronos, seguridad y experiencia de desarrollador.

Arquitectura y producción

Cómo integrar pagos a su sistema a través de API

Desde el sandbox hasta el go-live: estados, impotencia, retiros, filas, observabilidad, conciliación y tratamiento de excepciones en producción.

Leer el artículo↗
 Webhooks y eventos

Webhooks de pago: seguridad, impotencia y retiros

Cómo recibir eventos con seguridad, manejar duplicidades, retrasos, reenvíos y mantener el estado de la aplicación consistente.

Leer el artículo↗
 Experiencia de desarrollador

SDK o API REST para pagos: ¿cuál elegir?

Compara la velocidad de implementación, el nivel de control, la versión, el mantenimiento, la observabilidad y la portabilidad entre los enfoques.

Leer el artículo↗
 Seguridad de la API

Seguridad de las APIs de pago

Autenticación, secretos, limitación de tasas, idempotencia, autorización y controles esenciales para proteger una integración financiera.

Leer el artículo↗
Ver más sobre APIs —
La integración y APIs IO

Desde la primera llamada hasta la producción. Cuente con la mejor arquitectura de soluciones de pago

Explora la documentación, prueba su integración y leve los pagos dentro de su producto con la infraestructura IOPAY.

Abre tu cuenta ↗Referencia de la API