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

Campo	Tipo	Descrição	Máx. Caract.
outgoing_recurrence_spi_id*	string	Identificador SPI da recorrência de saída	50

Objeto Request Body

Campo	Tipo	Descrição	Máx. Caract.
outgoing_recurrence_status*	string	Status da recorrência de saída	50
account_data	object	Dados da conta (apenas jornadas 2, 3 e 4)	-

Objeto account_data

Campo	Tipo	Descrição	Máx. Caract.
account_number*	string	Número da conta	20
account_digit*	string	Dígito da conta	1
account_branch*	string	Agência da conta	6
ispb*	string	Código ISPB da instituição financeira	8

Enumerador outgoing_recurrence_status

Enumerador	Descrição
pending_confirmation	Pendente de confirmação
approved	Aprovado

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

Campo	Tipo	Descrição	Máx. Caract.
outgoing_recurrence_spi_id*	string	Identificador SPI da recorrência de saída	50

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

Campo	Tipo	Descrição	Máx. Caract.
outgoing_recurrence_spi_id*	string	Identificador SPI da recorrência de saída	50
payment_order_spi_id*	string	Identificador SPI da ordem de pagamento	50

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