Sandbox
Sandbox access is not offered yet: no sandbox deployment runs today, and this page describes it as it will be. The sandbox will be a separate Birlesa deployment for building and testing integrations, running the same code as production with its own data and its own keys; its address and sign-in will come with sandbox access.
What is different
- Partners are simulated. Escrow, financing, sanctions screening, e-invoicing and shipment tracking answer like the real partners, but no money moves and nothing reaches a tax authority or a carrier.
- You act as the partner with the routes below, so you can take a deal from quote to paid, released and invoiced without waiting for anyone. They take the same signed path as the real partners' notifications, so the ledger, events and webhooks that follow are the real ones.
- Data is test data. Company pages come from sample records. Do not put real personal data in the sandbox.
- Keys, OAuth clients and webhooks of the sandbox work only there, and production's only in production.
Acting as the partner
These routes exist only in the sandbox. They need a signed-in owner or admin of the side named.
| Route | Who | Does |
|---|---|---|
POST /sandbox/v1/escrows/{escrow_id}/pay | the buyer | Pays the escrow (what the partner's payment page would do). The escrow becomes funded; escrow.funded follows. |
POST /sandbox/v1/escrows/{escrow_id}/confirm | either side | The partner confirms the releases and refunds Birlesa instructed and it had not confirmed yet. |
POST /sandbox/v1/credit/{application_id}/decision | the buyer | {"decision": "offer"} (optionally total_due) or {"decision": "decline"}. |
POST /sandbox/v1/shipments/{shipment_id}/milestones | a party | {"code": "departed", "location": "Mersin"}: a milestone from the tracking provider. Codes: booked, gate_in, departed, transshipment, arrived, customs_cleared, out_for_delivery, delivered, exception. |
Each answers {"applied": n}: how many notifications took effect (0 when nothing was waiting).
Screening
The simulated sanctions screening flags any organization whose name contains "sanctioned" (in any letter case), so you can see a refused escrow (kyb_failed). Every other name passes.