Pular para o conteúdo principal

Simulação de cenários

Passo a passo para simular cenários do fluxo recebedor da automatic-pix-api. Essas simulações incluem a atualização de status de recorrências e cancelamentos que são acionados pela SPI (Sistema de Pagamentos Instantâneos).

Informação

Não há payload de retorno (response body) nessas requisições.

1 - Simulação de atualização de recorrência​

Este endpoint simula as atualizações de status de recorrência que a SPI enviará para a automatic-pix-api durante diferentes jornadas do fluxo recebedor.

Request​

ENDPOINT
/mock/outgoing_recurrence/OUTGOING_RECURRENCE_SPI_ID
MÉTODO
PATCH
Request Body: Jornada 1 - Recebimento da solicitação pelo PSP Pagador
{
  "outgoing_recurrence_status": "pending_confirmation"
}
Request Body: Jornada 1 - Recebimento da confirmação da solicitação pelo PSP Pagador
{
  "outgoing_recurrence_status": "approved"
}
Request Body: Jornadas 2, 3 e 4 - Recebimento da solicitação pelo PSP Pagador
{
  "outgoing_recurrence_status": "pending_confirmation"
}
Request Body: Jornadas 2, 3 e 4 - Recebimento da confirmação da solicitação pelo PSP Pagador
{
  "outgoing_recurrence_status": "approved",
  "account_data": {
    "account_number": "123456",
    "account_digit": "7",
    "account_branch": "0001",
    "ispb": "31872495"
  }
}

Path Parameters​

CampoTipoDescriçãoMáx. Caract.
outgoing_recurrence_spi_id*stringIdentificador SPI da recorrência de saída50

Objeto Request Body​

CampoTipoDescriçãoMáx. Caract.
outgoing_recurrence_status*stringStatus da recorrência de saída50
account_dataobjectDados da conta (apenas jornadas 2, 3 e 4)-

Objeto account_data​

CampoTipoDescriçãoMáx. Caract.
account_number*stringNúmero da conta20
account_digit*stringDígito da conta1
account_branch*stringAgência da conta6
ispb*stringCódigo ISPB da instituição financeira8

Enumerador outgoing_recurrence_status​

EnumeradorDescrição
pending_confirmationPendente de confirmação
approvedAprovado
Fluxos de Jornada
  • Jornada 1: Apenas atualização de status, sem dados da conta
  • Jornadas 2, 3 e 4: Primeiro apenas status, depois status + dados da conta

2 - Simulação de cancelamento de recorrência​

Este endpoint simula o cancelamento de uma recorrência de saída acionado pela SPI.

Request​

ENDPOINT
/mock/outgoing_recurrence/OUTGOING_RECURRENCE_SPI_ID/cancel
MÉTODO
PATCH
Sem Payload

Este endpoint não possui request body (payload). Apenas o path parameter é necessário.

Path Parameters​

CampoTipoDescriçãoMáx. Caract.
outgoing_recurrence_spi_id*stringIdentificador SPI da recorrência de saída50

3 - Simulação de cancelamento de pagamento​

Este endpoint simula o cancelamento de um pagamento específico dentro de uma recorrência de saída, acionado pela SPI.

Request​

ENDPOINT
/mock/outgoing_recurrence/OUTGOING_RECURRENCE_SPI_ID/payment_order/PAYMENT_ORDER_SPI_ID/cancel
MÉTODO
PATCH
Sem Payload

Este endpoint não possui request body (payload). Apenas os path parameters são necessários.

Path Parameters​

CampoTipoDescriçãoMáx. Caract.
outgoing_recurrence_spi_id*stringIdentificador SPI da recorrência de saída50
payment_order_spi_id*stringIdentificador SPI da ordem de pagamento50

4 - Simulação de processamento de Ordens de Pagamento e criação de Lotes​

Este endpoint simula o processamento das ordens de pagamento que, consequentemente, irá criar os lotes de conciliação e enviar o Webhook de criação desses lotes.

Request​

ENDPOINT
/mock/process_payment_orders
MÉTODO
PATCH
Sem Payload

Este endpoint não possui request body (payload). A simulação é executada automaticamente.

5 - Simulação de Pix de entrada​

Este endpoint simula o recebimento de um Pix que será associado a uma Ordem de Pagamento de uma recorrência.

Pré-requisito

Este cenário deve ser executado após a simulação do cenário 4 (processamento das ordens de pagamento), pois é necessário ter Ordens de Pagamento e Attempt já criadas para associar o pix de entrada.

Request​

ENDPOINT
/mock/automatic_pix/incoming_pix
MÉTODO
POST
Request Body
{
  "target_account_key": "23a4a2c8-9d82-4ebe-a90d-44fe8d839ec0",
  "amount": 1000.00,
  "receiver_conciliation_id": "7535f0467d9a4af69c4d99408c2fec9d"
}

Objeto Request Body​

CampoTipoDescriçãoMáx. Caract.
target_account_key*stringChave única da conta de destino36
target_alias_keystringChave única do alias de destino (opcional)36
amount*numberValor da transação PIX-
receiver_conciliation_idstringIdentificação de conciliação do recebedor35
Informação

Este endpoint simula o fluxo completo de Incoming Pix, incluindo:

  1. Processamento da transferência Pix
  2. Associação à ordem de pagamento da automatic-pix usando o receiver_conciliation_id

Cenários de Uso​

Jornada 1 - Autorização via Push Notification​

1º Recebimento da solicitação pelo PSP Pagador: Simule com status pending_confirmation

2º Recebimento da confirmação de solicitação pelo PSP Pagador: Simule com status approved

Jornadas 2, 3 e 4 - Autorização via QR Code​

1º Recebimento da solicitação pelo PSP Pagador: Simule com status pending_confirmation

2º Recebimento da confirmação de solicitação pelo PSP Pagador: Simule com status approved + account_data

Cancelamentos​

  • Cancelar Recorrência: Use o endpoint de cancelamento de recorrência
  • Cancelar Pagamento Específico: Use o endpoint de cancelamento de pagamento

Processamento de Lotes​

  • Simular Criação de Lotes: Use o endpoint de processamento das ordens de pagamento para criar lotes e receber webhooks.

Incoming PIX​

  • Simular Recebimento de Pix: Use o endpoint de Incoming Pix para simular pagamentos que serão associados às ordens de pagamento criadas no cenário anterior
Fluxo Recomendado
  1. Crie uma recorrência (cenários 1)
  2. Processe ordens de pagamento (cenário 4) para criar lotes e receber webhooks
  3. Simule Pix de entrada (cenário 5) para associar pagamentos às ordens de pagamento usando o mesmo receiver_conciliation_id