# Virtual Account Services ## Docs - [Introduction](https://vasdoc.transactionpointcorebankingsystem.com/introduction-857894m0.md): - [Terminologies](https://vasdoc.transactionpointcorebankingsystem.com/terminologies-876703m0.md): - [Webhooks](https://vasdoc.transactionpointcorebankingsystem.com/webhooks-923729m0.md): - [Authentication](https://vasdoc.transactionpointcorebankingsystem.com/authentication-857895m0.md): - Notifications [Notification ](https://vasdoc.transactionpointcorebankingsystem.com/notification-876705m0.md): ## API Docs - Account [Create Account](https://vasdoc.transactionpointcorebankingsystem.com/create-account-14271628e0.md): This API allows users to create a new account and generates a **NUBAN** that can be used for interbank transfers. - Account [Rename Account](https://vasdoc.transactionpointcorebankingsystem.com/rename-account-14271629e0.md): This API allows users to update the name of an account. - Account [Balance Inquiry](https://vasdoc.transactionpointcorebankingsystem.com/balance-inquiry-14271630e0.md): This API retrieves the current balance information for a specific account. - Account [Create Bulk Accounts](https://vasdoc.transactionpointcorebankingsystem.com/create-bulk-accounts-14271631e0.md): This API allows users to create multiple accounts in a single bulk operation. Each generated account details is sent to the callback url one after the other. - Account [List Accounts](https://vasdoc.transactionpointcorebankingsystem.com/list-accounts-14271632e0.md): This API retrieves a list of accounts associated with a given groupCode (external ID). The response includes account details such as name, BVN, and account ID. - Transaction [Credit Account](https://vasdoc.transactionpointcorebankingsystem.com/credit-account-14271635e0.md): This operation credits a virtual account. For this operation to be successful, a `classificationCode` must be entered. A classification code allows the accounting system understand which accouting ledger and payment type should be used for the transaction. - Transaction [Debit Account](https://vasdoc.transactionpointcorebankingsystem.com/debit-account-14271636e0.md): This API debits an virtual account. For this operation to be successful, a `classificationCode` must be entered. A classification code allows the accounting system understand which accouting ledger and payment type should be used for the transaction. - Transaction [Credit Account [Agency Banking]](https://vasdoc.transactionpointcorebankingsystem.com/credit-account-agency-banking-14271633e0.md): This operation credits a virtual account balance but it requires a corresponding debit from a main virtual account. This endpoint is only to be used for agency banking and not typical virtual accouting services. - Transaction [Debit Account [Agency Banking]](https://vasdoc.transactionpointcorebankingsystem.com/debit-account-agency-banking-14271634e0.md): This operation debits a virtual account balance but it requires a corresponding credit to a main virtual account. This endpoint is only to be used for agency banking and not typical virtual accouting services. - Transaction [Transaction Query](https://vasdoc.transactionpointcorebankingsystem.com/transaction-query-14271637e0.md): This operation retrieves the details of a credit or debit transaction. - Transaction [Transaction Details](https://vasdoc.transactionpointcorebankingsystem.com/transaction-details-14271638e0.md): This API retrieves transaction details of an interbank transferusing a unique `transactionID`. The response provides comprehensive details about the transaction. - Transaction [Transaction History](https://vasdoc.transactionpointcorebankingsystem.com/transaction-history-14271639e0.md): This operation fetches the transaction history for a specified `accountID`, providing details of past transactions. - Transfer [Get Institutions](https://vasdoc.transactionpointcorebankingsystem.com/get-institutions-14271640e0.md): This API retrieves a list of financial institutions authorized by NIBSS for Interbank Transfers. - Transfer [Name Inquiry](https://vasdoc.transactionpointcorebankingsystem.com/name-inquiry-14271641e0.md): This operation retrieves the account details of the destination account, commonly known as account name enquiry, to verify the recipient's information before transactions. - Transfer [Interbank Transfer](https://vasdoc.transactionpointcorebankingsystem.com/interbank-transfer-14271642e0.md): This API performs an interbank transfer between accounts. It debits funds from a source account and credits a destination account at a different institution. The request requires detailed account and transaction information. - Transfer [Interbank Transfer [Sync]](https://vasdoc.transactionpointcorebankingsystem.com/interbank-transfer-sync-14271643e0.md): The API processes the interbank transfers in real-time. This endpoint is highly discouraged as it negatively impacts the interbank transfer workflow - Transfer [Transfer Query](https://vasdoc.transactionpointcorebankingsystem.com/transfer-query-14271644e0.md): This API endpoint retrieves the current status of an interbank transfer associated with the provided transaction reference. The transaction reference is supplied as a path variable in the URL. The response returns detailed metadata about the transfer, including its status. - Transfer [Transfer Enquiry](https://vasdoc.transactionpointcorebankingsystem.com/transfer-enquiry-14271645e0.md): This operation retrieves the status of a transfer by specifying the transactionID, providing real-time updates on whether the transfer is successful, pending, or failed. - Transfer [Virtual Account Intrabank Transfer](https://vasdoc.transactionpointcorebankingsystem.com/virtual-account-intrabank-transfer-14271646e0.md): This API transfers funds within the same bank from a source account to another virtual account. - Transfer [Core Banking Intrabank Transfer](https://vasdoc.transactionpointcorebankingsystem.com/core-banking-intrabank-transfer-14271647e0.md): This operation facilitates an intrabank transfer to a Core Banking Account, enabling seamless fund transfers within the same financial institution. - Transfer [Collection Accounts Intrabank Transfer](https://vasdoc.transactionpointcorebankingsystem.com/collection-accounts-intrabank-transfer-14271648e0.md): This API facilitates an intrabank transfer between collection accounts for the same merchant/client. - Invoice [Create Invoice](https://vasdoc.transactionpointcorebankingsystem.com/create-invoice-14271650e0.md): Creates an Invoice Virtual Account with an expiry date and time. After the expiry or payment of the funds to the account, the NUBAN(Account number) is reallocated for reuse. - Invoice [Get Invoice Detail](https://vasdoc.transactionpointcorebankingsystem.com/get-invoice-detail-14271651e0.md): This operation retrieves invoice details using the specified `groupCode` and `invoiceReference`, providing key information about the invoice. - Invoice [List Merchant Invoices](https://vasdoc.transactionpointcorebankingsystem.com/list-merchant-invoices-14271652e0.md): Retrieves a list of merchant invoices for the specified `groupCode`. - Refunds [Initiate Refund](https://vasdoc.transactionpointcorebankingsystem.com/initiate-refund-14271653e0.md): The API allows merchants to process refunds for transactions. It enables full or partial refunds, providing flexibility in handling customer transactions. - Refunds [Get Refund Status](https://vasdoc.transactionpointcorebankingsystem.com/get-refund-status-14271654e0.md): This API retrieves the status of a refund based on the `refundReference` provided in the URL. The response indicates whether the request was successful and returns detailed information about the refund. - Refunds [Get Refunds](https://vasdoc.transactionpointcorebankingsystem.com/get-refunds-14271655e0.md): This API retrieves a list of refund transactions. It provides details about each refund, including its reference, amount, status, and other relevant metadata. - Notifications [Send Notification](https://vasdoc.transactionpointcorebankingsystem.com/send-notification-14271649e0.md): This operation sends transaction notifications based on the specified `transactionReference`. It can be used for testing or to resend notifications payload incase of integration issues. - Merchant > Account [Get Account](https://vasdoc.transactionpointcorebankingsystem.com/get-account-14271659e0.md): This API retrieves account details based on the specified NUBAN (Bank Account Number). - Merchant > Account [Activate Sub Ledger For Merchant](https://vasdoc.transactionpointcorebankingsystem.com/activate-sub-ledger-for-merchant-14271657e0.md): This API activates a client for virtual account services. - Merchant > Account [Get SubLedger Callback Urls](https://vasdoc.transactionpointcorebankingsystem.com/get-subledger-callback-urls-14271658e0.md): This API retrieves the callback URLs configured for subledger operations. The response includes URLs for normal, utility, and invoice callbacks. If a callback URL is not set, the corresponding field will be null. - Merchant > Account [Set SubLedger Callback Urls](https://vasdoc.transactionpointcorebankingsystem.com/set-subledger-callback-urls-14271660e0.md): This API sets the callback URLs for subledger operations for a given client. The client is identified by the `clientId` provided as a path variable. The request body includes the callback URLs for normal, utility, and invoice operations. The response returns the updated callback URL settings. - Merchant > Account [Get Collection Accounts](https://vasdoc.transactionpointcorebankingsystem.com/get-collection-accounts-14271661e0.md): This API retrieves a list of all collection accounts associated with a specified clientId. The accounts may include Normal, Utility, and Invoice collection types. - Merchant > Transfer [Get Transfer History](https://vasdoc.transactionpointcorebankingsystem.com/get-transfer-history-14271662e0.md): This API retrieves the transfer history for a merchant based on the provided `client ID`. It returns an array of transfer objects that include detailed information about each transaction. - Merchant > Transfer [Get Subledger transfers](https://vasdoc.transactionpointcorebankingsystem.com/get-subledger-transfers-14271663e0.md): This API retrieves the subledger transfers for a merchant based on the provided `client ID` and `nuban`. It returns an array of transfer objects that include detailed information about each transaction. - Merchant > Transfer [Get Transfer Details](https://vasdoc.transactionpointcorebankingsystem.com/get-transfer-details-14271665e0.md): This API retrieves detailed information about a specific transfer transaction using the provided `transaction ID`. The response includes comprehensive details such as institution codes, account details, transferred amount, charges, and any associated split payments. - Merchant > Transfer [Name Inquiry](https://vasdoc.transactionpointcorebankingsystem.com/name-inquiry-14271666e0.md): This operation retrieves the account details of the destination account, commonly known as account name enquiry, to verify the recipient's information before transactions on the merchant portal. - Merchant > Refund [Refund Details](https://vasdoc.transactionpointcorebankingsystem.com/refund-details-14271667e0.md): This API retrieves refund details for a specific transaction using the `transactionReference` provided in the URL. The response includes the total refundable amount and a history of refunds associated with the transaction. - Admin > Accounting [Get GL Accounts](https://vasdoc.transactionpointcorebankingsystem.com/get-gl-accounts-14271675e0.md): This API retrieves detailed information about all General Ledger (GL) accounts, providing essential data such as account identifiers, balances, and associated metadata. It enables seamless financial tracking, reconciliation, and reporting for organizations managing multiple GL accounts. - Admin > Accounting [Get Classification Codes](https://vasdoc.transactionpointcorebankingsystem.com/get-classification-codes-14271676e0.md): This API retrieves a list of classification codes used in the accounting system. - Admin > Dashboard [Dashboard Summary](https://vasdoc.transactionpointcorebankingsystem.com/dashboard-summary-14271677e0.md): This API provides a comprehensive summary of the dashboard, offering key insights and aggregated data relevant to the user's account. It retrieves essential metrics such as financial transactions, account balances, recent activities, and other critical indicators, enabling users to monitor performance and make informed decisions efficiently. - Admin > Dashboard [Dashboard Transactions](https://vasdoc.transactionpointcorebankingsystem.com/dashboard-transactions-14271678e0.md): This API provides a comprehensive overview of transactions for the admin dashboard. It returns detailed information about each transaction. This information is crucial for real-time monitoring and operational oversight of financial activities. - Admin > Dashboard [Dashboard Transaction Details](https://vasdoc.transactionpointcorebankingsystem.com/dashboard-transaction-details-14271679e0.md): This API provides detailed information about a specific transaction by utilizing its unique identifier, `transactionId`. It enables users to retrieve key transaction details, such as the source and destination account information, transaction status, amount, and any associated split payments. - Admin > Group Codes [Get Group Codes](https://vasdoc.transactionpointcorebankingsystem.com/get-group-codes-14271680e0.md): This API retrieves a list of group codes associated with a specific client. This data is essential for tracking virtual account groups and managing associated financial activities. - Admin > Group Codes [Set Collection Account](https://vasdoc.transactionpointcorebankingsystem.com/set-collection-account-14271681e0.md): This API operation enables merchants to designate a specific account as the primary collection account within the merchant portal. By setting a collection account, merchants can streamline the receipt of payments, ensuring all transactions are directed to a designated account for efficient tracking and reconciliation. - Admin > Group Codes [Create Group Code](https://vasdoc.transactionpointcorebankingsystem.com/create-group-code-14271682e0.md): This API enables you to create a new group code for a client, which is essential for organizing and managing client accounts under a specific group. This functionality is vital for structuring client data and streamlining subsequent transactions and reporting. - Admin > Reporting [Get Report Types](https://vasdoc.transactionpointcorebankingsystem.com/get-report-types-14271691e0.md): This API operation retrieves a comprehensive list of available report types, enabling merchants to access categorized financial and transactional reports. Each report type includes a unique identifier, name, and status indicators, such as whether it is featured or has been deleted. This functionality helps businesses streamline financial analysis, compliance tracking, and operational reporting by providing structured and easily accessible report categories. - Admin > Reporting [Get Report Parameters](https://vasdoc.transactionpointcorebankingsystem.com/get-report-parameters-14271692e0.md): This API retrieves a list of report parameters that are used for generating various reports. This information is essential for dynamically constructing report filters and ensuring accurate data retrieval based on user selections. - Admin > Reporting [Create Report](https://vasdoc.transactionpointcorebankingsystem.com/create-report-14271693e0.md): This API operation enables merchants to generate customized reports by specifying report types and associated parameters. It allows for the selection of key data points, such as date ranges, transaction types, and other relevant filters, ensuring precise and meaningful insights. By defining these parameters, merchants can tailor reports to meet their financial tracking and analytical needs, enhancing decision-making and operational efficiency. - Admin > Reporting [Get Reports](https://vasdoc.transactionpointcorebankingsystem.com/get-reports-14271694e0.md): This endpoint retrieves a list of available reports. Reports provide insights into various system activities, such as merchant transactions. If a report is successfully generated, a download URL may be provided. - Admin > Reporting [Get Reports Details](https://vasdoc.transactionpointcorebankingsystem.com/get-reports-details-14271695e0.md): This API operation allows merchants to retrieve detailed information about a specific report using the `reportId`. It provides key report metadata, including the report name, type, generation status, and a downloadable link. Additionally, it returns a chronological log of processing steps, enabling merchants to track the report’s creation process and troubleshoot any issues. This functionality ensures transparency and facilitates efficient report management within the merchant portal.