Transfer

1. Create a Transfer Between Accounts

The Create a Transfer API allows you to initiate a transfer of funds between two accounts. This is the first step in performing a transfer, and it requires specifying the source and destination accounts, as well as the transfer amount and currency.

Request Body Parameters:

Field	Type	Required	Description
`fromAccount`	string	Yes	The account ID from which the transfer is made.
`toAccount`	string	Yes	The account ID to which the funds are transferred.
`currency`	string	Yes	The currency in which the transfer is made.
`amount`	string	Yes	The amount of money to transfer.
`note`	string	No	An optional note or reference for the transfer.

Response (200 OK):

On success, the system will respond with the transfer details, including a unique transfer ID.

Field	Description
`id`	Unique identifier for the transfer.
`status`	The status of the transfer (e.g., `SUCCESS`).
`fromAmount`	The amount transferred from the source account.
`toAmount`	The amount received in the destination account.
`feeAmount`	The fee deducted for the transfer.
`feeCurrency`	The currency in which the fee is charged.
`createdAt`	Timestamp when the transfer was created.
`updatedAt`	Timestamp when the transfer was last updated.

2. Confirm a Transfer

After creating a transfer, it must be confirmed before it is processed. The Confirm a Transfer API allows you to confirm the transfer using its unique transfer ID (UUID).

Path Parameters:

Field	Type	Required	Description
`uuid`	string($uuid)	Yes	The UUID of the transfer to be confirmed.

Response (200 OK):

The system will respond with the status of the transfer after confirmation.

Field	Description
`id`	Unique identifier for the transfer.
`status`	The status of the transfer (e.g., `INIT`, `CONFIRMED`).
`statusDescription`	A description of the current status of the transfer.
`note`	The reference note for the transfer.
`createdAt`	Timestamp when the transfer was created.
`updatedAt`	Timestamp when the transfer was last updated.

Best Practices

Validate Inputs:
Ensure that both the fromAccount and toAccount exist and that the currency is supported.
Check Transfer Status:
Always check the status of the transfer using the status field. Transfers need to be confirmed before being processed.
Fees:
Keep in mind that transfer operations may include fees, which are deducted from the transfer amount.