Debit the Flash IbexHub Account

Oct 13, 2025 by wbrum.org 40 views

Overview

In this feature, we will be adding a new API endpoint to the GraphQL-admin to enable administrators to trigger a withdrawal from the Flash IbexHub account to the Flash Bank Account. This feature will provide a seamless payment flow for users, ensuring that their funds are safely transferred to their bank accounts.

Withdrawal Payment Flow

The withdrawal payment flow involves the following steps:

Flash Account in IbexHub: The user's Flash account is stored in the IbexHub.
Ibex Account in IbexHub: The user's Ibex account is also stored in the IbexHub.
Flash Bank Account: The user's bank account is linked to the Flash IbexHub account.

API Endpoint for Admins

The new API endpoint will allow admins to trigger a withdrawal from the Flash IbexHub account to the Flash Bank Account. This endpoint will be responsible for initiating the withdrawal process, which will involve the following steps:

Debit the Flash IbexHub Account: The API endpoint will debit the Flash IbexHub account, reducing the user's balance by the amount of the withdrawal.
Credit the Flash Bank Account: The API endpoint will credit the Flash Bank Account with the withdrawn amount.
Trigger the Callback Mechanism: The API endpoint will trigger the callback mechanism, which will notify the Medici system of the withdrawal.

Callback Mechanism

The callback mechanism will be responsible for notifying the Medici system of the withdrawal. This will involve sending a webhook to the Medici system, which will update the user's account balance accordingly.

Medici Withdrawal

In Medici, the withdrawal will be initiated from the Ibex:{FlashAccountId} account, and the "Cash" (external) account will be debited. This will ensure that the user's funds are safely transferred to their bank account.

Update InitiateCashout API

The initiateCashout API will be updated to credit the Ibex:{FlashAccountId} account, ensuring that the user's funds are credited to their Flash IbexHub account.

Implementation Details

The implementation details of the new API endpoint will involve the following steps:

Create a new API endpoint: A new API endpoint will be created to handle the withdrawal request.
Implement the debit and credit logic: The API endpoint will implement the debit and credit logic to update the user's account balance.
Trigger the callback mechanism: The API endpoint will trigger the callback mechanism to notify the Medici system of the withdrawal.
Update the initiateCashout API: The initiateCashout API will be updated to credit the Ibex:{FlashAccountId} account.

Benefits

The addition of the bank withdrawal API endpoint will provide several benefits, including:

Seamless payment flow: The withdrawal payment flow will be seamless, ensuring that users' funds are safely transferred to their bank accounts.
Improved user experience: The new API endpoint will improve the user experience, providing a more efficient and convenient way for users to withdraw their funds.
Enhanced security: The callback mechanism will ensure that the Medici system is notified of the withdrawal, providing an additional layer of security.

Conclusion

In conclusion, the addition of the bank withdrawal API endpoint will provide a seamless payment flow for users, ensuring that their funds are safely transferred to their bank accounts. The new API endpoint will improve the user experience, provide enhanced security, and ensure that the Medici system is notified of the withdrawal.

Technical Requirements

GraphQL-Admin: The GraphQL-admin will be updated to include the new API endpoint.
Medici: The Medici system will be updated to handle the withdrawal request.
IbexHub: The IbexHub will be updated to store the user's Flash account and Ibex account.
Flash Bank Account: The Flash Bank Account will be linked to the Flash IbexHub account.

API Endpoint Details

Endpoint: /graphql-admin/bank-withdrawal
Method: POST
Request Body: { "flashAccountId": "string", "amount": "number" }
Response: { "status": "string", "message": "string" }

Callback Mechanism Details

Webhook: The webhook will be sent to the Medici system to notify it of the withdrawal.
Payload: The payload will include the withdrawal details, including the user's Flash account ID and the amount withdrawn.

Medici Withdrawal Details

Account: The withdrawal will be initiated from the Ibex:{FlashAccountId} account.
Account Type: The account type will be "Cash" (external).
Amount: The amount withdrawn will be credited to the user's Flash IbexHub account.
Q&A: Bank Withdrawal API Endpoint =====================================

Frequently Asked Questions

Q: What is the purpose of the bank withdrawal API endpoint?

A: The bank withdrawal API endpoint is designed to enable administrators to trigger a withdrawal from the Flash IbexHub account to the Flash Bank Account. This endpoint will provide a seamless payment flow for users, ensuring that their funds are safely transferred to their bank accounts.

Q: How does the callback mechanism work?

A: The callback mechanism involves sending a webhook to the Medici system to notify it of the withdrawal. The webhook will include the withdrawal details, including the user's Flash account ID and the amount withdrawn.

Q: What is the initiateCashout API, and how is it updated?

A: The initiateCashout API is responsible for crediting the Ibex:{FlashAccountId} account. The API is updated to credit the Ibex:{FlashAccountId} account, ensuring that the user's funds are credited to their Flash IbexHub account.

Q: What are the benefits of the bank withdrawal API endpoint?

A: The addition of the bank withdrawal API endpoint provides several benefits, including:

Seamless payment flow
Improved user experience
Enhanced security

Q: How is the Flash Bank Account linked to the Flash IbexHub account?

A: The Flash Bank Account is linked to the Flash IbexHub account through the IbexHub system. The user's Flash account and Ibex account are stored in the IbexHub, and the Flash Bank Account is linked to the Flash IbexHub account.

Q: What are the technical requirements for implementing the bank withdrawal API endpoint?

A: The technical requirements for implementing the bank withdrawal API endpoint include:

Updating the GraphQL-admin to include the new API endpoint
Updating the Medici system to handle the withdrawal request
Updating the IbexHub to store the user's Flash account and Ibex account
Linking the Flash Bank Account to the Flash IbexHub account

Q: What is the endpoint URL for the bank withdrawal API?

A: The endpoint URL for the bank withdrawal API is /graphql-admin/bank-withdrawal.

Q: What is the request body for the bank withdrawal API?

A: The request body for the bank withdrawal API includes the following fields:

flashAccountId: The ID of the user's Flash account
amount: The amount to be withdrawn

Q: What is the response for the bank withdrawal API?

A: The response for the bank withdrawal API includes the following fields:

status: The status of the withdrawal request
message: A message indicating the result of the withdrawal request

Q: What is the payload for the webhook sent to the Medici system?

A: The payload for the webhook sent to the Medici system includes the following fields:

flashAccountId: The ID of the user's Flash account
amount: The amount withdrawn
withdrawalId: The ID of the withdrawal request

Q: How is the Medici system notified of the withdrawal?

A: The Medici system is notified of the withdrawal through the webhook sent by the bank withdrawal API endpoint. The webhook includes the withdrawal details, including the user's Flash account ID and the amount withdrawn.