Biftpaydocs

Brands

A brand is another name your business sells under: a second shop, a product line, a franchise. Each brand shows its own name and logo at checkout, keeps its own balance, and can settle to its own bank account. Your business itself is the main brand.

Finding a brand's ID#

Every brand has an ID. You'll find it with a Copy button on Brands in the dashboard, or list your brands with the API:

bash
curl https://sandbox.api.biftpay.com/v1/brands \
  -H "Authorization: Bearer bp_test_..."

Each brand in the list has an id, its name and display_name, and review.status.

Taking payments for a brand#

Pass the brand's ID as brand when you create a payment, a payment link, an invoice, a subscription or a virtual account:

bash
curl https://sandbox.api.biftpay.com/v1/payment_intents \
  -H "Authorization: Bearer bp_test_..." \
  -H "Idempotency-Key: order-1042" \
  -H "Content-Type: application/json" \
  -d '{ "amount": 500000, "currency": "NGN", "brand": "8c1f2e4a-0b3d-4c5e-9f6a-7b8c9d0e1f2a" }'

The customer sees the brand's display name and logo at checkout, and the money goes to that brand's balance. The payment comes back with brand set, so you can tell your brands apart in webhooks and lists.

Leave brand out and the payment belongs to your main business.

A new brand is reviewed before it takes live payments; most are approved straight away. Until then a live payment for it is refused with brand_not_approved (test mode works from the start). An archived brand, or an ID that isn't yours, is refused with brand_invalid.

Paying out from a brand#

Each brand's money stays in its own balance. To pay out from one, pass brand on the payout:

bash
curl https://sandbox.api.biftpay.com/v1/payouts \
  -H "Authorization: Bearer bp_test_..." \
  -H "Idempotency-Key: payout-brand-17-oct" \
  -H "Content-Type: application/json" \
  -d '{ "amount": 200000, "currency": "NGN", "bank_account_id": "...", "brand": "8c1f2e4a-0b3d-4c5e-9f6a-7b8c9d0e1f2a" }'

The amount and the fee come out of that brand's available balance. Leave brand out to pay from the main business's balance. Bulk payouts take brand too.

Balances, statements and settlement#

  • GET /v1/balance?brand=… is one brand's balance; leave brand out for the whole business.
  • GET /v1/balance_transactions?brand=… and the CSV export take brand the same way.
  • With automatic settlement on, each brand's available naira is paid to the brand's own settlement account if it has one, otherwise to your business's. Choose it on Brands in the dashboard.