Skip to main content
Weavr Webhook
Reference

Schemas

KybEvent

{}
objectobject · 6 fields

CorporateKybFailureReason

enum

Enum:UNDEFINED_REQUIRED_INTERVENTIONDOCUMENTS_UNSATISFACTORYSUPPLIED_DATA_AND_DOCUMENTS_MISMATCHLANGUAGE_IN_DOCUMENTS_UNSUPPORTEDSELFIE_UNSATISFACTORYSELFIE_AND_DOCUMENTS_MISMATCHCORPORATE_DETAILS_UNSATISFACTORYBENEFICIARY_DETAILS_UNSATISFACTORYREPRESENTATIVE_DETAILS_UNSATISFACTORYOTHERROOT_USER_UNMATCHED_TO_DIRECTOR_OR_REPRESENTATIVEUNSUPPORTED_COUNTRYEXPIRED_KYC_DOCUMENTS

BeneficiaryVerifiedEvent

{}
objectobject · 4 fields

BeneficiaryEventType

enum

Enum:STATUS_UPDATEDBENEFICIARY_TYPE_UPDATEDFIRST_NAME_UPDATEDMIDDLE_NAME_UPDATEDLAST_NAME_UPDATEDEMAIL_UPDATED

BeneficiaryVerifiedEventAdditionalInformation

{}
objectobject · 7 fields

KycEventAdditionalInformation

{}
objectobject · 2 fields

BeneficiaryInfo

{}
objectobject · 7 fields

KyiStatus

enum

Enum:UNDEFINEDNOT_STARTEDINITIATEDPENDING_REVIEWAPPROVEDREJECTED

BeneficiaryValidationFailure

enum

Enum:INSTRUMENT_DETAILS_NOT_FOUNDBENEFICIARY_DETAILS_ALREADY_EXISTBENEFICIARY_BELONGS_TO_SAME_IDENTITYBENEFICIARY_VALIDATION_FAILURE_UNKNOWN

BeneficiaryType

enum

Enum:UNDEFINED_BENEFICIARY_TYPEUBODIRECTORUNKNOWNSHAREHOLDERPARTNEROTHER_DIRECTOR

IdentityActivatedEvent

{}
objectobject · 2 fields

ActionDoneBy

enum

Enum:UNDEFINEDADMININNOVATOR

IdentityDeactivatedEvent

{}
objectobject · 3 fields

IdentityDeactivatedReasonCode

enum

Enum:UNDEFINED_REASONACCOUNT_REVIEWACCOUNT_SECURITYTEMPORARYACCOUNT_CLOSUREACCOUNT_ABANDONED

KycEvent

{}
objectobject · 10 fields

KycRejectionReason

enum

Enum:UNDEFINED_KYC_FAILURE_REASONDOCUMENTS_UNSATISFACTORYSUPPLIED_DATA_AND_DOCUMENTS_MISMATCHLANGUAGE_IN_DOCUMENTS_UNSUPPORTEDSELFIE_UNSATISFACTORYSELFIE_AND_DOCUMENTS_MISMATCHOTHERUNSUPPORTED_COUNTRYPEP_STATUSREJECTED_DUPLICATEEXPIRED_KYC_DOCUMENTS

IbanEvent

{}
objectobject · 3 fields

LinkedAccountEvent

{}
objectobject · 3 fields

ManagedAccountEvent

{}
objectobject · 3 fields

LegacyManagedAccount

{}
objectobject · 11 fields

LegacyCurrencyAmount

The object representing a monetary amount in a particular currency.

{}
objectobject · 2 fields

InstrumentStateLegacy

{}
objectobject · 2 fields

BankAccountDetails

{}
objectobject · 8 fields

IbanEventType

enum

Enum:CREATEDUPDATEDREQUESTEDREJECTEDBLOCKEDUNBLOCKEDDESTROYED

ManagedAccountEventType

enum

