BVNK Payments API (v.3 draft)
Draft spec, not yet live. Consolidates the Payments v.3 surface described in the API Unification project (payouts, payins, and channels moving to /payment/v3/*) with the Internal Transfers v.3 endpoints already shipped today, so reviewers can see the whole v.3 payments surface in one place.
The Transfers v.3 paths below are copied as-is from the live bvnk-api-endpoints.json for completeness. The Payouts, Payins, Channels, and Channel Payins paths are new and have not shipped yet.
Note on money amounts: Payouts, Payins, and Channels model every amount as a decimal string (for example "9.99"), per the source migration doc's cross-cutting change table. This differs from the already-shipped Transfers v.3 endpoints, which use numeric amounts. Reconcile this inconsistency before merging this draft into the live spec.
Scope: crypto payouts, crypto payment links (payins), and crypto channels are fully specified. Fiat is expected to share these same endpoints, with fiat versus crypto inferred from beneficiary.paymentInstrument.type rather than a request-side method, but its beneficiary bank-detail shape is not yet finalised in the source doc and is only partially modelled here.
See the companion migration guide, Migrate crypto payments from v.1 to v.3, for full v.1/v.2 to v.3 field mappings, and payments-v3-webhooks.yaml for the matching webhook events.
Authentication
- API Key: Hawk
Hawk Payload (see: https://github.com/hueniverse/hawk). Unchanged from v1/v2. No auth work is required to migrate.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | Authorization |