Simulação de cenários

Passo a passo para simular a criação de recorrências e pagamentos automáticos no âmbito do PIX Automático. Essas simulações incluem a criação de recorrências e a criação de pagamentos programados.

1 - Simulação de criação de recorrência

Request

ENDPOINT

/mock/incoming_recurrence

MÉTODO

POST

Request Body: Recorrência de valor fixo

{
  "request_control_key": "01585acf-b0c3-4389-baf3-a58abbe92d58",
  "recurrence_type": "fixed_amount",
  "transaction_amount": 100.50,
  "periodicity": "monthly",
  "journey_type": "journey_one",
  "start_date": "2025-07-01",
  "is_retry_allowed": true,
  "payer_account_information": {
    "owner_name": "John Doe",
    "document_number": "06975239000136",
    "ispb": "32402502",
    "account_digit": "7",
    "account_branch": "3",
    "account_number": "9552432"
}

Request Body: Recorrência de valor variável

{
  "request_control_key": "01585acf-b0c3-4389-baf3-a58abbe92d58",
  "recurrence_type": "variable_amount",
  "minimum_transaction_amount": 50.00,
  "periodicity": "monthly",
  "journey_type": "journey_one",
  "start_date": "2025-07-01",
  "is_retry_allowed": true,
  "payer_account_information": {
    "owner_name": "John Doe",
    "document_number": "06975239000136",
    "ispb": "32402502",
    "account_digit": "7",
    "account_branch": "3",
    "account_number": "9552432"}

Objeto Request Body

Campo	Tipo	Descrição	Máx. Caract.
request_control_key*	string	Chave única de identificação da request no formato uuid4	36
recurrence_type*	string	Tipo de recorrência (fixed_amount ou variable_amount)	20
transaction_amount	number, null	Valor da transação para recorrência de valor fixo (fixed_amount)	10
minimum_transaction_amount	number, null	Valor mínimo da transação para recorrência de valor variável (variable_amount)	10
periodicity*	string	Periodicidade da recorrência	20
journey_type*	string	Tipo da jornada de autorização	50
start_date*	string	Data de início da recorrência (formato YYYY-MM-DD)	10
end_date	string, null	Data de término da recorrência (formato YYYY-MM-DD)	10
is_retry_allowed*	boolean	Permissão para retentativa de transação	-
payer_account_information*	object	Dados da conta do pagador	-
pix_message	string, null	Mensagem PIX associada à transação	140

Observação

Pelo menos um dos campos transaction_amount ou minimum_transaction_amount deve ser fornecido com um valor não nulo. Ambos os campos não podem ser nulos simultaneamente.

Objeto payer_account_information

Campo	Tipo	Descrição	Máx. Caract.
owner_name*	string	Nome do titular da conta	150
document_number*	string	CPF ou CNPJ do titular da conta (apenas números)	14
ispb*	string	Código ISPB da instituição financeira	8
account_digit*	string	Dígito da conta	1
account_branch*	string	Agência da conta	6
account_number*	string	Número da conta	20

Tipos de Recorrência

• Recorrência de valor fixo (fixed_amount): Utilize o campo transaction_amount e não envie minimum_transaction_amount
• Recorrência de valor variável (variable_amount): Utilize o campo minimum_transaction_amount e não envie transaction_amount

Response

STATUS

200

Response Body

{
    "incoming_recurrence_key": "e13c5986-f4d1-4d07-a56b-eda90862630a",
    "incoming_recurrence_spi_id": "RR32402502202507170197A5B7CB9",
    "incoming_recurrence_status": "pending_confirmation",
    "created_at": "2025-07-17T14:44:38Z",
    "account_key": "ba685cfd-3aee-4992-b6bf-58f8038faa6b"
}

Response Body

Campo	Tipo	Descrição	Caracteres
incoming_recurrence_key	uuid	Chave única de identificação da recorrência de entrada	36
incoming_recurrence_spi_id	string	Identificador SPI da recorrência de entrada	29
incoming_recurrence_status	enumerator	Status atual da recorrência de entrada	Enumeradores incoming_recurrence_status
created_at	string	Data e hora de criação da recorrência (formato ISO 8601)	-
account_key	uuid	Chave única de identificação da conta	36

Enumeradores incoming_recurrence_status

Enumerador	Descrição
pending_confirmation	Recorrência pendente de confirmação
active	Recorrência ativa
cancelled	Recorrência cancelada
suspended	Recorrência suspensa
expired	Recorrência expirada

2 - Simulação de criação de pagamento

Request

ENDPOINT

/mock/incoming_recurrence/INCOMING_RECURRENCE_SPI_ID/outgoing_payment

MÉTODO

POST

Request Body

{
  "transaction_amount": 100.50,
  "target_account_data": {
    "owner_name": "John Doe",
    "owner_document_number": "06975239000136",
    "ispb": "32402502",
    "account_digit": "7",
    "account_branch": "3",
    "account_type": "checking_account",
    "account_number": "9552432"
  },
  "receiver_conciliation_id": "12345678900",
  "outgoing_payment_spi_id": "7260a2caa5624ee689292161c2ec07f4",
  "end_to_end_id": "E60701190202110191604DY5LHIZ9O66",
  "next_execution_datetime": "2023-06-01"
}

Objeto Request Body

Campo	Tipo	Descrição	Máx. Caract.
transaction_amount*	number	Valor da transação	10
target_account_data	object	Dados da conta de destino	-
receiver_conciliation_id*	string	Identificação de conciliação do recebedor	35
outgoing_payment_spi_id*	string	Identificador SPI do pagamento	20
end_to_end_id*	string	Chave de idempotência da transação PIX no SPI	32
next_execution_datetime	string	Data e hora da próxima execução (formato YYYY-MM-DD)	10

Objeto target_account_data

Campo	Tipo	Descrição	Máx. Caract.
owner_name*	string	Nome do titular da conta	150
owner_document_number*	string	CPF ou CNPJ do titular da conta (apenas números)	14
ispb_number*	string	Código ISPB da instituição financeira	8
account_digit*	string	Dígito da conta	1
account_branch*	string	Agência da conta	6
account_type*	string	Tipo da conta	20
account_number*	string	Número da conta	20

Enumerador account_type

Enumerador	Descrição
checking_account	Conta Corrente
salary_account	Conta Salário
saving_account	Conta Poupança
payment_account	Conta de Pagamentos

Enumeradores periodicity

Enumerador	Descrição
weekly	Recorrência semanal
monthly	Recorrência mensal
quarterly	Recorrência trimestral
semiannual	Recorrência semestral
annual	Recorrência anual

Enumeradores journey_type

Enumerador	Descrição
journey_one	Solicitação de autorização mediante uma notificação no aplicativo
journey_two	Solicitação de autorização mediante a leitura de um QR Code
journey_three	Autorização de recorrência por meio de um pix imediato mediante leitura de um QR Code
journey_four	Pagamento ou agendamento de um pix com uma solicitação de autorização da recorrência em sequência