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

Transfers

Webhooks

Send

Webhooks

Outgoing Wire Transfers

Webhooks

Manual Transactions

Webhooks

Fees

Webhooks

Login

Webhooks

Stepup

Webhooks

Authentication Factors

Webhooks

Beneficiaries

Webhooks

Beneficiary batchWebhook

Request

Notification that a Beneficiary batch has been submitted.

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
idstring^[0-9]+$required
operationstring(BeneficiaryBatchOperation)required
Enum"CREATE""REMOVE"
tagstring<= 50 characters^[a-zA-Z0-9_-]+$
publishedTimestampstring^[0-9]+$required

Epoch timestamp using millisecond precision.

eventTypestring(BeneficiaryBatchEventType)required
Enum"INITIALISED""FAILED""PENDING_CHALLENGE""CHALLENGE_FAILED""CHALLENGE_COMPLETED"
beneficiariesArray of objects(LegacyBeneficiary)required
beneficiaries[].​idstring^[0-9]+$required
beneficiaries[].​externalRefsArray of strings
beneficiaries[].​groupstring<= 50 characters^[a-zA-Z0-9_-]+$
beneficiaries[].​trustLevelstring(BeneficiaryTrustLevel)required

The value that determines whether a Beneficiary is trusted or not.

Value"TRUSTED"
beneficiaries[].​beneficiaryInformationobjectrequired
beneficiaries[].​beneficiaryInformation.​businessBeneficiaryTypeobject(BusinessBeneficiaryType)
beneficiaries[].​beneficiaryInformation.​consumerBeneficiaryTypeobject(ConsumerBeneficiaryType)
beneficiaries[].​beneficiaryDetailsobjectrequired
beneficiaries[].​beneficiaryDetails.​instrumentDetailsBeneficiaryobject(InstrumentDetailsBeneficiary)

Represents a Weavr beneficiary instrument typically used in Send transactions.

beneficiaries[].​beneficiaryDetails.​bankAccountDetailsBeneficiaryobject(LegacyBankAccountDetailsBeneficiary)
beneficiaries[].​statestring(BeneficiaryState)required
Enum"INITIALISED""INVALID""PENDING_CHALLENGE""CHALLENGE_FAILED""ACTIVE""REMOVED"
beneficiaries[].​validationFailurestring(BeneficiaryValidationFailure)
Enum"INSTRUMENT_DETAILS_NOT_FOUND""BENEFICIARY_DETAILS_ALREADY_EXIST""BENEFICIARY_BELONGS_TO_SAME_IDENTITY""BENEFICIARY_VALIDATION_FAILURE_UNKNOWN"
application/json
{
  "id": "string",
  "operation": "CREATE",
  "tag": "string",
  "publishedTimestamp": "string",
  "eventType": "INITIALISED",
  "beneficiaries": [
    { … }
  ]
}

Responses

Success - No Content

Bulk Operations

Webhooks

Auth Users

Webhooks