Custom Providers
Build your own connections to BT Core
Experimental API
This feature is still in the experimental phase. It is only supported in SaaS and may change with time. For enabling the permissions for your credentials, ask us in our help desk.
We love Open Banking, it's the main purpose of Bit Capital and for that we created a way to customize even more your BT Core with your own providers. In this section we describe in details how it works and the theory behind it.
We recommend reading the Assets and Wallets , Platform Assets and Custom Assets before.
Structure of an Asset Provider
A provider is basically a micro-service that follows the Bit Capital Provider API Contracts for communicating with the Core API. It is divides in the features and methods to allow different providers to have different operations that it controls.
Another important property of a provider is that it needs to be associated with an asset on the platform, it should be a Custom Assets.
Operation Flow
When you are using your instance of BT Core, whenever you want to execute a operation you usually send an asset for that operation (or it's implicit that it is the root asset). When you make this request, behind the curtains the Core API makes a request to a specific URL in the provider associated with the asset you specified.
After that, the provider answers the Core API and you get your operation executed in most cases. When you're using your own custom providers, expect that the Core API will make a request to you everytime someone asks for a given operation in your asset.
Provider Methods
These are the required methods for a provider to work, they mostly reside on the wallet registration cycle.
| Method | URL | Description |
|---|---|---|
| register | POST /provider/register | Registers a new wallet to the provider |
| unregister | POST /provider/unregister | Deletes an existing wallet from the provider |
| block | POST /provider/block | Blocks an existing wallet |
| unblock | POST /provider/unblock | Unblocks a wallet that was previously blocked |
| update | POST /provider/update | Updates informations about a certain wallet |
| isAccountNumberAvailable | POST /provider/accounts/availability-check | Checks if a account number is available for this provider |
| isApproved | GET /provider/:walletId/is-approved | Checks if a certain wallet is approved in the provider KYC. |
| status | GET /status | Health check between the Core API and the provider. |
Provider Features
Features are the possible types of operations a provider that can have, a provider can have multiple features and every feature has it's set of required methods in it.
| Feature | Description |
|---|---|
| audit | Features focused on gathering informations for audit reasons |
| block | Feature for blocking / unblocking user operations in the provider |
| branch | Feature related to branch management inside a provider |
| boleto_emission | Feature related to the boleto emission operation |
| boleto_payment | Feature related to the boleto payment operation |
| card | Feature related to card operations, more info in Provider Card Feature |
| deposit | Feature related to deposit operations in the provider |
| document | Feature related to document operations in the provider |
| payment | Feature related to p2p transfers inside a provider |
| postback | Feature related to handling postbacks that came outside the platform to this provider using the BT Core Hooks |
| withdraw | Feature related to handling the withdraw operation in a provider |
| phone_credits | Feature related to handling the phone credits purchases in a provider |
| legal | Feature related to the cycle of accepting legal terms inside a provider |
| participating_institution | Feature related to providing a list of participating institutions for this specific provider |
Updated almost 4 years ago