Simulação de cenários

Passo a passo para simular a efetivação de ações feitas por agentes externos. Essas simulações incluem: entrada, estorno e portabilidade IN de chave PIX.

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": "\<Chave unitária da conta de destino\>",
  "amount": "\<Valor da transação\>"
}

Body Parameters

Campo	Tipo	Descrição	Máx. Caract.	Exemplo	Observação
target_account_key	string	Chave unitária da conta de destino	36	"41112f46-0034-4007-85687-5e592173db2"
amount	number	Valor da transação	6	1000	Valor máximo de 100.000

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

Request

ENDPOINT

/mock/pix_transfer/incoming_pix_qrcode

MÉTODO

POST

Request Body

{
  "qr_code_key": "41112f46-0034-4007-85687-5e592173db2"
}

Body Parameters

Campo	Tipo	Descrição	Máx. Caract.	Exemplo	Observação
qr_code_key	string	Chave unitária de identificação do qr code	36	"41112f46-0034-4007-85687-5e592173db2"

3 - Simulação de estorno de PIX

Request

ENDPOINT

/mock/pix_transfer/chargeback

MÉTODO

POST

Request Body

{
  "end_to_end_id": "\<Chave unitária da transação\>",
  "amount": "\<Valor da transação\>"
}

Body Parameters

Campo	Tipo	Descrição	Máx. Caract.	Exemplo	Observação
amount	number	Valor da transação	6	1000	Valor máximo de 100.000
end_to_end_id	string	Chave unitária da transação PIX	32	"E3240250220210723142712312751267"

4 - Simulação de webhook de portabilidade IN de chave PIX

Request

ENDPOINT

/mock/pix_keys/key_claim_request/webhook

MÉTODO

POST

Request Body

{
  "claim_request_key": "\<Chave unitária do requester\>",
  "claim_request_status": "\<Enumerador de status\>"
}

Body Parameters

Campo	Tipo	Descrição	Máx. Caract.	Exemplo	Observação
claim_request_key	string	Chave unitária do requester	36	"ced00dc6-000a-0bd4-a111-85710a46ec05"
claim_request_status	enum	Enumerador Claim Request Status		"concluded"

Enumerador Claim Request Status

Enumerador	Descrição
concluded	Concluído
cancelled	Cancelado
failed	Falha
pending_confirmation	Pendente de confirmação

5 - 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

6 - 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.

7 - Recuperar Token enviado para Autenticação de Dois Fatores

Para transações pix individuais e em lote de parceiros integradores com configuração de autenticação de dois fatores, um token é enviado ao aprovador de movimentação da conta. Por meio deste endpoint é possível recuperar o endpoint enviado para fins de teste de integração.

ENDPOINT

/mock/2fa/transaction_request/TRANSACTION_REQUEST_KEY

MÉTODO

GET

Path Params

Campo	Tipo	Descrição	Caracteres
transaction_request_key	uuid4	Chave única de identificação transação. Para o caso de transação pix seria a pix_transfer_key e para o caso de transação pix em lote é a pix_transfer_batch_key	36

Response Body

{
  "token": "1a2b3c"
}