Scenario simulation

Step-by-step guide to simulate the creation of recurrences and automatic payments within the scope of PIX Automático. These simulations include creating recurrences and creating scheduled payments.

1 - Recurrence creation simulation

Request

ENDPOINT

/mock/incoming_recurrence

METHOD

POST

Request Body: Fixed amount recurrence

{
  "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: Variable amount recurrence

{
  "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"}

Request Body Object

Field	Type	Description	Max. Char.
request_control_key*	string	Unique request identification key in uuid4 format	36
recurrence_type*	string	Recurrence type (fixed_amount or variable_amount)	20
transaction_amount	number, null	Transaction amount for fixed amount recurrence (fixed_amount)	10
minimum_transaction_amount	number, null	Minimum transaction amount for variable amount recurrence (variable_amount)	10
periodicity*	string	Recurrence periodicity	20
journey_type*	string	Authorization journey type	50
start_date*	string	Recurrence start date (YYYY-MM-DD format)	10
end_date	string, null	Recurrence end date (YYYY-MM-DD format)	10
is_retry_allowed*	boolean	Transaction retry permission	-
payer_account_information*	object	Payer account data	-
pix_message	string, null	PIX message associated with the transaction	140

Note

At least one of the fields transaction_amount or minimum_transaction_amount must be provided with a non-null value. Both fields cannot be null simultaneously.

payer_account_information Object

Field	Type	Description	Max. Char.
owner_name*	string	Account holder name	150
document_number*	string	Account holder CPF or CNPJ (numbers only)	14
ispb*	string	Financial institution ISPB code	8
account_digit*	string	Account digit	1
account_branch*	string	Account branch	6
account_number*	string	Account number	20

Recurrence Types

• Fixed amount recurrence (fixed_amount): Use the transaction_amount field and do not send minimum_transaction_amount
• Variable amount recurrence (variable_amount): Use the minimum_transaction_amount field and do not send 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

Field	Type	Description	Characters
incoming_recurrence_key	uuid	Unique incoming recurrence identification key	36
incoming_recurrence_spi_id	string	Incoming recurrence SPI identifier	29
incoming_recurrence_status	enumerator	Current incoming recurrence status	incoming_recurrence_status Enumerators
created_at	string	Recurrence creation date and time (ISO 8601 format)	-
account_key	uuid	Unique account identification key	36

incoming_recurrence_status Enumerators

Enumerator	Description
pending_confirmation	Recurrence pending confirmation
active	Active recurrence
cancelled	Cancelled recurrence
suspended	Suspended recurrence
expired	Expired recurrence

2 - Payment creation simulation

Request

ENDPOINT

/mock/incoming_recurrence/INCOMING_RECURRENCE_SPI_ID/outgoing_payment

METHOD

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": "3d7d6a2bf72f44z7bb2079a2b94dff56452",
  "outgoing_payment_spi_id": "7d2d1b6cd72f44z7bb2079a2b94dff52673",
  "end_to_end_id": "E60701190202110191604DY5LHIZ9O66",
  "next_execution_datetime": "2023-06-01"
}

Request Body Object

Field	Type	Description	Max. Char.
transaction_amount*	number	Transaction amount	10
target_account_data	object	Target account data	-
receiver_conciliation_id*	string	Receiver conciliation identification	35
outgoing_payment_spi_id*	string	Payment SPI identifier	20
end_to_end_id*	string	PIX transaction idempotency key in SPI	32
next_execution_datetime	string	Next execution date and time (YYYY-MM-DD format)	10

target_account_data Object

Field	Type	Description	Max. Char.
owner_name*	string	Account holder name	150
owner_document_number*	string	Account holder CPF or CNPJ (numbers only)	14
ispb_number*	string	Financial institution ISPB code	8
account_digit*	string	Account digit	1
account_branch*	string	Account branch	6
account_type*	string	Account type	20
account_number*	string	Account number	20

account_type Enumerator

Enumerator	Description
checking_account	Checking Account
salary_account	Salary Account
saving_account	Savings Account
payment_account	Payment Account

periodicity Enumerators

Enumerator	Description
weekly	Weekly recurrence
monthly	Monthly recurrence
quarterly	Quarterly recurrence
semiannual	Semiannual recurrence
annual	Annual recurrence

journey_type Enumerators

Enumerator	Description
journey_one	Authorization request via app notification
journey_two	Authorization request via QR Code reading
journey_three	Recurrence authorization through an immediate pix via QR Code reading
journey_four	Payment or scheduling of a pix with a recurrence authorization request in sequence