Enum:CREATEDUPDATEDREQUESTEDREJECTEDBLOCKEDUNBLOCKEDDESTROYED

LinkedAccountEventType

enum

Enum:PENDING_VERIFICATIONVERIFIEDBLOCKEDUNBLOCKEDREMOVEDREJECTED

ManagedAccountsDepositEvent

{}
objectobject · 15 fields

ManagedAccountsIwtEventIwtState

enum

Enum:PENDINGCOMPLETEDREJECTED

ManagedCardsStateChangeEvent

{}
objectobject · 6 fields

ManagedCardsAuthorisationEvent

{}
objectobject · 28 fields

AuthDeclineReason

enum

Enum:NO_REASONPHYSICAL_NOT_ACTIVATEDINSUFFICIENT_BALANCECVV_CHECKS_FAILEDCVV_RETRIES_EXCEEDEDCARD_STATUS_NOT_ALLOWEDPIN_CHECKS_FAILEDPIN_RETRIES_EXCEEDEDCARD_EXPIRY_CHECKS_FAILEDAVS_CHECKS_FAILEDATM_WITHDRAWAL_LIMIT_EXCEEDEDSCA_REQUIREDAUTH_RULE_CHECKS_FAILEDTRANSACTION_NOT_PERMITTEDTIMEOUT

CardAuthorisationDetailsAuthorisationType

enum

Enum:AUTHORISEDAUTHORISED_CREDITDECLINEDONLINE_REVERSEEXPIREDMANUAL_CLOSECANCELLED

AuthRuleChecksFailedReason

enum

Enum:NONEMERCHANT_CATEGORY_NOT_IN_ALLOWED_LISTMERCHANT_CATEGORY_BLOCKEDMERCHANT_ID_NOT_IN_ALLOWED_LISTMERCHANT_ID_BLOCKEDATM_NOT_ALLOWEDCONTACTLESS_NOT_ALLOWEDECOMMERCE_NOT_ALLOWEDCASHBACK_NOT_ALLOWEDCREDIT_AUTHORISATIONS_NOT_ALLOWEDSPEND_LIMIT_EXCEEDEDMERCHANT_COUNTRY_NOT_IN_ALLOWED_LISTMERCHANT_COUNTRY_BLOCKEDMIN_TRANSACTION_AMOUNT_EXCEEDEDMAX_TRANSACTION_AMOUNT_EXCEEDEDAUTH_FORWARDING

StateChangeEventType

enum

Enum:ACTIVATEDBLOCKEDUNBLOCKEDDESTROYED

StateChangeState

{}
objectobject · 3 fields

ManagedCardModeDetails

{}
objectobject · 2 fields

PrepaidModeDetails

{}
objectobject · 1 field

DebitModeDetails

{}
objectobject · 2 fields

AuthForwardingDetails

{}
objectobject · 3 fields

AuthForwardingDefaultTimeoutDecision

enum

Enum:APPROVEDECLINE

ManagedCardsAdjustmentEvent

{}
objectobject · 8 fields

CardAdjustmentDetailsAdjustmentType

enum

Enum:DEFAULT_ADJUSTMENTLOST_STOLEN_REPLACEMENT_BALANCE_TRANSFER

ManagedCardsSettlementEvent

{}
objectobject · 24 fields

CardMerchantSettlementMerchantTransactionType

enum

Enum:SALE_PURCHASECASH_WITHDRAWALSALE_WITH_CASHBACKMAIL_OR_TELEPHONE_ORDERPURCHASE_REFUND_REVERSALORIGINAL_CREDIT_TRANSACTION_REVERSALCASH_WITHDRAWAL_REVERSALPURCHASE_REFUNDPURCHASE_REVERSALORIGINAL_CREDIT_TRANSACTIONFIRST_CHARGEBACKFIRST_CHARGEBACK_REVERSALFIRST_REPRESENTMENTFIRST_REPRESENTMENT_REVERSALSECOND_CHARGEBACKSECOND_CHARGEBACK_REVERSALSECOND_REPRESENTMENTARBITRATION_CHARGEBACKBALANCE_INQUIRY

