IOPAY→Developers→Postman Starter
Herramientas de desarrollo

Postman Starter

Collection inicial para configurar tus credenciales, autenticarte en IOPAY y ejecutar las primeras requests de la integración.

FormatoPostman Collection v2.1
AuthBearer
IncluyeLogin · Customer · PIX
Descargar collection ↓ Variables API Base →
Starter collection

Visión general

La collection organiza las credenciales necesarias para autenticarse en IOPAY, obtener un access_token y utilizarlo como Bearer token en las llamadas siguientes.

Autenticación

POST /auth/login

Utiliza tus credenciales para obtener el token de acceso de la API.

Endpoint base

base_url

Valor inicial configurado como https://api.iopay.com.br/api.

Importación

Importación

  1. Descarga el archivo JSON de esta página.
  2. En Postman, usa Import y selecciona la collection.
  3. Configura auth_email, auth_secret e io_seller_id.
  4. Ejecuta la request de autenticación. El access_token se guardará automáticamente en iopay_token.
  5. Crea un customer. El ID devuelto se guardará automáticamente en customer_id.
  6. Ejecuta la request PIX utilizando el customer creado.
Variables

Variables

VariableValor inicialUso
base_urlhttps://api.iopay.com.br/apiBase de las llamadas.
auth_emailDefinido por tiE-mail utilizado en la autenticación.
auth_secretDefinido por tiSecret utilizado en la autenticación.
io_seller_idDefinido por tiIdentificador del seller utilizado en la integración.
iopay_tokenDevuelto por la APIAccess token utilizado como Bearer.
customer_idDevuelto por la APIID del customer creado, guardado automáticamente por la collection.
Primeras requests

Autenticación

Antes de ejecutar operaciones autenticadas, envía tus credenciales para obtener el token de acceso.

POST {{base_url}}/auth/login
{
  "email": "{{auth_email}}",
  "secret": "{{auth_secret}}",
  "io_seller_id": "{{io_seller_id}}"
}

Respuesta

Access token
{
  "access_token": "<ACCESS_TOKEN>",
  "token_type": "bearer",
  "token_scope": "transaction",
  "expires_in": 3600
}
Bearer Token. Utiliza el valor de access_token como Authorization: Bearer tu_token en las llamadas siguientes.

Crear customer

Con el token configurado, crea un customer para utilizar en las transacciones. La collection guarda automáticamente el identificador devuelto en customer_id.

POST {{base_url}}/v1/customer/new
{
  "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"
  }
}
Automático. Tras la creación, la collection guarda success.id en customer_id para reutilizarlo en las siguientes requests.

Ejemplo con PIX

Con el token configurado, ya puedes ejecutar una transacción PIX utilizando un customer existente.

POST {{base_url}}/v1/transaction/new/{{customer_id}}
{
  "amount": 24990,
  "currency": "BRL",
  "description": "Pedido #84217",
  "statement_descriptor": "IOPAY STORE",
  "io_seller_id": "{{io_seller_id}}",
  "payment_type": "pix",
  "reference_id": "pedido_84217"
}
Valores monetarios. El campo amount debe enviarse en centavos. Por ejemplo, 24990 representa R$ 249,90.
Evolución

Uso recomendado

  • Mantén las credenciales y los tokens reales fuera de los archivos versionados.
  • Obtén un nuevo token cuando el access_token caduque.
  • Añade requests por recurso a medida que evolucione la integración.
  • Incluye pruebas automáticas de estado y campos esenciales.
  • Documenta las variables propias de marketplace, seller y Split.