Schemas

Reference

Jump to schemas

Email

string · email

Email Address of the user

Example

[email protected]

SensitivePassword

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

minimum 8 characters for end-users (Consumers and Corporates); 12 characters for others
maximum 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 tokenized.

{}

objectobject · 1 field

Error

A machine-readable error code and a human-readable explanation of the failure.

{}

objectobject · 2 fields

TokenType

enum

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

/identities
/access_token

Enum:NO_TYPEAUTHACCESS

IdentityId

{}

objectobject · 2 fields

CredentialId

{}

objectobject · 2 fields

SyntaxError

Field-level validation failures returned when the request body or parameters are invalid.

{}

objectobject · 1 field

TokenError

The used token is expired or not found

{}

objectobject · 1 field

SCAOtpChannel

enum

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

Enum:SMS

Nonce

string

A randomly generated one-time use code.

pattern ^[0-9]{6}$

Example

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

UserId

string

pattern ^[0-9]+$

Example

987654321

PasswordInfo

Additional information related to the user's password.

{}

objectobject · 2 fields

PasswordValidateComplexityIssueCode

enum

Enum:PASSWORD_TOO_SHORTPASSWORD_TOO_LONGPASSWORD_TOO_SIMPLE

PasswordValidateComplexityIssue

A single password complexity rule that the submitted password failed.

{}

objectobject · 3 fields

TokenResponse

{}

objectobject · 1 field

SCAChallengeType

enum

OTP: The OTP is sent as a text message
PUSH: The authorization 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 enrollment process but still hasn't completed enrollment. Challenges cannot be used before they are verified.
ACTIVE : The user has successfully completed enrollment and the challenge can be used to verify transactions.
INACTIVE : The user has rejected the enrollment.

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

SCAFactor

{}

objectobject · 3 fields

AuthSCAPushChannel

enum

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

Enum:AUTHY

MultipleSCAResourceType

enum

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

Enum:outgoing_wire_transferssendsvariable_recurring_paymentslinked_account_declarationcorrespondent_bank_transfers

Id

string

pattern ^[0-9]+$

Example

123456789

UserPredefinedRole

enum

Enum:CARD_ASSIGNEECARDS_MANAGEMENT_ROLEFUNDS_MANAGEMENT_ROLEACCESS_MANAGEMENT_ROLEADMIN

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

Example

customer-123

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

Example

Acme

User

{}

objectobject · 13 fields

BulkProcessStatus

enum

The current status of the bulk process:

SUBMITTED: The bulk process data has been persisted and is ready for execution. This is the initial state.
RUNNING: The bulk process is currently being executed.
PARTIALLY_COMPLETED: Execution is complete, but some bulk operations failed. This is a final state.
COMPLETED: Execution is complete, and all bulk operations succeeded. This is a final state.
FAILED: No operations in the bulk process were executed. This is a final state.
PAUSED: Execution has been paused and can be resumed.
CANCELLED: Execution has been canceled. This is a final state.

Enum:SUBMITTEDRUNNINGPARTIALLY_COMPLETEDCOMPLETEDFAILEDPAUSEDCANCELLED

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

BulkProcess

{}

objectobject · 7 fields

BulkProcessesPaged

{}

objectobject · 3 fields

BulkProcessConflictErrorCode

enum

Enum:VALIDATION_FAILEDUSER_VALIDATION_FAILEDALREADY_SUBMITTEDDUPLICATE_OPERATION_TYPENO_CONFIG_FOUNDINVALID_STATETOO_MANY_REQUESTS

BulkProcessConflict

{}

objectobject · 1 field

BulkId

string

pattern ^[0-9]+$

Example

2468013579

BulkProcessOperationStatus

enum

Enum:SUBMITTEDRUNNINGCOMPLETEDFAILEDCANCELLED

BulkProcessOperationStatusCounts

{}

objectobject · 2 fields

BulkProcessDetails

{}

objectobject · 8 fields

BulkProcessOperation

{}

objectobject · 7 fields

BulkProcessOperationsPaged

{}

objectobject · 3 fields

BulkProcessExecute

{}

objectobject · 2 fields

SubmitBulkProcessResponse

{}

objectobject · 3 fields

BulkManagedCardPathOperation

{}

objectobject · 1 field

RolloverPolicy

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

{}

objectobject · 1 field

CommonLevelSpendRules

{}

objectobject · 12 fields

Currency

string

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

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

Example

GBP

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: first day 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

SpendLimit

{}

objectobject · 3 fields

BaseCardLevelSpendRules

{}

objectobject · 13 fields

CardLevelSpendRules

{}

objectobject · 15 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

UpdateCardLevelSpendRules

{}

objectobject · 16 fields

BulkManagedCardSpendRulesOperation

{}

objectobject · 2 fields

StringWrappedTypeId

{}

objectobject · 2 fields

ScheduledTimestamp

string

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

pattern ^[0-9]+$

Example

1786118400000

CreateTransferRequest

{}

objectobject · 7 fields

BulkTransferCreateOperation

{}

objectobject · 1 field

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

Example

InstrumentType

enum

Enum:managed_cardsmanaged_accounts

InstrumentId

{}

objectobject · 2 fields

BeneficiaryId

{}

objectobject · 1 field

SendCreateRequest

{}

objectobject · 7 fields

BulkSendCreateOperation

{}

objectobject · 1 field

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

Nationality

string

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

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

Example

GB

DateOfBirth

string · date

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

Example

1990-01-01

OutgoingWireTransferBeneficiary

Details of the beneficiary of the outgoing wire transfer. Deprecated: Use SEPABeneficiary for SEPA/IBAN transfers or FasterPaymentsBeneficiary for Faster Payments transfers instead.

{}

objectobject · 9 fields

SEPABeneficiary

Beneficiary details for SEPA/IBAN wire transfers.

{}

objectobject · 9 fields

SWIFTBeneficiary

Beneficiary details for SWIFT wire transfers.

{}

objectobject · 9 fields

RIXBeneficiary

Beneficiary details for RIX wire transfers.

{}

objectobject · 9 fields

FasterPaymentsBeneficiary

Beneficiary details for Faster Payments wire transfers.

{}

objectobject · 11 fields

ExternalAccountType

enum

Enum:linked_accounts

ExternalAccountId

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

{}

objectobject · 2 fields

OutgoingWireTransferCreateRequest

{}

objectobject · 8 fields

BulkOutgoingWireTransferCreateOperation

{}

objectobject · 1 field

UserIdentity

{}

objectobject · 2 fields

UserIdentitiesGetResponseSchema

{}

objectobject · 3 fields

VerificationCode

string

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

pattern ^[0-9]{6}$

Example

CompanyPosition

enum

The company position of the Corporate Root User.

Enum:DIRECTORAUTHORISED_REPRESENTATIVE

CorporateRootUser

{}

objectobject · 13 fields

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

LegalAddress

The legal address of the company. This information is captured via the Due Diligence (KYB) process.

{}

objectobject · 6 fields

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

Corporate

{}

objectobject · 14 fields

CreatedCorporateRootUser

{}

objectobject · 14 fields

CreatedCorporate

{}

objectobject · 14 fields

KyiStatus

enum

Enum:NOT_STARTEDINITIATEDPENDING_REVIEWAPPROVEDREJECTED

CorporateKybStatusValue

enum

Whether the corporate may use financial services.

Enum:NEWPENDINGAPPROVEDREJECTEDCLOSED

KybRunStatus

enum

Status of a KYB run.

Enum:COLLECTION.NOT_STARTEDCOLLECTION.READY_TO_STARTCOLLECTION.IN_PROGRESSREVIEW.IN_PROGRESSRESUBMISSION.IN_PROGRESSKYB_RUN.APPROVEDKYB_RUN.REJECTEDKYB_RUN.CANCELLED

KybRunType

enum

Whether the run is the first verification or a later re-check.

Enum:INITIAL_ONBOARDINGREFRESH

KybRun

{}

objectobject · 7 fields

CorporateKybClassification

An industry or activity classification code.

{}

objectobject · 3 fields

CorporateKybTaxIdentifier

A tax identification number and its issuing country.

{}

objectobject · 2 fields

CorporateKybAddress

