Validate the status of a transaction by its BRR — partner perimeter.
Returns the current lifecycle status of the collection transaction identified by the supplied BRR. The authenticated partner may query only BRRs belonging to their own transactions; a BRR that resolves to another partner's transaction, or to no transaction, returns 404.
Partner-visible credential identifier issued by bank-rail at credential provisioning time. Names which credential signed the request; the corresponding signing secret never appears in any request.
In: header
Path Parameters
Response Body
application/json
curl -X GET "https://example.com/api/v1/bankrail/tokens/string/status"{ "brr": "BRR-0123456789ABCDEF01234567", "status": "pending", "amountKobo": 0, "currency": "NGN", "reference": "string", "createdAt": "2019-08-24T14:15:22Z", "amountPaidKobo": 0}Issue a BRR (Bankrail Retrieval Reference) — partner perimeter. POST
Mints a BRR as a standalone act, ahead of any payment. The authenticated partner (req.user.partnerId from PartnerHmacGuard) is recorded as the issuer; the partner's customer class and tier are read from bankrail.partners. Returns 200 OK with the opaque BRR token the payer presents and the backing vault row id. Standalone BRR issuance is a BRR-level capability: it succeeds for government and corporate partners; fintech and citizen partners receive a 403 (BRR_NOT_AVAILABLE_FOR_CUSTOMER_CLASS). One route and one schema serve every class — the outcome is categorised by the partner's customer class.
Create an invoice (partner perimeter). POST
Creates an invoice attributed to the authenticated partner. Defaults to status='draft'. Set publishOnCreate=true to atomically transition to published and allocate the underlying virtual account in one request. The partner identity (req.user.partnerId from PartnerHmacGuard) is recorded on bankrail.invoices.consumer_partner_id; invoice and credit callbacks are signed by the same partner attribution machinery as standalone payment-intents.