Skip to content
Send/
Send 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

Send

Webhooks

Send transactionWebhook

Request

Notification that a Send 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(SendEventSendEventType)required
Enum"PENDING""COMPLETED""FAILED""PENDING_CHALLENGE""INVALID""SCHEDULED""CANCELLED"
sendobject(LegacySend)required
send.​beneficiaryIdstring^[0-9]+$
send.​cancellationReasonstring(TransactionCancellationReason)<= 50 characters^[ a-zA-Z0-9_-]+$

The reason the scheduled transaction was cancelled.

send.​challengeExemptionReasonstring(ChallengeExemptionReason)

The Reason the transaction was exempted from SCA verification

Enum"NO_EXEMPTION""LOW_VALUE""NOT_ENABLED""TRUSTED_BENEFICIARY"
send.​conflictstring(CreateSendConflictErrorCode)
Enum"NO_ERROR""PROFILE_INACTIVE""MODEL_CONSTRAINTS_VIOLATED""DENIED_BY_INTERCEPTOR""DENIED_BY_INSTRUMENT""DENIED_BY_FOREX_TRADE""CURRENCY_MISMATCH""SOURCE_NOT_FOUND""DESTINATION_NOT_FOUND""FEE_NOT_CONFIGURED_FOR_CURRENCY"
send.​creationTimestampstring^[0-9]+$required
send.​descriptionstring<= 255 characters^[a-zA-Z0-9\/\-?:().$_,'+\s#=!"%&*<>;\{@\r\n]...

The description details that are included in the transaction as reference.

send.​destinationobject(InstrumentId)required
send.​destination.​idstring(Id)^[0-9]+$required
send.​destination.​typestring(InstrumentType)required
Enum"managed_cards""managed_accounts"
send.​destinationAmountobject(LegacyCurrencyAmount)required

The object representing a monetary amount in a particular currency.

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

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

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

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

send.​destinationFeeobject

The object representing a monetary amount in a particular currency.

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

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

send.​idobject(StringWrappedTypeId)required
send.​id.​typestring<= 50 characters^[a-zA-Z0-9_-]+$required
send.​id.​idstring^[0-9]+$required
send.​profileIdstring^[0-9]+$required
send.​scheduledTimestampstring(ScheduledTimestamp)^[0-9]+$

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

send.​sourceobject(InstrumentId)required
send.​source.​idstring(Id)^[0-9]+$required
send.​source.​typestring(InstrumentType)required
Enum"managed_cards""managed_accounts"
send.​sourceFeeobject

The object representing a monetary amount in a particular currency.

send.​statestring(SendState)required

The state of the send transaction, as follows:

  • INITIALISED: The initial state of a send transaction when SCA is not required.
  • PENDING_CHALLENGE: The send transaction requires verification before it can be initialised. Use the /sends/{id}/challenges/otp/{channel} API endpoint to start the verification process.
  • PENDING: The transaction has exceeded the destination limit and is pending treasury approval.
  • APPROVED: The send transaction was approved.
  • COMPLETED: The send transaction has been completed.
  • REJECTED: The send transaction was rejected.
  • FAILED: There was an issue with the send transaction, and the transaction has failed.
  • SCHEDULED: The send transaction will execute at the scheduled time.
  • CANCELLED: The scheduled send transaction has been cancelled.
Enum"UNDEFINED""INITIALISED""COMPLETED""REJECTED""FAILED""PENDING""PENDING_CHALLENGE""APPROVED""INVALID""SCHEDULED"
send.​tagstring<= 50 characters^[a-zA-Z0-9_-]+$
send.​transactionAmountobjectrequired

The object representing a monetary amount in a particular currency.

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

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

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

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

publishedTimestampstring^[0-9]+$required
application/json
{
  "eventType": "PENDING",
  "send": {
    "beneficiaryId": "string",
    "cancellationReason": "string",
    "challengeExemptionReason": "NO_EXEMPTION",
    "conflict": "NO_ERROR",
    "creationTimestamp": "string",
    "description": "string",
    "destination": { … },
    "destinationAmount": { … },
    "destinationFee": { … },
    "executionTimestamp": "string",
    "id": { … },
    "profileId": "string",
    "scheduledTimestamp": "string",
    "source": { … },
    "sourceFee": { … },
    "state": "UNDEFINED",
    "tag": "string",
    "transactionAmount": { … }
  },
  "publishedTimestamp": "string"
}

Responses

Success - No Content

Outgoing Wire Transfers

Webhooks

Manual Transactions

Webhooks

Fees

Webhooks

Login

Webhooks

Stepup

Webhooks

Authentication Factors

Webhooks

Beneficiaries

Webhooks

Bulk Operations

Webhooks

Auth Users

Webhooks