ManagedCardsSettlementEventSettlementState

enum

Enum:PENDINGCOMPLETED

TransferEvent

{}
objectobject · 3 fields

ManagedCardsExpiryAndRenewalEvent

{}
objectobject · 7 fields

ManagedCardsExpiryAndRenewalEventType

enum

Enum:CARD_ABOUT_TO_EXPIRECARD_EXPIREDCARD_RENEWED

ManagedCardsUpgradeToPhysicalEvent

{}
objectobject · 3 fields

ManagedCardsReplacementEventType

enum

Enum:VIRTUAL_REPLACEMENTPHYSICAL_REPLACEMENT

ManagedCardsReplacementEvent

The event that is triggered when a managed card is replaced. This can be either a virtual or physical replacement.

{}
objectobject · 6 fields

TransferEventTransferEventType

enum

Enum:PENDINGCOMPLETEDFAILEDSCHEDULEDCANCELLED

LegacyTransfer

{}
objectobject · 12 fields

TransferState

enum

Enum:INITIALISEDCOMPLETEDREJECTEDFAILEDPENDINGSCHEDULEDCANCELLED

CreateTransferConflictErrorCode

enum

Enum:UNDEFINEDNO_ERRORPROFILE_INACTIVEMODEL_CONSTRAINTS_VIOLATEDDENIED_BY_INTERCEPTORDENIED_BY_INSTRUMENTDENIED_BY_FOREX_TRADECURRENCY_MISMATCHINSUFFICIENT_FUNDSSYSTEM_ERRORSOURCE_NOT_FOUNDDESTINATION_NOT_FOUNDFEE_NOT_CONFIGURED_FOR_CURRENCYDESTINATION_LIMIT_EXCEEDEDTRANSFER_BETWEEN_INSTRUMENTS_UNSUPPORTEDSOURCE_INSTRUMENT_BLOCKEDDESTINATION_INSTRUMENT_BLOCKEDINVALID_AMOUNTSCHEDULED_TIMESTAMP_INVALID

SendEvent

{}
objectobject · 3 fields

SendEventSendEventType

enum

Enum:PENDINGCOMPLETEDFAILEDPENDING_CHALLENGEINVALIDSCHEDULEDCANCELLED

LegacySend

{}
objectobject · 18 fields

SendState

enum

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

ChallengeExemptionReason

enum

The Reason the transaction was exempted from SCA verification

Enum:NO_EXEMPTIONLOW_VALUENOT_ENABLEDTRUSTED_BENEFICIARY

CreateSendConflictErrorCode

enum

Enum:NO_ERRORPROFILE_INACTIVEMODEL_CONSTRAINTS_VIOLATEDDENIED_BY_INTERCEPTORDENIED_BY_INSTRUMENTDENIED_BY_FOREX_TRADECURRENCY_MISMATCHSOURCE_NOT_FOUNDDESTINATION_NOT_FOUNDFEE_NOT_CONFIGURED_FOR_CURRENCYDESTINATION_LIMIT_EXCEEDEDSEND_TO_INSTRUMENT_UNSUPPORTEDINSUFFICIENT_FUNDSSOURCE_INSTRUMENT_BLOCKEDDESTINATION_INSTRUMENT_BLOCKEDINVALID_AMOUNTIDENTITY_KYC_LEVEL_STEPUP_REQUIREDPROFILE_NOT_FOUNDSCHEDULED_TIMESTAMP_INVALID

OutgoingWireTransferEvent

{}
objectobject · 4 fields

LegacyOutgoingWireTransfer

{}
objectobject · 20 fields

OWTConflictErrorCode

enum

