Biftpaydocs
Dashboard

API reference

Every endpoint you can call with a secret key, generated from the same specification the API is built from.

OpenAPI specification

Base URL#

text
https://sandbox.api.biftpay.com

Authentication#

Send your secret key as a bearer token. Test keys start bp_test_, live keys bp_live_; create them in the dashboard under Developers → API keys.

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

Conventions#

  • Amounts are integers in the smallest unit (kobo, cents).
  • Every POST needs an Idempotency-Key header. See Errors, retries and lists.
  • Lists are newest first, up to limit (default 20, at most 100), and page with starting_after.
  • Errors have one shape: { "error": { "type", "code", "message", "param" } }.
Payment intents
  • get/v1/payment_intents
  • post/v1/payment_intents
  • get/v1/payment_intents/{id}
  • post/v1/payment_intents/{id}/cancel
  • and 1 more
Balance
  • get/v1/balance
  • get/v1/balance_transactions
  • get/v1/balance_transactions/export
  • get/v1/reserve
  • and 3 more
Payouts
  • get/v1/bank_accounts
  • post/v1/bank_accounts
  • get/v1/payouts
  • post/v1/payouts
  • and 7 more
Refunds
  • get/v1/refunds
  • post/v1/refunds
  • get/v1/refunds/{id}
Webhooks
  • get/v1/webhook_endpoints
  • post/v1/webhook_endpoints
  • post/v1/webhook_endpoints/{id}/disable
  • post/v1/webhook_endpoints/{id}/enable
  • and 3 more
Brands
  • get/v1/brands
Customers
  • get/v1/customers
  • post/v1/customers
  • get/v1/customers/{id}
Payment links
  • get/v1/payment_links
  • post/v1/payment_links
  • post/v1/payment_links/{id}/activate
  • post/v1/payment_links/{id}/deactivate
Disputes
  • get/v1/disputes
  • get/v1/disputes/{id}
  • get/v1/disputes/{id}/files
  • post/v1/disputes/{id}/files
  • and 3 more
Invoices
  • get/v1/invoices
  • post/v1/invoices
  • get/v1/invoices/{id}
  • post/v1/invoices/{id}/finalize
  • and 1 more
Virtual accounts
  • get/v1/virtual_accounts
  • post/v1/virtual_accounts
  • post/v1/virtual_accounts/{id}/close
Subscriptions
  • get/v1/customers/{id}/payment_methods
  • get/v1/subscriptions
  • post/v1/subscriptions
  • post/v1/subscriptions/{id}/cancel
Test helpers
  • post/v1/test_helpers/payment_intents/{id}/succeed
  • post/v1/test_helpers/balance/release_pending
  • post/v1/test_helpers/settlements/run
  • post/v1/test_helpers/virtual_accounts/{id}/simulate_transfer