Transfers
A transfer is a transaction that happens when you move funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity.
You cannot use cards that operate in debit mode as a source or destination instrument for transfers because these cards do not have a balance.
Create a Transfer
Create a transfer transaction using the POST /transfers
endpoint providing the source and destination instrument IDs. As part of the authentication header, you must also provide a valid access_token
that belongs to the identity whose funds will be moved.
You must specify a transfer profileId
that determines if you charge any end-customer fees for this transaction. You can find more information on how to earn revenue from your customers in the transfer fees guide.
To perform a transfer, both the source and destination instruments must be active.
Schedule a Transfer Transaction
Transfers can be scheduled to be executed on a future date & time. With every transaction request, you can optionally specify a scheduledTimestamp
which contains the date & time in UTC of when the transaction should be executed. Once a transaction is scheduled, and all validations are confirmed, you will receive a webhook with the state of the transaction being Scheduled
.
Cancel Scheduled Transfers
You can cancel scheduled transfers before the execution time has elapsed. To cancel the transaction you must provide the id
of the transaction, and add optionally adding a cancelling reason
using this endpoint:
Transactions that are not in state Scheduled
cannot be cancelled.
Retrieve the Status of a Transfer
You can get a status of a transfer transactions by using the API.