Enum:UNDEFINEDNO_ERRORPROFILE_INACTIVEMODEL_CONSTRAINTS_VIOLATEDDENIED_BY_INTERCEPTORDENIED_BY_INSTRUMENTUNSUPPORTED_CURRENCYINVALID_AMOUNTINSUFFICIENT_FUNDSSOURCE_NOT_FOUNDSOURCE_INSTRUMENT_BLOCKEDFEE_NOT_CONFIGURED_FOR_CURRENCYTYPE_NOT_SUPPORTED_BY_PROFILESOURCE_INSTRUMENT_DESTROYEDIDENTITY_KYC_LEVEL_STEPUP_REQUIREDCURRENCY_MISMATCHBENEFICIARY_NOT_FOUNDBENEFICIARY_TYPE_INVALIDPROFILE_NOT_FOUNDSCHEDULED_TIMESTAMP_INVALIDBENEFICIARY_BANK_DETAILS_INVALIDPROVIDER_ERRORSOURCE_HAS_NO_ACCESS_INSTRUMENTDESTINATION_ACCOUNT_TYPE_INVALIDEXTERNAL_DESTINATION_ACCOUNT_NOT_FOUND

Destination

{}
objectobject · 11 fields

OutgoingWireTransferEventType

enum

Enum:PENDING_CHALLENGESUBMITTEDAPPROVEDREJECTEDFAILEDCOMPLETEDRETURNEDINVALIDSCHEDULEDCANCELLEDPENDING_CONFIRMATION

ManualTransactionEvent

{}
objectobject · 6 fields

ChargeFeeEvent

{}
objectobject · 3 fields

ChargeFeeEventType

enum

Enum:UNDEFINEDCOMPLETED

LegacyFeeSpec

{}
objectobject · 3 fields

LegacyScaledAmount

A floating point number, represented as a value and its scale. Its actual value can be obtained using the equation: value * pow(10, -scale).

{}
objectobject · 2 fields

LegacyTransactionBatch

{}
objectobject · 11 fields

LegacyTransactionBatchInstrument

{}
objectobject · 11 fields

LegacyInstrumentParticipant

{}
objectobject · 25 fields

LegacyTransactionBatchForexTrade

{}
objectobject · 9 fields

LegacyInstrumentBalances

{}
objectobject · 5 fields

LegacyTransactionBatchInstrumentRemaining

{}
objectobject · 4 fields

LegacyForexTradeParticipant

{}
objectobject · 8 fields

LoginEvent

{}
objectobject · 5 fields

LoginEventLoginEventStatus

enum

Enum:VERIFIEDDECLINEDEXPIRED

StepupEvent

{}
objectobject · 7 fields

StepupEventEventStatus

enum

Enum:VERIFIEDDECLINEDEXPIRED

EnrolmentEvent

{}
objectobject · 4 fields

EnrolmentEventEnrolmentStatus

enum

Enum:ACTIVEINACTIVE

BeneficiaryBatchEvent

{}
objectobject · 6 fields

BeneficiaryBatchEventType

enum

Enum:INITIALISEDFAILEDPENDING_CHALLENGECHALLENGE_FAILEDCHALLENGE_COMPLETED

LegacyBeneficiary

{}
objectobject · 8 fields

LegacyBankAccountDetailsBeneficiary

{}
objectobject · 7 fields

BulkProcessProgressEvent

{}
objectobject · 4 fields

KycLevel

enumdeprecated

The KYC level, which determines what KYC information will be requested from the consumer:

  • KYC_LEVEL_1: The most basic level of KYC required.
  • KYC_LEVEL_2: Full due diligence level 2

Enum:KYC_LEVEL_1KYC_LEVEL_2

IbanInstrument

{}
objectobject · 10 fields

LinkedAccount

{}
objectobject · 12 fields

InstrumentId

{}
objectobject · 2 fields

StringWrappedTypeId

{}
objectobject · 2 fields

Currency

string

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

min length 3max length 3pattern ^[A-Z]*$

BlockedDetailsType

enum

Enum:VELOCITYUSERACCOUNTADMIN

TransferType

enum

