Integre com a API do Renko Adquirência de forma rápida, segura e organizada.

A documentação foi realinhada ao novo padrão visual para manter coerência com a Renko Tecnologia e, ao mesmo tempo, tornar o consumo da API mais claro para equipes de desenvolvimento, integrações e suporte.

Abrir OpenAPI Acesso ao gerencial

AuthFluxo com client_id, client_secret e Bearer token.

IdempotênciaProteção para operações de escrita e pagamentos online.

WebhooksEventos para ERP, CRM e backoffice do cliente.

OpenAPIBase pronta para Postman, Insomnia, Swagger UI e SDKs.

Primeiros passos

Crie o client_id e client_secret no gerencial da RenkoPay Acquiring.
Autentique-se em POST /api/v1/auth/token para obter o Bearer token.
Envie Idempotency-Key em operações de escrita, especialmente no e-commerce.
Cadastre webhooks do seu sistema em /api/v1/webhooks.
Consulte a especificação OpenAPI e os exemplos cURL desta página para acelerar a integração.

Exemplos de consumo

Do token à transação de e-commerce.

Os trechos abaixo cobrem o caminho mais comum de integração e podem ser usados como base para testes locais e homologação.

Obter token

curl -X POST https://adquirencia.renkopay.com.br/api/v1/auth/token \
  -H 'Content-Type: application/json' \
  -d '{
    "client_id": "seu_client_id",
    "client_secret": "seu_client_secret"
  }'

Consultar transações

curl -X GET https://adquirencia.renkopay.com.br/api/v1/transactions \
  -H 'Authorization: Bearer SEU_TOKEN' \
  -H 'Accept: application/json'

Criar transação de e-commerce

curl -X POST https://adquirencia.renkopay.com.br/api/v1/ecommerce/transactions \
  -H 'Authorization: Bearer SEU_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: 019-renko-demo-0001' \
  -d '{
    "amount": 12990,
    "currency": "BRL",
    "payment_method": "credit",
    "order_id": "PED-1001",
    "capture_mode": "automatic",
    "card": {
      "holder_name": "NOME TESTE",
      "number": "4111111111111111",
      "exp_month": "12",
      "exp_year": "2030",
      "cvv": "123"
    }
  }'

Cadastrar webhook

curl -X POST https://adquirencia.renkopay.com.br/api/v1/webhooks \
  -H 'Authorization: Bearer SEU_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "ERP Principal",
    "url": "https://erp.exemplo.com/webhooks/renko",
    "events": ["transaction.approved", "settlement.paid"]
  }'

Mapa da API

Visão rápida dos grupos de endpoints.

Use esta seção para localizar rapidamente os recursos da API antes de aprofundar-se na especificação OpenAPI.

Autenticação

POST /api/v1/auth/token

Merchants e estabelecimentos

GET /api/v1/merchants
GET /api/v1/merchants/{id}
GET /api/v1/establishments
GET /api/v1/establishments/{id}

Terminais

GET /api/v1/terminals
GET /api/v1/terminals/{id}
POST /api/v1/terminals/{id}/sync
POST /api/v1/terminals/{id}/activate
POST /api/v1/terminals/{id}/suspend

Transações e e-commerce

GET /api/v1/transactions
GET /api/v1/transactions/{id}
POST /api/v1/ecommerce/transactions
GET /api/v1/ecommerce/transactions/{id}
POST /api/v1/ecommerce/transactions/{id}/capture
POST /api/v1/ecommerce/transactions/{id}/cancel
POST /api/v1/ecommerce/transactions/{id}/refund

Financeiro e webhooks

GET /api/v1/reconciliations
GET /api/v1/receivables
GET /api/v1/settlements
GET|POST|PUT|DELETE /api/v1/webhooks
POST /api/webhooks/phoebus/ecommerce
POST /api/webhooks/phoebus/paystore
POST /api/webhooks/phoebus/conciliation