A postal address.

{}

objectobject · 7 fields

CorporateKybCompanyData

Details about the main corporate. Identity fields (name, registration number, country) are taken from the corporate record and aren't accepted here.

{}

objectobject · 6 fields

CorporateKybCompanyDetails

Details of an affiliated company in the ownership graph.

{}

objectobject · 7 fields

CorporateKybCompanyNode

An affiliated company in the ownership graph, referenced by relations.

{}

objectobject · 2 fields

CorporateKybIndividualDetails

Details of an individual in the ownership graph.

{}

objectobject · 13 fields

CorporateKybIndividualNode

An individual in the ownership graph, referenced by relations.

{}

objectobject · 7 fields

CorporateKybRelation

An ownership or control relationship between two entities in the graph.

{}

objectobject · 6 fields

CorporateKybEntityResponseSchema

The company and ownership-graph information submitted to pre-populate a corporate's KYB.

{}

objectobject · 7 fields

CorporateKybEntitySubmission

Company and ownership-graph information submitted to pre-populate a corporate's KYB. Every field is optional.

{}

objectobject · 4 fields

KybIndustry

enum

The corporate's industry, for KYB pre-population.

Enum:ACCOUNTINGAUDITFINANCEPUBLIC_SECTOR_ADMINISTRATIONART_ENTERTAINMENTAUTO_AVIATIONBANKING_LENDINGBUSINESS_CONSULTANCY_LEGALCONSTRUCTION_REPAIREDUCATION_PROFESSIONAL_SERVICESINFORMATION_TECHNOLOGIESTOBACCO_ALCOHOLGAMING_GAMBLINGMEDICAL_SERVICESPRECIOUS_GOODS_JEWELLERYNONGOVERNMENT_ORGANISATIONINSURANCE_SECURITYRETAIL_WHOLESALETRAVEL_TOURISMFREELANCER

KybSourceOfFunds

enum

The corporate's source of funds, for KYB pre-population.

CorporateKybProfile

How the corporate intends to use the account: where money comes from, where it goes, and how much of it is expected.

{}

objectobject · 36 fields

CorporateKybProfileResponseSchema

The account-usage profile submitted to pre-populate a corporate's KYB.

{}

objectobject · 1 field

CorporateKybProfileSubmission

Account-usage profile submitted to pre-populate a corporate's KYB.

{}

objectobject · 1 field

KybDocumentType

enum

The kind of KYB supporting document.

Enum:REGISTRATION_CERTIFICATEARTICLES_OF_ASSOCIATIONSHAREHOLDER_REGISTERPROOF_OF_ADDRESSPROOF_OF_IDENTITYBANK_STATEMENTTAX_RETURNANNUAL_REPORTSOURCE_OF_FUNDSOTHER

CorporateKybDocument

Metadata for a document uploaded to a corporate's KYB.

{}

objectobject · 4 fields

CorporateKybDocumentList

The documents uploaded to a corporate's KYB.

{}

objectobject · 1 field

CorporateKybDocumentForm

Multipart form carrying a single KYB supporting document, up to 10 MB.

{}

objectobject · 3 fields

CorporateKybDocumentResponse

Reference to the stored KYB document.

{}

objectobject · 1 field

Fee

{}

objectobject · 2 fields

TransactionId

{}

objectobject · 2 fields

TransactionState

enum

Status of the transaction.

Enum:INITIALISEDCOMPLETEDREJECTEDFAILEDPENDINGSCHEDULEDCANCELLED

ChargeFee

{}

objectobject · 7 fields

FeeSubtype

enum

The category of fee — indicates the activity or instrument-lifecycle event the fee relates to.

Enum:fee_reversalsincoming_wire_feeswithdrawal_feespurchase_feesrefund_feesatm_withdrawal_feeschargeback_feestransfer_feessend_feesoutgoing_wire_transfer_feescustom_feesother_feesinstrument_delete_feesfunds_redemption_feessystem_transaction_fees

FeeTransactionStatus

enum

Lifecycle status of a fee transaction:

PENDING: Fee accompanies a transaction that is still processing; it may still be canceled.
COMPLETED: Fee was charged and posted to the instrument balance.
CANCELLED: Fee was canceled before being charged.
REVERSED: Fee was previously charged and has been reversed.

Enum:PENDINGCOMPLETEDCANCELLEDREVERSED

FeeTransaction

A fee charged or reversed on an instrument. Surfaced through GET /fees, GET /transactions (Transaction Activity), and as line items on statements.

{}

objectobject · 9 fields

FeeTransactionList

A paginated list of fee transactions.

{}

objectobject · 3 fields

Occupation

enumdeprecated

The industry of the identity.

AddressWithNoRequiredFields

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

{}

objectobject · 6 fields

ConsumerRootUser

{}

objectobject · 16 fields

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

Consumer

{}

objectobject · 11 fields

AddressWithCountryRequired

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

{}

objectobject · 6 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

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.
NOT_ENABLED: The instrument is not enabled for use, since the linked user has not completed all necessary verification steps.

Enum:ACTIVEBLOCKEDDESTROYEDNOT_ENABLED

BlockedReason

enum

The reason why the instrument has been blocked:

USER: The root, or an authorized 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.
SINGLE_SPEND: The instrument has been automatically blocked after its first successful transaction (single-spend card).

Enum:USERSYSTEMLOSTSINGLE_SPEND

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 authorized 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.
SINGLE_SPEND: The instrument was automatically destroyed as it was a single-spend card that was used.

Enum:SYSTEMUSERLOSTSTOLENEXPIREDCOMPROMISEDSINGLE_SPEND

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

AccountLowBalanceThreshold

integer · int64

Sends a low balance notification webhook when the available balance drops below this amount. Currency is inherited from the managed account.

Example

ManagedAccount

{}

objectobject · 9 fields

SwiftBankDetails

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

{}

objectobject · 2 fields

ManagedAccountIBAN

{}

objectobject · 2 fields

StatementTransactionType

enum

Enum:AUTHORISATIONSETTLEMENTMANUAL_TRANSACTIONTRANSFERSENDDEPOSITAUTHORISATION_REVERSALAUTHORISATION_EXPIRYAUTHORISATION_DECLINEAUTHORISATION_MANUAL_CLOSEMERCHANT_REFUNDMERCHANT_REFUND_REVERSALORIGINAL_CREDIT_TRANSACTIONSETTLEMENT_REVERSALADJUSTMENTCHARGE_FEEWITHDRAWAL_RESERVEWITHDRAWAL_RELEASEFEE_REVERSALOUTGOING_WIRE_TRANSFERAUTHORISATION_CANCELLATIONSYSTEM_TRANSACTIONOUTGOING_DIRECT_DEBIT_COLLECTIONOUTGOING_DIRECT_DEBIT_REFUNDCORRESPONDENT_BANK_TRANSFER

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 finalize 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

StatementEntry

{}

objectobject · 16 fields

Statement

The list of statement entries.

{}

objectobject · 6 fields

InstrumentStatementSortOrder

enum

Enum:ASCDESC

StatementResponseEntryTransactionType

enum

The top-level type of transaction represented by this statement entry.

Enum:card_paymentstransferssendsoutgoing_wire_transfersincoming_wire_transferscorrespondent_bank_transfersfeessystem_transactions

AccessInstrumentType

enum

The type of access instrument that initiated a transaction.

Enum:managed_cardsibans

StatementResponseEntryTransaction

Reference to the transaction this statement entry records. The concrete shape is identified by the type discriminator — see the per-type variants for the available subtypes.

{}

objectobject · 2 fields

Accepted shapes

Selected by type

Statement Card Payment Transactioncard_paymentsobject

Reference to a card payment as it appears in a statement entry.

subtype: enum

Statement Transfer Transactiontransfersobject

Reference to a transfer as it appears in a statement entry.

Statement Send Transactionsendsobject

Reference to a send as it appears in a statement entry.

Statement Outgoing Wire Transfer Transactionoutgoing_wire_transfersobject

Reference to an outgoing wire transfer as it appears in a statement entry.

subtype: enum

Statement Incoming Wire Transfer Transactionincoming_wire_transfersobject

Reference to an incoming wire transfer as it appears in a statement entry.

