Skip to main content
Weavr Multi Product API
Reference

Schemas

BulkProcessesPaged

{}
objectobject · 3 fields

Email

string · email

E-mail Address of the user

VerificationCode

string

A randomly generated one-time use code used to verify the user's email address or mobile number.

pattern ^[0-9]{6}$

Error

{}
objectobject · 2 fields

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

BeneficiaryBatchState

enum

Enum:INITIALISEDFAILEDPENDING_CHALLENGECHALLENGE_FAILEDCHALLENGE_COMPLETEDCOMPLETED

BeneficiaryBatchOperation

enum

Enum:CREATEREMOVE

Mobile

{}
objectobject · 2 fields

Date

{}
objectobject · 3 fields

Tag

string

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

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

UserLocale

string

BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.

max length 5pattern ^[a-z]{2}(-[A-Z]{2})?$

Example
en-GB

Brand

string

Brand identifier used to determine the set of email and SMS user notification templates. Must be alphanumeric, up to 25 characters, and contain no spaces.

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

UserId

string

pattern ^[0-9]+$

UpdateCardLevelSpendRules

{}
objectobject · 16 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]+$

InstrumentId

{}
objectobject · 2 fields

CurrencyAmount

The object representing a monetary amount in a particular currency.

{}
objectobject · 2 fields

ScheduledTimestamp

string

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

pattern ^[0-9]+$

SendCreateRequest

{}
objectobject · 7 fields

OutgoingWireTransferCreateRequest

{}
objectobject · 7 fields

LinkedAccount

{}
objectobject · 12 fields

UnknownSenderAccount

{}
objectobject · 2 fields

ManagedAccount

{}
objectobject · 8 fields

Corporate

{}
objectobject · 14 fields

Consumer

{}
objectobject · 11 fields

CardAuthorisationEvent

{}
objectobject · 15 fields

SensitivePassword

The user's password or passcode used to log in a user. Passwords must be:

  • between 8 and 30 characters
  • include a lowercase character
  • include an uppercase character
  • include a digit and a special character
  • different from any of the 5 last such passwords used.

For non-PCI compliant integrations, the password submitted must be tokenised.

{}
objectobject · 1 field

IdentityId

{}
objectobject · 2 fields

Nonce

string

A randomly generated one-time use code.

pattern ^[0-9]{6}$

MultipleSCAResourceType

enum

The operation type upon which an SCA Challenge is being contested.

Enum:outgoing_wire_transferssendslinked_account_declaration

BulkProcessExecute

{}
objectobject · 2 fields

CompanyPosition

enum

The company position of the Corporate Root User.

Enum:DIRECTORAUTHORISED_REPRESENTATIVE

CompanyType

enum

Supported company types - if company type is not listed, please contact our support team to check if the company type can be supported.

Enum:SOLE_TRADERLLCPUBLIC_LIMITED_COMPANYLIMITED_LIABILITY_PARTNERSHIPNON_PROFIT_ORGANISATION

Address

{}
objectobject · 6 fields

Industry

enumdeprecated

The industry of the identity.

Enum:ACCOUNTINGAUDITFINANCEPUBLIC_SECTOR_ADMINISTRATIONART_ENTERTAINMENTAUTO_AVIATIONBANKING_LENDINGBUSINESS_CONSULTANCY_LEGALCONSTRUCTION_REPAIREDUCATION_PROFESSIONAL_SERVICESINFORMATIONAL_TECHNOLOGIESTOBACCO_ALCOHOLGAMING_GAMBLINGMEDICAL_SERVICESMANUFACTURINGPR_MARKETINGPRECIOUS_GOODS_JEWELRYNON_GOVERNMENTAL_ORGANIZATIONINSURANCE_SECURITYRETAIL_WHOLESALETRAVEL_TOURISMFREELANCER

CorporateSourceOfFunds

enumdeprecated

The corporate's source of funds.

Enum:LABOUR_CONTRACTCIVIL_CONTRACTRENTFUNDS_FROM_OTHER_AUXILIARY_SOURCESSALE_OF_MOVABLE_ASSETSSALE_OF_REAL_ESTATEORDINARY_BUSINESS_ACTIVITYDIVIDENDSLOAN_FROM_FINANCIAL_INSTITUTIONS_CREDIT_UNIONSLOAN_FROM_THIRD_PARTIESSALE_OF_COMPANY_SHARES_BUSINESSOTHERDONATIONINHERITANCEORIGIN_OF_FUNDS_UNKNOWN

