Simulação de cenários

Passo a passo para simular a efetivação de ações feitas por agentes externos. Essas simulações inclúi transações de entrada e devolução .

Informação

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

1 - Simulação de entrada de PIX

Request

ENDPOINT

/mock/pix_transfer/incoming_pix_transfer

MÉTODO

POST

Request Body

{
  "target_account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
  "target_alias_key": "c4332971-7cff-42eb-a117-7e6f0cd74db2",
  "amount": 100.01
}

Objeto Request Body

Campo	Tipo	Descrição	Máx. Caract.
target_account_key*	string	Chave única da conta de destino	36
target_alias_key	string	Chave única do alias de destino	36
amount*	number	Valor da transação	6

2 - Simulação de pagamento de PIX QR Code

Request

ENDPOINT

/mock/pix_transfer/incoming_pix_qrcode

MÉTODO

POST

Request Body

{
  "target_alias_key": "\<Chave única do alias de destino\>",
  "amount": "\<Valor da transação\>",
  "receiver_conciliation_id": "\<id do receiver conciliation do qr code\>"
}

Objeto Request Body

Campo	Tipo	Descrição	Máx. Caract.	Exemplo	Observação
target_alias_key*	string	Chave única do alias de destino	36	"41112f46-0034-4007-85687-5e592173db2"
amount*	decimal	Valor da transação	6	1000.00	Valor máximo de 100.000
receiver_conciliation_id*	string	id de conciliação do recebedor do qr code	36	1000

3 - Simulação de devolução de PIX

Simula a devolução de uma transferência de saída Pix. Para isso o valor total das devoluções não deve exceder o valor da transferência original. Para identificar a transação alvo, envie o end_to_end_id da transferência original.

Request

ENDPOINT

/mock/pix_transfer/reversal

MÉTODO

POST

Request Body

{
  "end_to_end_id": "E35713491202309182110sSCNh25ooX2",
  "amount": 100.00
}

Objeto Request Body

Campo	Tipo	Descrição	Máx. Caract.
end_to_end_id*	string	Chave unitária da transação a ser devolvida	32
amount*	number	Valor a ser devolvido	6

4 - Simulação de transação em estado pendente de confirmação

Transações pix podem entrar em status pending_confirmation quando ocorre alguma demora no retorno da resposta da transação Pix pelo Banco Central. Para simular este cenário, realize uma transação com a chave pix "target_pix_key": "0476f803-0129-430a-a66c-d2f0d7cf4aaa" ou, para transferências pix do tipo manual, utilize "owner_document_number": "48094884894" como número de documento do proprietário da conta de destino.

Para que o status da transação seja atualizado, realize a requisição abaixo com transaction_status de sent para aprovar a transação, ou rejected para reprová-la.

Request

ENDPOINT

/mock/pix_transfer/pending_confirmation

MÉTODO

POST

Request Body

{
  "end_to_end_id": "E32402502202308181802vSHbiqNCk9i",
  "transaction_status": "rejected",
  "status_reason_information": {
    "error_description": "description",
    "error_translation": "translation",
    "error_short_description": "short_description"
  },
  "error_code": "test_error"
}

Body Parameters

Campo	Tipo	Descrição	Máx. Caract.
end_to_end_id*	string	Chave unitária da transação PIX	36
transaction_status*	enum	Enumerador Transaction Status
status_reason_information	objeto	Objeto Status Reason Information
error_code	string	Código de erro

Enumerador Transaction Status

Enumerador	Descrição
sent	Concluído
rejected	Rejeitado

Objeto Status Reason Information

Campo	Tipo	Descrição	Máx. Caract.
error_description	string	Descrição do erro em inglês	100
error_translation	string	Descrição do erro em português	100
error_short_description	string	Descrição curta do erro em inglês	100

5 - Simulação de transação rejeitada

Transações pix podem entrar em status rejected quando ocorre algum retorno esperado de recusa da transação Pix pelo Banco Central ou PSP recebedor. Para simular este cenário, realize uma transação com a chave pix "target_pix_key": "b9380607-dac6-4e17-8ca7-eb761e3aa1dc" ou, para transferências pix do tipo manual, utilize "owner_document_number": "66972913039" ou "owner_document_number": "50305556000164" como número de documento do proprietário da conta de destino.