subtype: enum

Statement Correspondent Bank Transfer Transactioncorrespondent_bank_transfersobject

Reference to a correspondent bank transfer as it appears in a statement entry.

subtype: enum

Statement Fee Transactionfeesobject

Reference to a fee transaction as it appears in a statement entry.

subtype: enum

Statement System Transactionsystem_transactionsobject

Reference to a system-generated transaction as it appears in a statement entry.

subtype: enum

StatementCardPaymentSubtype

enum

Subtype of a card payment statement entry.

Enum:sale_purchasescash_withdrawalssales_with_cashbackmail_or_telephone_orderspurchase_refund_reversalsoriginal_credit_transaction_reversalscash_withdrawal_reversalspurchase_refundspurchase_reversalsoriginal_credit_transactionsfirst_chargebacksfirst_chargeback_reversalsfirst_representmentsfirst_representment_reversalssecond_chargebackssecond_chargeback_reversalssecond_representmentsarbitration_chargebacks

StatementCardPaymentTransaction

Reference to a card payment as it appears in a statement entry.

{}

objectobject · 3 fields

StatementTransferTransaction

Reference to a transfer as it appears in a statement entry.

{}

objectobject · 2 fields

StatementSendTransaction

Reference to a send as it appears in a statement entry.

{}

objectobject · 2 fields

StatementOutgoingWireTransferSubtype

enum

Subtype of an outgoing wire transfer statement entry.

Enum:redemptionsreturns

StatementOutgoingWireTransferTransaction

Reference to an outgoing wire transfer as it appears in a statement entry.

{}

objectobject · 3 fields

StatementIncomingWireTransferSubtype

enum

Subtype of an incoming wire transfer statement entry.

Enum:fundings

StatementIncomingWireTransferTransaction

Reference to an incoming wire transfer as it appears in a statement entry.

{}

objectobject · 3 fields

StatementCorrespondentBankTransferSubtype

enum

Subtype of a correspondent bank transfer statement entry.

Enum:returns

StatementCorrespondentBankTransferTransaction

Reference to a correspondent bank transfer as it appears in a statement entry.

{}

objectobject · 3 fields

StatementFeeTransaction

Reference to a fee transaction as it appears in a statement entry.

{}

objectobject · 3 fields

SystemTransactionSubtype

enum

The specific kind of system-generated transaction.

Enum:account_closureschargebacks_representedchargebacks_wonmanual_auth_expiriesnegative_card_balancesbalance_adjustmentslost_stolen_replacement_balance_transfers

StatementSystemTransaction

Reference to a system-generated transaction as it appears in a statement entry.

{}

objectobject · 3 fields

DigitalWalletType

enum

The digital wallet type.

Enum:GOOGLE_PAYAPPLE_PAYMERCHANT_TOKEN

MerchantCounterparty

Counterparty for a card transaction — a merchant.

{}

objectobject · 5 fields

InstrumentCounterparty

Counterparty that is an internal platform instrument (managed account, managed card).

{}

objectobject · 4 fields

BankAccountCounterparty

Counterparty that is a bank account (for wire transfers).

{}

objectobject · 7 fields

FeeSummary

{}

objectobject · 4 fields

TransactionForex

Foreign exchange details when the transaction involved currency conversion.

{}

objectobject · 4 fields

StatementResponseEntryExecutingAccessInstrument

The access instrument that initiated the transaction. The concrete shape is identified by the type discriminator.

{}

objectobject · 2 fields

Accepted shapes

Selected by type

Card Access Instrumentmanaged_cardsobject

An access instrument that is a managed card (e.g. a debit-mode card initiating a transaction on its parent managed account).

friendlyName: string
cardBrand: string
cardNumberFirstSix: string
cardNumberLastFour: string

Iban Access Instrumentibansobject

An access instrument that is an IBAN attached to a managed account.

friendlyName: string
handle: string

CardAccessInstrument

An access instrument that is a managed card (e.g. a debit-mode card initiating a transaction on its parent managed account).

{}

objectobject · 6 fields

IbanAccessInstrument

An access instrument that is an IBAN attached to a managed account.

{}

objectobject · 4 fields

StatementResponseEntry

A single entry in an instrument statement. Each entry represents a posted transaction that caused the actual balance of the instrument to change.

{}

objectobject · 11 fields

StatementResponse

A financial statement for an instrument over a given period. Contains only posted/completed transactions where funds have definitively moved (actual balance changed). Repeated requests for the same period return the same result.

{}

objectobject · 6 fields

TransactionActivityType

enum

The type of transaction:

transfers: Internal transfer between instruments of the same identity
sends: Transfer between instruments of different identities
outgoing_wire_transfers: Wire transfer to an external bank account
correspondent_bank_transfers: Wire transfer on behalf of a third-party originator
incoming_wire_transfers: Wire transfer received from an external bank account
card_payments: Card payment (purchase, refund, OCT, etc.) with full lifecycle
fees: Fee charged or reversed on an instrument
system_transactions: System-generated transactions (balance adjustments, account closures, dispute outcomes, etc.)

Enum:transferssendsoutgoing_wire_transferscorrespondent_bank_transfersincoming_wire_transferscard_paymentsfeessystem_transactions

TransactionActivityStatus

enum

Normalized lifecycle status of a transaction:

DRAFT: Transaction ID has been created. There are additional user-actions required before the transaction is considered an “executable instruction” that is fully submitted. No balance movements have taken place on the target instrument yet.
SUBMITTED: Transaction has been submitted and is awaiting processing. No balance movements have taken place yet. Transactions scheduled for processing on a future date remain in a submitted status.
PROCESSING: The submitted transaction is being processed.
COMPLETED: Executed and processed. Funds have moved, actual balance changed.
CANCELLED: Transaction was canceled before completion. Funds have been returned to the original instrument.
RETURNED: The transaction was previously COMPLETED but has been returned. Funds have been returned to the original instrument. Note that card refunds may be separate transactions, not RETURNED purchases.

Enum:DRAFTSUBMITTEDPROCESSINGCOMPLETEDCANCELLEDRETURNED

TransactionActivityDirection

enum

Whether funds were credited to or debited from the instrument.

Enum:CREDITDEBIT

TransactionActivitySortBy

enum

The field to sort transaction activity results by:

creationTimestamp: Sort by when the transaction was first created (default).
lastUpdatedTimestamp: Sort by when the transaction was most recently updated.

Enum:creationTimestamplastUpdatedTimestamp

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

Example

1786118401250

TransactionCancellationReason

string

The reason the scheduled transaction was canceled.

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

Example

Payment no longer required

Transfer

{}

objectobject · 12 fields

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 canceled.

Enum:INVALIDINITIALISEDCOMPLETEDREJECTEDFAILEDPENDINGPENDING_CHALLENGEAPPROVEDRETURNEDSCHEDULEDCANCELLED

ChallengeExemptionReason

enum

The Reason the transaction was exempted from SCA verification

Enum:LOW_VALUETRUSTED_BENEFICIARY

Send

{}

objectobject · 16 fields

OutgoingWireTransferType

enum

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

Enum:SEPAFASTER_PAYMENTSSWIFTRIX

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 canceled.
PENDING_CONFIRMATION: The wire transfer requires a manual confirmation by the user before proceeding.

Enum:INVALIDPENDING_CHALLENGESUBMITTEDREJECTEDAPPROVEDFAILEDCOMPLETEDRETURNEDSCHEDULEDDEFERREDCANCELLEDPENDING_CONFIRMATION

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

UKConfirmationOfPayeeResult

{}

objectobject · 3 fields

SEPAVerificationOfPayeeResult

{}

objectobject · 2 fields

OutgoingWireTransferValidationOutcome

{}

objectobject · 2 fields

OutgoingWireTransfer

{}

objectobject · 18 fields

CorrespondentBankingBankAccountDetails

Bank account details for the originator.

{}

objectobject · 2 fields

CorrespondentBankingIndividualAddressAndIdInfo

Personal identification for an individual originator.

{}

objectobject · 2 fields

CorrespondentBankingIndividualAddressAndBirthInfo

Birth information for an individual originator.

{}

objectobject · 2 fields

CorrespondentBankingIndividualOriginator

