Entities & Operations
All figures and data in this guide are representational. For production access, contact your Ahrvo Banking representative.
| Entity | Description | Operations |
|---|---|---|
| Customer | An individual or business onboarded onto the Ahrvo Banking system with or without an Ahrvo Banking account. Example: A merchant company registering as a customer to open an account. | - Create - Update - Retrieve - Delete - List - Add Customer Preferences - Retrieve Customer Preferences - Retrieve all Beneficial Owners for a Customer |
| Account | Accounts eligible for passthrough FDIC insurance, opened for a customer to collect, manage, store, and move funds. Example: A merchant account opened within the Ahrvo Banking system. | - Create - Update - Retrieve - Delete - Retrieve Accounts linked to a Customer - List - Close - Account Statement - List Interest History |
| External Account | A bank account outside the Ahrvo Banking system linked to a customer to pull or push funds. Example: Customer’s bank account at XYZ Bank. | - Create - Update - Retrieve - Delete - Retrieve External Accounts linked to a Customer - List - Validate - Verify |
| International External Accounts | Bank accounts outside the Ahrvo Banking system in another country supporting electronic fund transfers. | - Create - Update - Retrieve - Retrieve all International External Accounts linked to a Customer - List - List Meta Data |
| Merchant | A business customer that accepts and processes card transactions. Example: A merchant on Ahrvo Banking accepting card payments. | - Create - Update - Retrieve - Delete - Retrieve Merchants linked to a Customer - List - Retrieve Merchant Statement - Preview API |
| Terminal | POS integration with Ahrvo Network semi-integrated terminals for card-present payments. | - Retrieve |
| Card | A payment card linked to a customer for online or in-person purchases. Example: Consumer card at XYZ Bank used to pay a merchant. | - Create - Update - Retrieve - Delete - Retrieve Cards linked to a Customer |
| Mailing Address | A physical mailing address for an entity. Example: Customer’s address for check delivery. | - Create - Update - Retrieve - Delete - Retrieve Mailing Addresses linked to a Customer |
| Transaction | An instruction to move funds across Ahrvo Banking and third parties. | - Create - Update - Retrieve - Delete - Cancel - Stop - List - Void - Virtual Card Image - Capture Transaction - Retrieve Virtual Card - FxQuote |
| Recurring Transaction | An instruction to move funds at regular intervals via ACH, Card, Check, Wire, or Book. | - Create - Update - Retrieve - Delete - List - List history of recurring transactions - Cancel - Pause - Resume |
| Ledger | A record of every transaction performed on an account. | - List |
| Return | An instruction to return a collect or send transaction. | - List |
| Chargeback | An instruction by the issuing bank to reverse a card transaction for unauthorized or fraudulent claims. | - List |
| Authorized Users | Legal users added to business customers; a business can link multiple authorized users. | - Create - Update - Retrieve - List - Retrieve all Authorized Users for a Customer |
| Debit Card | Physical debit cards issued to access Ahrvo Banking account funds via ATM or POS. | - Create - Retrieve - List - Freeze - Unfreeze - Replace |
| Signup Invite | Codes for users to self-register and open an Ahrvo Banking account. | - Create - List |
| Contacts | Frequent payees of customers stored for quick payments. | - Create - Update - Retrieve - Delete - Retrieve all Contacts linked to a Customer - Verify PPI |
| Batch | A collection of authorized card transactions grouped for processing and settlement. | - List - Retrieve - Retrieve all Batches linked to a Customer |
| Funding Rules | Rules to split incoming funds among multiple recipients/accounts based on set percentages. | - Create - Retrieve - Deactivate - List |
| Secured Credit Card | A credit card requiring a cash deposit as collateral; the deposit sets the credit limit. | - Create - Retrieve - Activate |
| Location | Saved business address and related information. | - Create - Update - Retrieve - Delete - Retrieve all Locations linked to a Customer - Retrieve all Locations linked to a Merchant - List Location |
| Funding Rule | Rules to split incoming funds among multiple recipients/accounts based on set percentages. | - Create - Retrieve - Deactivate - List Funding Rule |
| Webhook | HTTP callbacks to notify configured endpoints about events related to Ahrvo Banking entities. | - Create - Update - Retrieve - Delete - List |