Gig economy
Use our Gig-economy product to access account, owner, and transaction data to get a comprehensive view of your gig user.
We refer to links created with a gig-economy provider (such as Uber or Rappi) as gig links.
Accounts
Our Accounts endpoint provides you with information regarding the gig account in a gig economy institution. Usually, an end user has just one Account inside each gig link.
Use this endpoint to get information about a gig link's:
- account type and category
- current account balance
- account currency
- and so much more
We offer the following methods when it comes to interacting with Accounts:
| Endpoints | Method | Description |
|---|---|---|
| Retrieve | POST | Retrieve all accounts related to a specific link. |
| List | GET | List all the accounts from all the Links already associated with your Belvo account. |
| Resume | PATCH | Resume an Account Retrieve session that was paused because an MFA token was required by the institution. |
| Detail | GET | Get the details of a specific account. |
| Destroy | DELETE | Delete a specific account and all associated transactions from your Belvo API key. |
Owners
Our Owners endpoint provides you information regarding the person who is the owner of each account within the gig link.
Use this endpoint to get information about a link owner's:
- full name
- phone number
- mailing address
- email address
We offer the following methods when it comes to interacting with Owners:
| Endpoints | Method | Description |
|---|---|---|
| Retrieve | POST | Retrieve the owner detail of a specific link. |
| List | GET | List all owners associated to your Belvo account. |
| Resume | PATCH | Resume an Owner Retrieve session that was paused because an MFA token was required by the institution. |
| Detail | GET | Get the details of a specific owner. |
| Destroy | DELETE | Delete a specific owner from your Belvo account. |
Transactions
Our Transactions endpoint provides you with detailed transactional information for an end user.
Use this endpoint to get information about a gig link's:
- transaction history
- the category for each transaction
- the status of each transaction
We offer the following methods when it comes to interacting with Transactions:
| Endpoints | Method | Description |
|---|---|---|
| Retrieve | POST | Retrieve all transactions related to a specific account within a data range. |
| List | GET | List all the transactions from all Links you have access to. |
| Resume | PATCH | Resume a Transaction Retrieve session that was paused because an MFA token was required by the institution. |
| Detail | GET | Get the details of a specific transaction, using the transaction ID. |
| Destroy | DELETE | Delete a specific transaction from your Belvo account. |
Transaction categorization
Using a combination of internal and external data sources, we provide a clean and standardized category for most transactions.
A category is automatically assigned to each transaction as soon as it is retrieved from the bank.
Here is the list of transaction categories we support:
| Category | Example of transaction |
|---|---|
| Deposits | "DEPOSITO INTERBANCARIO" |
| Home & Life | "ELEKTRA MEXIC" |
| Food & Groceries | "OXXO CIPRESES" |
| Online Platforms & Leisure | "NETFLIX COM CR" |
| Transport & Travel | "UBER TRIP HELP.UBER.COM" |
| Personal Shopping | "LIVERPOOL POR INTERNET" |
| Taxes | "IVA COM MEMBRESIA" |
| Withdrawal & ATM | "RETIRO CAJERO AUTOMATICO" |
| Credits & Loans | "ABONO A CREDITO GLOBAL" |
| Bills & Utilities | "HT TELCEL 018008" |
| Investments & Savings | "ABONO INTERESES AHORROS" |
| Fees & Charges | "COMISION EMISION" |
| Income & Payments | "PAGO DE NOMINA" |
| Transfers | "SPEI RECIBIDOSTP" |
Updated 5 months ago