BRR
The Bankrail Retrieval Reference — one reference for one value movement, from issuance through credit, callback, and reconciliation.
A BRR (Bankrail Retrieval Reference) is Bankrail's single reference for one value
movement. It identifies a collection or disbursement from issuance all the way through
credit, callback, and reconciliation. When an instrument is BRR-bearing, every
credit-confirmed callback for it carries a brr field you can reconcile against.
Who gets BRR-bearing instruments
Whether an instrument is BRR-bearing depends on your customer class:
- Government and corporate partners get BRR-bearing instruments by default.
- Fintech partners (the default for self-signup) are reference-only by default,
and opt in per call by passing
"brrBearing": trueon the create request.
Opting in per call
Fintech-class partners add "brrBearing": true when creating a virtual account or
intent. The instrument is then created with a BRR bound to it, and its callbacks carry
the brr.
Reconciling with a BRR
Because a BRR identifies exactly one value movement end to end, you reconcile by matching
the brr on a credit-confirmed callback against the instrument you issued. The reference
is stable across the whole lifecycle — issuance, credit, callback, settlement — so it's a
reliable join key for your books.
Same flow, every class
The end-to-end flow is identical for corporate and fintech partners. The only difference is whether the BRR is on by default or opted in with the flag.
Next
- Virtual Accounts — creating a BRR-bearing instrument.
- Callbacks — where the
brrarrives.
Callbacks
How Bankrail notifies your service — signed, retryable, idempotent by header — when a credit lands or a transfer settles.
Fire a synthetic inbound credit at a sandbox virtual account. POST
Sandbox-only. Simulates a customer paying into the given virtual account so you can test your credit-confirmed callback handler end-to-end. The synthetic credit runs through the same matching, intent-completion, and callback-delivery pipeline a real credit uses — your callbackUrl receives a real, signed, retried credit-confirmed callback. Available to any sandbox-environment credential, on a virtual account that resolves to a test adapter. Never available to a live-environment credential.