Currency

string

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

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

Fee

{}
objectobject · 2 fields

Occupation

enumdeprecated

The industry of the identity.

Enum:ACCOUNTINGAUDITFINANCEPUBLIC_SECTOR_ADMINISTRATIONART_ENTERTAINMENTAUTO_AVIATIONBANKING_LENDINGBUSINESS_CONSULTANCY_LEGALCONSTRUCTION_REPAIREDUCATION_PROFESSIONAL_SERVICESINFORMATIONAL_TECHNOLOGIESTOBACCO_ALCOHOLGAMING_GAMBLINGMEDICAL_SERVICESMANUFACTURINGPR_MARKETINGPRECIOUS_GOODS_JEWELRYNON_GOVERNMENTAL_ORGANIZATIONINSURANCE_SECURITYRETAIL_WHOLESALETRAVEL_TOURISMFREELANCERSTUDENTUNEMPLOYEDRETIREDOTHER

AddressWithCountryRequired

The address, with none of the separate fields being set as required.

{}
objectobject · 6 fields

Nationality

string

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

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

ConsumerSourceOfFunds

enumdeprecated

The consumer's source of funds.

Enum:PERSONAL_SAVINGSFAMILY_SAVINGSLABOUR_CONTRACTCIVIL_CONTRACTRENTFUNDS_FROM_OTHER_AUXILIARY_SOURCESSALE_OF_MOVABLE_ASSETSSALE_OF_REAL_ESTATEORDINARY_BUSINESS_ACTIVITYDIVIDENDSLOAN_FROM_FINANCIAL_INSTITUTIONS_CREDIT_UNIONSLOAN_FROM_THIRD_PARTIESINHERITANCESALE_OF_COMPANY_SHARES_BUSINESSOTHER

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

CreateLinkedAccountRequest

{}
objectobject · 8 fields

ManagedCardRequest

{}
objectobject · 14 fields

BillingAddress

{}
objectobject · 6 fields

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

DigitalWallets

{}
objectobject · 3 fields

ThreeDSecureAuthConfig

{}
objectobject · 3 fields

ExternalData

External data fields, as provided and managed by the caller that are to be stored and associated with a Managed Card instance. This information is not processed or used by Weavr but some of the values could be shown in specific reports and used as filters

{}
objectobject · 2 fields

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.

PhysicalCardActivationCode

string

pattern ^[0-9]{1,6}$

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

CardLevelSpendRules

{}
objectobject · 15 fields

SensitivePin

The PIN used for in-person transactions done with physical cards.

Unless you are PCI-DSS compliant and have opted to switch off Weavr's security model, the card's PIN will be tokenised.

To show the PIN to your user, you need to embed the Display Card PIN UI Component in your application. This accepts the tokenised PIN and shows the plain text PIN to the user on screen.

{}
objectobject · 1 field

TransactionBulkCancelRequest

{}
objectobject · 1 field

SendBulkCreateRequest

{}
objectobject · 1 field

OutgoingWireTransferBulkCreateRequest

{}
objectobject · 1 field

TransactionSingleCancelRequest

{}
objectobject · 1 field

BasicBeneficiary

{}
objectobject · 5 fields

TokenType

enum

The auth token received can only be used to access the following endpoints:

  • /identities
  • /access_token

Enum:NO_TYPEAUTHACCESS

CredentialId

{}
objectobject · 2 fields

SyntaxError

Is returned as part of an HTTP error response whenever a syntax error is detected. A list of the fields together with their syntax error will be provided.

{}
objectobject · 1 field

TokenError

The used token is expired or not found

{}
objectobject · 1 field

UserIdentitiesGetResponseSchema

{}
objectobject · 3 fields

PasswordInfo

Additional information related to the user's password.

{}
objectobject · 2 fields

TokenResponse

{}
objectobject · 1 field

SCAFactor

{}
objectobject · 3 fields

Id

string

pattern ^[0-9]+$

User

{}
objectobject · 12 fields

BulkProcessConflict

{}
objectobject · 1 field

BulkProcessDetails

{}
objectobject · 8 fields

BulkProcessOperationsPaged

{}
objectobject · 3 fields

CreatedCorporate

{}
objectobject · 14 fields

KyiStatus

enum

Enum:NOT_STARTEDINITIATEDPENDING_REVIEWAPPROVEDREJECTED

