Guide
Environments
How sandbox and live differ, and how to move between them.
There are two environments, separated by the key you present.
- Sandbox (
bp_test_) — full request and response shapes, simulated rails. Nothing settles, nothing is charged. - Live (
bp_live_) — real customers, real money, real settlement.
Objects never cross the boundary: a sandbox customer does not exist in live, and a live key cannot read a sandbox record. Mixing them returns ENVIRONMENT_MISMATCH.
Simulating money in sandbox
Sandbox helpers let you drive a deposit, a settlement or a failure without waiting for a rail. Use them to exercise the unhappy paths — underpayment, expiry, provider failure — before you go live.
Moving to live
Live keys are issued after full approval and integration readiness: a verified webhook endpoint, an IP allowlist, and at least one successful sandbox call per product you intend to use.
Next
Idempotency