Saltar al contenido principal

Sandbox Headers

El nuevo ambiente de sandbox de BTG Pactual Empresas ofrece un header personalizado llamado x-response que permite forzar el tipo de respuesta deseada: éxito o error.

Este recurso es especialmente útil durante el desarrollo para validar el comportamiento de la aplicación frente a diferentes escenarios de respuesta.

Las APIs compatibles con headers de sandbox se indicarán en el API reference con un aviso similar a:

📘 Headers de Sandbox

Este endpoint admite Sandbox Headers

HeaderDescripción
x-responseControlar el tipo de respuesta de la API.

Header: x-response​

⚠️ El header x-response funciona exclusivamente en ambiente de sandbox. Las llamadas en ambientes de producción no son compatibles con este header y resultarán en error.

Valores aceptados​

ValorDescripción
successFuerza a la API a retornar una respuesta de éxito (200 o 201)
errorFuerza a la API a retornar una respuesta de error (400) con payload simulado

Ejemplos de uso​

1. Simular respuesta de éxito​

GET /30306294000145/banking/direct-debit/debits HTTP/1.1
Host: api.sandbox.empresas.btgpactual.com
x-response: success
Content-Type: application/json

2. Simular respuesta de error​

GET /30306294000145/banking/direct-debit/debits HTTP/1.1
Host: api.sandbox.empresas.btgpactual.com
x-response: error
Content-Type: application/json