Simular pagamento

Simula o pagamento da cobrança em aberto de um pedido, como se o segurado tivesse autorizado o Pix Automático e pago a primeira parcela. Use-o para testar a jornada completa — emissão do pedido, criação das apólices e os webhooks — sem um pagamento real.

Disponível apenas no sandbox

Este endpoint não existe em produção. Lá, o pedido é emitido quando o segurado paga a primeira parcela pelo payment_artifact Pix retornado na criação do pedido.

O pagamento é assíncrono: a chamada responde assim que o Pix é simulado, e o pedido passa a emitted alguns segundos depois, quando o pagamento é conciliado. Acompanhe pelo webhook de pedido emitido ou pela consulta do pedido — uma consulta feita logo após a chamada ainda mostra awaiting_payment.

Request

ENDPOINT

/v1/insurance/orders/{order_key}/mock/pay

MÉTODO

POST

Path params

Parâmetro	Tipo	Obrigatoriedade	Descrição
order_key	string	obrigatório	Chave do pedido, que deve estar em awaiting_payment.

A requisição não tem corpo.

Response

STATUS

202

Response Body

{
  "insurance_order_key": "5e2b3f60-7c4b-4c8e-9f1a-6d2e8b4a7c90",
  "recurrence_status": "pending_confirmation",
  "recurrence_approval_requested": true,
  "charge_key": "9c1d2e3f-4a5b-4c6d-8e7f-0a1b2c3d4e5f",
  "incoming_pix": {
    "receiver_conciliation_id": "a3f1c9e27b4d4e0a9c552d8e7f6a1b30",
    "amount": 613.62,
    "end_to_end_id": "E00000000202610051559A1B2C3D4E5F",
    "pix_transfer_key": "7b8c9d0e-1f2a-4b3c-8d4e-5f6a7b8c9d0e"
  }
}

Campo	Tipo	Descrição
insurance_order_key	string	Chave do pedido pago — o mesmo order_key da chamada.
recurrence_status	string	Status da autorização do Pix Automático antes da simulação.
recurrence_approval_requested	boolean	true quando a simulação também aprovou a autorização, que ainda estava pendente.
charge_key	string	Chave da cobrança paga — a mais antiga em aberto do pedido.
incoming_pix	object	O Pix simulado: identificador de conciliação, valor pago, end_to_end_id e chave da transferência.

Erros

Todo erro (non-2xx) retorna o corpo padrão { "title", "description", "translation", "code" } — trate programaticamente apenas o campo code.

Status	Código	Descrição
401 / 403	—	Falha de autenticação ou autorização.
404	CAP000003	Pedido inexistente ou pertencente a outra integração.
404	CAP000008	O pedido não tem uma autorização de Pix Automático ativa — por exemplo, um pedido cancelado ou expirado.
422	CAP000021	O pedido não tem cobrança em aberto — por exemplo, um pedido já pago.
422	CAP000022	A autorização do pedido não tem o Pix de ativação a ser simulado.