Skip to content
Transfers/
Transfer transaction

Weavr Webhook (v2)

For Verification, create a base64 hash using HmacSHA256 using Published-Timestamp header as message and your API key as secret. The result should match the Signature header.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://weavr.io
Languages
Servers
Mock server
https://api.weavr.io/_mock/products/webhooks/openapi
https://api.weavr.io/""

Corporates

Webhooks

Consumers

Webhooks

Managed Cards

Webhooks

Managed Accounts

Webhooks

Linked Accounts

Webhooks

Transfers

Webhooks

Transfer transactionWebhook

Request

Notification that a Transfer transaction has been processed.

Headers
call-refstring

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

published-timestampinteger(int64)required

The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.

signature-v2stringrequired

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the call-ref + payload + published-timestamp using your API key.

signaturestringDeprecatedrequired

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the published-timestamp using your API key.

Bodyapplication/jsonrequired
eventTypestring(TransferEventTransferEventType)required
Enum"PENDING""COMPLETED""FAILED""SCHEDULED""CANCELLED"
transferobject(LegacyTransfer)required
transfer.​idobject(StringWrappedTypeId)required
transfer.​id.​typestring<= 50 characters^[a-zA-Z0-9_-]+$required
transfer.​id.​idstring^[0-9]+$required
transfer.​profileIdstring^[0-9]+$required
transfer.​tagstring<= 50 characters^[a-zA-Z0-9_-]+$
transfer.​sourceobject(InstrumentId)required
transfer.​source.​idstring(Id)^[0-9]+$required
transfer.​source.​typestring(InstrumentType)required
Enum"managed_cards""managed_accounts"
transfer.​destinationobject(InstrumentId)required
transfer.​destination.​idstring(Id)^[0-9]+$required
transfer.​destination.​typestring(InstrumentType)required
Enum"managed_cards""managed_accounts"
transfer.​destinationAmountobject(LegacyCurrencyAmount)required

The object representing a monetary amount in a particular currency.

transfer.​destinationAmount.​currencystring(Currency)= 3 characters^[A-Z]*$required

The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.

transfer.​destinationAmount.​amountstring^[0-9]+$required

The monetary amount, scaled to the lowest denomination of the currency.

transfer.​statestring(TransferState)required
Enum"INITIALISED""COMPLETED""REJECTED""FAILED""PENDING""SCHEDULED""CANCELLED"
transfer.​creationTimestampstring^[0-9]+$required

Epoch timestamp using millisecond precision.

transfer.​conflictstring(CreateTransferConflictErrorCode)
Enum"UNDEFINED""NO_ERROR""PROFILE_INACTIVE""MODEL_CONSTRAINTS_VIOLATED""DENIED_BY_INTERCEPTOR""DENIED_BY_INSTRUMENT""DENIED_BY_FOREX_TRADE""CURRENCY_MISMATCH""INSUFFICIENT_FUNDS""SYSTEM_ERROR"
transfer.​scheduledTimestampstring(ScheduledTimestamp)^[0-9]+$

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

transfer.​cancellationReasonstring(TransactionCancellationReason)<= 50 characters^[ a-zA-Z0-9_-]+$

The reason the scheduled transaction was cancelled.

transfer.​executionTimestampstring(ExecutionTimestamp)^[0-9]+$

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

publishedTimestampstring^[0-9]+$required

Epoch timestamp using millisecond precision.

application/json
{
  "eventType": "PENDING",
  "transfer": {
    "id": { … },
    "profileId": "string",
    "tag": "string",
    "source": { … },
    "destination": { … },
    "destinationAmount": { … },
    "state": "INITIALISED",
    "creationTimestamp": "string",
    "conflict": "UNDEFINED",
    "scheduledTimestamp": "string",
    "cancellationReason": "string",
    "executionTimestamp": "string"
  },
  "publishedTimestamp": "string"
}

Responses

Success - No Content

Send

Webhooks

Outgoing Wire Transfers

Webhooks

Manual Transactions

Webhooks

Fees

Webhooks

Login

Webhooks

Stepup

Webhooks

Authentication Factors

Webhooks

Beneficiaries

Webhooks

Bulk Operations

Webhooks

Auth Users

Webhooks