ALVIERE

ALVIERE Account Wallet API

This section details the ledger which contains the funding information for the account. ### Ledger and Balances There are three types of funding buckets managed by the Alviere ledger: | Bucket | Description | |--------|-------------| | **BALANCE** | These are the settled funds in the user account. | | **IN_TRANSIT** | The unsettled funds in the user account. This amount generally includes funds that have been authorized by a user transaction, but have not yet settled from the corresponding processor. | | **CAPTIVE** | The funds that have been held captive for a transaction that was performed on the account. For example, if an ACH Debit was performed, the funds will be held captive until the transaction executes. | The account wallet APIs allow you to perform operations on the account ledger or move funds within the system to other account wallets. ### Account Wallet Transactions Transactions on the account wallet follow a specific flow depending on the transaction type being executed. The available account statuses are as follows: | Status | Description | |--------|-------------| | **ACTIVE** | The transaction has been created in the system. | | **PROCESSING** | The transaction is currently processing; this usually happens when a ledger transaction requires a payment to be pulled or pushed from a payment method. | | **PENDING** | The transaction is pending acceptance from the receiver of the transaction. | | **CANCELLED_USER** | The transaction has been cancelled at the user's request. | | **CANCELLED_SYSTEM** | The transaction has been cancelled by an automated system process; the reason for the cancellation will be present on the response of the API call. | | **ERROR** | The transaction has failed due to a system error. | | **FAILED** | The transaction failed due to an unsuccessful underlying payment transaction, such as an NSF response from the processor. The reason for the failure will be present on the response of the API call. | | **EXPIRED** | The transaction has expired in the system because the processing of the transaction did not complete within the predefined time for execution. | | **COMPLETED** | The transaction has been completed and the funds were successfully transferred. | | **REJECTED** | The transaction was rejected by a manual review process. | | **PENDING_KYC** | The transaction is currently pending and awaiting the receiver/recipient to complete their KYC information. | | **PROCESSING_PAYMENT** | The transaction is currently processing a payment operation with the underlying processor. | | **WAITING** | The transaction is currently waiting for funds to be available in order to be executed; this status occurs only on Withdraw transactions when the corresponding reserve account has insufficient funds. The transaction will automatically post when the funds on the reserve account are replenished. | | **MANUAL_REVIEW** | The transaction has been placed in manual review and awaits an operator decision to be posted. | | **VOIDED** | The transaction has been voided due to voiding of the underlying payment transaction directly with the processor. | **Note**: Different workflows and statuses may apply to different transaction types. ### Holding Funds In order for any user account to hold funds in Alviere, they need to perform the full KYC and Identity Management processes. For further details, see the [Accounts](#tag/Accounts) section of the documentation. ### Service Fees Alviere supports the application of Service Fees on any user account wallet transaction. To apply your own service fees to a transaction, you should set the desired amount or percentage of the total value of the transaction in the corresponding structure. Service Fees will be automatically be moved to your service fees account; this is a native feature of Alviere's Treasury Management module. A transaction of type `SERVICE_FEE` will be automatically created as a child transaction of the original user account wallet transaction. Service Fees are only collected once the transaction moves to `COMPLETED` status. If the transaction is not completed (eg. `REFUND`), the service fee transaction will also be void and the funds will not move to your service fees account. Service Fees in Alviere always apply to transactions and can be charged in the following types: | Service Fee Type | Description | |------------------|-------------| | **PERCENT** | Use this service fee type if you want a service fee percentage to be applied on the total amount of the transaction. For example, if the total amount is $100 and you want to apply a 10% fee, you should set the property to `value: 10` | | **AMOUNT** | Use this service fee type if you want a fixed amount service fee to be applied to the transaction, in cents (eg. `value: 1000`). | | **PERCENT_CAPPED** | Use this service fee type if you want a service fee percentage to be applied on the total amount of the transaction, up to a certain amount. For example, if the total amount is $1000 and you want to apply a 10% fee capped to $50, you should set the `value: 10` and `cap: 5000` | In terms of how the transaction amount applies to the transaction: | Charge Type | Description | |-------------|-------------| | **UPCHARGE** | The service fee will be applied as an upcharge to the transaction. For example, if a customer is performing a cross-border transaction of $100 and there's a `PERCENT` service fee of 10%, the user account would be charged $110. | | **DEDUCT** | The service fee will be applied as a deduction to the transaction amount. For example, if a customer is performing a withdraw transaction of $100 and there's a `PERCENT` service fee of 10%, the user would only receive $90 on their account. | ### Captivating/Uncaptivating Funds Alviere supports the custom captivation of funds in the user account's wallet. Captivation needs to have a corresponding ledger entry associated with it, generally a `LOAD` funds transaction type. The following business rules apply to funds captivation: - Funds can only be captivated in the user account wallet if the sum `balance` + `in_transit` funds is equal to or greater than the funds being captivated. - When captivating funds, Alviere's ledger will always use `balance` funds first, and if the full amount is not available, the remainder will be taken from the `in_transit` funds. The following business rules apply to the uncaptivation of funds: - Funds can only be uncaptivated when the amount is less than or equal to the `captive` amount and the original transaction that captivated the funds has not completed. - Funds that are uncaptivated return to the corresponding buckets: - To the `balance` bucket for settled funds; - To the `in_transit` bucket for unsettled funds. Note that the captivated funds also abide by the settlement rules of the underlying payment processor. For example, if funds are captivated from the `in_transit` bucket and settle in the meantime, they return to the user account wallet as `balance` when the funds are uncaptivated.

GitHub OpenAPI

Operations 11

GET /v1/ledger/{account_uuid} Get Balance #
GET /v1/ledger/{account_uuid}/transactions/{transaction_uuid} Get Transaction #
GET /v1/ledger/{account_uuid}/transactions Get Transactions #
POST /v1/ledger/{account_uuid}/load Load Funds #
POST /v1/ledger/{account_uuid}/withdraw Withdraw Funds #
POST /v1/ledger/{account_uuid}/send Send Funds #
POST /v1/ledger/promo Add Promo Credit #
POST /v1/ledger/transfer/debit Create Debit Transaction #
POST /v1/ledger/transfer/credit Create Credit Transaction #
GET /v1/accounts/{account_uuid}/dda Get Demand Deposit Account #
GET /v1/ledger/{account_uuid}/transactions/{transaction_uuid}/receipt Get Receipt #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/alviere/refs/heads/main/openapi/alviere-account-wallet-api-openapi.yml

Other Resources

🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/alviere/refs/heads/main/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/alviere:alviere-account-wallet-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

alviere-account-wallet-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 0.0.3
  title: Alviere Account Wallet API
  contact:
    email: support@alviere.com
    url: http://alviere.com/
  x-logo:
    url: img/alviere-logo.svg
  description: '# Introduction


    Welcome to Alviere!


    This page provides developer API documentation for integrating into the Alviere platform.


    ### Notes


    * All times are in UTC time standard

    * All date fields use the RFC 3339 version of the ISO-8601 standard format'
servers:
- url: https://api.snd.alviere.com
  description: Alviere API
tags:


# --- truncated at 32 KB (267 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/alviere/refs/heads/main/openapi/alviere-account-wallet-api-openapi.yml