Integrate Fiat Payments

🚧
Early Access
The Fiat endpoints are currently in early access and may change as we continue to improve and refine their functionality.

What is a Fiat Payment?

Fiat Payouts refer to the fiat currency (for example, EUR or GBP) payouts to bank accounts of end-users or businesses directly from your BVNK merchant account or wallets.

Fiat Pay-ins refer to the fiat currency (for example, EUR or GBP) pay-ins from any bank accounts of end-users or businesses directly to your BVNK Virtual Accounts.

🚧
Testing Fiat Payouts in Sandbox
A test Virtual International Bank Account Number (VIBAN) is required to initiate fiat payouts.
Reach out to the integrations team to set one up if you wish to test this flow.
Once a wallet and VIBAN have been created, you may convert funds to this wallet and test the flow.
Note that no funds will be received when creating a payout, as this is only a test function.

What is a Fiat Webhook?

Webhooks are a form of event-driven communication, which means they execute immediately after a request is received. This mechanism allows BVNK to send real-time data to you when a specific event occurs such as a payin or a payout, the update of the event is sent via an HTTP request.

Fiat payout workflow

Fiat payouts progress through various statuses as part of the payout workflow. This document provides a detailed explanation of each status and its role in the process.

Status	Description
PENDING_APPROVAL	Optional. This state is returned if payouts from the wallet require approvals. The payout will remain in this state until all approvals are received. After that, the PROCESSING webhook is emitted. Only relevant for fiat transactions.
PROCESSING	Payouts will remain in this state until a final response has been received from our processing partners.
COMPLETED	Once a payout has been successfully completed from the side of BVNK, the payout will transition to COMPLETED. Note that it is still possible for the funds to be rejected by the beneficiary bank.
FAILED	If for any reason our processing partners are unable to successfully complete the payout, the payout will transition to FAILED, and funds will remain in the merchant's wallet.
CANCELLED	Should the payment be cancelled, then the status will be transitioned to the CANCELLED state. This can occur in scenarios such as when a four-eyes approval is rejected or the request of a four-eyes approval times out. Funds will be returned to the merchants wallet.
RETURNED	Optional. Should the funds be returned after we have received a response from our processing partners, the payout will be marked as returned and the funds will be returned to the merchants wallet.
ON_HOLD	This status is shown when screening takes longer than anticipated.

The following diagram shows the possible transitions between states.

API environments

You can use separate environments for development and live operations:

Environment	Endpoint
Production	`https://api.bvnk.com/`
Sandbox	`https://api.sandbox.bvnk.com/`

Use the Sandbox environment to test your integration safely before going live.