ChargeFee

{}
objectobject · 7 fields

LinkedAccountVerificationRun

{}
objectobject · 5 fields

ManagedAccountIBAN

{}
objectobject · 2 fields

Statement

The list of statement entries.

{}
objectobject · 6 fields

StatementEntry

{}
objectobject · 16 fields

ManagedCard

{}
objectobject · 32 fields

AllLevelSpendRules

{}
objectobject · 17 fields

Transfer

{}
objectobject · 12 fields

TransactionBulkCancelResponse

{}
objectobject · 1 field

Send

{}
objectobject · 16 fields

SendBulkCreateResponse

{}
objectobject · 1 field

OutgoingWireTransfer

{}
objectobject · 16 fields

OutgoingWireTransferBulkCreateResponse

{}
objectobject · 1 field

BeneficiaryBatch

{}
objectobject · 3 fields

Beneficiary

{}
objectobject · 9 fields

SCAOtpChannel

enum
  • "SMS": The one-time-password is sent as a text message

Enum:SMS

SCAPushChannel

enum
  • "AUTHY": The push notification is sent on the user's device using Twilio Authy
  • "BIOMETRIC": The push notification is sent to the user's device

Enum:AUTHYBIOMETRIC

AuthSCAPushChannel

enum
  • "AUTHY": The push notification is sent on the user's device using Twilio Authy

Enum:AUTHY

BulkProcessStatus

enum

Enum:SUBMITTEDRUNNINGPARTIALLY_COMPLETEDCOMPLETEDFAILEDPAUSEDCANCELLED

BulkId

string

pattern ^[0-9]+$

BulkProcessOperationStatus

enum

Enum:SUBMITTEDRUNNINGCOMPLETEDFAILEDCANCELLED

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

LinkedAccountVerificationRunState

enum

Enum:PENDINGVERIFIEDREJECTED

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

TransactionType

enum

Enum:INSTRUMENT_CREATEINSTRUMENT_BLOCKINSTRUMENT_UNBLOCKINSTRUMENT_DELETEAUTHORISATIONSETTLEMENTMANUAL_TRANSACTIONTRANSFERSENDDEPOSITAUTHORISATION_REVERSALAUTHORISATION_EXPIRYAUTHORISATION_DECLINEAUTHORISATION_MANUAL_CLOSEMERCHANT_REFUNDMERCHANT_REFUND_REVERSALORIGINAL_CREDIT_TRANSACTIONSETTLEMENT_REVERSALADJUSTMENTCHARGE_FEEWITHDRAWAL_RESERVEWITHDRAWAL_RELEASEFEE_REVERSALCARD_UPGRADE_TO_PHYSICALACTIVATE_PHYSICAL_CARDINSTRUMENT_REPLACEOUTGOING_WIRE_TRANSFERAUTHORISATION_CANCELLATIONSYSTEM_TRANSACTIONOUTGOING_DIRECT_DEBIT_COLLECTIONOUTGOING_DIRECT_DEBIT_REFUND

TransactionState

enum

Status of the transaction.

Enum:INITIALISEDCOMPLETEDREJECTEDFAILEDPENDINGSCHEDULEDCANCELLED

InstrumentType

enum

Enum:managed_cardsmanaged_accounts

SendState

enum

The state of the send transaction, as follows:

  • INVALID: The send transaction has failed initial validation checks.
  • INITIALISED: The initial state of a send transaction when SCA is not required.
  • PENDING_CHALLENGE: The send transaction requires the completion of a transaction confirmation challenge before it can be submitted.
  • PENDING: The send transaction has exceeded the destination limit and is pending treasury approval.
  • APPROVED: The send transaction that was submitted has been approved.
  • COMPLETED: The requested funds have been sent from the source instrument.
  • REJECTED: The send transaction that was submitted was rejected.
  • FAILED: There was an issue with the send transaction, and the transaction has failed.
  • RETURNED: The send transaction has been returned to the sender.
  • SCHEDULED: The send transaction will be executed at the scheduled time.
  • CANCELLED: The scheduled send transaction has been cancelled.

Enum:INVALIDINITIALISEDCOMPLETEDREJECTEDFAILEDPENDINGPENDING_CHALLENGEAPPROVEDRETURNEDSCHEDULEDCANCELLED

SourceInstrumentType

enum

Enum:managed_accounts

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

BulkProcess

