Skip to main content

Transfers

A transferTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations. is a transaction that happens when you move funds between instruments managed by Weavr. The source and destination instrumentsInstrument A financial product owned by an Identity. There are two types: Managed Accounts (stored-value accounts that hold balances and can receive wire transfers) and Managed Cards (prepaid cards - virtual or physical - used for purchases). of a transferTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations. transaction must be owned by the same identity.

Debit mode cards

You cannot use cards that operate in debit mode as a source or destination instrumentInstrument A financial product owned by an Identity. There are two types: Managed Accounts (stored-value accounts that hold balances and can receive wire transfers) and Managed Cards (prepaid cards - virtual or physical - used for purchases). for transfers because these cards do not have a balance.

Create a transfer​

Create a transferTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations. transaction using the POST /transfers endpoint, providing the source and destination instrumentInstrument A financial product owned by an Identity. There are two types: Managed Accounts (stored-value accounts that hold balances and can receive wire transfers) and Managed Cards (prepaid cards - virtual or physical - used for purchases). IDs. As part of the authentication header, you must also provide a valid access_token that belongs to the identity whose funds are being moved.

You must specify a transferTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations. 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.

POST/transfersTry it 
{
  "profileId": "string",
  "tag": "string",
  "source": {
    "id": "string",
    "type": "managed_cards"
  },
  "description": "string",
  "destination": {
    "id": "string",
    "type": "managed_cards"
  },
  "destinationAmount": {
    "currency": "str",
    "amount": 0
  },
  "scheduledTimestamp": "string"
}
info

To perform a transfer, both the source and destination instrumentsInstrument A financial product owned by an Identity. There are two types: Managed Accounts (stored-value accounts that hold balances and can receive wire transfers) and Managed Cards (prepaid cards - virtual or physical - used for purchases). must be active.

Transfers as bulk operations​

You can create transfersTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations. in bulk following the same process as other bulk operationsBulk Operations The capability of grouping multiple individual API-based actions into a batch. Bulk operations allow you to execute hundreds or thousands of operations by making only one or two API calls, increasing throughput, accomplishing actions in a secure session, and reducing complexity in your application.; the Bulk ProcessBulk Process A task created when initiating a group of bulk operations. The Bulk Process has a consistent lifecycle (statuses) and management method, regardless of the type of operation being performed. It can be in states such as SUBMITTED, RUNNING, PAUSED, CANCELLED, or completed states. executes them. See Bulk operations for more details.

Schedule a transfer transaction​

You can schedule transfersTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations. to execute on a future date and time. With every transaction request, you can optionally specify a scheduledTimestamp containing the date and time in UTC when the transaction should execute. Once a transaction is scheduled and all validations pass, you receive a webhook with the transaction state set to Scheduled.

Cancel scheduled transfers​

You can cancel a scheduled transferTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations. before its execution time elapses. To cancel, provide the transaction id and optionally a cancellation reason:

POST/transfers/bulk/cancelTry it 
{
  "cancellations": [
    {
      "id": "string",
      "cancellationReason": "string"
    }
  ]
}
info

Transactions that are not in state Scheduled cannot be canceled.

Retrieve the status of a Transfer​

You can get the status of a transferTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations. transaction using the API.

GET/transfers/{id}Try it 
{
  "id": "string",
  "profileId": "string",
  "tag": "string",
  "source": {
    "id": "string",
    "type": "managed_cards"
  },
  "destination": {
    "id": "string",
    "type": "managed_cards"
  },
  "destinationAmount": {
    "currency": "str",
    "amount": 0
  },
  "description": "string",
  "state": "INITIALISED",
  "creationTimestamp": 0,
  "scheduledTimestamp": "string",
  "executionTimestamp": "string",
  "cancellationReason": "string"
}