Search
K
financials v1

BankAccountDto

object

This field is required and can be updated only for type DESTINATION.

accountNamestringrequired

Match pattern:^[a-zA-Z0-9\/\-\\?:().,'#=!"%&*<>;@{+\s]*$

>= 1 characters<= 35 characters

Example:Bob Smith

accountNumberstringrequired

Match pattern:^\d{8}$

Example:12345678

bankCodestringrequired

Match pattern:^\d{6}$

Example:123456

accountTypestring

Allowed Values: [BUSINESS, PERSONAL]

Match pattern:^(BUSINESS|PERSONAL)$

Example:BUSINESS

displayNamestring

Match pattern:^[0-9a-zA-Z/\-\?:\(\)\.,'\+ !#$%&\*=^_`\{\|\}~";<>@\[\\\]]+$

<= 35 characters

Example:Mortgage account

Example

LineItemAttributesDto

object

Additional line item attributes. Omitted when neither subCategory nor notes is set.

subCategorystring

Sub-category. Only populated when category is Third Party Payment.

Match pattern:^(LANDLORD_FEE|MANAGEMENT_COMPANY_FEE|INDEMNITY_INSURANCE|ESTATE_AGENTS_FEE|OTHER)$

Example:INDEMNITY_INSURANCE

notesstring

Optional free-text notes for the line item.

>= 0 characters<= 128 characters

Example:Insurance Fee

Example

schemas-Authorised

boolean

Authorisation status of the line item

Example:true

AccountVerificationStatus

string

status of account verification Allowed Values: [ MATCH, NAME_PARTIAL_MATCH, NAME_PARTIAL_MATCH_TYPE_NO_MATCH, NO_MATCH, UNABLE_TO_MATCH, ERROR, TIMEOUT, TYPE_NO_MATCH, ACCOUNT_VERIFICATION_NOT_RUN ]

Match pattern:^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$

Example

AccountVerificationDetailDto

object
statusstring

status of account verification Allowed Values: [ MATCH, NAME_PARTIAL_MATCH, NAME_PARTIAL_MATCH_TYPE_NO_MATCH, NO_MATCH, UNABLE_TO_MATCH, ERROR, TIMEOUT, TYPE_NO_MATCH, ACCOUNT_VERIFICATION_NOT_RUN ]

Match pattern:^(MATCH|NAME_PARTIAL_MATCH|NAME_PARTIAL_MATCH_TYPE_NO_MATCH|NO_MATCH|UNABLE_TO_MATCH|ERROR|TIMEOUT|TYPE_NO_MATCH|ACCOUNT_VERIFICATION_NOT_RUN)$

Example:NAME_PARTIAL_MATCH

partnerReasonCodestring

Reason code sent from third party system for account verification.

Code Description
ANNM Account Name does Not Match
MBAM There may be a match on the Account name
BANM Business account, name matches
PANM Personal account, name matches
BAMM Business account, name may be a match
PAMM Personal account, name may be a match
AC01 Incorrect Account Number
IVCR Invalid Customer Reference
ACNS Account type Not Supported for CoP
OPTO Opted out of CoP Scheme
CASS Account has been switched
SCNS Sort code not supported at endpoint
verifiedboolean

denotes in the account details are verified

acceptedAtstring(date-time)

timestamp recorded when the consent was given for the account

acceptedBystring

id of the user who gave the consent for the account

actualNamestring

Actual name of given account received from CoP in case of partial match

isManualOverrideAllowedboolean

Flag to indicate if manual override is allowed

Example