Enum:SEPAFASTER_PAYMENTSSWIFTBACSCHAPSRIX

CardType

enum

Enum:VIRTUALPHYSICAL

CardRenewalType

enum

Indicates how the card will be handled once it is close to expiring.

  • RENEW: The card will be automatically renewed, keeping the same card number but with a new expiry date and CVV.
  • NO_RENEW: Once the expiry date is reached, the card is destroyed.

Enum:RENEWNO_RENEW

MerchantData

{}
objectobject · 14 fields

AuthorisationCategory

enum

The category of the authorisation.

Enum:PRE_AUTHFINAL_AUTH

CardHolderPresent

enum

Enum:PRESENTNOT_PRESENTPRESENCE_UNKNOWN

DigitalWalletDetails

Contains information about the digital wallet, if it has been used.

{}
objectobject · 1 field

UserCurrencyTransactionDetails

The object representing the user transaction's currency, amount and rate.

{}
objectobject · 2 fields

InstrumentState

enum

The state of the instrument indicating what it can and cannot do as follows:

  • ACTIVE: The instrument is in an active state and can be used in transactions.
  • BLOCKED: The instrument is temporarily blocked and cannot be used. Any funds on the instrument are also frozen. The blockedReason provides more information as to why it was blocked.
  • DESTROYED: The instrument has been permanently destroyed. The destroyReason provides more information as to why it was destroyed.

Enum:ACTIVEBLOCKEDDESTROYED

BlockedReason

enum

The reason why the instrument has been blocked:

  • USER: The root, or an authorised user, of the identity owning the instrument has temporarily blocked the instrument.
  • SYSTEM: The platform or an administrator of the platform has temporarily blocked the instrument.
  • LOST: The instrument has been blocked because it was marked as lost.

Enum:USERSYSTEMLOST

DestroyedReason

enum

The reason why the instrument has been destroyed:

  • SYSTEM: The platform or an administrator of the platform has destroyed the instrument.
  • USER: The root, or an authorised user, of the identity owning the instrument has destroyed the instrument.
  • LOST: The instrument was automatically destroyed as it was marked as lost.
  • STOLEN: The instrument was automatically destroyed as it was marked as stolen.
  • EXPIRED: The instrument was automatically destroyed as it expired.
  • COMPROMISED: The instrument was automatically destroyed as it was marked as compromised.

Enum:SYSTEMUSERLOSTSTOLENEXPIREDCOMPROMISED

CurrencyAmount

The object representing a monetary amount in a particular currency.

{}
objectobject · 2 fields

SpendLimitInterval

enum

The time period for which the spendLimit is valid.

  • DAILY: starting from 00:00:00 UTC of current day to 23:59:59 UTC of current day

  • WEEKLY: 00:00:00 UTC Monday of current week to following Sunday 23:59:59 UTC

  • MONTHLY: 1st of current calendar month to end of current calendar month

  • QUARTERLY: starting from beginning of current quarter where quarters are defined as follows:

  • 1 January 00:00:00 UTC to 31 March 23:59:59 UTC

  • 1 April 00:00:00 UTC to 30 Jun 23:59:59 UTC

  • 1 July 00:00:00 UTC to 30 September 23:59:59 UTC

  • 1 October 00:00:00 UTC to 31 December 23:59:59 UTC

  • YEARLY: 1 January 00:00:00 UTC of current calendar year to 31 December 23:59:59 UTC of current calendar year.

  • ALWAYS: This indicates that the spendLimit is the total amount that can be spent through the card throughout the whole lifetime of the card.

Enum:DAILYWEEKLYMONTHLYQUARTERLYYEARLYALWAYS

ManagedInstrumentState

{}
objectobject · 3 fields

PhysicalCardDetails

{}
objectobject · 13 fields

ReplacementType

enum

Enum:DAMAGEDLOST_STOLENRENEWCOMPROMISED

UserId

string

pattern ^[0-9]+$

ScheduledTimestamp

