Transfers

Get a transfer

Returns the transfer identified by id, including its current state.

Use the state to determine whether the transfer is scheduled, has completed, or has failed.

get/transfers/{id}

Request

  • Base URL: https://sandbox.weavr.io/multi
  • URL: https://sandbox.weavr.io/multi/transfers/{id}
  • Auth: HTTP bearer and API key in header api-key

Path parameters

idstring required
Example:123456789

The unique identifier of the transfer.

Response

Success

idstring required

The unique identifier of a Transfer transaction.

profileIdstring required

The profile Id which a specific identity, instrument, or transaction type is linked to.

Profiles contain configuration and determine behavioral aspects of the newly created transaction, for example, fees that may apply.

You can have one or more profiles linked to your application, and these can be used to drive different behaviors according to your product's needs.

Profile Ids can be found in the Multi Portal, in the API Credentials page.

tagstring

The tag field is a custom field that can be used to search and filter.

descriptionstring

The description details that are included in the transaction as reference.

state'INITIALISED' | 'COMPLETED' | 'REJECTED' | 'FAILED' | 'PENDING' | 'SCHEDULED' | 'CANCELLED' required

Status of the transaction.

creationTimestampinteger required

The time when the transaction was created, expressed in Epoch timestamp using millisecond precision.

scheduledTimestampstring

The epoch timestamp at which the transaction is scheduled to be executed.

executionTimestampstring

The epoch timestamp at which the transaction was executed, transitioning to a final state such as COMPLETED, REJECTED, or FAILED.

cancellationReasonstring

The reason the scheduled transaction was canceled.

Example response

{
  "id": "2468013579",
  "profileId": "10001",
  "tag": "invoice-2026-0042",
  "source": {
    "type": "managed_accounts",
    "id": "123456789"
  },
  "destination": {
    "type": "managed_accounts",
    "id": "987654321"
  },
  "destinationAmount": {
    "currency": "GBP",
    "amount": 1250
  },
  "description": "Invoice 2026-0042",
  "state": "COMPLETED",
  "creationTimestamp": 1786118400000,
  "executionTimestamp": "1786118401250"
}

Changes

No recorded changes to this operation across all 1 revision of this API.