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

Linked Account UpdateWebhook

Request

Notification that an event related to a Linked Account has occurred.

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
linkedAccountobject(LinkedAccount)required
linkedAccount.​idstring^[0-9]+$required

The unique identifier of the linked account.

linkedAccount.​profileIdstring(ProfileId)^[0-9]+$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.

linkedAccount.​tagstring(Tag)<= 50 characters^[a-zA-Z0-9_-]+$

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

linkedAccount.​friendlyNamestring[ 1 .. 50 ] characters

A user-friendly label assigned to the Linked Account to help end-users easily identify it within the application. This name can be updated at any time using the PATCH endpoint

linkedAccount.​namestring[ 1 .. 100 ] charactersrequired

The full name or corporate name of the account holder as registered with the external bank or payment service provider. This is the name under which the account is officially held.

linkedAccount.​typestring(AccountType)

An account can be of two types, Personal or Business:

  • PERSONAL means that the account held at the external bank or PSP is registered under the ownership of a natural person or consumer identity;
  • BUSINESS means that the account held at the external bank or PSP is registered under the ownership of a corporate entity.
Enum"BUSINESS""PERSONAL"
linkedAccount.​currencystring(Currency)= 3 characters^[A-Z]*$

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

linkedAccount.​countrystring= 2 characters^[A-Z]+$required

The country of the bank or institution at which the account is held.

linkedAccount.​accountReferenceAccountNumberAndSortCode (object) or Iban (object) or AccountDescriptor (object)

The IBAN or Account Number and Sort Code of the account held at the external bank or payment service provider.

One of:

Bank details

linkedAccount.​statestring(LinkedAccountState)required

The state of the linked account:

  • PENDING_VERIFICATION: The Linked Account is pending the completion of the required verification steps.
  • ACTIVE: The Linked Account is verified and active, ready to be used for self-to-self wire transfers.
  • BLOCKED: The Linked Account is temporarily blocked, preventing any use of this external account in self-to-self wire transfers. A Linked Account can be unblocked by calling the Multi API endpoint POST /linked_accounts/{id}/unblock.
  • REMOVED: The Linked Account has been removed from the platform and can no longer be used for self-to-self wire transfers unless a new verification is completed in future.
  • REJECTED: The Linked Account failed the verification process and cannot be used for self-to-self wire transfers unless a new verification is completed in future. A Linked Account can transition through these different overall states, starting at the PENDING_VERIFICATION state until all verification steps are followed through.
Enum"PENDING_VERIFICATION""BLOCKED""ACTIVE""REJECTED""REMOVED"
linkedAccount.​creationTimestampinteger(int64)

The timestamp when the linked account was created, expressed in Epoch timestamp using millisecond precision.

linkedAccount.​ownerobject(StringWrappedTypeId)
publishedTimestampstring^[0-9]+$required

Epoch timestamp using millisecond precision.

eventTypestring(LinkedAccountEventType)required

The type of event that occurred related to the linked account. Possible values are:

  • PENDING_VERIFICATION: The linked account is pending verification.
  • VERIFIED: The overall verification run was successfully completed. The linked account is now verified.
  • BLOCKED: The linked account has been blocked.
  • UNBLOCKED: The linked account has been unblocked.
  • REMOVED: The linked account has been removed.
  • REJECTED: The linked account was rejected.
Enum"PENDING_VERIFICATION""VERIFIED""BLOCKED""UNBLOCKED""REMOVED""REJECTED"
application/json
{
  "linkedAccount": {
    "id": "string",
    "profileId": "string",
    "tag": "string",
    "friendlyName": "string",
    "name": "string",
    "type": "BUSINESS",
    "currency": "str",
    "country": "st",
    "accountReference": { … },
    "state": "PENDING_VERIFICATION",
    "creationTimestamp": 0,
    "owner": { … }
  },
  "publishedTimestamp": "string",
  "eventType": "PENDING_VERIFICATION"
}

Responses

Success - No Content

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