IOPAY→Developers→Postman Starter
Ferramentas de desenvolvimento

Postman Starter

Collection inicial para configurar suas credenciais, autenticar na IOPAY e executar os primeiros requests da integração.

FormatoPostman Collection v2.1
AuthBearer
IncluiLogin · Customer · PIX
Baixar collection ↓ Variáveis API Base →
Starter collection

Visão geral

A collection organiza as credenciais necessárias para autenticar na IOPAY, obter um access_token e utilizá-lo como Bearer token nas chamadas seguintes.

Autenticação

POST /auth/login

Utilize suas credenciais para obter o token de acesso da API.

Endpoint base

base_url

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

Importação

Importação

  1. Baixe o arquivo JSON desta página.
  2. No Postman, use Import e selecione a collection.
  3. Configure auth_email, auth_secret e io_seller_id.
  4. Execute o request de autenticação. O access_token será salvo automaticamente em iopay_token.
  5. Crie um customer. O ID retornado será salvo automaticamente em customer_id.
  6. Execute o request PIX utilizando o customer criado.
Variáveis

Variáveis

VariávelValor inicialUso
base_urlhttps://api.iopay.com.br/apiBase das chamadas.
auth_emailDefinido por vocêE-mail utilizado na autenticação.
auth_secretDefinido por vocêSecret utilizado na autenticação.
io_seller_idDefinido por vocêIdentificador do seller utilizado na integração.
iopay_tokenRetornado pela APIAccess token utilizado como Bearer.
customer_idRetornado pela APIID do customer criado, salvo automaticamente pela collection.
Primeiros requests

Autenticação

Antes de executar operações autenticadas, envie suas credenciais para obter o token de acesso.

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

Retorno

Access token
{
  "access_token": "<ACCESS_TOKEN>",
  "token_type": "bearer",
  "token_scope": "transaction",
  "expires_in": 3600
}
Bearer Token. Utilize o valor de access_token como Authorization: Bearer seu_token nas chamadas seguintes.

Criar customer

Com o token configurado, crie um customer para utilizar nas transações. A collection salva automaticamente o identificador retornado em 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. Após a criação, a collection salva success.id em customer_id para reutilizá-lo nas próximas requests.

Exemplo com PIX

Com o token configurado, você já pode executar uma transação PIX utilizando um 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 monetários. O campo amount deve ser enviado em centavos. Por exemplo, 24990 representa R$ 249,90.
Evolução

Uso recomendado

  • Mantenha credenciais e tokens reais fora de arquivos versionados.
  • Obtenha um novo token quando o access_token expirar.
  • Adicione requests por recurso conforme a integração evoluir.
  • Inclua testes automáticos de status e campos essenciais.
  • Documente variáveis próprias de marketplace, seller e Split.