Contas

Capacidades e restrições da conta

GET/v1/accounts/capabilitiesImplementada

Chave de API (Authorization: Bearer ep_…)· escopo payments:read· getCapabilities

Capacidades efetivas da conta selecionada em X-Account-Id: interseção de flags da plataforma, contrato, provedor, situação cadastral e risco. Consulte antes de oferecer um meio de pagamento.

Escopo da chave: payments:read.

curl -X GET "$ECLIPTA_PAY_API/v1/accounts/capabilities" \
  -H "Authorization: Bearer $ECLIPTA_PAY_KEY" \
  -H "X-Account-Id: $ECLIPTA_PAY_ACCOUNT"

{
  "accountId": "acc_01JDY7Q2M3N4P5R6S7T8V9W0XB",
  "environment": "sandbox",
  "asOf": "2026-11-13T13:00:00.000Z",
  "enabled": [
    "PAYMENTS",
    "PIX",
    "BOLETO",
    "CARD_TRANSPARENT"
  ],
  "restrictions": [
    {
      "code": "CONTRACT_PENDING",
      "capability": "PIX_FINANCED",
      "message": "Pix financiado indisponível: sem provedor de crédito."
    }
  ]
}

Erros

Conta financeira selecionada e situação do onboarding

GET/v1/accountImplementada

Chave de API (Authorization: Bearer ep_…)· escopo payments:read· getAccount

Conta financeira selecionada, situação do onboarding no provedor e eventual suspensão local de novas operações (consultas continuam disponíveis).

Escopo da chave: payments:read.

curl -X GET "$ECLIPTA_PAY_API/v1/account" \
  -H "Authorization: Bearer $ECLIPTA_PAY_KEY" \
  -H "X-Account-Id: $ECLIPTA_PAY_ACCOUNT"

{
  "id": "acc_01JDY7Q2M3N4P5R6S7T8V9W0XB",
  "environment": "sandbox",
  "kind": "SUBACCOUNT",
  "displayName": "Loja Exemplo",
  "status": "ACTIVE",
  "onboarding": {
    "general": "APPROVED",
    "documentation": "APPROVED",
    "commercialInfo": "APPROVED",
    "bankAccountInfo": "APPROVED"
  },
  "localSuspension": {
    "suspended": false,
    "reason": null
  }
}

Erros

E-mails ao pagador: link do checkout e lembretes

GET/v1/account/payer-notificationsImplementada

Chave de API (Authorization: Bearer ep_…)· escopo checkout:write· getPayerNotificationSettings

E-mails ao pagador desta conta: o link do checkout ao criar a sessão e lembretes em dias relativos ao prazo do link (padrão D-3, D0 e D+1). Lembrete de link já expirado não é enviado.

Escopo da chave: checkout:write.

curl -X GET "$ECLIPTA_PAY_API/v1/account/payer-notifications" \
  -H "Authorization: Bearer $ECLIPTA_PAY_KEY" \
  -H "X-Account-Id: $ECLIPTA_PAY_ACCOUNT"

{
  "enabled": true,
  "reminderOffsetsDays": [
    -3,
    0,
    1
  ]
}

Erros

Configurar os e-mails ao pagador (lembretes D-3, D0, D+1 por padrão)

PUT/v1/account/payer-notificationsImplementada

Chave de API (Authorization: Bearer ep_…)· escopo checkout:write· updatePayerNotificationSettings

Liga/desliga os e-mails ao pagador e define até 5 lembretes, de 7 dias antes a 7 dias depois do prazo do link. Vale para as próximas sessões.

Escopo da chave: checkout:write.

Idempotência: exige o header Idempotency-Key.

Corpo da requisição

curl -X PUT "$ECLIPTA_PAY_API/v1/account/payer-notifications" \
  -H "Authorization: Bearer $ECLIPTA_PAY_KEY" \
  -H "X-Account-Id: $ECLIPTA_PAY_ACCOUNT" \
  -H "Idempotency-Key: <uma chave por intenção>" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"reminderOffsetsDays":[-1,0]}'

{
  "enabled": true,
  "reminderOffsetsDays": [
    -1,
    0
  ]
}

Erros