An individual (natural person) originator of the transfer.

Travel Rule Requirements:

Mandatory: Full name and account number (via bankAccountDetails)
Mandatory: At least one supplementary information type (address + birth details, or address + official ID)

{}

objectobject · 6 fields

CorrespondentBankingBusinessAddressAndIdInfo

Business identification for a business originator.

{}

objectobject · 2 fields

CorrespondentBankingBusinessOriginator

A business (legal entity) originator of the transfer.

Travel Rule Requirements:

Mandatory: Full legal name and account number (via bankAccountDetails)
Mandatory: Registered address and business identification (LEI, registration number, or tax ID)

{}

objectobject · 6 fields

CorrespondentBankingSEPABeneficiary

CBT-specific beneficiary details for SEPA/IBAN wire transfers with Banking Circle FI-to-FI field limits.

{}

objectobject · 9 fields

CorrespondentBankingRIXBeneficiary

CBT-specific beneficiary details for RIX wire transfers with Banking Circle FI-to-FI field limits.

{}

objectobject · 9 fields

CorrespondentBankingFasterPaymentsBeneficiary

CBT-specific beneficiary details for Faster Payments wire transfers with Banking Circle FI-to-FI field limits.

{}

objectobject · 11 fields

CorrespondentBankingExternalData

External data key-value pair.

{}

objectobject · 2 fields

CorrespondentBankingOwtState

enum

The state of the correspondent bank transfer transaction, as follows:

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

Enum:INVALIDPENDING_CHALLENGESUBMITTEDREJECTEDAPPROVEDFAILEDCOMPLETEDRETURNEDSCHEDULEDCANCELLEDPENDING_CONFIRMATION

CorrespondentBankingOwtValidationOutcome

{}

objectobject · 2 fields

CorrespondentBankingOwt

{}

objectobject · 15 fields

IncomingWireTransferMultiState

enum

The state of an incoming wire transfer:

PENDING: The transfer has been received and is being processed. Funds have not yet been credited to the destination account.
COMPLETED: Funds have been credited to the destination account.
REJECTED: The transfer was not accepted; funds were not credited.

Enum:PENDINGCOMPLETEDREJECTED

IncomingWireTransfer

An incoming wire transfer received from an external bank account.

{}

objectobject · 14 fields

CardPaymentType

enum

High-level type of card payment, derived from the first event.

PURCHASE — standard purchase at a merchant. A purchase of zero is the check a merchant runs to prove the card is live before storing it on file: no money moves, no hold is placed, and it is SETTLED on arrival since nothing further will follow. If the merchant later charges the same purchase, the card payment adopts the real type and amount.
REFUND — refund from a merchant to the cardholder.
ORIGINAL_CREDIT — push credit to the cardholder (OCT).
ACCOUNT_FUNDING — load funds onto an account.
CASH_WITHDRAWAL — cash withdrawn at ATM or scheme cash service.
BALANCE_INQUIRY — non-financial balance check.

Enum:PURCHASEREFUNDORIGINAL_CREDITACCOUNT_FUNDINGCASH_WITHDRAWALBALANCE_INQUIRY

Card

Information about a managed card — used wherever a card appears (the card on a card payment, or the access instrument that initiated a transaction).

{}

objectobject · 10 fields

Merchant

Information about a merchant — used wherever a merchant appears in card-payment flows, statement entries, and transaction activity.

{}

objectobject · 16 fields

CardPaymentStatus

enum

Lifecycle status of a CardPayment.

SETTLEMENT_IN_PROGRESS — authorized, not yet (or not fully) settled. The hold is still on the card.
SETTLED — terminal; nothing further is expected. The customer has been charged, except for a zero-amount card check, which settles on arrival without a charge.
DECLINED — the latest authorization was declined; no money moved.
CANCELLED — the authorization was cancelled/reversed before settlement; no charge applied.
EXPIRED — the authorization timed out without settling.

Enum:SETTLEMENT_IN_PROGRESSSETTLEDDECLINEDCANCELLEDEXPIRED

CardPaymentEvent

An event in a card payment's lifecycle, lean — used nested inside CardPayment.events[]. The parent card payment provides cardPaymentId, card, and merchant, so the lean variants don't repeat them. Each event carries its own authCode. Four variants discriminated by type:

AUTHORISATION → CardPaymentAuthorisationEvent
SETTLEMENT → CardPaymentSettlementEvent
REFUND → CardPaymentRefundEvent
ORIGINAL_CREDIT → CardPaymentOriginalCreditEvent (Visa OCT / Mastercard MoneySend)

For the standalone version returned by GET /card_payment_events — which carries cardPaymentId, card, and merchant so each row is self-contained — see CardPaymentEventDetail.

{}

objectobject · 1 field

Accepted shapes

Selected by type

Card Payment Authorisation EventAUTHORISATIONobject

An authorization lifecycle event — the merchant asked the bank for funds, or an existing hold was adjusted / released. No money moves until clearing. Used inside CardPayment.events[]; the parent card payment provides cardPaymentId, card, and merchant so this lean variant doesn't repeat them. For a standalone version with that context attached, see CardPaymentAuthorisationEventDetail.

id*: string
subtype*: enum
reversal: boolean
result: enum
authorisationCategory: enum
authForwardingDetails: object
declineReason: enum
authRuleFailedReason: string
cancellationReason: string
transactionAmount: object
billingAmount: object
forex: object
userAmount: object
userExchangeRate: object
authCode: string
fees: array<CardPaymentFee · object>
timestamp*: integer · int64
processedTimestamp: integer · int64

Card Payment Settlement EventSETTLEMENTobject

A settlement event — money actually moves between the cardholder's account and the merchant, or back the other way. Visa Financial Transaction 0220 · Mastercard First Presentment 1240.

id*: string
subtype*: enum
reversal: boolean
settlementState*: enum
transactionAmount: object
billingAmount: object
exchangeRate: object
userAmount: object
userExchangeRate: object
authCode: string
fees: array<CardPaymentFee · object>
timestamp*: integer · int64
processedTimestamp: integer · int64

Card Payment Refund EventREFUNDobject

A refund credited to the card, tied to an earlier purchase.

id*: string
reversal: boolean
subtype: enum
reasonCode: string
transactionAmount: object
billingAmount: object
exchangeRate: object
userAmount: object
userExchangeRate: object
authCode: string
fees: array<CardPaymentFee · object>
timestamp*: integer · int64
processedTimestamp: integer · int64

Card Payment Original Credit EventORIGINAL_CREDITobject

A push credit to the card not tied to a prior purchase. Visa Original Credit Transaction (OCT) · Mastercard MoneySend.

id*: string
reversal: boolean
subtype: enum
reasonCode: string
transactionAmount: object
billingAmount: object
exchangeRate: object
userAmount: object
userExchangeRate: object
authCode: string
fees: array<CardPaymentFee · object>
timestamp*: integer · int64
processedTimestamp: integer · int64

CardPaymentEventResult

enum

Outcome of an authorization event.

Enum:APPROVEDDECLINED

AuthorisationCategory

enum

The category of the authorization.

Enum:PRE_AUTHFINAL_AUTH

CardPaymentAuthForwardingDecisionOutcome

enum

Default decision applied if the innovator does not respond in time during auth-forwarding.

Enum:APPROVEDECLINE

CardPaymentAuthForwardingDetails

Details of auth-forwarding handling on the authorization.

{}

objectobject · 3 fields

CardPaymentDeclineReason

enum

Reason an authorization was declined; populated only when result = DECLINED. Mirrors the legacy authorization webhook's decline reason values.

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_PERMITTEDTIMEOUTSINGLE_SPEND

CardPaymentForex

