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

Outgoing Wire Transfer transactionWebhook

Request

Notification that a Outgoing Wire Transfer 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
ownerobject(StringWrappedTypeId)required
owner.​typestring<= 50 characters^[a-zA-Z0-9_-]+$required
owner.​idstring^[0-9]+$required
transferobject(LegacyOutgoingWireTransfer)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.​transferAmountobject(LegacyCurrencyAmount)

The object representing a monetary amount in a particular currency.

transfer.​descriptionstring<= 50 characters
transfer.​typestring(OutgoingWireTransferType)required

The wire transfer rails used, from SEPA, Faster Payments or SWIFT.

Enum"SEPA""FASTER_PAYMENTS""SWIFT"
transfer.​destinationobject(Destination)required
transfer.​destination.​beneficiaryNamestring<= 100 characters^$|^.*$required

The name of the beneficiary

transfer.​destination.​beneficiaryAddressstring<= 150 characters^$|^.*$

The beneficiary address

transfer.​destination.​beneficiaryBankNamestring<= 150 characters^$|^.*$

The name of the beneficiary bank

transfer.​destination.​beneficiaryBankAddressstring<= 150 characters^$|^.*$

The beneficiary bank address

transfer.​destination.​beneficiaryBankCountrystring<= 2 characters^$|^[A-Z]+$

The beneficiary bank country - using ISO 3166 alpha-2

transfer.​destination.​beneficiaryAccountTypestring

The type of beneficiary account. Required only when FasterPaymentsBankDetailsOrBACSBankDetails are specified

Enum"PERSONAL""BUSINESS"
transfer.​destination.​beneficiaryNationalitystring(Nationality)= 2 characters^[A-Z]+$

Nationality of the user - using ISO 3166 alpha-2.

transfer.​destination.​beneficiaryDateOfBirthstring(date)(DateOfBirth)

The date of birth in ISO 8601 format (YYYY-MM-DD).

transfer.​destination.​sepaobject(IBANDetails)

Bank details used in case the wire transfer is executed over SEPA or RIX

transfer.​destination.​fasterPaymentsobject(FasterPaymentsBankDetailsOrBACSBankDetails)

Bank details used in case the wire transfer is executed over Faster Payments.

transfer.​destination.​swiftobject
transfer.​externalAccountIdobject(ExternalAccountId)

The id of an external account, such as a Linked Account, registered with the Weavr Platform.

transfer.​beneficiaryIdstring^$|^[0-9]+$
transfer.​statestring(OutgoingWireTransferState)required

The state of the Outgoing wire transfer transaction, as follows:

  • INVALID: The wire transfer has failed initial validation checks.
  • PENDING_CHALLENGE: The wire transfer requires the completion of a transaction confirmation challenge before it can be submitted.
  • SUBMITTED: The wire transfer has been submitted to the sending financial institution for processing.
  • REJECTED: The wire transfer that was submitted was rejected.
  • APPROVED: The wire transfer that was submitted has been approved and is being processed by the sending financial institution.
  • FAILED: There was an issue with the wire transfer, and the transaction has failed.
  • COMPLETED: The requested funds have been sent from the source instrument.
  • RETURNED: The wire transfer has been returned to the sender.
  • SCHEDULED: The wire transfer will be executed at the scheduled time.
  • CANCELLED: The scheduled wire transfer has been cancelled.
  • PENDING_CONFIRMATION: The wire transfer requires a manual confirmation by the user before proceeding.
Enum"INVALID""PENDING_CHALLENGE""SUBMITTED""REJECTED""APPROVED""FAILED""COMPLETED""RETURNED""SCHEDULED""CANCELLED"
transfer.​challengeExemptionReasonstring(ChallengeExemptionReason)

The Reason the transaction was exempted from SCA verification

Enum"NO_EXEMPTION""LOW_VALUE""NOT_ENABLED""TRUSTED_BENEFICIARY"
transfer.​creationTimestampstring^[0-9]+$required

Epoch timestamp using millisecond precision.

transfer.​transactionAmountobject(LegacyCurrencyAmount)required

The object representing a monetary amount in a particular currency.

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

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

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

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

transfer.​transactionFeeobject(LegacyCurrencyAmount)

Any fee amount taken with the OWT

transfer.​conflictstring(OWTConflictErrorCode)
Enum"UNDEFINED""NO_ERROR""PROFILE_INACTIVE""MODEL_CONSTRAINTS_VIOLATED""DENIED_BY_INTERCEPTOR""DENIED_BY_INSTRUMENT""UNSUPPORTED_CURRENCY""INVALID_AMOUNT""INSUFFICIENT_FUNDS""SOURCE_NOT_FOUND"
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.

transfer.​validationOutcomesArray of objects(OutgoingWireTransferValidationOutcome)
publishedTimestampstring^[0-9]+$required

Epoch timestamp using millisecond precision.

eventTypestring(OutgoingWireTransferEventType)required
Enum"PENDING_CHALLENGE""SUBMITTED""APPROVED""REJECTED""FAILED""COMPLETED""RETURNED""INVALID""SCHEDULED""CANCELLED"
application/json
{
  "owner": {
    "type": "string",
    "id": "string"
  },
  "transfer": {
    "id": { … },
    "profileId": "string",
    "tag": "string",
    "source": { … },
    "transferAmount": { … },
    "description": "string",
    "type": "SEPA",
    "destination": { … },
    "externalAccountId": { … },
    "beneficiaryId": "string",
    "state": "INVALID",
    "challengeExemptionReason": "NO_EXEMPTION",
    "creationTimestamp": "string",
    "transactionAmount": { … },
    "transactionFee": { … },
    "conflict": "UNDEFINED",
    "scheduledTimestamp": "string",
    "cancellationReason": "string",
    "executionTimestamp": "string",
    "validationOutcomes": [ … ]
  },
  "publishedTimestamp": "string",
  "eventType": "PENDING_CHALLENGE"
}

Responses

Success - No Content

Manual Transactions

Webhooks

Fees

Webhooks

Login

Webhooks

Stepup

Webhooks

Authentication Factors

Webhooks

Beneficiaries

Webhooks

Bulk Operations

Webhooks

Auth Users

Webhooks