Sends

List sends

Retrieves all the send transactions performed by the logged-in identity.

get/sends

Request

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

Query parameters

offsetinteger

The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results.

limitinteger
Example:25

The limit of the results for paging, starting at the offset. Limit is always capped at 100.

profileIdstring

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.

Example:10001

Filter by the Send profile. Leave out to fetch all entries.

idstring required
type'managed_cards' | 'managed_accounts' required

Filter by the source instrument id.

{
  "id": "123456789",
  "type": "managed_accounts"
}
source.idstring
Example:123456789

Filter by the source instrument id. Must be specified when source.type is provided.

source.type'managed_cards' | 'managed_accounts'

Filter by the source instrument type. Must be specified when source.id is provided.

stateSendState[]

Filter by the Send transaction state. Leave out to fetch all states.

createdFrominteger

Filter for send transactions created after createdFrom timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all Send transactions.

createdTointeger

Filter for send transactions created before createdTo timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all Send transactions.

executedFrominteger

Filter for send transactions executed after executedFrom timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all Send transactions.

executedTointeger

Filter for send transactions executed before executedTo timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all Send transactions.

tagstring

Filter by the send tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all entries.

Response

Success

countinteger

Total number of records (excluding the paging limit).

responseCountinteger

Total number of records returned in this response.

Example response

{
  "send": [
    {
      "id": "123456789",
      "profileId": "10001",
      "tag": "customer-123",
      "source": {
        "id": "123456789",
        "type": "managed_accounts"
      },
      "sourceFee": {
        "currency": "GBP",
        "amount": 1250
      },
      "destination": {
        "id": "123456789",
        "type": "managed_accounts"
      },
      "destinationAmount": {
        "currency": "GBP",
        "amount": 1250
      },
      "destinationFee": {
        "currency": "GBP",
        "amount": 1250
      },
      "transactionAmount": {
        "currency": "GBP",
        "amount": 1250
      },
      "description": "Invoice 1042",
      "creationTimestamp": 1786118400000,
      "scheduledTimestamp": "1786118400000",
      "executionTimestamp": "1786118401250",
      "cancellationReason": "Payment no longer required"
    }
  ]
}

Changes

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