Withdrawal Amount
This API is used when a user wants to withdraw funds from their overdraft account. It initiates the transfer of the specified amount and informs the user about the expected transfer time.
Input
To initiate a withdrawal from a specific overdraft account, you need to provide the following details:
Customer ID: The unique identifier of the user who wants to withdraw funds (e.g., "32ce79860a45cd4857be9df097f46b4f8d").
Order ID: The unique identifier of the overdraft account from which the funds will be withdrawn (e.g., "e90dfdf6-b467-4fa6-a52c-784b1a65f2be").
Withdrawal Amount: The amount of money the user wants to withdraw (e.g., 6000).
Authorization Key: A secure key to authenticate the request. This key must be included in the headers of your request.
Output
The response from this API confirms that the withdrawal process has been initiated and provides an estimated time for the transfer.
Message: A confirmation message indicating that the withdrawal has been initiated and the expected time for the funds to be transferred.
Input Type
| Input | Type | Description |
|---|---|---|
| finsire_id | string | A valid id generated during user creation |
| order_id | string | A unique id for each order which you can fetch from the last API |
| withdrawal_amount | string | The amount which the user wants to withdraw. |
Common error scenarios
The following are the common error scenarios in sending an API request:
| Error | Description |
|---|---|
| param is missing or the value is empty: finsire_id | finsire_id is a required field |
Try out the API here
Updated 3 months ago