API principal

API Base

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

Base URLhttps://api.iopay.com.br/api
AutenticaciónBearer token
FormatoJSON

Visión general

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

Customers

Identidad reutilizable.

Crea el comprador una vez y reutiliza el contexto en nuevos recorridos.

Transactions

Crea y sigue pagos.

Pix, tarjeta y boleto entran en el mismo ciclo transaccional de la API.

Tokenización

Menos exposición.

Asocia instrumentos de pago al customer para recorridos recurrentes y de recompra.

Autenticación

Envía email, secret e io_seller_id para obtener el access_token. Utiliza el token devuelto en el header Authorization de las siguientes requests.

POST /auth/login
curl --request POST \
  --url https://api.iopay.com.br/api/auth/login \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "tu_email",
    "secret": "tu_secret",
    "io_seller_id": "<IO_SELLER_ID>"
  }'
Bearer Token. La autenticación devuelve access_token, token_type, token_scope y expires_in. Usa el access token como Authorization: Bearer tu_token en las siguientes llamadas y no expongas credenciales ni tokens en el frontend, el repositorio o logs públicos.

Flujo básico

01 · AccesoAutentícate.

Envía tus credenciales y obtén el access token.

02 · CustomerCrea el comprador.

Recibe un identificador reutilizable para el recorrido.

03 · TransacciónGenera el pago.

Crea Pix, tarjeta o boleto asociado al customer.

04 · EstadoSincroniza.

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

Crear customer

POST /v1/customer/new
curl --request POST \
  --url https://api.iopay.com.br/api/v1/customer/new \
  --header 'Authorization: Bearer tu_token' \
  --header 'Content-Type: application/json' \
  --data '{
    "first_name": "Maria",
    "last_name": "Oliveira",
    "customer_type": "person_natural",
    "email": "[email protected]",
    "taxpayer_id": "12345678909",
    "phone_number": "+5511999999999",
    "address": {
      "line1": "Av. Paulista, 1000",
      "line2": "Apto 101",
      "neighborhood": "Bela Vista",
      "city": "São Paulo",
      "state": "SP",
      "postal_code": "01310100",
      "country_code": "BR"
    }
  }'

Crear transacción Pix

POST /v1/transaction/new/:CustomerID
curl --request POST \
  --url https://api.iopay.com.br/api/v1/transaction/new/:CustomerID \
  --header 'Authorization: Bearer tu_token' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": 12990,
    "currency": "BRL",
    "description": "Pedido #102938",
    "statement_descriptor": "IOPAY STORE",
    "io_seller_id": "<IO_SELLER_ID>",
    "payment_type": "pix",
    "reference_id": "order_102938"
  }'
Ejemplos de integración. Mantén rutas, campos y ejemplos sincronizados con la implementación vigente antes de publicar cambios.

Recursos

ÁreaUsoSiguiente referencia
CustomersRegistro, consulta e identidad del pagador.API Base
Tarjetas / tokenizaciónInstrumentos asociados al customer y recompra.API Base
TransaccionesCreación, consulta, captura y cancelación.API Base
PixCobro, identificadores y seguimiento del estado.API Base + Webhooks
BoletoCreación y ciclo del cobro bancario.API Base + Webhooks
SellersParticipantes de plataforma / marketplace.Sellers API →
SplitDistribución entre participantes.Split API →