{}
objectobject · 7 fields

SpendLimitUpdateMethod

enum

The spend limit update method to apply. Currently supported:

  • OVERWRITE: (default option if nothing selected). Overwrites the previous values for the spendLimit object i.e. sets new limits
  • INCREMENT : This will increase the existing value of the spend limit by the amount input the value field. If used in conjunction with an ALWAYS interval, this can be used to increment a spend limit on a periodic basis (controlled by you, e.g. monthly), and means that any 'unused' balance from the previous period will still available to spend. See examples in our documentation

Enum:OVERWRITEINCREMENT

BeneficiaryId

{}
objectobject · 1 field

OutgoingWireTransferBeneficiary

Details of the beneficiary of the outgoing wire transfer.

{}
objectobject · 9 fields

ExternalAccountId

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

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

StringWrappedTypeId

{}
objectobject · 2 fields

ManagedInstrumentBalance

Instruments with funds have 2 balances, the availableBalance indicating the funds that are available for transactions such as purchases, and the actualBalance indicating the funds that are actually on the instrument.

{}
objectobject · 2 fields

ManagedInstrumentState

{}
objectobject · 3 fields

CorporateRootUser

{}
objectobject · 13 fields

ConsumerRootUser

{}
objectobject · 16 fields

CardAuthorisationDetailsAuthorisationType

enum

Enum:AUTHORISEDAUTHORISED_CREDIT

MerchantData

{}
objectobject · 14 fields

CardHolderPresent

enum

Enum:PRESENTNOT_PRESENTPRESENCE_UNKNOWN

PrepaidModeCardAuthorisationEvent

{}
objectobject · 16 fields

DebitModeCardAuthorisationEvent

{}
objectobject · 17 fields

BulkProcessMode

enum

ON_FAILURE_STOP : the execution of the bulk process stops after the first bulk operation that fails (operation returns a 4xx or 5xx response code). ON_FAILURE_CONTINUE: the execution of the bulk process resumes as normal even when any of the bulk operations fail.

Enum:ON_FAILURE_STOPON_FAILURE_CONTINUE

LinkedAccountProfileId

string

The id of the Linked Account Profile which this instrument is linked to.

You can have one or more profiles linked to your application, and these can be used to drive different behaviours according to your product's needs.

This field is necessary only if you have been provided with multiple Linked Account Profiles.

Profile Ids can be found in the Multi Portal, in the API Credentials page.

pattern ^[0-9]+$

PrepaidModeCardRequest

{}
objectobject · 15 fields

DebitModeCardRequest

{}
objectobject · 16 fields

PhoneNumber

string

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

BaseCardLevelSpendRules

{}
objectobject · 13 fields

TransactionCancelRequest

{}
objectobject · 2 fields

TransactionCancellationReason

string

The reason the scheduled transaction was cancelled.

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

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

BankAccountDetailsBeneficiary

Represent the beneficiary bank account typically used in Outgoing Wire Transfer transactions.

{}
objectobject · 5 fields

UserIdentity

{}
objectobject · 2 fields

SCAChallengeType

enum
  • "OTP": The OTP is sent as a text message
  • "PUSH": The authorisation request is sent as a push notification
  • "BIOMETRIC": The push notification is sent via Firebase to a mobile application

Enum:OTPPUSHBIOMETRIC

SCAFactorStatus

enum

The state of the factor type.

  • PENDING_VERIFICATION : The user has started the enrolment process but still hasn't completed enrolment. Challenges cannot be used before they are verified.
  • ACTIVE : The user has successfully completed enrolment and the challenge can be used to verify transactions.
  • INACTIVE : The user has rejected the enrolment.

Enum:PENDING_VERIFICATIONACTIVEINACTIVE

SCAChannel

enum
  • "SMS": The one-time-password is sent as a text message
  • "AUTHY": The push notification is sent to an Authy application
  • "BIOMETRIC": The push notification is sent to an innovator application

Enum:SMSAUTHYBIOMETRIC

BulkProcessConflictErrorCode

enum

Enum:VALIDATION_FAILEDUSER_VALIDATION_FAILEDALREADY_SUBMITTEDDUPLICATE_OPERATION_TYPENO_CONFIG_FOUNDINVALID_STATETOO_MANY_REQUESTS

BulkProcessOperationStatusCounts

{}
objectobject · 2 fields

BulkProcessOperation

{}
objectobject · 7 fields