Auth-time FX context: the rate applied at authorization and the cushion blocked to cater for rate movement before settlement. Surfaced as a pair on AUTHORISATION events only — on settlement/refund/oct the rate sits at the event top-level (it modifies that event's amounts directly) and padding has already been absorbed or released at clearing time.

{}

objectobject · 2 fields

CardPaymentFee

A fee accrued on a specific card payment event. Discriminated by type:

PLATFORM_FEE → CardPaymentPlatformFee — fee charged by the platform; points at the underlying FeeTransaction.
FOREX_FEE → CardPaymentForexFee — forex padding + forex fee captured at authorization on a cross-currency event.

{}

objectobject · 1 field

Accepted shapes

Selected by type

Card Payment Platform FeePLATFORM_FEEobject

A fee charged by the platform on this card payment event (a FeeTransaction posted against the cardholder's instrument). The id points at the underlying fee transaction, retrievable in full via the Transaction Activity API.

id*: string
subtype*: enum
amount*: object

Card Payment Forex FeeFOREX_FEEobject

Forex fee charged on a cross-currency event. Already included in the event's transactionAmount — surfaced here so the embedder can show the cardholder how much of the charge was the forex fee.

amount: object

CardPaymentFeeSubtype

enum

The category of a platform fee accrued on a card payment event. Restricted to subtypes that can fire on card payments.

Enum:purchase_feesrefund_feesatm_withdrawal_feeswithdrawal_feeschargeback_feesfee_reversalscustom_feesother_fees

CardPaymentPlatformFee

{}

objectobject · 4 fields

CardPaymentForexFee

Forex fee charged on a cross-currency event. Already included in the event's transactionAmount — surfaced here so the embedder can show the cardholder how much of the charge was the forex fee.

{}

objectobject · 2 fields

CardPaymentFeeType

enum

Enum:PLATFORM_FEEFOREX_FEE

CardPaymentAuthorisationEvent

{}

objectobject · 19 fields

CardPaymentSettlementState

enum

Processing state of a settlement event at the scheme.

Enum:PENDINGCOMPLETED

CardPaymentSettlementEvent

A settlement event — money actually moves between the cardholder's account and the merchant, or back the other way. Visa Financial Transaction 0220 · Mastercard First Presentment 1240.

{}

objectobject · 14 fields

CardPaymentRefundEvent

A refund credited to the card, tied to an earlier purchase.

{}

objectobject · 14 fields

CardPaymentOriginalCreditEvent

A push credit to the card not tied to a prior purchase. Visa Original Credit Transaction (OCT) · Mastercard MoneySend.

{}

objectobject · 14 fields

CardPaymentEventType

enum

Type of event recorded against a CardPayment. The reversal flag on each event distinguishes a reversal from the original action.

Enum:AUTHORISATIONSETTLEMENTREFUNDORIGINAL_CREDIT

CardPayment

One card transaction's full lifecycle — authorization, settlement, refunds — as a single resource that the platform keeps up to date as scheme events arrive.

Designed for two audiences:

Building UI? Read the top-level summary fields (displayAmount, status, type, merchant, card). They are platform-maintained — show them as-is. No need to understand auth-vs-clearing, reversals, or scheme messages. The debit/credit direction is implicit from type (purchases / cash withdrawals / account funding debit the card; refunds / original credits credit it). For the issuer authorization code, walk events[] — every event in the lifecycle carries it.
Need scheme-level detail? Walk events[] for the full per-step audit trail — every authorization, clearing, reversal, and refund step — with original scheme amounts (merchant + card currency, with exchange rates), reason codes, and fees attached to the event that triggered them.

Each card payment corresponds to one card-scheme lifecycle (Visa Transaction Identifier / Mastercard TLID). Related-but-separate transactions (refunds, tips, recurring follow-ups) are separate card payments linked via relatedCardPaymentId (direct parent).

{}

objectobject · 11 fields

SystemTransaction

A system-generated transaction applied to an instrument by the platform (balance adjustments, account closures, dispute outcomes, replacement balance transfers, etc.). Only surfaced through Transaction Activity.

{}

objectobject · 9 fields

InstrumentTransactionActivityItem

A transaction activity entry returned by the per-instrument transactions endpoints (e.g. /managed_accounts/{id}/transactions). The instrument is omitted because it is already known from the path parameter.

{}

objectobject · 9 fields

InstrumentTransactionActivityList

A paginated list of transaction activity entries scoped to a single instrument.

{}

objectobject · 3 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

ManagedCard

{}

objectobject · 33 fields

Accepted shapes

Selected by mode

Prepaid Mode CardPREPAID_MODEobject

mode: enum
balances: object

Debit Mode CardDEBIT_MODEobject

mode: enum
currency: string
parentManagedAccountId*: string
userCurrency: enum
availableToSpend: array<AvailableToSpend · object>

PrepaidModeCard

{}

objectobject · 34 fields

SupportedUserCurrency

enum

Enum:JPYBGNCZKDKKHUFPLNRONSEKCHFISKNOKTRYAUDBRLCADCNYHKDIDRILSINRKRWMXNMYRNZDPHPSGDTHBZAREURUSDGBP

AvailableToSpend

{}

objectobject · 2 fields

DebitModeCard

{}

objectobject · 36 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 tokenized.

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 tokenized card number and shows the unredacted card number to the user on screen.

In addition, it is returned only when the current session is stepped-up.

{}

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 tokenized.

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

In addition, it is returned only when the current session is stepped-up.

{}

objectobject · 1 field

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

BillingAddress

{}

objectobject · 6 fields

BulkCardDelivery

boolean

Bulk delivery is available for deliveryMethods REGISTERED_MAIL or COURIER. All cards marked as bulk and ordered within the fulfillment center’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.

Example

true

PhoneNumber

string

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

Example

+447700900123

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.

Deliveries to a US address must use COURIER.

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.

Example

JD0002231234567890

DeliveryTrackingMethod

string

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

Example

ROYAL_MAIL

DeliveryTrackingUrl

string

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

Example

https://www.royalmail.com/track-your-item#/tracking-results/JD0002231234567890

PhysicalCardDetails

{}

objectobject · 13 fields

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

ManagedCardReplacement

Indicates if the card is replaced by another card.

{}

objectobject · 2 fields

ManagedCardRequest

{}

objectobject · 12 fields

PrepaidModeCardRequest

{}

objectobject · 13 fields

DebitModeCardRequest

{}

objectobject · 14 fields

SystemManagedCard

{}

objectobject · 25 fields

Accepted shapes

Selected by mode

Prepaid Mode System Managed CardPREPAID_MODEobject

balances: object

Debit Mode System Managed CardDEBIT_MODEobject

parentManagedAccountId: integer · int64
availableToSpend: array<AvailableToSpend · object>
userCurrency: enum

PrepaidModeSystemManagedCard

{}

objectobject · 26 fields

DebitModeSystemManagedCard

{}

objectobject · 28 fields

SpendActor

enum

Indicates whether the card is operated by a system or a user.

Enum:SYSTEMUSER

SystemManagedCardRequest

{}

objectobject · 7 fields

Accepted shapes

Selected by mode

Prepaid Mode System Managed Card RequestPREPAID_MODEobject

currency*: string

Debit Mode System Managed Card RequestDEBIT_MODEobject

parentManagedAccountId*: string
userCurrency: enum

PrepaidModeSystemManagedCardRequest

{}

objectobject · 8 fields

DebitModeSystemManagedCardRequest

{}

objectobject · 9 fields

PhysicalCardActivationCode

string

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

Example

CardPaymentSubtype

enum

Scheme-network subtype that further classifies an event. Reversal-vs-original lives on the separate reversal field on each event.

Enum:sale_purchasescash_withdrawalssales_with_cashbackmail_or_telephone_ordersaccount_fundingpurchase_reversalscash_withdrawal_reversalspurchase_refundspurchase_refund_reversalsoriginal_credit_transactionsoriginal_credit_transaction_reversals

CardPaymentList

Paginated list of CardPayments.

{}

objectobject · 3 fields

CardPaymentEventDetail

Standalone card payment event — same four variants as CardPaymentEvent, but each row also carries the parent CardPayment context (cardPaymentId, card, merchant) so embedders can render an event-centric history feed without fetching each parent card payment.

Used as the item type of GET /card_payment_events. For the lean nested version (inside CardPayment.events[]), see CardPaymentEvent.

{}

objectobject · 1 field

Accepted shapes

Selected by type

Card Payment Authorisation Event DetailAUTHORISATIONobject

Authorization event with parent card-payment context — used by GET /card_payment_events so each row is self-contained.

id*: string
subtype*: enum
reversal: boolean
result: enum
authorisationCategory: enum
authForwardingDetails: object
declineReason: enum
authRuleFailedReason: string
cancellationReason: string
transactionAmount: object
billingAmount: object
forex: object
userAmount: object
userExchangeRate: object
authCode: string
fees: array<CardPaymentFee · object>
timestamp*: integer · int64
processedTimestamp: integer · int64
cardPaymentId*: string
card*: object
merchant*: object

Card Payment Settlement Event DetailSETTLEMENTobject

Settlement event with parent card-payment context — used by GET /card_payment_events so each row is self-contained.

id*: string
subtype*: enum
reversal: boolean
settlementState*: enum
transactionAmount: object
billingAmount: object
exchangeRate: object
userAmount: object
userExchangeRate: object
authCode: string
fees: array<CardPaymentFee · object>
timestamp*: integer · int64
processedTimestamp: integer · int64
cardPaymentId*: string
card*: object
merchant*: object

Card Payment Refund Event DetailREFUNDobject

Refund event with parent card-payment context — used by GET /card_payment_events so each row is self-contained.

id*: string
reversal: boolean
subtype: enum
reasonCode: string
transactionAmount: object
billingAmount: object
exchangeRate: object
userAmount: object
userExchangeRate: object
authCode: string
fees: array<CardPaymentFee · object>
timestamp*: integer · int64
processedTimestamp: integer · int64
cardPaymentId*: string
card*: object
merchant*: object

Card Payment Original Credit Event DetailORIGINAL_CREDITobject

Original-credit event with parent card-payment context — used by GET /card_payment_events so each row is self-contained.

id*: string
reversal: boolean
subtype: enum
reasonCode: string
transactionAmount: object
billingAmount: object
exchangeRate: object
userAmount: object
userExchangeRate: object
authCode: string
fees: array<CardPaymentFee · object>
timestamp*: integer · int64
processedTimestamp: integer · int64
cardPaymentId*: string
card*: object
merchant*: object

CardPaymentEventContext

Parent card-payment context attached to standalone (*EventDetail) variants so each event row returned by GET /card_payment_events is self-contained — no need to fetch the parent card payment separately to render a history entry.

{}

objectobject · 3 fields

CardPaymentAuthorisationEventDetail

Authorization event with parent card-payment context — used by GET /card_payment_events so each row is self-contained.

{}

objectobject · 22 fields

CardPaymentSettlementEventDetail

Settlement event with parent card-payment context — used by GET /card_payment_events so each row is self-contained.

{}

objectobject · 17 fields

CardPaymentRefundEventDetail

Refund event with parent card-payment context — used by GET /card_payment_events so each row is self-contained.

{}

objectobject · 17 fields

CardPaymentOriginalCreditEventDetail

Original-credit event with parent card-payment context — used by GET /card_payment_events so each row is self-contained.

{}

objectobject · 17 fields

CardPaymentEventList

Paginated list of CardPaymentEventDetail.

{}

objectobject · 3 fields

ProfileLevelSpendRules

{}

objectobject · 13 fields

IdentityLevelSpendRules

{}

objectobject · 14 fields

AllLevelSpendRules

{}

objectobject · 17 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 tokenized.

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

{}

objectobject · 1 field

ManagedCardPhysicalUpgradeBase

{}

objectobject · 5 fields

name

string

max length 100

Example

Alex

surname

string

max length 100

Example

Smith

IndividualCardDeliveryAddress

The delivery address of the cardholder.

{}

objectobject · 9 fields

ManagedCardPhysicalUpgrade

{}

objectobject · 8 fields

BulkCardDeliveryAddress

The delivery address for the processing location that the parcel is sent to.

{}

objectobject · 9 fields

ManagedCardPhysicalUpgradeBulk

{}

objectobject · 8 fields

TransactionCancelRequest

{}

objectobject · 2 fields

TransactionBulkCancelRequest

{}

objectobject · 1 field

TransactionCancelResponse

{}

objectobject · 3 fields

TransactionBulkCancelResponse

{}

objectobject · 1 field

TransactionSingleCancelRequest

{}

objectobject · 1 field

IncomingWireTransferList

A paginated list of incoming wire transfers.

{}

objectobject · 3 fields

SourceInstrumentType

enum

Enum:managed_accounts

OutgoingWireTransferUpdateBeneficiaryNameRequest

{}

objectobject · 2 fields

OutgoingWireTransferUpdateBeneficiaryNameConflictSchemaErrorCode

enum

Enum:INVALID_STATECONFLICT_BENEFICIARYID_NAMECONFLICT_EXTERNALACCOUNTID_NAMEMODEL_CONSTRAINTS_VIOLATEDNO_NAME_TO_ACCEPT

OutgoingWireTransferUpdateBeneficiaryNameConflict

{}

objectobject · 1 field

OutgoingWireTransferPaymentConfirmationConflictErrorCode

enum

Enum:TRANSFER_NOT_COMPLETED

OutgoingWireTransferPaymentConfirmationConflict

{}

objectobject · 1 field

CorrespondentBankingOwtCreateRequest

{}

objectobject · 10 fields

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

BasicBeneficiary

{}

objectobject · 5 fields

BeneficiaryBatchOperation

enum

Enum:CREATEREMOVE

BeneficiaryOperationBatchId

{}

objectobject · 2 fields

BeneficiaryState

enum

Enum:INITIALISEDINVALIDPENDING_CHALLENGECHALLENGE_FAILEDACTIVEREMOVED

BeneficiaryValidationFailure

enum

Enum:INSTRUMENT_DETAILS_NOT_FOUNDBENEFICIARY_DETAILS_ALREADY_EXISTBENEFICIARY_BELONGS_TO_SAME_IDENTITY

Beneficiary

{}

objectobject · 9 fields

BeneficiaryBatchState

enum

Enum:INITIALISEDFAILEDPENDING_CHALLENGECHALLENGE_FAILEDCHALLENGE_COMPLETEDCOMPLETED

BeneficiaryBatch

{}

objectobject · 3 fields

RbacRole

{}

objectobject · 3 fields

TransactionActivityItem

A transaction activity entry returned by the cross-instrument /transactions endpoint. Common fields are surfaced at the top level for easy filtering and sorting without inspecting the nested transaction. The full transaction object (Transfer, Send, OWT, CBT, IWT, CardPayment, FeeTransaction, SystemTransaction) is available under transaction for detailed consumption.

{}

objectobject · 10 fields

TransactionActivityList

A paginated list of transaction activity entries.

{}

objectobject · 3 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

CorporateKybEvent

{}

objectobject · 8 fields

CorporateBeneficiaryEventType

enum

The beneficiary field whose change triggered the event.

Enum:STATUS_UPDATEDBENEFICIARY_TYPE_UPDATEDFIRST_NAME_UPDATEDMIDDLE_NAME_UPDATEDLAST_NAME_UPDATEDEMAIL_UPDATED

BeneficiaryType

enum

Enum:UBODIRECTORUNKNOWNSHAREHOLDERPARTNEROTHER_DIRECTOR

CorporateBeneficiaryInfo

Details of the beneficiary at the time of the event.

{}

objectobject · 7 fields

CorporateBeneficiaryEventDetails

The corporate and beneficiary the event relates to.

{}

objectobject · 7 fields

CorporateBeneficiaryEvent

Sent on the /corporates/kyb/beneficiaries/watch webhook when the verification status or details of a corporate beneficiary change. A beneficiary is a director, UBO, shareholder, or partner whose own verification contributes to the corporate's KYB outcome.

{}

objectobject · 4 fields

IdentityLifecycleActor

enum

Who performed the activation or deactivation:

ADMIN: Weavr, through the Admin API or Admin Portal.
INNOVATOR: you, through the Innovator API or Embedder Portal.

Enum:ADMININNOVATOR

IdentityActivatedEvent

Sent when a corporate or consumer identity is activated, restoring access to its managed accounts, cards, and outbound payments.

{}

objectobject · 2 fields

IdentityDeactivationReason

enum

Why an identity was deactivated:

ACCOUNT_REVIEW: the identity is under review.
ACCOUNT_SECURITY: deactivated in response to a security concern.
TEMPORARY: a temporary deactivation the identity is expected to recover from.
ACCOUNT_CLOSURE: the account is being closed.
ACCOUNT_ABANDONED: the account was abandoned before it became usable.

Enum:ACCOUNT_REVIEWACCOUNT_SECURITYTEMPORARYACCOUNT_CLOSUREACCOUNT_ABANDONED

IdentityDeactivatedEvent

Sent when a corporate or consumer identity is deactivated. A deactivated identity cannot sign in, and its instruments stop accepting new transactions until it is activated again.

{}

objectobject · 3 fields

ConsumerKycFailureReason

enum

Why a consumer's KYC check was rejected.

Enum:DOCUMENTS_UNSATISFACTORYSUPPLIED_DATA_AND_DOCUMENTS_MISMATCHLANGUAGE_IN_DOCUMENTS_UNSUPPORTEDSELFIE_UNSATISFACTORYSELFIE_AND_DOCUMENTS_MISMATCHOTHERUNSUPPORTED_COUNTRYPEP_STATUSREJECTED_DUPLICATEEXPIRED_KYC_DOCUMENTS

ConsumerKycEvent

Sent on the /consumers/kyc/watch webhook each time the KYC status of a consumer identity changes.

{}

objectobject · 9 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 awaiting a decision and cannot be used yet.
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. Blocking is reversible.
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 verification and cannot be used for self-to-self wire transfers unless a new verification is completed in future. A Linked Account starts in the PENDING_VERIFICATION state and becomes ACTIVE once verified.

Enum:PENDING_VERIFICATIONBLOCKEDACTIVEREJECTEDREMOVED

LinkedAccount

{}

objectobject · 12 fields

UnknownSenderAccount

{}

objectobject · 2 fields

CardAuthorisationEvent

{}

objectobject · 16 fields

Accepted shapes

Selected by mode

Prepaid Mode Card Authorisation EventPREPAID_MODEobject

availableBalance: object

Debit Mode Card Authorisation EventDEBIT_MODEobject

parentManagedAccountId*: string
availableToSpend: array<AvailableToSpend · object>

PrepaidModeCardAuthorisationEvent

{}

objectobject · 17 fields

DebitModeCardAuthorisationEvent

{}

objectobject · 18 fields

CardAuthorisationDetailsAuthorisationType

enum

Enum:AUTHORISEDAUTHORISED_CREDIT

MerchantData

{}

objectobject · 14 fields

CardHolderPresent

enum

Enum:PRESENTNOT_PRESENTPRESENCE_UNKNOWN

CardAuthorisationDetailsTransactionType

enum

Enum:SALE_PURCHASEMAIL_OR_TELEPHONE_ORDERCASH_WITHDRAWALORIGINAL_CREDIT_TRANSACTIONACCOUNT_FUNDING_TRANSACTIONCASH_DISBURSEMENTPURCHASE_REFUNDBALANCE_INQUIRYPIN_CHANGEPIN_UNBLOCK

ManagedCardsUpgradeToPhysicalEvent

Sent on the /managed_cards/physical_cards_upgrade/watch webhook each time the fulfillment status (physicalCardDetails.manufacturingState) of a physical card changes.

{}

objectobject · 3 fields

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

IbanInstrumentState

{}

objectobject · 2 fields

IbanInstrument

{}

objectobject · 10 fields

IbanEventType

enum

What happened to the IBAN:

REQUESTED: an IBAN was requested for the managed account and is awaiting allocation.
CREATED: the IBAN was allocated and can receive funds.
UPDATED: the IBAN's details changed.
REJECTED: the allocation request was rejected.
BLOCKED: the IBAN was blocked and cannot receive funds.
UNBLOCKED: the IBAN was unblocked and can receive funds again.
DESTROYED: the IBAN was permanently withdrawn. This is a final state.

Enum:CREATEDUPDATEDREQUESTEDREJECTEDBLOCKEDUNBLOCKEDDESTROYED

IbanEvent

Sent on the /ibans/watch webhook each time an IBAN allocated to a managed account is issued or changes state.

{}

objectobject · 3 fields

TransferType

enum

Enum:SEPAFASTER_PAYMENTSSWIFTBACSCHAPSRIXTARGET

BankAccountDetails

{}

objectobject · 9 fields

ManagedAccountEventAccount

The managed account as carried on the event. Extends the managed account resource with the owning identity and, once the account has been issued, its bank account details.

{}

objectobject · 12 fields

ManagedAccountEventType

enum

What happened to the managed account:

REQUESTED: creation was requested and is awaiting issuance.
CREATED: the account was issued and can be transacted on.
UPDATED: the account's details changed.
REJECTED: the creation request was rejected.
BLOCKED: the account was blocked and cannot transact.
UNBLOCKED: the account was unblocked and can transact again.
DESTROYED: the account was permanently closed. This is a final state.

Enum:CREATEDUPDATEDREQUESTEDREJECTEDBLOCKEDUNBLOCKEDDESTROYED

ManagedAccountEvent

Sent on the /managed_accounts/watch webhook each time a managed account is created or changes state.

{}

objectobject · 3 fields

ManagedAccountDepositState

enum

Where the deposit has reached:

PENDING: the deposit is being processed and funds are not yet available.
COMPLETED: the funds have been credited to the managed account. This is a final state.
REJECTED: the deposit was rejected and no funds were credited. This is a final state.

Enum:PENDINGCOMPLETEDREJECTED

ManagedAccountDepositEvent

Sent on the /managed_accounts/deposits/watch webhook when an incoming wire transfer is received into a managed account.

{}

objectobject · 15 fields

ManagedCardStateChangeEventType

enum

What happened to the card:

ACTIVATED: the card was activated and can be transacted on.
BLOCKED: the card was blocked and will decline authorizations.
UNBLOCKED: the card was unblocked and can be transacted on again.
DESTROYED: the card was permanently destroyed. This is a final state.

Enum:ACTIVATEDBLOCKEDUNBLOCKEDDESTROYED

CardType

enum

Enum:VIRTUALPHYSICAL

ManagedCardStateChangeEvent

Sent on the /managed_cards/state_change/watch webhook each time a managed card is activated, blocked, unblocked, or destroyed.

{}

objectobject · 6 fields

CardAdjustmentDetailsAdjustmentType

enum

Enum:DEFAULT_ADJUSTMENTLOST_STOLEN_REPLACEMENT_BALANCE_TRANSFER

PrepaidModeDetails

Balance context for a card created in prepaid mode, which holds its own balance.

{}

objectobject · 1 field

DebitModeAvailableToSpend

Remaining spendable amount for one spend limit interval.

{}

objectobject · 2 fields

DebitModeDetails

Balance context for a card created in debit mode, which draws on its parent managed account up to a configurable spend limit.

{}

objectobject · 2 fields

ManagedCardModeDetails

Balance context for the card, carrying whichever set of details matches the mode the card was created in. Exactly one of the two is populated.

{}

objectobject · 2 fields

ManagedCardAdjustmentEvent

Sent on the /managed_cards/adjustments/watch webhook when a card's balance is adjusted outside the normal authorization and settlement flow.

{}

objectobject · 8 fields

ManagedCardPaymentEvent

Sent on the /managed_cards/payments/watch webhook each time a card payment is created or updated. Unlike the per-event-type card webhooks (authorization, settlement, adjustment, ...), this carries the full current state of the CardPayment aggregate, including its complete events[] history — so a single subscription can track the overall card payment without also subscribing to the per-event-type webhooks.

{}

objectobject · 2 fields

ManagedCardExpiryEventType

enum

Where the card is in its expiry cycle:

CARD_ABOUT_TO_EXPIRE: the card is approaching its expiry date.
CARD_EXPIRED: the card has expired and will decline authorizations.
CARD_RENEWED: the card was renewed and a new expiry date applies.

Enum:CARD_ABOUT_TO_EXPIRECARD_EXPIREDCARD_RENEWED

ManagedCardExpiryEvent

Sent on the /managed_cards/expiries/watch webhook as a managed card approaches expiry, expires, or is renewed.

{}

objectobject · 7 fields

ManagedCardReplacementEventType

enum

How the card was replaced:

VIRTUAL_REPLACEMENT: a new virtual card was issued.
PHYSICAL_REPLACEMENT: a new physical card was issued and sent for fulfillment.

Enum:VIRTUAL_REPLACEMENTPHYSICAL_REPLACEMENT

ReplacementType

enum

Enum:DAMAGEDLOST_STOLENRENEWCOMPROMISED

ManagedCardReplacementEvent

Sent on the /managed_cards/replacement/watch webhook when a managed card is replaced, either virtually or physically.

{}

objectobject · 6 fields

TransferEventType

enum

The state the transfer has reached:

SCHEDULED: the transfer is scheduled for a future date.
PENDING: the transfer is being processed.
COMPLETED: the funds have moved. This is a final state.
FAILED: the transfer could not be completed. conflict says why. This is a final state.
CANCELLED: a scheduled transfer was canceled before execution. This is a final state.

Enum:PENDINGCOMPLETEDFAILEDSCHEDULEDCANCELLED

CreateTransferConflictErrorCode

enum

Enum:NO_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_BLOCKEDSOURCE_IS_NOT_BALANCE_OWNERDESTINATION_IS_NOT_BALANCE_OWNERINVALID_AMOUNTSOURCE_INSTRUMENT_DESTROYEDDESTINATION_INSTRUMENT_DESTROYEDSOURCE_AND_DESTINATION_MUST_BE_DIFFERENTSCHEDULED_TIMESTAMP_INVALID

TransferEventTransfer

The transfer as carried on the event. Extends the transfer resource with the conflict code explaining a failure.

{}

objectobject · 13 fields

TransferEvent

Sent on the /transfers/watch webhook each time a transfer between two of an identity's own instruments changes state.

{}

objectobject · 3 fields

SendEventType

enum

The state the send has reached:

SCHEDULED: the send is scheduled for a future date.
PENDING_CHALLENGE: the send is awaiting Strong Customer Authentication.
PENDING: the send is being processed.
COMPLETED: the funds have moved. This is a final state.
FAILED: the send could not be completed. conflict says why. This is a final state.
INVALID: the send was rejected as invalid. conflict says why. This is a final state.
CANCELLED: the send was canceled before execution. This is a final state.

Enum:PENDINGCOMPLETEDFAILEDPENDING_CHALLENGEINVALIDSCHEDULEDCANCELLED

SendConflictErrorCode

enum

Why a send could not be completed.

Enum:NO_ERRORPROFILE_INACTIVEPROFILE_NOT_FOUNDMODEL_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_REQUIREDSCHEDULED_TIMESTAMP_INVALID

SendEventSend

The send as carried on the event. Extends the send resource with the beneficiary, the conflict code explaining a failure, and the cancellation and execution timestamps.

{}

objectobject · 18 fields

SendEvent

Sent on the /send/watch webhook each time a send to another identity within the same programme changes state.

{}

objectobject · 3 fields

OutgoingWireTransferConflictErrorCode

enum

Why an outgoing wire transfer could not be submitted.

Enum:NO_ERRORPROFILE_INACTIVEPROFILE_NOT_FOUNDMODEL_CONSTRAINTS_VIOLATEDDENIED_BY_INTERCEPTORDENIED_BY_INSTRUMENTUNSUPPORTED_CURRENCYCURRENCY_MISMATCHINVALID_AMOUNTINSUFFICIENT_FUNDSSOURCE_NOT_FOUNDSOURCE_INSTRUMENT_BLOCKEDSOURCE_INSTRUMENT_DESTROYEDSOURCE_HAS_NO_ACCESS_INSTRUMENTFEE_NOT_CONFIGURED_FOR_CURRENCYTYPE_NOT_SUPPORTED_BY_PROFILEIDENTITY_KYC_LEVEL_STEPUP_REQUIREDBENEFICIARY_NOT_FOUNDBENEFICIARY_TYPE_INVALIDBENEFICIARY_BANK_DETAILS_INVALIDDESTINATION_ACCOUNT_TYPE_INVALIDEXTERNAL_DESTINATION_ACCOUNT_NOT_FOUNDSCHEDULED_TIMESTAMP_INVALIDPROVIDER_ERROR

OutgoingWireTransferEventTransfer

The outgoing wire transfer as carried on the event. Extends the outgoing wire transfer resource with the trusted payee or external account it was sent to, and the conflict code explaining a rejection.

{}

objectobject · 21 fields

OutgoingWireTransferEventType

enum

The state the outgoing wire transfer has reached:

SCHEDULED: the transfer is scheduled for a future date.
PENDING_CHALLENGE: the transfer is awaiting Strong Customer Authentication.
PENDING_CONFIRMATION: the transfer is awaiting confirmation.
SUBMITTED: the transfer has been submitted to the payment network.
APPROVED: the transfer passed validation and will be sent.
COMPLETED: the funds have left the account. This is a final state.
REJECTED: the transfer was rejected before submission. conflict says why.
FAILED: the transfer could not be completed. conflict says why.
RETURNED: the funds were returned by the receiving bank.
INVALID: the transfer was rejected as invalid. conflict says why.
CANCELLED: the transfer was canceled before execution. This is a final state.

Enum:PENDING_CHALLENGEPENDING_CONFIRMATIONSCHEDULEDSUBMITTEDAPPROVEDCOMPLETEDREJECTEDFAILEDRETURNEDINVALIDCANCELLED

OutgoingWireTransferEvent

Sent on the /outgoing_wire_transfers/watch webhook each time an outgoing wire transfer moves through its lifecycle.

{}

objectobject · 4 fields

ManualTransactionEvent

Sent on the /manual_transactions/watch webhook when Weavr manually credits or debits an instrument — for example to correct a processing error or settle a dispute.

{}

objectobject · 6 fields

FeeType

enum

Enum:DEPOSITWITHDRAWALPURCHASEREFUNDATM_WITHDRAWALCHARGEBACKTRANSFERSENDOWTCUSTOMOTHER

ChargeFeeEventDetails

The fee that was charged and the instrument it was taken from.

{}

objectobject · 6 fields

ChargeFeeEventType

enum

The state the fee charge has reached:

COMPLETED: the fee was charged. This is a final state.

Enum:COMPLETED

ChargeFeeEvent

Sent on the /fees/watch webhook when a fee is charged to an instrument.

{}

objectobject · 3 fields

AuthenticationEventStatus

enum

The outcome of an authentication attempt:

VERIFIED: the attempt succeeded.
DECLINED: the attempt was rejected.
EXPIRED: the attempt was not completed in time.

Enum:VERIFIEDDECLINEDEXPIRED

StepUpEvent

Sent on the /stepup/watch webhook when a step-up authentication challenge is resolved. A stepped-up token is required for operations that need Strong Customer Authentication.

{}

objectobject · 7 fields

AuthenticationFactorEnrollmentStatus

enum

Whether the authentication factor is usable:

ACTIVE: the factor is enrolled and can be challenged.
INACTIVE: the factor has been removed and can no longer be challenged.

Enum:ACTIVEINACTIVE

AuthenticationFactorEnrollmentEvent

Sent on the /authentication_factors/watch webhook when a user's authentication factor is enrolled or removed.

{}

objectobject · 4 fields

BeneficiaryBatchEventType

enum

The state the batch has reached:

INITIALISED: the batch was accepted and is awaiting a challenge.
PENDING_CHALLENGE: a Strong Customer Authentication challenge has been issued.
CHALLENGE_COMPLETED: the challenge succeeded and the batch has been applied. This is a final state.
CHALLENGE_FAILED: the challenge was not completed, so the batch was not applied. This is a final state.
FAILED: the batch could not be processed. This is a final state.

Enum:INITIALISEDPENDING_CHALLENGECHALLENGE_COMPLETEDCHALLENGE_FAILEDFAILED

BeneficiaryBatchEvent

Sent on the /beneficiaries/batch/watch webhook as a batch of trusted payee operations moves through verification. Payees added in a batch only become usable once the batch reaches CHALLENGE_COMPLETED.

{}

objectobject · 6 fields

BulkProcessProgressStatus

enum

Enum:RUNNINGPARTIALLY_COMPLETEDCOMPLETEDFAILEDPAUSEDCANCELLED

BulkProcessProgressEvent

{}

objectobject · 4 fields