Zopio
Desenvolvedores/Guia para desenvolvedores
Guia para desenvolvedores

Um pagamento é um ciclo de vida, não uma única chamada de API.

Mantenha a referência de negócio, a decisão de pagamento, a execução do provedor e o resultado financeiro conectados como uma única operação rastreável — do contexto inicial à autenticação, mudanças de estado, cancelamento ou reembolso.

01Preparar
02Simular
03Executar
04Autenticar
05Observar
06Ajustar
Limite de integração

Identidade estável ao longo do ciclo

A integração começa com uma referência pertencente ao negócio e produz uma identidade transacional durável que pode permanecer conectada à execução do provedor e ao estado financeiro posterior. Assim, a obrigação comercial não depende de uma única solicitação ao provedor.

Referência de negócio

Pedido, recebível, reserva ou outra referência comercial durável pertencente ao seu negócio.

Identidade da transação

Identidade em nível de plataforma usada para acompanhar a operação enquanto estado do provedor e canal mudam.

Resultado do provedor

Resultados de autorização, autenticação e execução permanecem ligados ao contexto da transação.

Estado financeiro

Cancelamento, reembolso, liquidação ou conciliação posteriores podem continuar no mesmo ciclo.

Padrão comprovado

Visualize antes de executar

Uma etapa de decisão pode avaliar o contexto da transação antes de o dinheiro se mover. O padrão comprovado separa elegibilidade e escolha de rota da execução, permitindo avaliar o caminho e a economia esperada antes de confirmar a operação.

  • Use valor, moeda, contexto de cliente ou conta e regras comerciais para definir elegibilidade.
  • Avalie um provedor ou rota de execução elegível antes da chamada final de pagamento.
  • Mantenha a economia esperada e a escolha do provedor explicáveis como parte da decisão.
  • Execute somente quando a aplicação tiver a decisão de que precisa.
Modelo conceitual de objeto — não é um schema atual de API
{
  "reference": "your-business-reference",
  "payment_context": {
    "amount": "...",
    "currency": "...",
    "channel": "..."
  },
  "transaction": {
    "id": "durable-transaction-id",
    "state": "..."
  },
  "decision": {
    "eligible_path": "...",
    "expected_economics": "..."
  }
}
Modelo de implementação

Operações do ciclo de vida

Estes padrões descrevem comportamentos de integração comprovados em sistemas de produção. Eles definem o modelo técnico; não prometem que a API atual da Zopio utilizará um endpoint, campo ou formato de contrato específico.

01

Preparar

Reúna o contexto comercial e de pagamento necessário para formar uma experiência elegível.

02

Simular

Avalie a rota elegível e a economia esperada antes da execução.

03

Executar

Inicie o pagamento pela rota conectada selecionada.

04

Autenticar

Conclua a autenticação do cliente exigida pelo provedor quando o fluxo pedir.

05

Observar

Use mudanças de estado, eventos e consultas para entender o resultado atual.

06

Ajustar

Continue o ciclo com conclusão, cancelamento, reembolso ou outra ação posterior permitida.