Skip to content

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
Overview
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

Account updateWebhook

Request

Notification that the status of a managed account has been updated.

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
accountobject(LegacyManagedAccount)required
account.​idobject(InstrumentId)required
account.​id.​idstring(Id)^[0-9]+$required
account.​id.​typestring(InstrumentType)required
Enum"managed_cards""managed_accounts"
account.​profileIdstring^[0-9]+$required
account.​tagstring<= 50 characters^$|^[a-zA-Z0-9_-]+$
account.​ownerobject(StringWrappedTypeId)required
account.​owner.​typestring<= 50 characters^[a-zA-Z0-9_-]+$required
account.​owner.​idstring^[0-9]+$required
account.​friendlyNamestring[ 1 .. 50 ] charactersrequired
account.​activeboolean
account.​currencystring(Currency)= 3 characters^[A-Z]*$required

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

account.​balancesobject
account.​stateobject(InstrumentStateLegacy)
account.​creationTimestampstring^[0-9]+$required

Epoch timestamp using millisecond precision.

account.​bankAccountDetailsobject(BankAccountDetails)

The bank account details to be used when loading funds to this managed account.

publishedTimestampstring^[0-9]+$required

Epoch timestamp using millisecond precision.

typestring(ManagedAccountEventType)required
Enum"CREATED""UPDATED""REQUESTED""REJECTED""BLOCKED""UNBLOCKED""DESTROYED"
application/json
{ "account": { "id": { … }, "profileId": "string", "tag": "string", "owner": { … }, "friendlyName": "string", "active": true, "currency": "str", "balances": { … }, "state": { … }, "creationTimestamp": "string", "bankAccountDetails": { … } }, "publishedTimestamp": "string", "type": "CREATED" }

Responses

Success - No Content

Account incoming wire transferWebhook

Request

Notification that an incoming wire transfer (previously called 'deposit') has been performed on a managed account.

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
idobject(InstrumentId)required

The id of the managed account where an incoming wire transfer has been received.

id.​idstring(Id)^[0-9]+$required
id.​typestring(InstrumentType)required
Enum"managed_cards""managed_accounts"
transactionIdstring^[0-9]+$required

The id of the transaction, for reference.

transactionAmountobject(LegacyCurrencyAmount)required

The amount of the transaction.

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

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

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

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

transactionTimestampstring^[0-9]+$required

The timestamp of the transaction, using epoch timestamp with millisecond precision.

paymentNetworkstring(TransferType)

The field specifies the payment system through which the incoming wire transfer was processed.

Enum"SEPA""FASTER_PAYMENTS""SWIFT""BACS""CHAPS""RIX"
emailAddressstring

The email address of the user who effected the incoming wire transfer.

ownerobject(StringWrappedTypeId)required
owner.​typestring<= 50 characters^[a-zA-Z0-9_-]+$required
owner.​idstring^[0-9]+$required
senderNamestring
statestring(ManagedAccountsIwtEventIwtState)
Enum"PENDING""COMPLETED""REJECTED"
senderIbanstring
senderSortCodestring
senderAccountNumberstring
senderAccountDescriptorstring
transactionFeeobject(LegacyCurrencyAmount)

Any fee amount taken with the incoming wire transfer

senderReferencestring

A reference provided by the sender of the incoming wire transfer

application/json
{ "id": { "id": "string", "type": "managed_cards" }, "transactionId": "string", "transactionAmount": { "currency": "str", "amount": "string" }, "transactionTimestamp": "string", "paymentNetwork": "SEPA", "emailAddress": "string", "owner": { "type": "string", "id": "string" }, "senderName": "string", "state": "PENDING", "senderIban": "string", "senderSortCode": "string", "senderAccountNumber": "string", "senderAccountDescriptor": "string", "transactionFee": { "currency": "str", "amount": "string" }, "senderReference": "string" }

Responses

Success - No Content

Linked Accounts

Webhooks

Transfers

Webhooks

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