How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

BVNK Payments API

The Payments API from BVNK — 3 operation(s) for payments.

BVNK Payments API is one of 17 APIs that BVNK publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 3 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 1.0.1.

Requests are made against 2 base URLs: https://api.sandbox.bvnk.com, https://api.bvnk.com.

4 operations 3 paths 14 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.1
Base URL
https://api.bvnk.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

BVNK Payments API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Hawk).

  • Hawk — Hawk Payload (see: https://github.com/hueniverse/hawk)

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Payments 4
GET
/api/v1/pay/summary
List Payments
9 params → 200400500
POST
/api/v1/pay/summary
Create payment
body → 200400500
GET
/api/v1/pay/{uuid}/summary
Get Payment
1 param → 200400500
PUT
/api/v1/pay/validate
Validate Address
body → 200400500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are SummaryPaymentDto (24 properties), GatewayTransactionDto (10 properties), PayRequestDto (9 properties), PayOutDetailDto (5 properties). Each schema is shown below with its type and property counts.

PayInDetailDto
object
Specify payment details
1 property 1 required
SummaryPaymentDto
object
Contains all the information about a summary payment object
24 properties
AlternativeAddress
object
List of non-default addresses for other tokens
4 properties
PayAmountsDto
object
Contains the type of currency, and amount to be paid and received
3 properties
PaymentStatusDto
string
Payment status
PayRequestDto
object
DTO required to create a payment in or a payment out
9 properties 5 required
ValidationErrorDto
object
Error object shared when an exception or error is encountered
3 properties 3 required
PayOutDetailDto
object
Specify payment details
5 properties 3 required
DirectionDto
string
Payment in or payment out
ExchangeRateDto
object
contains exchange rate information to convert from base to counter currency
3 properties
ClientValidationErrorDto
object
List of validation errors
1 property
GatewayTransactionDto
object
Specify details about transaction (onchain or offchain) linked to the payment
10 properties
CryptoAddressDto
object
Payment address details
5 properties
ServerErrorDto
object
Error object shared when an exception or error is encountered
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bvnk-payments-api-openapi.yml Raw ↑

Other APIs BVNK publishes across the network.

BVNK Cards API
BVNK Address API
BVNK Asset Pool API
BVNK Channels API
BVNK Currencies API
BVNK Export API
BVNK Fee API
BVNK Key Pair API
BVNK Merchant IDs API
BVNK Network API
BVNK Return API
BVNK Screening API
Where this information came from

This is an independent, third-party profile of BVNK Payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.