Sandbox Headers
O ambiente de sandbox do BTG Pactual Empresas oferece um header customizado chamado x-response
que permite forçar o tipo de resposta desejada: sucesso ou erro.
Esse recurso é especialmente útil durante o desenvolvimento para validar o comportamento da aplicação frente a diferentes cenários de resposta.
APIs compatíveis com headers de sandbox serão indicadas na API reference com um aviso similar a:
Headers de Sandbox
Este endpoint suporta Sandbox Headers
Header Descrição x-response Controlar o tipo de resposta da API.
Header: x-response
x-response
O header
x-response
funciona exclusivamente em ambiente de sandbox. Chamadas em ambientes de produção não são compatíveis com este header e resultarão em erro.
Valores Aceitos
Valor | Descrição |
---|---|
success | Força a API a retornar uma resposta de sucesso (200 ou 201 ) |
error | Força a API a retornar uma resposta de erro (400 ) com payload simulado |
Exemplos de Uso
1. Simular Resposta de sucesso
GET /30306294000145/banking/direct-debit/debits HTTP/1.1
Host: api.sandbox.empresas.btgpactual.com
x-response: success
Content-Type: application/json
2. Simular resposta de erro
GET /30306294000145/banking/direct-debit/debits HTTP/1.1
Host: api.sandbox.empresas.btgpactual.com
x-response: error
Content-Type: application/json
Updated 3 days ago