CreatedCorporateRootUser

{}
objectobject · 14 fields

TransactionId

{}
objectobject · 2 fields

LinkedAccountVerificationStep

enum

Enum:TRANSFER_INSTRUCTIONUSER_DECLARATION_SCA_CHALLENGEINTERNAL_CHECKSMICRO_DEPOSIT

LinkedAccountVerificationTransferInstruction

{}
objectobject · 3 fields

LinkedAccountMicroDepositVerification

{}
objectobject · 2 fields

LinkedAccountVerificationStepStatus

enum

Enum:PENDING_USERPENDING_REVIEWPENDING_EXECUTIONREJECTEDCOMPLETED

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

SwiftBankDetails

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

{}
objectobject · 2 fields

StatementEntryState

enum

The transaction entry state, as follows:

  • PENDING: The transaction has started and some of the fund movements have completed, however additional fund movements are still pending to finalise the transaction.
  • COMPLETED: All fund movements for a transaction have completed.

Enum:PENDINGCOMPLETED

ScaledAmount

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

UserCurrencyTransactionDetails

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

{}
objectobject · 2 fields

SensitiveCardNumber

The full card number of the card.

Unless you are PCI-DSS compliant and have opted to switch off Weavr's security model, the card number will be tokenised.

To show the full unredacted card number to your user, you need to embed the Card number UI Component in your application. This accepts the tokenised card number and shows the unredacted card number to the user on screen.

{}
objectobject · 1 field

SensitiveCvv

The CVV of the card.

Unless you are PCI-DSS compliant and have opted to switch off Weavr's security model, the card's CVV will be tokenised.

To show the card's CVV to your user, you need to embed the CVV UI Component in your application. This accepts the tokenised CVV and shows the plain text CVV number to the user on screen.

{}
objectobject · 1 field

PhysicalCardDetails

{}
objectobject · 13 fields

ManagedCardReplacement

Indicates if the card is replaced by another card.

{}
objectobject · 2 fields

PrepaidModeCard

{}
objectobject · 33 fields

DebitModeCard

{}
objectobject · 35 fields

SpendLimit

{}
objectobject · 3 fields

ProfileLevelSpendRules

{}
objectobject · 13 fields

IdentityLevelSpendRules

{}
objectobject · 14 fields

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]+$

TransactionCancelResponse

{}
objectobject · 3 fields

ChallengeExemptionReason

enum

The Reason the transaction was exempted from SCA verification

Enum:LOW_VALUETRUSTED_BENEFICIARY

OutgoingWireTransferType

enum

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

Enum:SEPAFASTER_PAYMENTSSWIFT

OutgoingWireTransferRejectedInfo

enum

Additional info when the outgoing wire transfer has been rejected, as follows:

  • SYSTEM: The wire transfer was rejected by the system.
  • USER: The wire transfer was rejected by the user.

Enum:SYSTEMUSER

OutgoingWireTransferValidationOutcome

{}
objectobject · 2 fields

BeneficiaryOperationBatchId

{}
objectobject · 2 fields

BeneficiaryState

enum

Enum:INITIALISEDINVALIDPENDING_CHALLENGECHALLENGE_FAILEDACTIVEREMOVED

BeneficiaryValidationFailure

enum

Enum:INSTRUMENT_DETAILS_NOT_FOUNDBENEFICIARY_DETAILS_ALREADY_EXISTBENEFICIARY_BELONGS_TO_SAME_IDENTITY

DateOfBirth

string · date

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

ExternalAccountType

enum

Enum:linked_accounts

AddressWithNoRequiredFields

The address, with none of the separate fields being set as required.

{}
objectobject · 6 fields

AvailableToSpend

{}
objectobject · 2 fields

SupportedUserCurrency

enum

Enum:JPYBGNCZKDKKHUFPLNRONSEKCHFISKNOKTRYAUDBRLCADCNYHKDIDRILSINRKRWMXNMYRNZDPHPSGDTHBZAREURUSDGBP

CommonLevelSpendRules

{}
objectobject · 12 fields

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.

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

UKConfirmationOfPayeeResult

{}
objectobject · 3 fields

RolloverPolicy

The rollover policy will dictate how Weavr handles any eventual overspending. This is possible if a merchant clears more funds than authorised, or when a merchant clears funds without authorising, resulting in the availableToSpend value to go into negative. Rollover is relative to a spendLimit.interval

{}
objectobject · 1 field