IOPAY→Desarrolladores→API Base
API principal

API Base

Referencia interna para organizar el flujo principal de API IOPAY: autenticación, clientes, instrumentos de pago y transacciones.

Base de URLhttps://api.iopay.com.br/api/
AutenticaciónBearer token
FormaciónJSON
¡Curso de inicio! Ver recursos Webhooks →
Visión general

Visión general

La base API concentra el principal flujo de pagos: autenticación, clientes, tarjetas/tokenización y transacciones. Sellers y Split tienen sus propias superficies porque atienden operaciones de plataforma y distribución.

Los clientes

Identidad reutilizable.

Crea el comprador una vez y reutiliza el contexto en nuevos flujos de pago.

Transaccional

Crear y seguir los pagos.

Pix, tarjeta y boleto Entrarán en el mismo ciclo transaccional de la API.

Tokenización

Menos exposición.

Asociar instrumentos de pago a customer para flujos de pago recurrentes y recompra.

Autenticación

Autenticación

Envía un token válido en el encabezado Authorization y utilice JSON en las cargas de integración.

Ejemplo de autenticación
curl --request GET \
  --url https://api.iopay.com.br/api/v1/customer/get/:customerId \
  --header 'Authorization: Bearer seu_token' \
  --header 'Content-Type: application/json'
Ambientes. Separar las credenciales de desarrollo/testa y producción. No exponga tokens en el frontend, el repositorio o los registros públicos.
¡Curso de inicio!

Flujo básico

01 · AccesoAutentique.

Elija el entorno y envíe el token Bearer.

02 · ClienteCrea el comprador.

Reciba un identificador reutilizable para el viaje.

03 · TransacciónManeja el pago.

Crea Pix, tarjeta o boleto asociado con customer.

04 · EstadoSincronize.

Utilice la consulta por ID y webhooks para seguir los cambios.

Crear customer

POST /api/v1/customer/new
curl --request POST \
  --url https://api.iopay.com.br/api/customer/new \
  --header 'Authorization: Bearer seu_token' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Maria Oliveira",
    "email": "[email protected]",
    "document": "12345678909",
    "phone_number": "+5511999999999"
  }'

Crear una transacción Pix

POST /api/v1/transaction/new/:CustomerID
curl --request POST \
  --url https://api.iopay.com.br/api/v1/transaction/new/:CustomerID \
  --header 'Authorization: Bearer seu_token' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": 12990,
    "payment_method": "pix",
    "reference_id": "order_102938"
  }'
Ejemplos de integración. Mantenga las rutas, campos y ejemplos en sincronía con la implementación vigente antes de publicar cambios.
Mapa de recursos

Funcionalidades

ÁreaUsoPróximo referente
Los clientesRegistro, consulta e identidad del pagador.API Base
Carteles / tokenizaciónInstrumentos asociados con el customer y vuelve a comprar.API Base
TransaccionesCreación, consulta, captura y cancelación.API Base
PixCobro, identificadores y seguimiento del estado.API base + webhooks
BoletoCreación y ciclo de cobro bancario.API base + webhooks
SellersParticipadores de plataforma/mercado.Sellers API →
SplitDistribución entre los participantes.El API de la división