string

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

pattern ^[0-9]+$

TransactionCancellationReason

string

The reason the scheduled transaction was cancelled.

max length 50pattern ^[ a-zA-Z0-9_-]+$

ExecutionTimestamp

string

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

pattern ^[0-9]+$

OutgoingWireTransferType

enum

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

Enum:SEPAFASTER_PAYMENTSSWIFT

ExternalAccountId

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

{}
objectobject · 2 fields

OutgoingWireTransferState

enum

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

OutgoingWireTransferValidationOutcome

{}
objectobject · 2 fields

Nationality

string

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

min length 2max length 2pattern ^[A-Z]+$

DateOfBirth

string · date

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

IBANDetails

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

{}
objectobject · 2 fields

FasterPaymentsBankDetailsOrBACSBankDetails

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

{}
objectobject · 3 fields

FeeType

enum

Enum:DEPOSITWITHDRAWALPURCHASEREFUNDATM_WITHDRAWALCHARGEBACKTRANSFERSENDOWTCUSTOMOTHER

FeeSpecType

enum

Enum:FLATPERCENTAGEPLUSMAXMIN

TransactionBatchIntercept

{}
objectobject · 4 fields

TransactionBatchState

enum

Enum:EXECUTION_PENDINGEXECUTEDCOMPLETEDCOMPENSATION_PENDINGREJECTEDFAILEDEXECUTION_SUSPENDEDCOMPENSATION_SUSPENDED

TransactionBatchErrorType

enum

Enum:REVERSAL_EXCEEDS_REMAININGDENIED_BY_INTERCEPTORDENIED_BY_INSTRUMENTDENIED_BY_FOREX_TRADEFI_PROVIDER_TREASURY_UNSUPPORTEDDENIED_BY_SUSPENSEDENIED_BY_STATE_CHANGE

TransactionBatchParticipantState

enum

Enum:EXECUTION_PENDINGEXECUTEDCOMMITTEDREJECTEDFAILEDCOMPENSATION_PENDINGCOMPENSATEDOBSOLETEEXECUTION_SUSPENDEDCOMPENSATION_SUSPENDED

InstrumentParticipantErrorType

enum

Enum:NO_INSTRUMENT_ERRORBALANCE_LIMIT_EXCEEDEDINSTRUMENT_ALREADY_EXISTSINSTRUMENT_ALREADY_DESTROYEDSTATE_DOES_NOT_PERMIT_ACTIONUNSUPPORTED_CURRENCYINSTRUMENT_ALREADY_RESTRICTEDINSTRUMENT_ALREADY_ACTIVEINSTRUMENT_EXPIREDPROVIDER_REJECTEDINSTRUMENT_ALREADY_BLOCKEDINSTRUMENT_NOT_BLOCKED

BlockedDetailsSubType

enum

Enum:FREEZELOSTSINGLE_SPENDPENDING_APPROVAL

DestroyType

enum

Enum:USERADMINSYSTEMLOSTSTOLENSINGLE_SPENDACCOUNT_REJECTEDEXPIREDCOMPROMISED

ForexTradeParticipantErrorType

enum

Enum:NO_FOREX_TRADE_ERRORRATE_EXPIRED

CredentialId

{}
objectobject · 2 fields

BeneficiaryBatchOperation

enum

Enum:CREATEREMOVE

BeneficiaryTrustLevel

enum

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

Enum:TRUSTED

BusinessBeneficiaryType

{}
objectobject · 1 field

ConsumerBeneficiaryType

{}
objectobject · 3 fields

InstrumentDetailsBeneficiary

Represents a Weavr beneficiary instrument typically used in Send transactions.

{}
objectobject · 1 field

BeneficiaryState

enum

Enum:INITIALISEDINVALIDPENDING_CHALLENGECHALLENGE_FAILEDACTIVEREMOVED

BulkProcessProgressStatus

enum

Enum:RUNNINGPARTIALLY_COMPLETEDCOMPLETEDFAILEDPAUSEDCANCELLED

BulkProcessOperationStatusCounts

{}
objectobject · 2 fields

ProfileId

string

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.

pattern ^[0-9]+$

Tag

string

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

max length 50pattern ^[a-zA-Z0-9_-]+$

IbanInstrumentState

{}
objectobject · 2 fields

SwiftBankDetails

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

{}
objectobject · 2 fields

AccountType

enum

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

AccountNumberAndSortCode

Bank details

{}
objectobject · 3 fields

Iban

Bank details

{}
objectobject · 2 fields

AccountDescriptor

Identifier or account number which does not follow either the IBAN or Faster Payment (sort code and account number) format, such as a US bank account identifier.

{}
objectobject · 1 field

LinkedAccountState

enum

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_VERIFICATIONBLOCKEDACTIVEREJECTEDREMOVED

Id

string

pattern ^[0-9]+$

InstrumentType

enum

Enum:managed_cardsmanaged_accounts

DigitalWalletType

enum

The digital wallet type.

Enum:GOOGLE_PAYAPPLE_PAYMERCHANT_TOKEN

BulkCardDelivery

boolean

Bulk delivery is available for deliveryMethods REGISTERED_MAIL or COURIER. All cards marked as bulk and ordered within the fulfilment centre’s dispatch window will be sent in bulk. Delivery address must be identical for all orders. contactNumber in the deliveryAddress object is mandatory when bulk is selected. Maximum number of cards delivered in a single box/packet is REGISTERED_MAIL = 90, COURIER = 200.

ManufacturingState

enum

Information on the manufacturing of the physical card, as follows:

  • REQUESTED: The upgrade of the card to physical has been requested.
  • SENT_FOR_FULFILLMENT - The card has been sent for printing.
  • DISPATCHED: The card has been manufactured and dispatched. You may receive a second DISPATCHED event when the manufacturer provides a tracking code.
  • DELIVERED: The card has been received and activated by the recipient.

Enum:REQUESTEDSENT_FOR_FULFILLMENTDISPATCHEDDELIVERED

DeliveryAddress

The delivery address where the physical card is delivered.

{}
objectobject · 9 fields

DeliveryMethod

enum

The delivery methods supported for delivering printed physical cards. If not specified, the STANDARD_DELIVERY method will be used.

Enum:STANDARD_DELIVERYREGISTERED_MAILCOURIERFIRST_CLASS_MAIL

DeliveryTrackingCode

string

The delivery tracking code for tracking the physical card's delivery status. This may not always be available on the first dispatched event, and so you will receive an additional dispatched notification with the delivery tracking code populated as soon as it is available.

DeliveryTrackingMethod

string

The delivery tracking method for tracking the physical card's delivery status.

DeliveryTrackingUrl

string

The delivery tracking URL for tracking the physical card's delivery status.

ExternalAccountType

enum

Enum:linked_accounts

UKConfirmationOfPayeeResult

{}
objectobject · 3 fields

TransactionBatchInterceptState

enum

Enum:PENDINGALLOWEDDENIEDFAILEDSUSPENDED

BulkProcessOperationStatus

enum

Enum:SUBMITTEDRUNNINGCOMPLETEDFAILEDCANCELLED

IbanState

enum

The state of the instrument indicating what it can and cannot do as follows:

  • PENDING: The instrument is pending creation.
  • ACTIVE: The instrument is in an active state and can be used in transactions.
  • BLOCKED: The instrument is temporarily blocked and cannot be used. Any funds on the instrument are also frozen. The blockedReason provides more information as to why it was blocked.
  • REJECTED: The instrument was rejected from being created.
  • DESTROYED: The instrument has been permanently destroyed. The destroyReason provides more information as to why it was destroyed.

Enum:PENDINGACTIVEBLOCKEDREJECTEDDESTROYED

PhoneNumber

string

min length 5max length 20pattern ^\+[0-9]+$