Skip to main content
API docs by Redocly

PortX ORCA Management (0.1.1)

Download OpenAPI specification:Download

E-mail: betiana.darderes@portx.io

PortX Open Restful Core API (ORCA) semantic and interaction is based on ISO 20022 and restricted to the US banking domain. The scope covers the following communication flows: bank account opening, maintenance, closing and reporting. In many cases, the financial institution will require additional documentation that is available as PDF or Word document. The recommended solution is to group one ORCA message (for example the account opening request) with these accompanying documents in one file archive. The archive establishes the link between the different documents. Every ORCA request message has an attribute to support the ISO 20022 digital signature.

Accounts

Bank Account Management

Opens an Account

Authorizations:
jwtopenIdConnect
header Parameters
idempotencyId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Request Body schema: application/json
servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: "SEA_1"

Identification of the account servicer institution at branch level or operation level.

accountType
required
string (AccountType) [ 1 .. 35 ] characters
Example: "Current"

Type of the account. Some possible ISO 20022 compliant values are: Current, CardAccount, CashPayment, Charges, CashIncome, Commission, ClearingParticipantSettlementAccount, LimitedLiquiditySavingsAccount, MarginalLending, MoneyMarket, NonResidentExternal, Overdraft, OverNightDeposit, Settlement, Salary, Savings, Tax, TransactingAccount, CashTrading, VirtualAccount, Checking, CreditCard, DebitCard, Universal, Investment, EpurseCard, CertificateOfDeposit, MoneyMarketChecking, RetirementAccount, StockOrBond, PrePaid, FleetCard, Cash, DebitAccount, CreditAccount, Benefit, HealthSavingsAccount, FlexibleSpendingAccount, ForBenefitOf, Estate

accountOwnershipType
required
string (AccountOwnershipType) [ 1 .. 35 ] characters
Example: "Owner"

Specifies the type of account ownership. Possible ISO 20022 compliant values names are: JointAccountWithSurvivorshipRights, JointAccountInCommon, CustodialAccount, SingleOwnerAccount, JointAccount, Corporation, FormalPartnership, FormalTrust, Nominee, NonProfitOrganisation, OtherNonIndividual, EUResidualEntity, GovernmentOrganization, LimitedLiabilityCompany, RegisteredInvestmentCompany, Entrepreneurial, Unincorporated, LimitedPartnership, BareOwner, Owner, Usufructuary, Fiduciary

productId
string (ProductId) [ 1 .. 36 ] characters
Example: "PD_CA_0002"
name
string (AccountName) [ 1 .. 70 ] characters
Example: "Hermes PD_CA 0002"

Name of the account. It provides an additional means of identification, and is designated by the account servicer in agreement with the account owner.

accountPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
currency
string (CurrencyCode) = 3 characters ^([A-Z]{3})?$
Example: "USD"

Three contiguous letters for the representation of currencies and funds. Valid currency codes are registered with the ISO 4217 Maintenance Agency.

initialAmount
string (AmountInCents) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

object (AccountContract)

Account contractual details between the owners and the account servicer.

documentId
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
documentReference
string [ 1 .. 35 ] characters

Document location.

version
string [ 1 .. 18 ] characters

Document version indentification.

signOffDate
string <date>
Example: "2022-04-17"

Signoff date of the document.

issueDate
string <date>
Example: "2022-04-17"

Issue date of the document.

purpose
string [ 1 .. 35 ] characters

Specifies the function of the document.

fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

object (Jurisdiction)

Area with a set of laws under the control of a system which are different from neighbouring areas

countrySubdivision
string [ 1 .. 35 ] characters
Example: "Oregon"
townName
string [ 1 .. 35 ] characters
Example: "Tualatin"
country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

targetClosingDate
string <date>
Example: "2022-04-17"

Date on which the account and related services are expected to cease for the account owner.

targetGoLiveDate
string <date>
Example: "2022-04-17"

Date on which the account and related services are expected to be operational for the account owner.

object

Agreement that governs a contract agreed between parties.

documentId
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
documentReference
string [ 1 .. 35 ] characters

Document location.

version
string [ 1 .. 18 ] characters

Document version indentification.

signOffDate
string <date>
Example: "2022-04-17"

Signoff date of the document.

issueDate
string <date>
Example: "2022-04-17"

Issue date of the document.

purpose
string [ 1 .. 35 ] characters

Specifies the function of the document.

Array of objects (InterestCalculation)
Array
fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

name
string (InterestName) [ 1 .. 35 ] characters
Example: "LatePayment"

Name of the interest that applies to the account. For instance, Overdraft, LatePayment.

dayCountBasis
string (InterestComputationMethod) [ 1 .. 50 ] characters
Example: "30360AmericanBasicRule"

Specifies the method used to compute accruing interest of a financial instrument. Some ISO 20022 compliant values are: 30360AmericanBasicRule, IC30365, IC30Actual, Actual360, Actual365Fixed, ActualActualICMA, IC30E360orEuroBondBasismodel1, ActualActualISDA, Actual365LorActuActubasisRule, ActualActualAFB, IC30360ICMAor30360basicrule, IC30E2360orEurobondbasismodel2, IC30E3360orEurobondbasismodel3, Actual365NL, Narrative, ActualActualUltimo, IC30EPlus360, Actual364, Business252, Actual360NL, OneOne, Other

rate
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

The actual interest rate used for the payment of the interest for the specified interest period.

interestRateType
string (InterestRateType) [ 1 .. 35 ] characters
Example: "Fixed"

Specifies the type of interest rate. Some ISO 20022 compliant values are: Fixed, Forfeit, Variable, Scheduled, Unscheduled, Discount, FixedRateUnderlyingExposureForLife, FixedRateUnderlyingExposureWithCompulsoryFutureSwitchToFloating, FixedWithFuturePeriodicResets, FloatingLinkedToIndex, FloatingRateUnderlyingExposureForLife, FloatingRateUnderlyingExposureWithCap, FloatingRateUnderlyingExposureWithFloor, FloatingRateUnderlyingExposureWithFloorAndCap, Modular, ObligorSwapped, Other, SwicthOptionality

object (Frequency)

Specifies an event frequency

object (Frequency)

Specifies an event frequency

object (VariableInterestCalculation)

Specifies the parameters to be used for variable interest.

Array of objects (ChargeCalculation)
Array
fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

name
string (ChargeName) [ 1 .. 60 ] characters
Example: "cardLatePayment"

Name of the charge calculation in PascalCase. Possible values: cardLatePayment, cashAdvance

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount charged for the service.

rate
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Rate applied on a basis amount to calculate the service charge.

chargeType
string (ChargeType) [ 1 .. 35 ] characters
Example: "ManagementFee"

Type of service for which a charge is asked or paid. Some possible ISO 20022 compliant values are: BrokerageFee, Commission, BackEndLoad, FrontEndLoad, Switch, DilutionLevy, Discount, ManagementFee, TransferFee, MatchingFees, PostageCharge, RegulatoryFee, ShippingCharge, ServiceProvisionFee, SpecialConcessions, PartAcquis, Penalty, ContingencyDeferredSalesCharge, Other, Equalisation, CorrespondentBankCharge, Premium, Initial, AdvisoryFee, CustodyFee, PublicationFee, AccountingFee, SignatureService, StorageAtDestination, StorageAtOrigin, Packaging, PickUp, DangerousGoodsFee, SecurityCharge, InsurancePremium, CollectFreight, ClearanceAndHandlingAtOrigin, ClearanceAndHandlingAtDestination, AirWayBillFee, TransportCharges, UCITSCommission, SpeciallyAgreedFrontEndLoad, ADRFee, IssuanceCancellationFee, MiscellaneousFee, IssuanceFee.

calculationBasis
string (CalculationBasis) [ 1 .. 35 ] characters
Example: "Monthly"

Specifies the calculation basis of a charge or fee. Some possible ISO 20022 compliant values are: Average, Daily, Other, Monthly, Annual

bearerType
string (ChargeBearerType) [ 1 .. 35 ] characters
Example: "Shared"

Specifies which party(ies) will pay charges due for processing of the instruction. BorneByDebtor, BorneByCreditor, Shared, FollowingServiceLevel

maximumAmount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Maximum amount of money asked or paid for the charge.

object (InterestCalculation)

Set of parameters used to calculate an interest.

required
Array of objects (AccountParty)
Array
partyId
required
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
partyType
required
string (PartyType)
Example: "Person"

Possible values are: Person, Organization. Also other types of servicer internal entities: ServicerOfficer

partyAccountRole
required
string (AccountPartyRole) [ 1 .. 35 ] characters
Example: "AccountOwner"

Type of the account. Some possible ISO 20022 compliant values are: AccountOwner, LiquidityManager, LimitManager, PaymentManager, Reader, BackupManager, SettlementManager, FundManagementCompany, TransferAgent, FundAccountant, Registrar, InvestmentManager, Custodian, Auditor, PayingAgent, CashCorrespondent, DataProvider, FinalAgent, Investor, FirstAgent, Intermediary, Distributor, Concentrator, UnderlyingClient1, UnderlyingClient2, TransmittingAgent, FundBroker, FinancialAdvisor, ContactPersonAtInstructingPartyInstitution, ContactPersonAtExecutingPartyInstitution, NameOfAgentToOrder, PrimeBroker, Internal, LegalGuardian, DecisionMaker, Guarantor, LoanLender, LoanBorrower, LoanCoBorrower, PrimaryOwner, Trustee, CustodianForMinor, Nominee, SecondaryOwner, Executor, Beneficiary, PrimaryServicerOfficer, SecondaryServicerOfficer.

maturityDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

Array of objects (RelatedAccount)
Array
accountRelationType
string (AccountRelationType)

Account relation role. Possible values are: Parent, Child, Group.

accountId
string (AccountId) [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Identification assigned by the account service institution (Servicer).

accountNumber
string (AccountNumber) <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN).

referenceAccount
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Account used as a reference for the account opening. Could be used to provide initial funds.

Array of objects (Restriction)
Array
name
string [ 1 .. 60 ] characters
Example: "externalTransferAllowed"

Name of the restriction in PascalCase. Possible values: externalTransferAllowed, urgentTransferAllowed

restrictionPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
validFrom
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

validUntil
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

Array of objects (Limit)
Array
name
string [ 1 .. 60 ] characters
Example: "creditLimit"

Name of the limit in PascalCase. Possible values: overdraft, creditLimit

limitTypeCode
string (LimitType) <= 35 characters
Example: "DirectDebit"

Specifies the type of risk management limit. Possible ISO 20020 compliant values are: Bilateral, NetBilateral, IndirectBilateral, Global, MandatoryBilateral, DiscretionaryBilateral, DirectDebit, SingleCustomerDirectDebit, SingleFinancialInstitutionDirectDebit, TotalDailyCustomerDirectDebit, TotalDailyFinancialInstitutionDirectDebit, AutoCollateralisation, UnsecuredCredit, ExternalGuarantee

channelType
string [ 1 .. 30 ] characters

Channel type for which this limit applies. Possible values: Online, ATM

amount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount limit

percentage
string (Percentage) <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Value expressed as a percentage, for example, 0.7 is %70; 0.3333 is %33.33. total number of digits: 11 number of digits in fractional part: 10 Max Value: 1

validFrom
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

validUntil
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

usedAmount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount limit used

usedPercentage
string (Percentage) <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Value expressed as a percentage, for example, 0.7 is %70; 0.3333 is %33.33. total number of digits: 11 number of digits in fractional part: 10 Max Value: 1

status
string (LimitStatus) <= 35 characters
Example: "Requested"

Specifies the current status of a limit. Possible ISO 20020 compliant values are: Enabled, Disabled, Deleted, Requested

object (Frequency)

Specifies an event frequency

object (StatementSettings)

Specifies how often statements will be sent, in which format, to which address.

object (Frequency)

Specifies an event frequency

unit
string [ 1 .. 35 ] characters
Example: "Monthly"

Specifies a frequency. Some ISO 20022 compliant values are: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Adhoc, IntraDay, Overnight, TenDays, Fortnightly, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Hourly, TriAnnual, Bimonthly, OnDemand, Shift, TwiceAWeek, XDays, XMonths, XYears.

value
integer <= 999

Number of units, for XDays, XMonths, XYears.

communicationMethod
string (CommunicationChannelName) [ 1 .. 35 ] characters
Example: "Email"

Channel used to communicate with a party. Possible Values: Email, Fax, File, Online, PostalService, LiveSupport, ATM, IVR, Kiosk, Mobile, OnlineBanking, Phone, SMS, Card, InPerson.

format
string (DocumentFormat) [ 1 .. 35 ] characters
Example: "PDF"

Specifies a choice of format for a document. Possible Values: PDF, HTML

category
string (StatementCategory) [ 1 .. 36 ] characters
Example: "BalanceSheet"

Used to categorize the statement. Possible Values: BalanceSheet, ProfitAndLoss

subcategory
string (StatementSubcategory) [ 1 .. 36 ] characters
Example: "Cash"

Used to subcategorize the statement. Possible Values: Cash, AccountReceivable, Inventory, CurrentAssets

supplementaryData
object (SupplementaryData)

Additional information that cannot be captured in the structured elements and/or any other specific block. If this information need to be converted in ISO Messages, must be ISO 20022 compliant: it requires development of a compliant message extension model and its components must be registered in the ISO 20022 Data Dictionary. https://www.iso20022.org/catalogue-messages/additional-content-messages/supplementary-data

Responses

Request samples

Content type
application/json
{
  • "servicerBranchId": "SEA_1",
  • "accountType": "Current",
  • "accountOwnershipType": "Owner",
  • "productId": "PD_CA_0002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "initialAmount": "100",
  • "contract": {
    },
  • "parties": [
    ],
  • "maturityDate": "2022-04-17",
  • "relatedAccounts": [
    ],
  • "referenceAccount": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "statementSettings": {
    },
  • "supplementaryData": { }
}

Response samples

Content type
application/json
{
  • "servicerBranchId": "SEA_1",
  • "accountType": "Current",
  • "accountOwnershipType": "Owner",
  • "productId": "PD_CA_0002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "initialAmount": "100",
  • "contract": {
    },
  • "parties": [
    ],
  • "maturityDate": "2022-04-17",
  • "relatedAccounts": [
    ],
  • "referenceAccount": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "statementSettings": {
    },
  • "supplementaryData": { },
  • "status": "Pending",
  • "statusDateAndTime": "2022-04-17T08:00:00Z",
  • "substatus": "string",
  • "openDate": "2022-04-17",
  • "closeDate": "2022-04-17",
  • "accountNumber": "012345678",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "accountId": "0dd926fe-1ca2-11ed-861d-0242ac120002"
}

Retrieves an Account

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 36 ] characters
Example: 0dd926fe-1ca2-11ed-861d-0242ac120002

Account Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "accountNumber": "012345678",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "servicerBranchId": "SEA_1",
  • "accountType": "Current",
  • "accountOwnershipType": "Owner",
  • "productId": "PD_CA_0002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "initialAmount": "100",
  • "contract": {
    },
  • "parties": [
    ],
  • "maturityDate": "2022-04-17",
  • "relatedAccounts": [
    ],
  • "referenceAccount": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "statementSettings": {
    },
  • "supplementaryData": { },
  • "status": "Pending",
  • "statusDateAndTime": "2022-04-17T08:00:00Z",
  • "substatus": "string",
  • "openDate": "2022-04-17",
  • "closeDate": "2022-04-17",
  • "balances": [
    ],
  • "transactions": [
    ],
  • "accountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "relatedCards": [
    ],
  • "standingOrders": [
    ]
}

Updates an Account

Use the JSON Merge Patch standard https://tools.ietf.org/html/rfc7396

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 36 ] characters
Example: 0dd926fe-1ca2-11ed-861d-0242ac120002

Account Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Request Body schema: application/merge-patch+json
accountNumber
string (AccountNumber) <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN).

Array of objects (RoutingNumber)
Array
number
string (ABANumber) = 9 characters
Example: "012345678"

The routing number (sometimes referred to as an ABA routing number, regarding the American Bankers Association) is a sequence of nine digits used by banks to identify specific financial institutions within the United States.

routingNumberType
string (RoutingNumberType) = 9 characters
Example: "ACH"

Different types of payments may require different bank routing numbers. Some possible values: ACH, WIRE, ElectronicCheck, PaperCheck

Array of objects (AccountIdentification)
Array
identification
string [ 1 .. 34 ] characters

Identification assigned by an institution.

schemeName
string [ 1 .. 35 ] characters
Example: "BBANIdentifier"

Name of the identification scheme, in PascalCase. Possible ISO 20022 compliant values names are: IssuerIdentificationNumber, BBANIdentifier, CHIPSUniversalIdentifier, UPICIdentifier, IBANIdentifier

issuer
string [ 1 .. 35 ] characters

Entity that assigns the identification.

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: "SEA_1"

Identification of the account servicer institution at branch level or operation level.

accountType
required
string (AccountType) [ 1 .. 35 ] characters
Example: "Current"

Type of the account. Some possible ISO 20022 compliant values are: Current, CardAccount, CashPayment, Charges, CashIncome, Commission, ClearingParticipantSettlementAccount, LimitedLiquiditySavingsAccount, MarginalLending, MoneyMarket, NonResidentExternal, Overdraft, OverNightDeposit, Settlement, Salary, Savings, Tax, TransactingAccount, CashTrading, VirtualAccount, Checking, CreditCard, DebitCard, Universal, Investment, EpurseCard, CertificateOfDeposit, MoneyMarketChecking, RetirementAccount, StockOrBond, PrePaid, FleetCard, Cash, DebitAccount, CreditAccount, Benefit, HealthSavingsAccount, FlexibleSpendingAccount, ForBenefitOf, Estate

accountOwnershipType
required
string (AccountOwnershipType) [ 1 .. 35 ] characters
Example: "Owner"

Specifies the type of account ownership. Possible ISO 20022 compliant values names are: JointAccountWithSurvivorshipRights, JointAccountInCommon, CustodialAccount, SingleOwnerAccount, JointAccount, Corporation, FormalPartnership, FormalTrust, Nominee, NonProfitOrganisation, OtherNonIndividual, EUResidualEntity, GovernmentOrganization, LimitedLiabilityCompany, RegisteredInvestmentCompany, Entrepreneurial, Unincorporated, LimitedPartnership, BareOwner, Owner, Usufructuary, Fiduciary

productId
string (ProductId) [ 1 .. 36 ] characters
Example: "PD_CA_0002"
name
string (AccountName) [ 1 .. 70 ] characters
Example: "Hermes PD_CA 0002"

Name of the account. It provides an additional means of identification, and is designated by the account servicer in agreement with the account owner.

accountPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
currency
string (CurrencyCode) = 3 characters ^([A-Z]{3})?$
Example: "USD"

Three contiguous letters for the representation of currencies and funds. Valid currency codes are registered with the ISO 4217 Maintenance Agency.

initialAmount
string (AmountInCents) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

object (AccountContract)

Account contractual details between the owners and the account servicer.

documentId
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
documentReference
string [ 1 .. 35 ] characters

Document location.

version
string [ 1 .. 18 ] characters

Document version indentification.

signOffDate
string <date>
Example: "2022-04-17"

Signoff date of the document.

issueDate
string <date>
Example: "2022-04-17"

Issue date of the document.

purpose
string [ 1 .. 35 ] characters

Specifies the function of the document.

fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

object (Jurisdiction)

Area with a set of laws under the control of a system which are different from neighbouring areas

countrySubdivision
string [ 1 .. 35 ] characters
Example: "Oregon"
townName
string [ 1 .. 35 ] characters
Example: "Tualatin"
country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

targetClosingDate
string <date>
Example: "2022-04-17"

Date on which the account and related services are expected to cease for the account owner.

targetGoLiveDate
string <date>
Example: "2022-04-17"

Date on which the account and related services are expected to be operational for the account owner.

object

Agreement that governs a contract agreed between parties.

documentId
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
documentReference
string [ 1 .. 35 ] characters

Document location.

version
string [ 1 .. 18 ] characters

Document version indentification.

signOffDate
string <date>
Example: "2022-04-17"

Signoff date of the document.

issueDate
string <date>
Example: "2022-04-17"

Issue date of the document.

purpose
string [ 1 .. 35 ] characters

Specifies the function of the document.

Array of objects (InterestCalculation)
Array
fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

name
string (InterestName) [ 1 .. 35 ] characters
Example: "LatePayment"

Name of the interest that applies to the account. For instance, Overdraft, LatePayment.

dayCountBasis
string (InterestComputationMethod) [ 1 .. 50 ] characters
Example: "30360AmericanBasicRule"

Specifies the method used to compute accruing interest of a financial instrument. Some ISO 20022 compliant values are: 30360AmericanBasicRule, IC30365, IC30Actual, Actual360, Actual365Fixed, ActualActualICMA, IC30E360orEuroBondBasismodel1, ActualActualISDA, Actual365LorActuActubasisRule, ActualActualAFB, IC30360ICMAor30360basicrule, IC30E2360orEurobondbasismodel2, IC30E3360orEurobondbasismodel3, Actual365NL, Narrative, ActualActualUltimo, IC30EPlus360, Actual364, Business252, Actual360NL, OneOne, Other

rate
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

The actual interest rate used for the payment of the interest for the specified interest period.

interestRateType
string (InterestRateType) [ 1 .. 35 ] characters
Example: "Fixed"

Specifies the type of interest rate. Some ISO 20022 compliant values are: Fixed, Forfeit, Variable, Scheduled, Unscheduled, Discount, FixedRateUnderlyingExposureForLife, FixedRateUnderlyingExposureWithCompulsoryFutureSwitchToFloating, FixedWithFuturePeriodicResets, FloatingLinkedToIndex, FloatingRateUnderlyingExposureForLife, FloatingRateUnderlyingExposureWithCap, FloatingRateUnderlyingExposureWithFloor, FloatingRateUnderlyingExposureWithFloorAndCap, Modular, ObligorSwapped, Other, SwicthOptionality

object (Frequency)

Specifies an event frequency

object (Frequency)

Specifies an event frequency

object (VariableInterestCalculation)

Specifies the parameters to be used for variable interest.

Array of objects (ChargeCalculation)
Array
fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

name
string (ChargeName) [ 1 .. 60 ] characters
Example: "cardLatePayment"

Name of the charge calculation in PascalCase. Possible values: cardLatePayment, cashAdvance

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount charged for the service.

rate
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Rate applied on a basis amount to calculate the service charge.

chargeType
string (ChargeType) [ 1 .. 35 ] characters
Example: "ManagementFee"

Type of service for which a charge is asked or paid. Some possible ISO 20022 compliant values are: BrokerageFee, Commission, BackEndLoad, FrontEndLoad, Switch, DilutionLevy, Discount, ManagementFee, TransferFee, MatchingFees, PostageCharge, RegulatoryFee, ShippingCharge, ServiceProvisionFee, SpecialConcessions, PartAcquis, Penalty, ContingencyDeferredSalesCharge, Other, Equalisation, CorrespondentBankCharge, Premium, Initial, AdvisoryFee, CustodyFee, PublicationFee, AccountingFee, SignatureService, StorageAtDestination, StorageAtOrigin, Packaging, PickUp, DangerousGoodsFee, SecurityCharge, InsurancePremium, CollectFreight, ClearanceAndHandlingAtOrigin, ClearanceAndHandlingAtDestination, AirWayBillFee, TransportCharges, UCITSCommission, SpeciallyAgreedFrontEndLoad, ADRFee, IssuanceCancellationFee, MiscellaneousFee, IssuanceFee.

calculationBasis
string (CalculationBasis) [ 1 .. 35 ] characters
Example: "Monthly"

Specifies the calculation basis of a charge or fee. Some possible ISO 20022 compliant values are: Average, Daily, Other, Monthly, Annual

bearerType
string (ChargeBearerType) [ 1 .. 35 ] characters
Example: "Shared"

Specifies which party(ies) will pay charges due for processing of the instruction. BorneByDebtor, BorneByCreditor, Shared, FollowingServiceLevel

maximumAmount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Maximum amount of money asked or paid for the charge.

object (InterestCalculation)

Set of parameters used to calculate an interest.

required
Array of objects (AccountParty)
Array
partyId
required
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
partyType
required
string (PartyType)
Example: "Person"

Possible values are: Person, Organization. Also other types of servicer internal entities: ServicerOfficer

partyAccountRole
required
string (AccountPartyRole) [ 1 .. 35 ] characters
Example: "AccountOwner"

Type of the account. Some possible ISO 20022 compliant values are: AccountOwner, LiquidityManager, LimitManager, PaymentManager, Reader, BackupManager, SettlementManager, FundManagementCompany, TransferAgent, FundAccountant, Registrar, InvestmentManager, Custodian, Auditor, PayingAgent, CashCorrespondent, DataProvider, FinalAgent, Investor, FirstAgent, Intermediary, Distributor, Concentrator, UnderlyingClient1, UnderlyingClient2, TransmittingAgent, FundBroker, FinancialAdvisor, ContactPersonAtInstructingPartyInstitution, ContactPersonAtExecutingPartyInstitution, NameOfAgentToOrder, PrimeBroker, Internal, LegalGuardian, DecisionMaker, Guarantor, LoanLender, LoanBorrower, LoanCoBorrower, PrimaryOwner, Trustee, CustodianForMinor, Nominee, SecondaryOwner, Executor, Beneficiary, PrimaryServicerOfficer, SecondaryServicerOfficer.

maturityDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

Array of objects (RelatedAccount)
Array
accountRelationType
string (AccountRelationType)

Account relation role. Possible values are: Parent, Child, Group.

accountId
string (AccountId) [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Identification assigned by the account service institution (Servicer).

accountNumber
string (AccountNumber) <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN).

referenceAccount
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Account used as a reference for the account opening. Could be used to provide initial funds.

Array of objects (Restriction)
Array
name
string [ 1 .. 60 ] characters
Example: "externalTransferAllowed"

Name of the restriction in PascalCase. Possible values: externalTransferAllowed, urgentTransferAllowed

restrictionPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
validFrom
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

validUntil
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

Array of objects (Limit)
Array
name
string [ 1 .. 60 ] characters
Example: "creditLimit"

Name of the limit in PascalCase. Possible values: overdraft, creditLimit

limitTypeCode
string (LimitType) <= 35 characters
Example: "DirectDebit"

Specifies the type of risk management limit. Possible ISO 20020 compliant values are: Bilateral, NetBilateral, IndirectBilateral, Global, MandatoryBilateral, DiscretionaryBilateral, DirectDebit, SingleCustomerDirectDebit, SingleFinancialInstitutionDirectDebit, TotalDailyCustomerDirectDebit, TotalDailyFinancialInstitutionDirectDebit, AutoCollateralisation, UnsecuredCredit, ExternalGuarantee

channelType
string [ 1 .. 30 ] characters

Channel type for which this limit applies. Possible values: Online, ATM

amount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount limit

percentage
string (Percentage) <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Value expressed as a percentage, for example, 0.7 is %70; 0.3333 is %33.33. total number of digits: 11 number of digits in fractional part: 10 Max Value: 1

validFrom
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

validUntil
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

usedAmount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount limit used

usedPercentage
string (Percentage) <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Value expressed as a percentage, for example, 0.7 is %70; 0.3333 is %33.33. total number of digits: 11 number of digits in fractional part: 10 Max Value: 1

status
string (LimitStatus) <= 35 characters
Example: "Requested"

Specifies the current status of a limit. Possible ISO 20020 compliant values are: Enabled, Disabled, Deleted, Requested

object (Frequency)

Specifies an event frequency

object (StatementSettings)

Specifies how often statements will be sent, in which format, to which address.

object (Frequency)

Specifies an event frequency

unit
string [ 1 .. 35 ] characters
Example: "Monthly"

Specifies a frequency. Some ISO 20022 compliant values are: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Adhoc, IntraDay, Overnight, TenDays, Fortnightly, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Hourly, TriAnnual, Bimonthly, OnDemand, Shift, TwiceAWeek, XDays, XMonths, XYears.

value
integer <= 999

Number of units, for XDays, XMonths, XYears.

communicationMethod
string (CommunicationChannelName) [ 1 .. 35 ] characters
Example: "Email"

Channel used to communicate with a party. Possible Values: Email, Fax, File, Online, PostalService, LiveSupport, ATM, IVR, Kiosk, Mobile, OnlineBanking, Phone, SMS, Card, InPerson.

format
string (DocumentFormat) [ 1 .. 35 ] characters
Example: "PDF"

Specifies a choice of format for a document. Possible Values: PDF, HTML

category
string (StatementCategory) [ 1 .. 36 ] characters
Example: "BalanceSheet"

Used to categorize the statement. Possible Values: BalanceSheet, ProfitAndLoss

subcategory
string (StatementSubcategory) [ 1 .. 36 ] characters
Example: "Cash"

Used to subcategorize the statement. Possible Values: Cash, AccountReceivable, Inventory, CurrentAssets

supplementaryData
object (SupplementaryData)

Additional information that cannot be captured in the structured elements and/or any other specific block. If this information need to be converted in ISO Messages, must be ISO 20022 compliant: it requires development of a compliant message extension model and its components must be registered in the ISO 20022 Data Dictionary. https://www.iso20022.org/catalogue-messages/additional-content-messages/supplementary-data

status
string (AccountStatus) [ 1 .. 35 ] characters
Example: "Pending"

Specifies the current state of an account. Possible ISO 20022 compliant values names are: Enable,
Disable, Deleted, Pending, Form.

statusDateAndTime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
substatus
string [ 1 .. 35 ] characters

Status defined by the account servicer.

openDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

closeDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

Array of objects (Balance)
Array
balanceName
string (BalanceName) [ 1 .. 17 ] characters
Example: "Available"

Specifies the nature of the balance. Possible ISO 20022 compliant value names are: Current, Available, Pending, Blocked.

amount
string (AmountInCents) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

currency
string (CurrencyCode) = 3 characters ^([A-Z]{3})?$
Example: "USD"

Three contiguous letters for the representation of currencies and funds. Valid currency codes are registered with the ISO 4217 Maintenance Agency.

calculationDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Specifies the date and time at which the balance is calculated.

Array of objects (NumberOfTransactions)
Array
codeType
string [ 1 .. 50 ] characters
Example: "DetailBAI"

Name of the code in PascalCase form. Possible values are: DetailBAI, SummaryBAI, MT940

codeName
string [ 1 .. 50 ] characters
Example: "Incoming Wire"

Code value description

code
string [ 1 .. 35 ] characters
Example: "195"

Code value to identify the type of transaction.

status
string (TransactionStatus) [ 1 .. 35 ] characters
Example: "Booked"

Specifies the status of an entry on the books of the account servicer. Some possible ISO 20022 compliant values are: Booked, Future, Information, Pending.

number
integer

Number of individual transactions.

controlSum
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Total of all individual amounts.

accountId
string (AccountId) [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Identification assigned by the account service institution (Servicer).

Array of objects (RelatedCard)

Payment cards related to the account. Debit cards, for loans or current accounts. Credit cards, for credit card accounts.

Array
cardId
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
cardHolderName
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

cardHolderType
string (CardHolderType) [ 1 .. 35 ] characters
Example: "Primary"

Specifies the card holder type of payment card. Possible Values: Primary, Additional

Array of objects (StandingOrder)

Instructions given by an account holder to an account servicer to make regular transfers on given dates to the same beneficiary.

Array
standingOrderId
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Unique and unambiguous identification for a standing order, as assigned by the account servicer or the account owner.

object

Dates during which the standing order is in effect.

orderSequence
integer
Example: 1

Specifies the sequence in which the system will execute the liquidity transfers standing order within the set.

object (CreditTransferDetail)

Further details on the credit transfer instruction

object (Payment)
object

Dates during which the standing order is in effect

eventDescription
string [ 1 .. 1025 ] characters
Example: "This is a description."

Describes the event which triggers the exercise of a standing order for instance the reception of a report or the closing of an account.

day
integer <= 31
Example: 30

Specifies the day for the time event.

object

Specifies the hour of the day for the time event.

status
string (StandingOrderStatus) [ 1 .. 36 ] characters
Example: "Months"

Specifies the status of a standing order request. Possible values: Cancelled, Pending, Sent.

statusDateAndTime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
cancellationReason
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."

Responses

Request samples

Content type
application/merge-patch+json
{
  • "accountNumber": "012345678",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "servicerBranchId": "SEA_1",
  • "accountType": "Current",
  • "accountOwnershipType": "Owner",
  • "productId": "PD_CA_0002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "initialAmount": "100",
  • "contract": {
    },
  • "parties": [
    ],
  • "maturityDate": "2022-04-17",
  • "relatedAccounts": [
    ],
  • "referenceAccount": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "statementSettings": {
    },
  • "supplementaryData": { },
  • "status": "Pending",
  • "statusDateAndTime": "2022-04-17T08:00:00Z",
  • "substatus": "string",
  • "openDate": "2022-04-17",
  • "closeDate": "2022-04-17",
  • "balances": [
    ],
  • "transactions": [
    ],
  • "accountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "relatedCards": [
    ],
  • "standingOrders": [
    ]
}

Response samples

Content type
application/json
{
  • "accountNumber": "012345678",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "servicerBranchId": "SEA_1",
  • "accountType": "Current",
  • "accountOwnershipType": "Owner",
  • "productId": "PD_CA_0002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "initialAmount": "100",
  • "contract": {
    },
  • "parties": [
    ],
  • "maturityDate": "2022-04-17",
  • "relatedAccounts": [
    ],
  • "referenceAccount": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "statementSettings": {
    },
  • "supplementaryData": { },
  • "status": "Pending",
  • "statusDateAndTime": "2022-04-17T08:00:00Z",
  • "substatus": "string",
  • "openDate": "2022-04-17",
  • "closeDate": "2022-04-17",
  • "balances": [
    ],
  • "transactions": [
    ],
  • "accountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "relatedCards": [
    ],
  • "standingOrders": [
    ]
}

Retrieves Account Balances

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 36 ] characters
Example: 0dd926fe-1ca2-11ed-861d-0242ac120002

Account Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "accountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "accountNumber": "012345678",
  • "balances": [
    ]
}

Retrieves Account Identifiers

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 36 ] characters
Example: 0dd926fe-1ca2-11ed-861d-0242ac120002

Account Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "accountNumber": "012345678",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "accountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "accountType": "Current"
}

Retrieves Account Parties

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 36 ] characters
Example: 0dd926fe-1ca2-11ed-861d-0242ac120002

Account Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "accountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "accountNumber": "012345678",
  • "parties": [
    ]
}

Retrieves Account Owners

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 36 ] characters
Example: 0dd926fe-1ca2-11ed-861d-0242ac120002

Account Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "accountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "accountNumber": "012345678",
  • "owners": [
    ]
}

Retrieves Account Cards

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 36 ] characters
Example: 0dd926fe-1ca2-11ed-861d-0242ac120002

Account Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "accountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "accountNumber": "012345678",
  • "cards": [
    ]
}

Retrieves Account Standing Orders

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 36 ] characters
Example: 0dd926fe-1ca2-11ed-861d-0242ac120002

Account Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "accountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "accountNumber": "012345678",
  • "standingOrders": [
    ]
}

Request Standing Order Cancellation

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 36 ] characters
Example: 0dd926fe-1ca2-11ed-861d-0242ac120002

Account Identification

standingOrderId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Standing Order Identification

header Parameters
idempotencyId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Request Body schema: application/json
cancellationReason
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."

Responses

Request samples

Content type
application/json
{
  • "cancellationReason": "This is a description."
}

Response samples

Content type
application/json
{
  • "standingOrderId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "period": {
    },
  • "orderSequence": 1,
  • "paymentInstruction": {
    },
  • "payment": {
    },
  • "frequency": {
    },
  • "eventDescription": "This is a description.",
  • "day": 30,
  • "timeOfDay": {
    },
  • "status": "Months",
  • "statusDateAndTime": "2022-04-17T08:00:00Z",
  • "cancellationReason": "This is a description."
}

Parties

Person and Organization Management

Retrieves a Person

Authorizations:
jwtopenIdConnect
query Parameters
name.inc
string

The person name includes the substring provided.

lastName.eq
string (PartyName) [ 1 .. 350 ] characters
Example: lastName.eq=Jane Birkin

Name by which a party is known and which is usually used to identify that party.

firstName.eq
string (PartyName) [ 1 .. 350 ] characters
Example: firstName.eq=Jane Birkin

Name by which a party is known and which is usually used to identify that party.

birthDate.eq
string <date> (Date)
Example: birthDate.eq=2022-04-17

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

phoneNumber.eq
string (PhoneNumber) ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$
Example: phoneNumber.eq=+1-415-731359

Any phone number equals to.

accountNumber.eq
string (AccountNumber) <= 30 characters
Example: accountNumber.eq=012345678

The account number or Basic Bank Account Number (BBAN).

tin.eq
string
ssn.eq
string

Social Security Number

ssn.last4
string

Social Security Number last four digits.

email.eq
string

Email equals to

addressLine.inc
string

Any address line of any postal address includes substring

postCode.eq
string

Any postal address with post code equals to

country.eq
string

Any postal address with Country code equals to

countrySubDivision.inc
string

Any postal address with country subdivision includes substring

townName.inc
string

Any postal address with town name includes substring

personId.eq
string (Id) [ 1 .. 36 ] characters
Example: personId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002

System id equals to

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a Person

Authorizations:
jwtopenIdConnect
header Parameters
idempotencyId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Request Body schema: application/json
uSDocumentedIndicator
boolean
Array of objects (PersonIdentification)
Array
number
string [ 1 .. 35 ] characters
Example: "123-45-6789"

Unique and unambiguous identification of a person.

schemeName
string [ 1 .. 35 ] characters
Example: "SocialSecurityNumber"

Name of the identification scheme in PascalCase form. Possible ISO Compliant values are: AlienRegistrationNumber PassportNumber CustomerIdentificationNumber DriversLicenseNumber EmployeeIdentificationNumber NationalIdentityNumber SocialSecurityNumber TelephoneNumber TaxIdentificationNumber PersonCommercialIdentification

issuer
string
Example: "US"

Entity that assigns the identification.

issueDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

expirationDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

name
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

shortName
string (PartyShortName) [ 1 .. 35 ] characters
Example: "Jane"

Short name or nickname by which a party is known and which is usually used to identify that party.

Array of objects (RelatedParty)
Array
partyId
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
partyType
string (PartyType)
Example: "Person"

Possible values are: Person, Organization. Also other types of servicer internal entities: ServicerOfficer

partyName
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

partyRelationType
string (PartyRelationType) [ 1 .. 40 ] characters
Example: "Owner"

Type of relation between parties. Some ISO 20022 compliant values for Organizations are: RepresentativeOfficer, ResponsibleParty, Owner, PrimaryContact, SecondaryContact. For Trusts: Trustor, Trustee. Between organizations: ParentOrganization, Branch. Between persons (organizations) and internal entities: PrimaryServicerOfficer, SecondaryServicerOfficer. Between financial institutions: AffiliateFinancialInstitution, HoldingCompany.

ownershipPercentage
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Company Ownership Percentage. If the relation Type is Owner the ownership percentage could be added.

Array of objects (PostalAddress)
Array
addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible ISO Compliant values are: Postal, POBox, Residential, Permanent, Temporary, Business.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible ISO Compliant values are: MailTo, DeliveryTo, Billing, PlaceOfOperation, PlaceOfRegistration.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion y is primary.

department
string [ 1 .. 70 ] characters
Example: "A"

Identification of a division of a large organisation or building.

subDepartment
string [ 1 .. 70 ] characters
Example: "B"

Identification of a sub-division of a large organisation or building.

streetName
string [ 1 .. 70 ] characters
Example: "First Street"

Name of a street or thoroughfare.

firstCrossStreetName
string [ 1 .. 70 ] characters

Name of a the first cross street.

secondCrossStreetName
string [ 1 .. 70 ] characters
Example: "Second Street"

Name of a the second cross street.

buildingNumber
string [ 1 .. 16 ] characters
Example: "11407"

Number that identifies the position of a building or house on a street.

buildingName
string [ 1 .. 35 ] characters
Example: "Tall Tower"

Name of the building or house.

floor
string [ 1 .. 70 ] characters
Example: "20"

Floor or storey within a building.

postBox
string [ 1 .. 16 ] characters
Example: "MY779"

Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for.

room
string [ 1 .. 70 ] characters
Example: "22"

Building room number.

postCode
string [ 1 .. 16 ] characters
Example: "97062-6884"

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string [ 1 .. 35 ] characters
Example: "Tualatin"

Name of a built-up area, with defined boundaries, and a local government.

townLocationName
string [ 1 .. 35 ] characters
Example: "Clackamas"

Specific location name within the town.

districtName
string [ 1 .. 35 ] characters
Example: "Washington"

Identifies a subdivision within a country sub-division.

countrySubDivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

countrySubDivisionCode
string (CountrySubdivisionCode) ^[A-Z]{2,2}\-[0-9A-Z]{1,3}
Example: "AR-B"

Code to identify a name of a unit resulting from the division of a country, dependency, or other area of special geopolitical interest contained in ISO 3166-1, on the basis of country names obtained from the United Nations (ISO 3166-2: Country subdivision code).

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

addressLine
Array of strings[ items [ 1 .. 70 ] characters ]
Example: ["11407 Sw Amu st, Suite MY777"]

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

residenceType
string [ 1 .. 35 ] characters
Example: "Domestic"

Specifies the type of residence where the party has its permanent home or principal establishment. Possible ISO Complaian values are: Domestic, Foreign, Mixed

object (TaxPartyInformation)

Taxation parameters which apply to an individual person or to an organization.

tIN
string
Example: "778-62-8144"

A Taxpayer Identification Number

taxIdType
string [ 1 .. 30 ] characters
Example: "SSN"

Identifies what type of tax ID is in the TIN field. Possible Values: SocialSecurityNumber (SSN), EmployerIdentificationNumber (EIN), IndividualTaxpayerIdentificationNumber (ITIN), TaxpayerIdentificationNumber forPendingAdoptions (ATIN), Preparer TaxpayerIdentificationNumber (PTIN), ForeignTaxID

reportingIndicator
boolean

Whether the financial income for this party should be reported to the U.S. government (IRS) when related to an account in a way which requires reporting (for example, primary, joint ownership). Defaults to true if not specified.

tinStatus
string
Example: "Valid"

'The tax ID has been verified by the IRS as valid. Possible values: Valid, NotValid, NotVerified, IRSWarning, NotVerified, TINApplied.

taxStatus
string
Example: "Valid"

Exempt, ExemptExpired, VoluntaryWithholding, Chapter3, Chapter4.

Array of objects (TaxForm)
Array
formName
string [ 1 .. 10 ] characters
Example: "W-9"
cerfiticationDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

expirationDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

Array of objects (TaxRegulation)
Array
name
string [ 1 .. 35 ] characters
Example: "Chapter4"
section
string [ 1 .. 10 ] characters
Example: "1471"

String that represent the section number.

Array of objects (WithholdingTax)
Array
withholdingTaxType
string (WithholdingTaxType) [ 1 .. 35 ] characters
Example: "NonResidentAlienTax"

Type of Withholding. Possible Values: ForeignAccountTaxComplianceAct, NonResidentAlienTax, BackUpWithholding, VoluntaryWithholding, Federal, State, Local, W-4.

withholdingRate
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Rate applied on a basis amount to calculate the withholding.

withholdingAmount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Withholding amount.

nRAIndicator
boolean

Indicates whether the party is a Non-residen alien.

countrySubDivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

countrySubDivisionCode
string (CountrySubdivisionCode) ^[A-Z]{2,2}\-[0-9A-Z]{1,3}
Example: "AR-B"

Code to identify a name of a unit resulting from the division of a country, dependency, or other area of special geopolitical interest contained in ISO 3166-1, on the basis of country names obtained from the United Nations (ISO 3166-2: Country subdivision code).

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

supplementaryData
object (SupplementaryData)

Additional information that cannot be captured in the structured elements and/or any other specific block. If this information need to be converted in ISO Messages, must be ISO 20022 compliant: it requires development of a compliant message extension model and its components must be registered in the ISO 20022 Data Dictionary. https://www.iso20022.org/catalogue-messages/additional-content-messages/supplementary-data

object (PowerOfAttorney)

Document that transfers specific rights from a party to a person.

documentId
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
documentReference
string [ 1 .. 35 ] characters

Document location.

version
string [ 1 .. 18 ] characters

Document version indentification.

signOffDate
string <date>
Example: "2022-04-17"

Signoff date of the document.

issueDate
string <date>
Example: "2022-04-17"

Issue date of the document.

purpose
string [ 1 .. 35 ] characters

Specifies the function of the document.

fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

object (Jurisdiction)

Area with a set of laws under the control of a system which are different from neighbouring areas

countrySubdivision
string [ 1 .. 35 ] characters
Example: "Oregon"
townName
string [ 1 .. 35 ] characters
Example: "Tualatin"
country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

authorizedPerson
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Person which is the holder of the power of attorney.

authorizedAccount
string [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Specifies the account on which the power of attorney applies.

supplementaryData
object (SupplementaryData)

Additional information that cannot be captured in the structured elements and/or any other specific block. If this information need to be converted in ISO Messages, must be ISO 20022 compliant: it requires development of a compliant message extension model and its components must be registered in the ISO 20022 Data Dictionary. https://www.iso20022.org/catalogue-messages/additional-content-messages/supplementary-data

object (PartySystemSettings)

System configurations at Party level.

Array of objects (CommunicationChannel)
Array
channel
string (CommunicationChannelName) [ 1 .. 35 ] characters
Example: "Email"

Channel used to communicate with a party. Possible Values: Email, Fax, File, Online, PostalService, LiveSupport, ATM, IVR, Kiosk, Mobile, OnlineBanking, Phone, SMS, Card, InPerson.

channelIdentification
string (CommunicationChannelIdentification) [ 1 .. 128 ] characters
Example: "011-02010020202"

Communication value such as phone number or email address.

codeWord
string

A party is asked for a codeword to verify their identity trought a communication channel

alertIndicator
any

Indicates whether the channel is used for enterprise alerts

Array of objects (Restriction)

Access and operation restrictions at Party level.

Array
name
string [ 1 .. 60 ] characters
Example: "externalTransferAllowed"

Name of the restriction in PascalCase. Possible values: externalTransferAllowed, urgentTransferAllowed

restrictionPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
validFrom
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

validUntil
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

object (PlaceAndDateOfBirth)

Date and place of birth of a person.

countrySubdivision
string [ 1 .. 35 ] characters
Example: "Oregon"
townName
string [ 1 .. 35 ] characters
Example: "Tualatin"
country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

birthDate
string <date>
Example: "2022-04-17"

Date on which a person is born.

signature
string <byte> (DigitalSignature) [ 1 .. 13654 ] characters

Binary data of 10K maximum.

object (PersonContactDetails)

Specifies the contact details of a person.

namePrefix
string [ 1 .. 35 ] characters

Specifies the terms used to formally address a person, in PascalCase form. Possible ISO compliant values are:
Doctor, Madam, Miss, Mister, GenderNeutral

name
string [ 1 .. 350 ] characters
Example: "Jane Birkin"

Preferred name to contact the person

Array of objects (Phone)
Array
number
string (PhoneNumber) ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$
Example: "+1-415-731359"

The collection of information which identifies a specific phone or FAX number as defined by telecom services.

extension
string <= 5 characters

Phone Number Extension.

phoneType
string [ 1 .. 35 ] characters

Type of phone address. Possible values are:
Mobile, Landline, Fax.

phonePurpose
string [ 1 .. 35 ] characters

Purpose of the phone address. Possible values are: Business, Personal.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion y is primary.

object (HourOfTheDay)
Array of objects (Email)
Array
emailAddress
string [ 1 .. 2048 ] characters

Address for electronic mail (e-mail).

emailPurpose
string [ 1 .. 35 ] characters
Example: "Statements"

Purpose of the e-mail address. Possible values: Marketing, Statements.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion y is primary.

jobTitle
string (JobTitle) [ 1 .. 35 ] characters
Example: "Head of Documentation"

Title of the function in an organization.

department
string [ 1 .. 35 ] characters
Example: "Sales"

Identification of a division of a large organisation or building.

Array of objects (GenericContact)
Array
channelType
string [ 1 .. 35 ] characters
Example: "Email"

Communication device number or electronic address used for communication: Fax, Email, Mobile, Phone.

identification
string (CommunicationChannelIdentification) [ 1 .. 128 ] characters
Example: "011-02010020202"

Communication value such as phone number or email address.

preferredMethod
string [ 1 .. 35 ] characters
Example: "Email"

Preferred method used to reach the contact, in PascalCase form. Possible ISO compliant values are:
Letter, Email, Phone, Fax, MobileOrCellPhone.

preferredLanguage
string (PreferredLanguage) [ 1 .. 35 ] characters
Example: "English"

Language of the contact person. Names according to the language list provided in the ISO 639-1 codes. Some possible values: Chinese, Spanish, French, English, Japanese, Italian, German.

headOfHousehold
boolean
Example: true

Indicates whether the person pay the costs of supporting a house.

civilStatus
string (CivilStatus) [ 1 .. 17 ] characters
Example: "Single"

Specifies the civil status of a person. Possible ISO 20022 compliant values names are: Single, Married, LegallyDivorced, Divorced, Widow, StableUnion

object (StructuredName)

The structured name is used to initialize the person name with the format

firstName
string [ 1 .. 200 ] characters
Example: "Mary"

Person given first name.

middleName
string [ 1 .. 200 ] characters
Example: "Joe"

Person given middle name.

lastName
string [ 1 .. 200 ] characters
Example: "Smith"

Person surname.

suffix
string [ 1 .. 20 ] characters
Example: "PhD"

A name suffix in the Western English-Language naming tradition, follows a person's full name and provides additional information about the person. Possible Values: PhD, Snr, Jnr.

prefix
string [ 1 .. 20 ] characters
Example: "Dr."

Name prefixes are typically Dr., Mr., Mrs., Ms.

gender
string (Gender) [ 1 .. 36 ] characters
Example: "Female"

Specifies the gender of the person. Possible Values: Female, Male, NonBinary

profession
string (Profession) <= 35 characters
Example: "Artist"

Professional Designation or name of the occupation of a person.

jobTitle
string (JobTitle) [ 1 .. 35 ] characters
Example: "Head of Documentation"

Title of the function in an organization.

residentialStatus
string (ResidentialStatus) [ 1 .. 35 ] characters
Example: "Permanent"

Residential status of an individual. Possible values: Permanent, Resident, NonResident, Rents, Owns

minorIndicator
boolean (MinorIndicator)

Indicates whether the person is a legal minor.

Array of objects (Citizenship)
Array
fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

countryOfResidence
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

object (PersonProfile)

Information to support Know Your Customer (KYC) processes.

riskLevel
string (RiskLevel) [ 1 .. 35 ] characters
Example: "Permanent"

Specifies the customer’s money laundering risk. Possible values: High, Medium, Low.

object (CreditReview)

A credit review is a periodic assessment of an individual’s or businesses' credit profile.

object (Frequency)

Specifies an event frequency

lastReviewDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time if the last credit review.

nextReviewDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time if the next credit review.

creditQuality
string (CreditQuality) [ 1 .. 35 ] characters
Example: "UpperMediumGrade"

Credit quality rating of an issuer or financial obligation. Possible Values: DefaultImminent, ExtremelySpeculative, HighGrade, HighlySpeculative, InDefault, LowerMediumGrade, NonInvestmentGradeSpeculative, Prime, SubstantialRisk, UpperMediumGrade

creditScore
number
creditBureauReportCode
string

Code used for reporting to the credit bureaus. This code is used to report the trade line of a credit account to the credit bureau agencies.

previousFinancialInstitution
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

referredByWhom
string [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

moneyLaunderingCheck
string (MoneyLaunderingCheck)
Example: "AuthorizedCredit"

Specifies the status of money laundering identification procedures. Possible Values: PassedNotChecked, ExemptBelowLimit, ClientMoneyTypeExempt, AuthorizedCredit, PostalOrElectronicPaymentExempt

knowYourCustomerCheck
string (KnowYourCustomerCheckType) [ 1 .. 36 ] characters
Example: "Ordinary"

Specifies the type of Know Your Customer (KYC) or anti-money laundering due diligence to which the investor has been subjected. Possible Values: Ordinary, Simple, Enhanced.

object (TemporalDuration)

Describes a temporal duration.

unit
string [ 1 .. 36 ] characters
Example: "Months"

Unit that describes the duration.

value
integer <= 999

Value of the duration in number of units.

sourceOfWealth
string [ 1 .. 1025 ] characters
Example: "This is a description."

Indicates the main sources of the money.

politicalAffiliation
string

Indicates the political affiliation of the Party. Possible values could be: Democrat, Independent, Republican.

lastContactDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

lastContactChannel
string (CommunicationChannelName) [ 1 .. 35 ] characters
Example: "Email"

Channel used to communicate with a party. Possible Values: Email, Fax, File, Online, PostalService, LiveSupport, ATM, IVR, Kiosk, Mobile, OnlineBanking, Phone, SMS, Card, InPerson.

lostCustomerDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

lostCustomerReason
string (LostCustomerReason) [ 1 .. 35 ] characters
Example: "Deceased"

Possible values are: Competition, Deceased, Dissatisfied, Moved

customerConductClassification
string (CustomerConductClassification) [ 1 .. 35 ] characters

Assessment of the customer’s behaviour at the time of the account opening application. Possible Values: Standard, NonStandard, Reluctant.

familyMedicalInsuranceIndicator
boolean
Example: true

Indicates if the person has family medical insurance coverage available.

object (AmountRange)

Range an amount

minAmount
string (PositiveAmountInCents) <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: 0

maxAmount
string (PositiveAmountInCents) <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: 0

employmentStatus
string (EmploymentStatus)

Represents available individual employment status. Possible Values: Contract, Employed, Homemaker, Retired, SelfEmployed, Student, Temporary, Unemployed.

vIPStatus
string (VIPStatus)
Example: "Elite"

Very Important People Program Status. Possible Values: Novice, Pro, Elite

Array of objects (Employment)
Array
employingPartyName
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

jobTitle
string (JobTitle) [ 1 .. 35 ] characters
Example: "Head of Documentation"

Title of the function in an organization.

employeeTerminationIndicator
boolean
Example: false
object (TemporalDuration)

Describes a temporal duration.

endDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

object (Place)

Town, CountrySubdivision and Country .

object (Regulation0)

Regulation O is a Federal Reserve regulation that places limits and stipulations on the credit extensions a member bank can offer to its executive officers, principal shareholders, and directors.

insider
string (InsiderType) [ 1 .. 35 ] characters
Example: "Director"

Director, Employee, Officer, PrincipalShareholder, Shareholder, Executive.

familyRelationship
string [ 1 .. 40 ] characters
Example: "Owner"

Insider familiar relation. Child, Spouse, Parent, Relative

institutionRelationship
string [ 1 .. 40 ] characters
Example: "Owner"

Relation with the insider financial institution. Possible Values: AffiliateFinancialInstitution, HoldingCompany.

anualIncome
string (AmountInCents) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

object (PartySystemSettings)

System configurations at Party level.

Array of objects (CommunicationChannel)
Array
channel
string (CommunicationChannelName) [ 1 .. 35 ] characters
Example: "Email"

Channel used to communicate with a party. Possible Values: Email, Fax, File, Online, PostalService, LiveSupport, ATM, IVR, Kiosk, Mobile, OnlineBanking, Phone, SMS, Card, InPerson.

channelIdentification
string (CommunicationChannelIdentification) [ 1 .. 128 ] characters
Example: "011-02010020202"

Communication value such as phone number or email address.

codeWord
string

A party is asked for a codeword to verify their identity trought a communication channel

alertIndicator
any

Indicates whether the channel is used for enterprise alerts

Responses

Request samples

Content type
application/json
{
  • "uSDocumentedIndicator": true,
  • "identifiers": [
    ],
  • "name": "Jane Birkin",
  • "shortName": "Jane",
  • "relatedParties": [
    ],
  • "postalAddresses": [
    ],
  • "residenceType": "Domestic",
  • "taxInformation": {
    },
  • "powerOfAttorney": {
    },
  • "supplementaryData": { },
  • "settings": {
    },
  • "restrictions": [
    ],
  • "placeAndDateOfBirth": {
    },
  • "signature": "string",
  • "contact": {
    },
  • "headOfHousehold": true,
  • "civilStatus": "Single",
  • "structuredName": {
    },
  • "gender": "Female",
  • "profession": "Artist",
  • "jobTitle": "Head of Documentation",
  • "residentialStatus": "Permanent",
  • "minorIndicator": true,
  • "citizenships": [
    ],
  • "countryOfResidence": "US",
  • "profile": {
    },
  • "partySettings": {
    }
}

Response samples

Content type
application/json
{
  • "uSDocumentedIndicator": true,
  • "identifiers": [
    ],
  • "name": "Jane Birkin",
  • "shortName": "Jane",
  • "relatedParties": [
    ],
  • "postalAddresses": [
    ],
  • "residenceType": "Domestic",
  • "taxInformation": {
    },
  • "powerOfAttorney": {
    },
  • "supplementaryData": { },
  • "settings": {
    },
  • "restrictions": [
    ],
  • "placeAndDateOfBirth": {
    },
  • "signature": "string",
  • "contact": {
    },
  • "headOfHousehold": true,
  • "civilStatus": "Single",
  • "structuredName": {
    },
  • "gender": "Female",
  • "profession": "Artist",
  • "jobTitle": "Head of Documentation",
  • "residentialStatus": "Permanent",
  • "minorIndicator": true,
  • "citizenships": [
    ],
  • "countryOfResidence": "US",
  • "profile": {
    },
  • "partySettings": {
    },
  • "personId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "status": "Queued"
}

Retrieves a Person

Authorizations:
jwtopenIdConnect
path Parameters
personId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Person Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "uSDocumentedIndicator": true,
  • "identifiers": [
    ],
  • "name": "Jane Birkin",
  • "shortName": "Jane",
  • "relatedParties": [
    ],
  • "postalAddresses": [
    ],
  • "residenceType": "Domestic",
  • "taxInformation": {
    },
  • "powerOfAttorney": {
    },
  • "supplementaryData": { },
  • "settings": {
    },
  • "restrictions": [
    ],
  • "placeAndDateOfBirth": {
    },
  • "signature": "string",
  • "contact": {
    },
  • "headOfHousehold": true,
  • "civilStatus": "Single",
  • "structuredName": {
    },
  • "gender": "Female",
  • "profession": "Artist",
  • "jobTitle": "Head of Documentation",
  • "residentialStatus": "Permanent",
  • "minorIndicator": true,
  • "citizenships": [
    ],
  • "countryOfResidence": "US",
  • "profile": {
    },
  • "partySettings": {
    },
  • "personId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "status": "Queued"
}

Updates a Person

Use the JSON Merge Patch standard https://tools.ietf.org/html/rfc7396

Authorizations:
jwtopenIdConnect
path Parameters
personId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Person Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Request Body schema: application/merge-patch+json
uSDocumentedIndicator
boolean
Array of objects (PersonIdentification)
Array
number
string [ 1 .. 35 ] characters
Example: "123-45-6789"

Unique and unambiguous identification of a person.

schemeName
string [ 1 .. 35 ] characters
Example: "SocialSecurityNumber"

Name of the identification scheme in PascalCase form. Possible ISO Compliant values are: AlienRegistrationNumber PassportNumber CustomerIdentificationNumber DriversLicenseNumber EmployeeIdentificationNumber NationalIdentityNumber SocialSecurityNumber TelephoneNumber TaxIdentificationNumber PersonCommercialIdentification

issuer
string
Example: "US"

Entity that assigns the identification.

issueDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

expirationDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

name
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

shortName
string (PartyShortName) [ 1 .. 35 ] characters
Example: "Jane"

Short name or nickname by which a party is known and which is usually used to identify that party.

Array of objects (RelatedParty)
Array
partyId
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
partyType
string (PartyType)
Example: "Person"

Possible values are: Person, Organization. Also other types of servicer internal entities: ServicerOfficer

partyName
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

partyRelationType
string (PartyRelationType) [ 1 .. 40 ] characters
Example: "Owner"

Type of relation between parties. Some ISO 20022 compliant values for Organizations are: RepresentativeOfficer, ResponsibleParty, Owner, PrimaryContact, SecondaryContact. For Trusts: Trustor, Trustee. Between organizations: ParentOrganization, Branch. Between persons (organizations) and internal entities: PrimaryServicerOfficer, SecondaryServicerOfficer. Between financial institutions: AffiliateFinancialInstitution, HoldingCompany.

ownershipPercentage
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Company Ownership Percentage. If the relation Type is Owner the ownership percentage could be added.

Array of objects (PostalAddress)
Array
addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible ISO Compliant values are: Postal, POBox, Residential, Permanent, Temporary, Business.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible ISO Compliant values are: MailTo, DeliveryTo, Billing, PlaceOfOperation, PlaceOfRegistration.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion y is primary.

department
string [ 1 .. 70 ] characters
Example: "A"

Identification of a division of a large organisation or building.

subDepartment
string [ 1 .. 70 ] characters
Example: "B"

Identification of a sub-division of a large organisation or building.

streetName
string [ 1 .. 70 ] characters
Example: "First Street"

Name of a street or thoroughfare.

firstCrossStreetName
string [ 1 .. 70 ] characters

Name of a the first cross street.

secondCrossStreetName
string [ 1 .. 70 ] characters
Example: "Second Street"

Name of a the second cross street.

buildingNumber
string [ 1 .. 16 ] characters
Example: "11407"

Number that identifies the position of a building or house on a street.

buildingName
string [ 1 .. 35 ] characters
Example: "Tall Tower"

Name of the building or house.

floor
string [ 1 .. 70 ] characters
Example: "20"

Floor or storey within a building.

postBox
string [ 1 .. 16 ] characters
Example: "MY779"

Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for.

room
string [ 1 .. 70 ] characters
Example: "22"

Building room number.

postCode
string [ 1 .. 16 ] characters
Example: "97062-6884"

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string [ 1 .. 35 ] characters
Example: "Tualatin"

Name of a built-up area, with defined boundaries, and a local government.

townLocationName
string [ 1 .. 35 ] characters
Example: "Clackamas"

Specific location name within the town.

districtName
string [ 1 .. 35 ] characters
Example: "Washington"

Identifies a subdivision within a country sub-division.

countrySubDivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

countrySubDivisionCode
string (CountrySubdivisionCode) ^[A-Z]{2,2}\-[0-9A-Z]{1,3}
Example: "AR-B"

Code to identify a name of a unit resulting from the division of a country, dependency, or other area of special geopolitical interest contained in ISO 3166-1, on the basis of country names obtained from the United Nations (ISO 3166-2: Country subdivision code).

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

addressLine
Array of strings[ items [ 1 .. 70 ] characters ]
Example: ["11407 Sw Amu st, Suite MY777"]

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

residenceType
string [ 1 .. 35 ] characters
Example: "Domestic"

Specifies the type of residence where the party has its permanent home or principal establishment. Possible ISO Complaian values are: Domestic, Foreign, Mixed

object (TaxPartyInformation)

Taxation parameters which apply to an individual person or to an organization.

tIN
string
Example: "778-62-8144"

A Taxpayer Identification Number

taxIdType
string [ 1 .. 30 ] characters
Example: "SSN"

Identifies what type of tax ID is in the TIN field. Possible Values: SocialSecurityNumber (SSN), EmployerIdentificationNumber (EIN), IndividualTaxpayerIdentificationNumber (ITIN), TaxpayerIdentificationNumber forPendingAdoptions (ATIN), Preparer TaxpayerIdentificationNumber (PTIN), ForeignTaxID

reportingIndicator
boolean

Whether the financial income for this party should be reported to the U.S. government (IRS) when related to an account in a way which requires reporting (for example, primary, joint ownership). Defaults to true if not specified.

tinStatus
string
Example: "Valid"

'The tax ID has been verified by the IRS as valid. Possible values: Valid, NotValid, NotVerified, IRSWarning, NotVerified, TINApplied.

taxStatus
string
Example: "Valid"

Exempt, ExemptExpired, VoluntaryWithholding, Chapter3, Chapter4.

Array of objects (TaxForm)
Array
formName
string [ 1 .. 10 ] characters
Example: "W-9"
cerfiticationDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

expirationDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

Array of objects (TaxRegulation)
Array
name
string [ 1 .. 35 ] characters
Example: "Chapter4"
section
string [ 1 .. 10 ] characters
Example: "1471"

String that represent the section number.

Array of objects (WithholdingTax)
Array
withholdingTaxType
string (WithholdingTaxType) [ 1 .. 35 ] characters
Example: "NonResidentAlienTax"

Type of Withholding. Possible Values: ForeignAccountTaxComplianceAct, NonResidentAlienTax, BackUpWithholding, VoluntaryWithholding, Federal, State, Local, W-4.

withholdingRate
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Rate applied on a basis amount to calculate the withholding.

withholdingAmount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Withholding amount.

nRAIndicator
boolean

Indicates whether the party is a Non-residen alien.

countrySubDivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

countrySubDivisionCode
string (CountrySubdivisionCode) ^[A-Z]{2,2}\-[0-9A-Z]{1,3}
Example: "AR-B"

Code to identify a name of a unit resulting from the division of a country, dependency, or other area of special geopolitical interest contained in ISO 3166-1, on the basis of country names obtained from the United Nations (ISO 3166-2: Country subdivision code).

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

supplementaryData
object (SupplementaryData)

Additional information that cannot be captured in the structured elements and/or any other specific block. If this information need to be converted in ISO Messages, must be ISO 20022 compliant: it requires development of a compliant message extension model and its components must be registered in the ISO 20022 Data Dictionary. https://www.iso20022.org/catalogue-messages/additional-content-messages/supplementary-data

object (PowerOfAttorney)

Document that transfers specific rights from a party to a person.

documentId
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
documentReference
string [ 1 .. 35 ] characters

Document location.

version
string [ 1 .. 18 ] characters

Document version indentification.

signOffDate
string <date>
Example: "2022-04-17"

Signoff date of the document.

issueDate
string <date>
Example: "2022-04-17"

Issue date of the document.

purpose
string [ 1 .. 35 ] characters

Specifies the function of the document.

fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

object (Jurisdiction)

Area with a set of laws under the control of a system which are different from neighbouring areas

countrySubdivision
string [ 1 .. 35 ] characters
Example: "Oregon"
townName
string [ 1 .. 35 ] characters
Example: "Tualatin"
country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

authorizedPerson
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Person which is the holder of the power of attorney.

authorizedAccount
string [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Specifies the account on which the power of attorney applies.

supplementaryData
object (SupplementaryData)

Additional information that cannot be captured in the structured elements and/or any other specific block. If this information need to be converted in ISO Messages, must be ISO 20022 compliant: it requires development of a compliant message extension model and its components must be registered in the ISO 20022 Data Dictionary. https://www.iso20022.org/catalogue-messages/additional-content-messages/supplementary-data

object (PartySystemSettings)

System configurations at Party level.

Array of objects (CommunicationChannel)
Array
channel
string (CommunicationChannelName) [ 1 .. 35 ] characters
Example: "Email"

Channel used to communicate with a party. Possible Values: Email, Fax, File, Online, PostalService, LiveSupport, ATM, IVR, Kiosk, Mobile, OnlineBanking, Phone, SMS, Card, InPerson.

channelIdentification
string (CommunicationChannelIdentification) [ 1 .. 128 ] characters
Example: "011-02010020202"

Communication value such as phone number or email address.

codeWord
string

A party is asked for a codeword to verify their identity trought a communication channel

alertIndicator
any

Indicates whether the channel is used for enterprise alerts

Array of objects (Restriction)

Access and operation restrictions at Party level.

Array
name
string [ 1 .. 60 ] characters
Example: "externalTransferAllowed"

Name of the restriction in PascalCase. Possible values: externalTransferAllowed, urgentTransferAllowed

restrictionPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
validFrom
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

validUntil
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

object (PlaceAndDateOfBirth)

Date and place of birth of a person.

countrySubdivision
string [ 1 .. 35 ] characters
Example: "Oregon"
townName
string [ 1 .. 35 ] characters
Example: "Tualatin"
country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

birthDate
string <date>
Example: "2022-04-17"

Date on which a person is born.

signature
string <byte> (DigitalSignature) [ 1 .. 13654 ] characters

Binary data of 10K maximum.

object (PersonContactDetails)

Specifies the contact details of a person.

namePrefix
string [ 1 .. 35 ] characters

Specifies the terms used to formally address a person, in PascalCase form. Possible ISO compliant values are:
Doctor, Madam, Miss, Mister, GenderNeutral

name
string [ 1 .. 350 ] characters
Example: "Jane Birkin"

Preferred name to contact the person

Array of objects (Phone)
Array
number
string (PhoneNumber) ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$
Example: "+1-415-731359"

The collection of information which identifies a specific phone or FAX number as defined by telecom services.

extension
string <= 5 characters

Phone Number Extension.

phoneType
string [ 1 .. 35 ] characters

Type of phone address. Possible values are:
Mobile, Landline, Fax.

phonePurpose
string [ 1 .. 35 ] characters

Purpose of the phone address. Possible values are: Business, Personal.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion y is primary.

object (HourOfTheDay)
Array of objects (Email)
Array
emailAddress
string [ 1 .. 2048 ] characters

Address for electronic mail (e-mail).

emailPurpose
string [ 1 .. 35 ] characters
Example: "Statements"

Purpose of the e-mail address. Possible values: Marketing, Statements.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion y is primary.

jobTitle
string (JobTitle) [ 1 .. 35 ] characters
Example: "Head of Documentation"

Title of the function in an organization.

department
string [ 1 .. 35 ] characters
Example: "Sales"

Identification of a division of a large organisation or building.

Array of objects (GenericContact)
Array
channelType
string [ 1 .. 35 ] characters
Example: "Email"

Communication device number or electronic address used for communication: Fax, Email, Mobile, Phone.

identification
string (CommunicationChannelIdentification) [ 1 .. 128 ] characters
Example: "011-02010020202"

Communication value such as phone number or email address.

preferredMethod
string [ 1 .. 35 ] characters
Example: "Email"

Preferred method used to reach the contact, in PascalCase form. Possible ISO compliant values are:
Letter, Email, Phone, Fax, MobileOrCellPhone.

preferredLanguage
string (PreferredLanguage) [ 1 .. 35 ] characters
Example: "English"

Language of the contact person. Names according to the language list provided in the ISO 639-1 codes. Some possible values: Chinese, Spanish, French, English, Japanese, Italian, German.

headOfHousehold
boolean
Example: true

Indicates whether the person pay the costs of supporting a house.

civilStatus
string (CivilStatus) [ 1 .. 17 ] characters
Example: "Single"

Specifies the civil status of a person. Possible ISO 20022 compliant values names are: Single, Married, LegallyDivorced, Divorced, Widow, StableUnion

object (StructuredName)

The structured name is used to initialize the person name with the format

firstName
string [ 1 .. 200 ] characters
Example: "Mary"

Person given first name.

middleName
string [ 1 .. 200 ] characters
Example: "Joe"

Person given middle name.

lastName
string [ 1 .. 200 ] characters
Example: "Smith"

Person surname.

suffix
string [ 1 .. 20 ] characters
Example: "PhD"

A name suffix in the Western English-Language naming tradition, follows a person's full name and provides additional information about the person. Possible Values: PhD, Snr, Jnr.

prefix
string [ 1 .. 20 ] characters
Example: "Dr."

Name prefixes are typically Dr., Mr., Mrs., Ms.

gender
string (Gender) [ 1 .. 36 ] characters
Example: "Female"

Specifies the gender of the person. Possible Values: Female, Male, NonBinary

profession
string (Profession) <= 35 characters
Example: "Artist"

Professional Designation or name of the occupation of a person.

jobTitle
string (JobTitle) [ 1 .. 35 ] characters
Example: "Head of Documentation"

Title of the function in an organization.

residentialStatus
string (ResidentialStatus) [ 1 .. 35 ] characters
Example: "Permanent"

Residential status of an individual. Possible values: Permanent, Resident, NonResident, Rents, Owns

minorIndicator
boolean (MinorIndicator)

Indicates whether the person is a legal minor.

Array of objects (Citizenship)
Array
fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

countryOfResidence
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

object (PersonProfile)

Information to support Know Your Customer (KYC) processes.

riskLevel
string (RiskLevel) [ 1 .. 35 ] characters
Example: "Permanent"

Specifies the customer’s money laundering risk. Possible values: High, Medium, Low.

object (CreditReview)

A credit review is a periodic assessment of an individual’s or businesses' credit profile.

object (Frequency)

Specifies an event frequency

lastReviewDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time if the last credit review.

nextReviewDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time if the next credit review.

creditQuality
string (CreditQuality) [ 1 .. 35 ] characters
Example: "UpperMediumGrade"

Credit quality rating of an issuer or financial obligation. Possible Values: DefaultImminent, ExtremelySpeculative, HighGrade, HighlySpeculative, InDefault, LowerMediumGrade, NonInvestmentGradeSpeculative, Prime, SubstantialRisk, UpperMediumGrade

creditScore
number
creditBureauReportCode
string

Code used for reporting to the credit bureaus. This code is used to report the trade line of a credit account to the credit bureau agencies.

previousFinancialInstitution
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

referredByWhom
string [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

moneyLaunderingCheck
string (MoneyLaunderingCheck)
Example: "AuthorizedCredit"

Specifies the status of money laundering identification procedures. Possible Values: PassedNotChecked, ExemptBelowLimit, ClientMoneyTypeExempt, AuthorizedCredit, PostalOrElectronicPaymentExempt

knowYourCustomerCheck
string (KnowYourCustomerCheckType) [ 1 .. 36 ] characters
Example: "Ordinary"

Specifies the type of Know Your Customer (KYC) or anti-money laundering due diligence to which the investor has been subjected. Possible Values: Ordinary, Simple, Enhanced.

object (TemporalDuration)

Describes a temporal duration.

unit
string [ 1 .. 36 ] characters
Example: "Months"

Unit that describes the duration.

value
integer <= 999

Value of the duration in number of units.

sourceOfWealth
string [ 1 .. 1025 ] characters
Example: "This is a description."

Indicates the main sources of the money.

politicalAffiliation
string

Indicates the political affiliation of the Party. Possible values could be: Democrat, Independent, Republican.

lastContactDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

lastContactChannel
string (CommunicationChannelName) [ 1 .. 35 ] characters
Example: "Email"

Channel used to communicate with a party. Possible Values: Email, Fax, File, Online, PostalService, LiveSupport, ATM, IVR, Kiosk, Mobile, OnlineBanking, Phone, SMS, Card, InPerson.

lostCustomerDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

lostCustomerReason
string (LostCustomerReason) [ 1 .. 35 ] characters
Example: "Deceased"

Possible values are: Competition, Deceased, Dissatisfied, Moved

customerConductClassification
string (CustomerConductClassification) [ 1 .. 35 ] characters

Assessment of the customer’s behaviour at the time of the account opening application. Possible Values: Standard, NonStandard, Reluctant.

familyMedicalInsuranceIndicator
boolean
Example: true

Indicates if the person has family medical insurance coverage available.

object (AmountRange)

Range an amount

minAmount
string (PositiveAmountInCents) <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: 0

maxAmount
string (PositiveAmountInCents) <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: 0

employmentStatus
string (EmploymentStatus)

Represents available individual employment status. Possible Values: Contract, Employed, Homemaker, Retired, SelfEmployed, Student, Temporary, Unemployed.

vIPStatus
string (VIPStatus)
Example: "Elite"

Very Important People Program Status. Possible Values: Novice, Pro, Elite

Array of objects (Employment)
Array
employingPartyName
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

jobTitle
string (JobTitle) [ 1 .. 35 ] characters
Example: "Head of Documentation"

Title of the function in an organization.

employeeTerminationIndicator
boolean
Example: false
object (TemporalDuration)

Describes a temporal duration.

endDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

object (Place)

Town, CountrySubdivision and Country .

object (Regulation0)

Regulation O is a Federal Reserve regulation that places limits and stipulations on the credit extensions a member bank can offer to its executive officers, principal shareholders, and directors.

insider
string (InsiderType) [ 1 .. 35 ] characters
Example: "Director"

Director, Employee, Officer, PrincipalShareholder, Shareholder, Executive.

familyRelationship
string [ 1 .. 40 ] characters
Example: "Owner"

Insider familiar relation. Child, Spouse, Parent, Relative

institutionRelationship
string [ 1 .. 40 ] characters
Example: "Owner"

Relation with the insider financial institution. Possible Values: AffiliateFinancialInstitution, HoldingCompany.

anualIncome
string (AmountInCents) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

object (PartySystemSettings)

System configurations at Party level.

Array of objects (CommunicationChannel)
Array
channel
string (CommunicationChannelName) [ 1 .. 35 ] characters
Example: "Email"

Channel used to communicate with a party. Possible Values: Email, Fax, File, Online, PostalService, LiveSupport, ATM, IVR, Kiosk, Mobile, OnlineBanking, Phone, SMS, Card, InPerson.

channelIdentification
string (CommunicationChannelIdentification) [ 1 .. 128 ] characters
Example: "011-02010020202"

Communication value such as phone number or email address.

codeWord
string

A party is asked for a codeword to verify their identity trought a communication channel

alertIndicator
any

Indicates whether the channel is used for enterprise alerts

personId
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Person identifier code assigned by the account service institution.

status
string (InstructionStatus) [ 1 .. 35 ] characters
Example: "Queued"

Details about the processing of a request on party reference data (create or update). Possible ISO compliant values are: Rejected, Completed, Queued.

Responses

Request samples

Content type
application/merge-patch+json
{
  • "uSDocumentedIndicator": true,
  • "identifiers": [
    ],
  • "name": "Jane Birkin",
  • "shortName": "Jane",
  • "relatedParties": [
    ],
  • "postalAddresses": [
    ],
  • "residenceType": "Domestic",
  • "taxInformation": {
    },
  • "powerOfAttorney": {
    },
  • "supplementaryData": { },
  • "settings": {
    },
  • "restrictions": [
    ],
  • "placeAndDateOfBirth": {
    },
  • "signature": "string",
  • "contact": {
    },
  • "headOfHousehold": true,
  • "civilStatus": "Single",
  • "structuredName": {
    },
  • "gender": "Female",
  • "profession": "Artist",
  • "jobTitle": "Head of Documentation",
  • "residentialStatus": "Permanent",
  • "minorIndicator": true,
  • "citizenships": [
    ],
  • "countryOfResidence": "US",
  • "profile": {
    },
  • "partySettings": {
    },
  • "personId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "status": "Queued"
}

Response samples

Content type
application/json
{
  • "uSDocumentedIndicator": true,
  • "identifiers": [
    ],
  • "name": "Jane Birkin",
  • "shortName": "Jane",
  • "relatedParties": [
    ],
  • "postalAddresses": [
    ],
  • "residenceType": "Domestic",
  • "taxInformation": {
    },
  • "powerOfAttorney": {
    },
  • "supplementaryData": { },
  • "settings": {
    },
  • "restrictions": [
    ],
  • "placeAndDateOfBirth": {
    },
  • "signature": "string",
  • "contact": {
    },
  • "headOfHousehold": true,
  • "civilStatus": "Single",
  • "structuredName": {
    },
  • "gender": "Female",
  • "profession": "Artist",
  • "jobTitle": "Head of Documentation",
  • "residentialStatus": "Permanent",
  • "minorIndicator": true,
  • "citizenships": [
    ],
  • "countryOfResidence": "US",
  • "profile": {
    },
  • "partySettings": {
    },
  • "personId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "status": "Queued"
}

Retrieves Person Accounts

Authorizations:
jwtopenIdConnect
path Parameters
personId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Person Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "personId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "personName": "Jane Birkin",
  • "accounts": [
    ]
}

Retrieves Person Cards

Authorizations:
jwtopenIdConnect
path Parameters
personId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Person Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "personId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "personName": "Jane Birkin",
  • "cards": [
    ]
}

Creates a Card

Creates a personal payment card related to one or multiple accounts. The person may be not an account owner (an additional). For debit cards, the fund account should be provided in the request.

Authorizations:
jwtopenIdConnect
path Parameters
personId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Person Identification

header Parameters
idempotencyId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Request Body schema: application/json
fundingSourceType
string (CardFundingSourceType) [ 1 .. 35 ] characters
Example: "Credit"

Specifies the funding source type of payment card. Possible Values: Credit, Debit, Prepaid, Charge, DeferredDebit

productCode
string (CardProductCode) [ 1 .. 4 ] characters
Example: "F"

Specifies the product code of payment card.

digitalIndicator
boolean (DigitalCardIndicator)

Indicates whether the payment card is digital or physical.

number
string (PrimaryAccountNumber) [ 1 .. 19 ] characters
Example: "1234567890123456789"

Primary Account Number (PAN) of the card.

cardHolder
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Card holder person Id

cardHolderType
string (CardHolderType) [ 1 .. 35 ] characters
Example: "Primary"

Specifies the card holder type of payment card. Possible Values: Primary, Additional

nameOnCard
string [ 1 .. 350 ] characters
Example: "Jane Birkin"

Specifies the name on the card if overriding the name from the card holder.

referenceAccount
string [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Account used as a reference for the card creation. Could be a cash or loan account owned by the primary card holder.

Array of objects (CardRelatedAccount)

Account that provides the payment card transactions. The account is the funding source for the card. Could be a cash or loan account linked to the debit card or a credit card account. A card can have one or many accounts.

Array
accountId
string (AccountId) [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Identification assigned by the account service institution (Servicer).

accountNumber
string (AccountNumber) <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN).

startDate
string <= 7 characters ^\d{4}-([0]\d|1[0-2])$
Example: "2022-12"

Year and month the card is available for use.

expiryDate
string <= 7 characters ^\d{4}-([0]\d|1[0-2])$
Example: "2022-12"

Year and month the card expires.

securityCode
string <= 35 characters
Example: "103"

Security code written on the card, sometimes called card security code (CSC).

pin
string <= 35 characters
Example: "1031"

PIN is the 4 digit security code that is used to authenticate the user and allow them access to the associated accounts of the card.

sequenceNumber
string <= 20 characters
Example: "1"

Identifies a card inside a set of cards with the same number (or PAN).

brand
string <= 35 characters
Example: "Visa"

Brand name of the card.

Array of objects (Limit)
Array
name
string [ 1 .. 60 ] characters
Example: "creditLimit"

Name of the limit in PascalCase. Possible values: overdraft, creditLimit

limitTypeCode
string (LimitType) <= 35 characters
Example: "DirectDebit"

Specifies the type of risk management limit. Possible ISO 20020 compliant values are: Bilateral, NetBilateral, IndirectBilateral, Global, MandatoryBilateral, DiscretionaryBilateral, DirectDebit, SingleCustomerDirectDebit, SingleFinancialInstitutionDirectDebit, TotalDailyCustomerDirectDebit, TotalDailyFinancialInstitutionDirectDebit, AutoCollateralisation, UnsecuredCredit, ExternalGuarantee

channelType
string [ 1 .. 30 ] characters

Channel type for which this limit applies. Possible values: Online, ATM

amount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount limit

percentage
string (Percentage) <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Value expressed as a percentage, for example, 0.7 is %70; 0.3333 is %33.33. total number of digits: 11 number of digits in fractional part: 10 Max Value: 1

validFrom
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

validUntil
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

usedAmount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount limit used

usedPercentage
string (Percentage) <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Value expressed as a percentage, for example, 0.7 is %70; 0.3333 is %33.33. total number of digits: 11 number of digits in fractional part: 10 Max Value: 1

status
string (LimitStatus) <= 35 characters
Example: "Requested"

Specifies the current status of a limit. Possible ISO 20020 compliant values are: Enabled, Disabled, Deleted, Requested

object (Frequency)

Specifies an event frequency

Array of objects (InterestCalculation)
Array
fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

name
string (InterestName) [ 1 .. 35 ] characters
Example: "LatePayment"

Name of the interest that applies to the account. For instance, Overdraft, LatePayment.

dayCountBasis
string (InterestComputationMethod) [ 1 .. 50 ] characters
Example: "30360AmericanBasicRule"

Specifies the method used to compute accruing interest of a financial instrument. Some ISO 20022 compliant values are: 30360AmericanBasicRule, IC30365, IC30Actual, Actual360, Actual365Fixed, ActualActualICMA, IC30E360orEuroBondBasismodel1, ActualActualISDA, Actual365LorActuActubasisRule, ActualActualAFB, IC30360ICMAor30360basicrule, IC30E2360orEurobondbasismodel2, IC30E3360orEurobondbasismodel3, Actual365NL, Narrative, ActualActualUltimo, IC30EPlus360, Actual364, Business252, Actual360NL, OneOne, Other

rate
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

The actual interest rate used for the payment of the interest for the specified interest period.

interestRateType
string (InterestRateType) [ 1 .. 35 ] characters
Example: "Fixed"

Specifies the type of interest rate. Some ISO 20022 compliant values are: Fixed, Forfeit, Variable, Scheduled, Unscheduled, Discount, FixedRateUnderlyingExposureForLife, FixedRateUnderlyingExposureWithCompulsoryFutureSwitchToFloating, FixedWithFuturePeriodicResets, FloatingLinkedToIndex, FloatingRateUnderlyingExposureForLife, FloatingRateUnderlyingExposureWithCap, FloatingRateUnderlyingExposureWithFloor, FloatingRateUnderlyingExposureWithFloorAndCap, Modular, ObligorSwapped, Other, SwicthOptionality

object (Frequency)

Specifies an event frequency

object (Frequency)

Specifies an event frequency

object (VariableInterestCalculation)

Specifies the parameters to be used for variable interest.

Array of objects (Restriction)
Array
name
string [ 1 .. 60 ] characters
Example: "externalTransferAllowed"

Name of the restriction in PascalCase. Possible values: externalTransferAllowed, urgentTransferAllowed

restrictionPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
validFrom
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

validUntil
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

Array of objects (ChargeCalculation)
Array
fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

name
string (ChargeName) [ 1 .. 60 ] characters
Example: "cardLatePayment"

Name of the charge calculation in PascalCase. Possible values: cardLatePayment, cashAdvance

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount charged for the service.

rate
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Rate applied on a basis amount to calculate the service charge.

chargeType
string (ChargeType) [ 1 .. 35 ] characters
Example: "ManagementFee"

Type of service for which a charge is asked or paid. Some possible ISO 20022 compliant values are: BrokerageFee, Commission, BackEndLoad, FrontEndLoad, Switch, DilutionLevy, Discount, ManagementFee, TransferFee, MatchingFees, PostageCharge, RegulatoryFee, ShippingCharge, ServiceProvisionFee, SpecialConcessions, PartAcquis, Penalty, ContingencyDeferredSalesCharge, Other, Equalisation, CorrespondentBankCharge, Premium, Initial, AdvisoryFee, CustodyFee, PublicationFee, AccountingFee, SignatureService, StorageAtDestination, StorageAtOrigin, Packaging, PickUp, DangerousGoodsFee, SecurityCharge, InsurancePremium, CollectFreight, ClearanceAndHandlingAtOrigin, ClearanceAndHandlingAtDestination, AirWayBillFee, TransportCharges, UCITSCommission, SpeciallyAgreedFrontEndLoad, ADRFee, IssuanceCancellationFee, MiscellaneousFee, IssuanceFee.

calculationBasis
string (CalculationBasis) [ 1 .. 35 ] characters
Example: "Monthly"

Specifies the calculation basis of a charge or fee. Some possible ISO 20022 compliant values are: Average, Daily, Other, Monthly, Annual

bearerType
string (ChargeBearerType) [ 1 .. 35 ] characters
Example: "Shared"

Specifies which party(ies) will pay charges due for processing of the instruction. BorneByDebtor, BorneByCreditor, Shared, FollowingServiceLevel

maximumAmount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Maximum amount of money asked or paid for the charge.

object (InterestCalculation)

Set of parameters used to calculate an interest.

status
string (CardStatus) [ 1 .. 60 ] characters
Example: "Active"

Specifies the status of payment card. Some possible values are: Active, Blocked, Closed, Expedite, Expired, Inactive, Issued, Lost, Restricted, Stolen, Suspended.

statusDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
statusReason
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
supplementaryData
object (SupplementaryData)

Additional information that cannot be captured in the structured elements and/or any other specific block. If this information need to be converted in ISO Messages, must be ISO 20022 compliant: it requires development of a compliant message extension model and its components must be registered in the ISO 20022 Data Dictionary. https://www.iso20022.org/catalogue-messages/additional-content-messages/supplementary-data

Responses

Request samples

Content type
application/json
{
  • "fundingSourceType": "Credit",
  • "productCode": "F",
  • "digitalIndicator": true,
  • "number": "1234567890123456789",
  • "cardHolder": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "cardHolderType": "Primary",
  • "nameOnCard": "Jane Birkin",
  • "referenceAccount": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "relatedAccounts": [
    ],
  • "startDate": "2022-12",
  • "expiryDate": "2022-12",
  • "securityCode": "103",
  • "pin": "1031",
  • "sequenceNumber": "1",
  • "brand": "Visa",
  • "limits": [
    ],
  • "interests": [
    ],
  • "restrictions": [
    ],
  • "charges": [
    ],
  • "status": "Active",
  • "statusDate": "2022-04-17T08:00:00Z",
  • "statusReason": "This is a description.",
  • "supplementaryData": { }
}

Response samples

Content type
application/json
{
  • "fundingSourceType": "Credit",
  • "productCode": "F",
  • "digitalIndicator": true,
  • "number": "1234567890123456789",
  • "cardHolder": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "cardHolderType": "Primary",
  • "nameOnCard": "Jane Birkin",
  • "referenceAccount": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "relatedAccounts": [
    ],
  • "startDate": "2022-12",
  • "expiryDate": "2022-12",
  • "securityCode": "103",
  • "pin": "1031",
  • "sequenceNumber": "1",
  • "brand": "Visa",
  • "limits": [
    ],
  • "interests": [
    ],
  • "restrictions": [
    ],
  • "charges": [
    ],
  • "status": "Active",
  • "statusDate": "2022-04-17T08:00:00Z",
  • "statusReason": "This is a description.",
  • "supplementaryData": { },
  • "cardId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "productName": "Visa Classic",
  • "creditCardStatement": {
    },
  • "offers": [
    ]
}

Retrieves an Organization

Authorizations:
jwtopenIdConnect
query Parameters
name.inc
string

The organization name includes the substring provided.

accountNumber.eq
string (AccountNumber) <= 30 characters
Example: accountNumber.eq=012345678

The account number or Basic Bank Account Number (BBAN).

tin.eq
string
email.eq
string

Email equals to

addressLine.inc
string

Any address line of any postal address includes substring

postCode.eq
string

Any postal address with post code equals to

country.eq
string

Any postal address with country code equals to

countrySubDivision.inc
string

Any postal address with country subdivision includes substring

townName.inc
string

Any postal address with town name includes substring

organizationId.eq
string (Id) [ 1 .. 36 ] characters
Example: organizationId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002

System id equals to

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates an Organization

Authorizations:
jwtopenIdConnect
header Parameters
idempotencyId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Request Body schema: application/json
Array of objects (OrganizationIdentification)
Array
number
string [ 1 .. 35 ] characters
Example: "123-45-6789"

Unique and unambiguous identification of an organization.

schemeName
string [ 1 .. 35 ] characters
Example: "TaxIdentificationNumber"

Name of the identification scheme, in PascalCase form. Possible ISO compliant values are: BankPartyIdentification CentralBankIdentificationNumber ClearingIdentificationNumber CertificateOfIncorporationNumber CountryIdentificationCode CustomerNumber DataUniversalNumberingSystem EmployerIdentificationNumber GS1GLNIdentifier SIREN SIRET TaxIdentificationNumber BusinessDomainIdentifier BusinessOtherIdentification EmployerIdentificationNumber BICIdentifier LEIIdentifier

issuer
string
Example: "UnitedStates"

Entity that assigns the identification.

issueDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

expirationDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

name
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

shortName
string (PartyShortName) [ 1 .. 35 ] characters
Example: "Jane"

Short name or nickname by which a party is known and which is usually used to identify that party.

Array of objects (RelatedParty)
Array
partyId
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
partyType
string (PartyType)
Example: "Person"

Possible values are: Person, Organization. Also other types of servicer internal entities: ServicerOfficer

partyName
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

partyRelationType
string (PartyRelationType) [ 1 .. 40 ] characters
Example: "Owner"

Type of relation between parties. Some ISO 20022 compliant values for Organizations are: RepresentativeOfficer, ResponsibleParty, Owner, PrimaryContact, SecondaryContact. For Trusts: Trustor, Trustee. Between organizations: ParentOrganization, Branch. Between persons (organizations) and internal entities: PrimaryServicerOfficer, SecondaryServicerOfficer. Between financial institutions: AffiliateFinancialInstitution, HoldingCompany.

ownershipPercentage
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Company Ownership Percentage. If the relation Type is Owner the ownership percentage could be added.

Array of objects (PostalAddress)
Array
addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible ISO Compliant values are: Postal, POBox, Residential, Permanent, Temporary, Business.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible ISO Compliant values are: MailTo, DeliveryTo, Billing, PlaceOfOperation, PlaceOfRegistration.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion y is primary.

department
string [ 1 .. 70 ] characters
Example: "A"

Identification of a division of a large organisation or building.

subDepartment
string [ 1 .. 70 ] characters
Example: "B"

Identification of a sub-division of a large organisation or building.

streetName
string [ 1 .. 70 ] characters
Example: "First Street"

Name of a street or thoroughfare.

firstCrossStreetName
string [ 1 .. 70 ] characters

Name of a the first cross street.

secondCrossStreetName
string [ 1 .. 70 ] characters
Example: "Second Street"

Name of a the second cross street.

buildingNumber
string [ 1 .. 16 ] characters
Example: "11407"

Number that identifies the position of a building or house on a street.

buildingName
string [ 1 .. 35 ] characters
Example: "Tall Tower"

Name of the building or house.

floor
string [ 1 .. 70 ] characters
Example: "20"

Floor or storey within a building.

postBox
string [ 1 .. 16 ] characters
Example: "MY779"

Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for.

room
string [ 1 .. 70 ] characters
Example: "22"

Building room number.

postCode
string [ 1 .. 16 ] characters
Example: "97062-6884"

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string [ 1 .. 35 ] characters
Example: "Tualatin"

Name of a built-up area, with defined boundaries, and a local government.

townLocationName
string [ 1 .. 35 ] characters
Example: "Clackamas"

Specific location name within the town.

districtName
string [ 1 .. 35 ] characters
Example: "Washington"

Identifies a subdivision within a country sub-division.

countrySubDivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

countrySubDivisionCode
string (CountrySubdivisionCode) ^[A-Z]{2,2}\-[0-9A-Z]{1,3}
Example: "AR-B"

Code to identify a name of a unit resulting from the division of a country, dependency, or other area of special geopolitical interest contained in ISO 3166-1, on the basis of country names obtained from the United Nations (ISO 3166-2: Country subdivision code).

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

addressLine
Array of strings[ items [ 1 .. 70 ] characters ]
Example: ["11407 Sw Amu st, Suite MY777"]

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

residenceType
string [ 1 .. 35 ] characters
Example: "Domestic"

Specifies the type of residence where the party has its permanent home or principal establishment. Possible ISO Complaian values are: Domestic, Foreign, Mixed

object (TaxPartyInformation)

Taxation parameters which apply to an individual person or to an organization.

tIN
string
Example: "778-62-8144"

A Taxpayer Identification Number

taxIdType
string [ 1 .. 30 ] characters
Example: "SSN"

Identifies what type of tax ID is in the TIN field. Possible Values: SocialSecurityNumber (SSN), EmployerIdentificationNumber (EIN), IndividualTaxpayerIdentificationNumber (ITIN), TaxpayerIdentificationNumber forPendingAdoptions (ATIN), Preparer TaxpayerIdentificationNumber (PTIN), ForeignTaxID

reportingIndicator
boolean

Whether the financial income for this party should be reported to the U.S. government (IRS) when related to an account in a way which requires reporting (for example, primary, joint ownership). Defaults to true if not specified.

tinStatus
string
Example: "Valid"

'The tax ID has been verified by the IRS as valid. Possible values: Valid, NotValid, NotVerified, IRSWarning, NotVerified, TINApplied.

taxStatus
string
Example: "Valid"

Exempt, ExemptExpired, VoluntaryWithholding, Chapter3, Chapter4.

Array of objects (TaxForm)
Array
formName
string [ 1 .. 10 ] characters
Example: "W-9"
cerfiticationDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

expirationDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

Array of objects (TaxRegulation)
Array
name
string [ 1 .. 35 ] characters
Example: "Chapter4"
section
string [ 1 .. 10 ] characters
Example: "1471"

String that represent the section number.

Array of objects (WithholdingTax)
Array
withholdingTaxType
string (WithholdingTaxType) [ 1 .. 35 ] characters
Example: "NonResidentAlienTax"

Type of Withholding. Possible Values: ForeignAccountTaxComplianceAct, NonResidentAlienTax, BackUpWithholding, VoluntaryWithholding, Federal, State, Local, W-4.

withholdingRate
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Rate applied on a basis amount to calculate the withholding.

withholdingAmount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Withholding amount.

nRAIndicator
boolean

Indicates whether the party is a Non-residen alien.

countrySubDivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

countrySubDivisionCode
string (CountrySubdivisionCode) ^[A-Z]{2,2}\-[0-9A-Z]{1,3}
Example: "AR-B"

Code to identify a name of a unit resulting from the division of a country, dependency, or other area of special geopolitical interest contained in ISO 3166-1, on the basis of country names obtained from the United Nations (ISO 3166-2: Country subdivision code).

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

supplementaryData
object (SupplementaryData)

Additional information that cannot be captured in the structured elements and/or any other specific block. If this information need to be converted in ISO Messages, must be ISO 20022 compliant: it requires development of a compliant message extension model and its components must be registered in the ISO 20022 Data Dictionary. https://www.iso20022.org/catalogue-messages/additional-content-messages/supplementary-data

object (PowerOfAttorney)

Document that transfers specific rights from a party to a person.

documentId
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
documentReference
string [ 1 .. 35 ] characters

Document location.

version
string [ 1 .. 18 ] characters

Document version indentification.

signOffDate
string <date>
Example: "2022-04-17"

Signoff date of the document.

issueDate
string <date>
Example: "2022-04-17"

Issue date of the document.

purpose
string [ 1 .. 35 ] characters

Specifies the function of the document.

fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

object (Jurisdiction)

Area with a set of laws under the control of a system which are different from neighbouring areas

countrySubdivision
string [ 1 .. 35 ] characters
Example: "Oregon"
townName
string [ 1 .. 35 ] characters
Example: "Tualatin"
country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

authorizedPerson
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Person which is the holder of the power of attorney.

authorizedAccount
string [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Specifies the account on which the power of attorney applies.

supplementaryData
object (SupplementaryData)

Additional information that cannot be captured in the structured elements and/or any other specific block. If this information need to be converted in ISO Messages, must be ISO 20022 compliant: it requires development of a compliant message extension model and its components must be registered in the ISO 20022 Data Dictionary. https://www.iso20022.org/catalogue-messages/additional-content-messages/supplementary-data

object (PartySystemSettings)

System configurations at Party level.

Array of objects (CommunicationChannel)
Array
channel
string (CommunicationChannelName) [ 1 .. 35 ] characters
Example: "Email"

Channel used to communicate with a party. Possible Values: Email, Fax, File, Online, PostalService, LiveSupport, ATM, IVR, Kiosk, Mobile, OnlineBanking, Phone, SMS, Card, InPerson.

channelIdentification
string (CommunicationChannelIdentification) [ 1 .. 128 ] characters
Example: "011-02010020202"

Communication value such as phone number or email address.

codeWord
string

A party is asked for a codeword to verify their identity trought a communication channel

alertIndicator
any

Indicates whether the channel is used for enterprise alerts

Array of objects (Restriction)

Access and operation restrictions at Party level.

Array
name
string [ 1 .. 60 ] characters
Example: "externalTransferAllowed"

Name of the restriction in PascalCase. Possible values: externalTransferAllowed, urgentTransferAllowed

restrictionPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
validFrom
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

validUntil
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

organizationType
string (OrganizationLegalStructure)
Example: "Corporation"

Specifies the legal standing of the organization. Possible values are: Government, FinancialInstitution SoleProprietorship, Llc, Partnership, Corporation, NotForProfit, Club, Corporation, Individual, Supranational, Sovereign, Municipal, Province, State, County, National, ExemptionTrust, LivingTrust, EmployeeTrust, RevocableTrust, IrrovocableTrust, NakedTrust, CliffordTrust

organizationPurpose
string [ 1 .. 1025 ] characters
Example: "This is a description."

Description and purpose of an organization.

legalName
string [ 1 .. 35 ] characters
Example: "Jane"

Official name under which an organization is registered.

tradingName
string [ 1 .. 35 ] characters
Example: "Jane"

Name used by a business for commercial purposes, although its registered legal name, used for contracts and other formal situations, may be another.

registrationDate
string <date>
Example: "2022-04-17"

Date and time at which a given organization was officially registered.

establishmentDate
string <date>
Example: "2022-04-17"

Date when the organisation was established.

entityExpirationDate
string <date>
Example: "2022-04-17"

The date the Legal Entity ceased operation or was merged.

merchantCategory
string (MerchantCategoryCode) ^[0-9]{4,4}
Example: "482"

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

sector
string (OrganizationSector)

A sector is an area of the economy in which businesses share the same or related business activity, product, or service. Energy, Materials, Industrials, ConsumerDiscretionary, ConsumerStaples, HealthCare, Financials, InformationTechnology, TelecommunicationServices, Utilities, RealEstate.

object (OrganizationProfile)

Information to support Know Your Customer (KYC) processes.

riskLevel
string (RiskLevel) [ 1 .. 35 ] characters
Example: "Permanent"

Specifies the customer’s money laundering risk. Possible values: High, Medium, Low.

object (CreditReview)

A credit review is a periodic assessment of an individual’s or businesses' credit profile.

object (Frequency)

Specifies an event frequency

lastReviewDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time if the last credit review.

nextReviewDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time if the next credit review.

creditQuality
string (CreditQuality) [ 1 .. 35 ] characters
Example: "UpperMediumGrade"

Credit quality rating of an issuer or financial obligation. Possible Values: DefaultImminent, ExtremelySpeculative, HighGrade, HighlySpeculative, InDefault, LowerMediumGrade, NonInvestmentGradeSpeculative, Prime, SubstantialRisk, UpperMediumGrade

creditScore
number
creditBureauReportCode
string

Code used for reporting to the credit bureaus. This code is used to report the trade line of a credit account to the credit bureau agencies.

previousFinancialInstitution
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

referredByWhom
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

moneyLaunderingCheck
string (MoneyLaunderingCheck)
Example: "AuthorizedCredit"

Specifies the status of money laundering identification procedures. Possible Values: PassedNotChecked, ExemptBelowLimit, ClientMoneyTypeExempt, AuthorizedCredit, PostalOrElectronicPaymentExempt

knowYourCustomerCheck
string (KnowYourCustomerCheckType) [ 1 .. 36 ] characters
Example: "Ordinary"

Specifies the type of Know Your Customer (KYC) or anti-money laundering due diligence to which the investor has been subjected. Possible Values: Ordinary, Simple, Enhanced.

object (TemporalDuration)

Describes a temporal duration.

unit
string [ 1 .. 36 ] characters
Example: "Months"

Unit that describes the duration.

value
integer <= 999

Value of the duration in number of units.

sourceOfWealth
string [ 1 .. 1025 ] characters
Example: "This is a description."

Indicates the main sources of the money.

politicalAffiliation
string

Indicates the political affiliation of the Party. Possible values could be: Democrat, Independent, Republican.

lastContactDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

lastContactChannel
string (CommunicationChannelName) [ 1 .. 35 ] characters
Example: "Email"

Channel used to communicate with a party. Possible Values: Email, Fax, File, Online, PostalService, LiveSupport, ATM, IVR, Kiosk, Mobile, OnlineBanking, Phone, SMS, Card, InPerson.

lostCustomerDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

lostCustomerReason
string (LostCustomerReason) [ 1 .. 35 ] characters
Example: "Deceased"

Possible values are: Competition, Deceased, Dissatisfied, Moved

numberOfEmployees
integer
Example: 100

Number of employees of the corporation.

anualSales
string (AmountInCents) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

services
string [ 1 .. 1025 ] characters
Example: "This is a description."

Description of the services that are offered for sale.

goods
string [ 1 .. 1025 ] characters
Example: "This is a description."

Description of the goods that are offered for sale.

Array of objects (Place)

Places where the goods and services are sold.

Array
countrySubdivision
string [ 1 .. 35 ] characters
Example: "Oregon"
townName
string [ 1 .. 35 ] characters
Example: "Tualatin"
country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

Array of objects (Phone)

Business phone numbers

Array
number
string (PhoneNumber) ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$
Example: "+1-415-731359"

The collection of information which identifies a specific phone or FAX number as defined by telecom services.

extension
string <= 5 characters

Phone Number Extension.

phoneType
string [ 1 .. 35 ] characters

Type of phone address. Possible values are:
Mobile, Landline, Fax.

phonePurpose
string [ 1 .. 35 ] characters

Purpose of the phone address. Possible values are: Business, Personal.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion y is primary.

object (HourOfTheDay)
Array of objects (Email)

Business e-mails

Array
emailAddress
string [ 1 .. 2048 ] characters

Address for electronic mail (e-mail).

emailPurpose
string [ 1 .. 35 ] characters
Example: "Statements"

Purpose of the e-mail address. Possible values: Marketing, Statements.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion y is primary.

webPage
stringˆ[(http(s)?):\/\/(www\.)?a-zA-Z0-9@:%._\+~#=]...

Business web page

logo
string <byte> (ComercialLogo) [ 1 .. 10240 ] characters

Commercial logo of the organization. 10K Binary Data.

Responses

Request samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "name": "Jane Birkin",
  • "shortName": "Jane",
  • "relatedParties": [
    ],
  • "postalAddresses": [
    ],
  • "residenceType": "Domestic",
  • "taxInformation": {
    },
  • "powerOfAttorney": {
    },
  • "supplementaryData": { },
  • "settings": {
    },
  • "restrictions": [
    ],
  • "organizationType": "Corporation",
  • "organizationPurpose": "This is a description.",
  • "legalName": "Jane",
  • "tradingName": "Jane",
  • "registrationDate": "2022-04-17",
  • "establishmentDate": "2022-04-17",
  • "entityExpirationDate": "2022-04-17",
  • "merchantCategory": "482",
  • "sector": "string",
  • "organizationProfile": {
    },
  • "phones": [
    ],
  • "emails": [
    ],
  • "webPage": "string",
  • "logo": "string"
}

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "name": "Jane Birkin",
  • "shortName": "Jane",
  • "relatedParties": [
    ],
  • "postalAddresses": [
    ],
  • "residenceType": "Domestic",
  • "taxInformation": {
    },
  • "powerOfAttorney": {
    },
  • "supplementaryData": { },
  • "settings": {
    },
  • "restrictions": [
    ],
  • "organizationType": "Corporation",
  • "organizationPurpose": "This is a description.",
  • "legalName": "Jane",
  • "tradingName": "Jane",
  • "registrationDate": "2022-04-17",
  • "establishmentDate": "2022-04-17",
  • "entityExpirationDate": "2022-04-17",
  • "merchantCategory": "482",
  • "sector": "string",
  • "organizationProfile": {
    },
  • "phones": [
    ],
  • "emails": [
    ],
  • "webPage": "string",
  • "logo": "string",
  • "organizationId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "status": "Queued"
}

Retrieves an Organization

Authorizations:
jwtopenIdConnect
path Parameters
organizationId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Organization Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "name": "Jane Birkin",
  • "shortName": "Jane",
  • "relatedParties": [
    ],
  • "postalAddresses": [
    ],
  • "residenceType": "Domestic",
  • "taxInformation": {
    },
  • "powerOfAttorney": {
    },
  • "supplementaryData": { },
  • "settings": {
    },
  • "restrictions": [
    ],
  • "organizationType": "Corporation",
  • "organizationPurpose": "This is a description.",
  • "legalName": "Jane",
  • "tradingName": "Jane",
  • "registrationDate": "2022-04-17",
  • "establishmentDate": "2022-04-17",
  • "entityExpirationDate": "2022-04-17",
  • "merchantCategory": "482",
  • "sector": "string",
  • "organizationProfile": {
    },
  • "phones": [
    ],
  • "emails": [
    ],
  • "webPage": "string",
  • "logo": "string",
  • "organizationId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "status": "Queued"
}

Updates an Organization

Use the JSON Merge Patch standard https://tools.ietf.org/html/rfc7396

Authorizations:
jwtopenIdConnect
path Parameters
organizationId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Organization Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Request Body schema: application/merge-patch+json
Array of objects (OrganizationIdentification)
Array
number
string [ 1 .. 35 ] characters
Example: "123-45-6789"

Unique and unambiguous identification of an organization.

schemeName
string [ 1 .. 35 ] characters
Example: "TaxIdentificationNumber"

Name of the identification scheme, in PascalCase form. Possible ISO compliant values are: BankPartyIdentification CentralBankIdentificationNumber ClearingIdentificationNumber CertificateOfIncorporationNumber CountryIdentificationCode CustomerNumber DataUniversalNumberingSystem EmployerIdentificationNumber GS1GLNIdentifier SIREN SIRET TaxIdentificationNumber BusinessDomainIdentifier BusinessOtherIdentification EmployerIdentificationNumber BICIdentifier LEIIdentifier

issuer
string
Example: "UnitedStates"

Entity that assigns the identification.

issueDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

expirationDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

name
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

shortName
string (PartyShortName) [ 1 .. 35 ] characters
Example: "Jane"

Short name or nickname by which a party is known and which is usually used to identify that party.

Array of objects (RelatedParty)
Array
partyId
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
partyType
string (PartyType)
Example: "Person"

Possible values are: Person, Organization. Also other types of servicer internal entities: ServicerOfficer

partyName
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

partyRelationType
string (PartyRelationType) [ 1 .. 40 ] characters
Example: "Owner"

Type of relation between parties. Some ISO 20022 compliant values for Organizations are: RepresentativeOfficer, ResponsibleParty, Owner, PrimaryContact, SecondaryContact. For Trusts: Trustor, Trustee. Between organizations: ParentOrganization, Branch. Between persons (organizations) and internal entities: PrimaryServicerOfficer, SecondaryServicerOfficer. Between financial institutions: AffiliateFinancialInstitution, HoldingCompany.

ownershipPercentage
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Company Ownership Percentage. If the relation Type is Owner the ownership percentage could be added.

Array of objects (PostalAddress)
Array
addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible ISO Compliant values are: Postal, POBox, Residential, Permanent, Temporary, Business.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible ISO Compliant values are: MailTo, DeliveryTo, Billing, PlaceOfOperation, PlaceOfRegistration.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion y is primary.

department
string [ 1 .. 70 ] characters
Example: "A"

Identification of a division of a large organisation or building.

subDepartment
string [ 1 .. 70 ] characters
Example: "B"

Identification of a sub-division of a large organisation or building.

streetName
string [ 1 .. 70 ] characters
Example: "First Street"

Name of a street or thoroughfare.

firstCrossStreetName
string [ 1 .. 70 ] characters

Name of a the first cross street.

secondCrossStreetName
string [ 1 .. 70 ] characters
Example: "Second Street"

Name of a the second cross street.

buildingNumber
string [ 1 .. 16 ] characters
Example: "11407"

Number that identifies the position of a building or house on a street.

buildingName
string [ 1 .. 35 ] characters
Example: "Tall Tower"

Name of the building or house.

floor
string [ 1 .. 70 ] characters
Example: "20"

Floor or storey within a building.

postBox
string [ 1 .. 16 ] characters
Example: "MY779"

Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for.

room
string [ 1 .. 70 ] characters
Example: "22"

Building room number.

postCode
string [ 1 .. 16 ] characters
Example: "97062-6884"

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string [ 1 .. 35 ] characters
Example: "Tualatin"

Name of a built-up area, with defined boundaries, and a local government.

townLocationName
string [ 1 .. 35 ] characters
Example: "Clackamas"

Specific location name within the town.

districtName
string [ 1 .. 35 ] characters
Example: "Washington"

Identifies a subdivision within a country sub-division.

countrySubDivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

countrySubDivisionCode
string (CountrySubdivisionCode) ^[A-Z]{2,2}\-[0-9A-Z]{1,3}
Example: "AR-B"

Code to identify a name of a unit resulting from the division of a country, dependency, or other area of special geopolitical interest contained in ISO 3166-1, on the basis of country names obtained from the United Nations (ISO 3166-2: Country subdivision code).

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

addressLine
Array of strings[ items [ 1 .. 70 ] characters ]
Example: ["11407 Sw Amu st, Suite MY777"]

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

residenceType
string [ 1 .. 35 ] characters
Example: "Domestic"

Specifies the type of residence where the party has its permanent home or principal establishment. Possible ISO Complaian values are: Domestic, Foreign, Mixed

object (TaxPartyInformation)

Taxation parameters which apply to an individual person or to an organization.

tIN
string
Example: "778-62-8144"

A Taxpayer Identification Number

taxIdType
string [ 1 .. 30 ] characters
Example: "SSN"

Identifies what type of tax ID is in the TIN field. Possible Values: SocialSecurityNumber (SSN), EmployerIdentificationNumber (EIN), IndividualTaxpayerIdentificationNumber (ITIN), TaxpayerIdentificationNumber forPendingAdoptions (ATIN), Preparer TaxpayerIdentificationNumber (PTIN), ForeignTaxID

reportingIndicator
boolean

Whether the financial income for this party should be reported to the U.S. government (IRS) when related to an account in a way which requires reporting (for example, primary, joint ownership). Defaults to true if not specified.

tinStatus
string
Example: "Valid"

'The tax ID has been verified by the IRS as valid. Possible values: Valid, NotValid, NotVerified, IRSWarning, NotVerified, TINApplied.

taxStatus
string
Example: "Valid"

Exempt, ExemptExpired, VoluntaryWithholding, Chapter3, Chapter4.

Array of objects (TaxForm)
Array
formName
string [ 1 .. 10 ] characters
Example: "W-9"
cerfiticationDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

expirationDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

Array of objects (TaxRegulation)
Array
name
string [ 1 .. 35 ] characters
Example: "Chapter4"
section
string [ 1 .. 10 ] characters
Example: "1471"

String that represent the section number.

Array of objects (WithholdingTax)
Array
withholdingTaxType
string (WithholdingTaxType) [ 1 .. 35 ] characters
Example: "NonResidentAlienTax"

Type of Withholding. Possible Values: ForeignAccountTaxComplianceAct, NonResidentAlienTax, BackUpWithholding, VoluntaryWithholding, Federal, State, Local, W-4.

withholdingRate
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Rate applied on a basis amount to calculate the withholding.

withholdingAmount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Withholding amount.

nRAIndicator
boolean

Indicates whether the party is a Non-residen alien.

countrySubDivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

countrySubDivisionCode
string (CountrySubdivisionCode) ^[A-Z]{2,2}\-[0-9A-Z]{1,3}
Example: "AR-B"

Code to identify a name of a unit resulting from the division of a country, dependency, or other area of special geopolitical interest contained in ISO 3166-1, on the basis of country names obtained from the United Nations (ISO 3166-2: Country subdivision code).

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

supplementaryData
object (SupplementaryData)

Additional information that cannot be captured in the structured elements and/or any other specific block. If this information need to be converted in ISO Messages, must be ISO 20022 compliant: it requires development of a compliant message extension model and its components must be registered in the ISO 20022 Data Dictionary. https://www.iso20022.org/catalogue-messages/additional-content-messages/supplementary-data

object (PowerOfAttorney)

Document that transfers specific rights from a party to a person.

documentId
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
documentReference
string [ 1 .. 35 ] characters

Document location.

version
string [ 1 .. 18 ] characters

Document version indentification.

signOffDate
string <date>
Example: "2022-04-17"

Signoff date of the document.

issueDate
string <date>
Example: "2022-04-17"

Issue date of the document.

purpose
string [ 1 .. 35 ] characters

Specifies the function of the document.

fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

object (Jurisdiction)

Area with a set of laws under the control of a system which are different from neighbouring areas

countrySubdivision
string [ 1 .. 35 ] characters
Example: "Oregon"
townName
string [ 1 .. 35 ] characters
Example: "Tualatin"
country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

authorizedPerson
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Person which is the holder of the power of attorney.

authorizedAccount
string [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Specifies the account on which the power of attorney applies.

supplementaryData
object (SupplementaryData)

Additional information that cannot be captured in the structured elements and/or any other specific block. If this information need to be converted in ISO Messages, must be ISO 20022 compliant: it requires development of a compliant message extension model and its components must be registered in the ISO 20022 Data Dictionary. https://www.iso20022.org/catalogue-messages/additional-content-messages/supplementary-data

object (PartySystemSettings)

System configurations at Party level.

Array of objects (CommunicationChannel)
Array
channel
string (CommunicationChannelName) [ 1 .. 35 ] characters
Example: "Email"

Channel used to communicate with a party. Possible Values: Email, Fax, File, Online, PostalService, LiveSupport, ATM, IVR, Kiosk, Mobile, OnlineBanking, Phone, SMS, Card, InPerson.

channelIdentification
string (CommunicationChannelIdentification) [ 1 .. 128 ] characters
Example: "011-02010020202"

Communication value such as phone number or email address.

codeWord
string

A party is asked for a codeword to verify their identity trought a communication channel

alertIndicator
any

Indicates whether the channel is used for enterprise alerts

Array of objects (Restriction)

Access and operation restrictions at Party level.

Array
name
string [ 1 .. 60 ] characters
Example: "externalTransferAllowed"

Name of the restriction in PascalCase. Possible values: externalTransferAllowed, urgentTransferAllowed

restrictionPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
validFrom
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

validUntil
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

organizationType
string (OrganizationLegalStructure)
Example: "Corporation"

Specifies the legal standing of the organization. Possible values are: Government, FinancialInstitution SoleProprietorship, Llc, Partnership, Corporation, NotForProfit, Club, Corporation, Individual, Supranational, Sovereign, Municipal, Province, State, County, National, ExemptionTrust, LivingTrust, EmployeeTrust, RevocableTrust, IrrovocableTrust, NakedTrust, CliffordTrust

organizationPurpose
string [ 1 .. 1025 ] characters
Example: "This is a description."

Description and purpose of an organization.

legalName
string [ 1 .. 35 ] characters
Example: "Jane"

Official name under which an organization is registered.

tradingName
string [ 1 .. 35 ] characters
Example: "Jane"

Name used by a business for commercial purposes, although its registered legal name, used for contracts and other formal situations, may be another.

registrationDate
string <date>
Example: "2022-04-17"

Date and time at which a given organization was officially registered.

establishmentDate
string <date>
Example: "2022-04-17"

Date when the organisation was established.

entityExpirationDate
string <date>
Example: "2022-04-17"

The date the Legal Entity ceased operation or was merged.

merchantCategory
string (MerchantCategoryCode) ^[0-9]{4,4}
Example: "482"

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

sector
string (OrganizationSector)

A sector is an area of the economy in which businesses share the same or related business activity, product, or service. Energy, Materials, Industrials, ConsumerDiscretionary, ConsumerStaples, HealthCare, Financials, InformationTechnology, TelecommunicationServices, Utilities, RealEstate.

object (OrganizationProfile)

Information to support Know Your Customer (KYC) processes.

riskLevel
string (RiskLevel) [ 1 .. 35 ] characters
Example: "Permanent"

Specifies the customer’s money laundering risk. Possible values: High, Medium, Low.

object (CreditReview)

A credit review is a periodic assessment of an individual’s or businesses' credit profile.

object (Frequency)

Specifies an event frequency

lastReviewDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time if the last credit review.

nextReviewDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time if the next credit review.

creditQuality
string (CreditQuality) [ 1 .. 35 ] characters
Example: "UpperMediumGrade"

Credit quality rating of an issuer or financial obligation. Possible Values: DefaultImminent, ExtremelySpeculative, HighGrade, HighlySpeculative, InDefault, LowerMediumGrade, NonInvestmentGradeSpeculative, Prime, SubstantialRisk, UpperMediumGrade

creditScore
number
creditBureauReportCode
string

Code used for reporting to the credit bureaus. This code is used to report the trade line of a credit account to the credit bureau agencies.

previousFinancialInstitution
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

referredByWhom
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

moneyLaunderingCheck
string (MoneyLaunderingCheck)
Example: "AuthorizedCredit"

Specifies the status of money laundering identification procedures. Possible Values: PassedNotChecked, ExemptBelowLimit, ClientMoneyTypeExempt, AuthorizedCredit, PostalOrElectronicPaymentExempt

knowYourCustomerCheck
string (KnowYourCustomerCheckType) [ 1 .. 36 ] characters
Example: "Ordinary"

Specifies the type of Know Your Customer (KYC) or anti-money laundering due diligence to which the investor has been subjected. Possible Values: Ordinary, Simple, Enhanced.

object (TemporalDuration)

Describes a temporal duration.

unit
string [ 1 .. 36 ] characters
Example: "Months"

Unit that describes the duration.

value
integer <= 999

Value of the duration in number of units.

sourceOfWealth
string [ 1 .. 1025 ] characters
Example: "This is a description."

Indicates the main sources of the money.

politicalAffiliation
string

Indicates the political affiliation of the Party. Possible values could be: Democrat, Independent, Republican.

lastContactDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

lastContactChannel
string (CommunicationChannelName) [ 1 .. 35 ] characters
Example: "Email"

Channel used to communicate with a party. Possible Values: Email, Fax, File, Online, PostalService, LiveSupport, ATM, IVR, Kiosk, Mobile, OnlineBanking, Phone, SMS, Card, InPerson.

lostCustomerDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

lostCustomerReason
string (LostCustomerReason) [ 1 .. 35 ] characters
Example: "Deceased"

Possible values are: Competition, Deceased, Dissatisfied, Moved

numberOfEmployees
integer
Example: 100

Number of employees of the corporation.

anualSales
string (AmountInCents) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

services
string [ 1 .. 1025 ] characters
Example: "This is a description."

Description of the services that are offered for sale.

goods
string [ 1 .. 1025 ] characters
Example: "This is a description."

Description of the goods that are offered for sale.

Array of objects (Place)

Places where the goods and services are sold.

Array
countrySubdivision
string [ 1 .. 35 ] characters
Example: "Oregon"
townName
string [ 1 .. 35 ] characters
Example: "Tualatin"
country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

Array of objects (Phone)

Business phone numbers

Array
number
string (PhoneNumber) ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$
Example: "+1-415-731359"

The collection of information which identifies a specific phone or FAX number as defined by telecom services.

extension
string <= 5 characters

Phone Number Extension.

phoneType
string [ 1 .. 35 ] characters

Type of phone address. Possible values are:
Mobile, Landline, Fax.

phonePurpose
string [ 1 .. 35 ] characters

Purpose of the phone address. Possible values are: Business, Personal.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion y is primary.

object (HourOfTheDay)
Array of objects (Email)

Business e-mails

Array
emailAddress
string [ 1 .. 2048 ] characters

Address for electronic mail (e-mail).

emailPurpose
string [ 1 .. 35 ] characters
Example: "Statements"

Purpose of the e-mail address. Possible values: Marketing, Statements.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion y is primary.

webPage
stringˆ[(http(s)?):\/\/(www\.)?a-zA-Z0-9@:%._\+~#=]...

Business web page

logo
string <byte> (ComercialLogo) [ 1 .. 10240 ] characters

Commercial logo of the organization. 10K Binary Data.

organizationId
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Organization identifier code assigned by the account service institution.

status
string (InstructionStatus) [ 1 .. 35 ] characters
Example: "Queued"

Details about the processing of a request on party reference data (create or update). Possible ISO compliant values are: Rejected, Completed, Queued.

Responses

Request samples

Content type
application/merge-patch+json
{
  • "identifiers": [
    ],
  • "name": "Jane Birkin",
  • "shortName": "Jane",
  • "relatedParties": [
    ],
  • "postalAddresses": [
    ],
  • "residenceType": "Domestic",
  • "taxInformation": {
    },
  • "powerOfAttorney": {
    },
  • "supplementaryData": { },
  • "settings": {
    },
  • "restrictions": [
    ],
  • "organizationType": "Corporation",
  • "organizationPurpose": "This is a description.",
  • "legalName": "Jane",
  • "tradingName": "Jane",
  • "registrationDate": "2022-04-17",
  • "establishmentDate": "2022-04-17",
  • "entityExpirationDate": "2022-04-17",
  • "merchantCategory": "482",
  • "sector": "string",
  • "organizationProfile": {
    },
  • "phones": [
    ],
  • "emails": [
    ],
  • "webPage": "string",
  • "logo": "string",
  • "organizationId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "status": "Queued"
}

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "name": "Jane Birkin",
  • "shortName": "Jane",
  • "relatedParties": [
    ],
  • "postalAddresses": [
    ],
  • "residenceType": "Domestic",
  • "taxInformation": {
    },
  • "powerOfAttorney": {
    },
  • "supplementaryData": { },
  • "settings": {
    },
  • "restrictions": [
    ],
  • "organizationType": "Corporation",
  • "organizationPurpose": "This is a description.",
  • "legalName": "Jane",
  • "tradingName": "Jane",
  • "registrationDate": "2022-04-17",
  • "establishmentDate": "2022-04-17",
  • "entityExpirationDate": "2022-04-17",
  • "merchantCategory": "482",
  • "sector": "string",
  • "organizationProfile": {
    },
  • "phones": [
    ],
  • "emails": [
    ],
  • "webPage": "string",
  • "logo": "string",
  • "organizationId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "status": "Queued"
}

Retrieves Organization Accounts

Authorizations:
jwtopenIdConnect
path Parameters
organizationId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Organization Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "organizationId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "organizationName": "Jane Birkin",
  • "accounts": [
    ]
}

Transactions

Account Transactions Management

Creates a Credit Transaction

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 36 ] characters
Example: 0dd926fe-1ca2-11ed-861d-0242ac120002

Account Identification

header Parameters
idempotencyId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Request Body schema: application/json
transactionType
string (DepositTransactionType) [ 1 .. 35 ] characters
Example: "Cash"

Type of Credit Transaction: Cash, Check, Merchandise

amount
string (AmountInCents) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

object (Exchange)
currency
string = 3 characters ^([A-Z]{3})?$
Example: "USD"

Currency in which the rate of exchange is expressed in a currency exchange.

exchangeFactor
string (BaseOneRate) [ 1 .. 35 ] characters
Example: "0.7"

Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%. total number of digits: 11 number of digits in fractional part: 10 base value: 1

object (Check)

Characteristics of a check

checkType
string

Specifies the type of the check. Possible ISO compliant values are: CustomerCheque, CertifiedCustomerCheque, BankCheque, Draft, ElectronicDraft.

checkNumber
string <= 35 characters

The number on the face of the check indicating the id of that check in a series.

availabilityDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Indicates when the amount of money will become available. Usage: This type of information is used in the US and is linked to particular instruments such as cheques. Example: When a cheque is deposited, it will be booked on the deposit day, but the amount of money will only be accessible as of the indicated availability day (according to national banking regulations).

Responses

Request samples

Content type
application/json
{
  • "transactionType": "Cash",
  • "amount": "100",
  • "exchange": {
    },
  • "check": {
    }
}

Response samples

Content type
application/json
{
  • "transactionId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "amount": "100",
  • "creditDebitIndicator": "Credit",
  • "domain": "Payments",
  • "family": "CustomerCardTransactions",
  • "subFamily": "CreditCardPayment",
  • "description": "This is a description.",
  • "status": "Booked",
  • "reversalIndicator": true,
  • "creationDate": "2022-04-17T08:00:00Z",
  • "valueDate": "2022-04-17T08:00:00Z",
  • "bookingDate": "2022-04-17T08:00:00Z",
  • "charges": [
    ],
  • "codes": [
    ],
  • "interests": [
    ],
  • "currentBalance": "100",
  • "payment": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "check": {
    },
  • "card": {
    },
  • "remittanceInformation": {
    },
  • "supplementaryData": { }
}

Creates a Debit Transaction

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 36 ] characters
Example: 0dd926fe-1ca2-11ed-861d-0242ac120002

Account Identification

header Parameters
idempotencyId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Request Body schema: application/json
transactionType
string (WithdrawalTransactionType) [ 1 .. 35 ] characters
Example: "Cash"

Type of Debit Transaction: Cash

amount
string (AmountInCents) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

object (Check)

Characteristics of a check

checkType
string

Specifies the type of the check. Possible ISO compliant values are: CustomerCheque, CertifiedCustomerCheque, BankCheque, Draft, ElectronicDraft.

checkNumber
string <= 35 characters

The number on the face of the check indicating the id of that check in a series.

availabilityDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Indicates when the amount of money will become available. Usage: This type of information is used in the US and is linked to particular instruments such as cheques. Example: When a cheque is deposited, it will be booked on the deposit day, but the amount of money will only be accessible as of the indicated availability day (according to national banking regulations).

Responses

Request samples

Content type
application/json
{
  • "transactionType": "Cash",
  • "amount": "100",
  • "check": {
    }
}

Response samples

Content type
application/json
{
  • "transactionId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "amount": "100",
  • "creditDebitIndicator": "Credit",
  • "domain": "Payments",
  • "family": "CustomerCardTransactions",
  • "subFamily": "CreditCardPayment",
  • "description": "This is a description.",
  • "status": "Booked",
  • "reversalIndicator": true,
  • "creationDate": "2022-04-17T08:00:00Z",
  • "valueDate": "2022-04-17T08:00:00Z",
  • "bookingDate": "2022-04-17T08:00:00Z",
  • "charges": [
    ],
  • "codes": [
    ],
  • "interests": [
    ],
  • "currentBalance": "100",
  • "payment": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "check": {
    },
  • "card": {
    },
  • "remittanceInformation": {
    },
  • "supplementaryData": { }
}

Retrieves Account Transactions

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 36 ] characters
Example: 0dd926fe-1ca2-11ed-861d-0242ac120002

Account Identification

query Parameters
transactionId.eq
string (TransactionId) [ 1 .. 36 ] characters
Example: transactionId.eq=0dd926fe-1ca2-11ed-861d-0242ac120002

Unique reference as assigned by the account servicing institution to unambiguously identify the transaction.

status.eq
string (TransactionStatus) [ 1 .. 35 ] characters
Example: status.eq=Booked

Specifies the status of an entry on the books of the account servicer. Some possible ISO 20022 compliant values are: Booked, Future, Information, Pending.

amount.lte
string (AmountInCents) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: amount.lte=100

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

amount.gte
string (AmountInCents) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: amount.gte=100

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

creationDate.lte
string <date> (Date)
Example: creationDate.lte=2022-04-17

Input cycle date less than or equal

creationDate.gte
string <date> (Date)
Example: creationDate.gte=2022-04-17

Input cycle date greater than or equal

cursor
string

Specifies an opaque string value ( "no meaning" string value) at which start retrieving transactions. For instance, limit=5&cursor=62aef884fbe3470ce7d9a92140b09b17

limit
string

Specifies the number of resources to return in one request, specified as an integer from 1 to 100.

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Pagination-Cursor
required
string

Pagination Cursor

Pagination-Total
required
string

Total number of resources.

Responses

Response samples

Content type
application/json
{
  • "accountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "accountNumber": "012345678",
  • "accountType": "Current",
  • "currency": "USD",
  • "currentBalance": "100",
  • "availableBalance": "100",
  • "transactions": [
    ]
}

Products

Financial Product Management

Retrieves Financial Products

Authorizations:
jwtopenIdConnect
header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "productId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "name": "string",
  • "description": "This is a description.",
  • "productType": "string",
  • "productSubType": "string",
  • "supplementaryData": { }
}

Cards

Card Management

Retrieves Cards

Authorizations:
jwtopenIdConnect
query Parameters
number.eq
string (PrimaryAccountNumber) [ 1 .. 19 ] characters
Example: number.eq=1234567890123456789

Primary Account Number (PAN) of the card.

sourceType.eq
string (CardFundingSourceType) [ 1 .. 35 ] characters
Example: sourceType.eq=Credit

Specifies the funding source type of payment card. Possible Values: Credit, Debit, Prepaid, Charge, DeferredDebit

productName.eq
string (CardProductName) [ 1 .. 60 ] characters
Example: productName.eq=Visa Classic

Specifies the product name of payment card.

brand.inc
string (PartyName) [ 1 .. 350 ] characters
Example: brand.inc=Jane Birkin

Name by which a party is known and which is usually used to identify that party.

name.inc
string (PartyName) [ 1 .. 350 ] characters
Example: name.inc=Jane Birkin

Name by which a party is known and which is usually used to identify that party.

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "fundingSourceType": "Credit",
  • "productCode": "F",
  • "digitalIndicator": true,
  • "number": "1234567890123456789",
  • "cardHolder": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "cardHolderType": "Primary",
  • "nameOnCard": "Jane Birkin",
  • "referenceAccount": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "relatedAccounts": [
    ],
  • "startDate": "2022-12",
  • "expiryDate": "2022-12",
  • "securityCode": "103",
  • "pin": "1031",
  • "sequenceNumber": "1",
  • "brand": "Visa",
  • "limits": [
    ],
  • "interests": [
    ],
  • "restrictions": [
    ],
  • "charges": [
    ],
  • "status": "Active",
  • "statusDate": "2022-04-17T08:00:00Z",
  • "statusReason": "This is a description.",
  • "supplementaryData": { },
  • "cardId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "productName": "Visa Classic",
  • "creditCardStatement": {
    },
  • "offers": [
    ]
}

Retrieves a Card

Authorizations:
jwtopenIdConnect
path Parameters
cardId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Card Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates a Card

Use the JSON Merge Patch standard https://tools.ietf.org/html/rfc7396

Authorizations:
jwtopenIdConnect
path Parameters
cardId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Card Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Request Body schema: application/merge-patch+json
fundingSourceType
string (CardFundingSourceType) [ 1 .. 35 ] characters
Example: "Credit"

Specifies the funding source type of payment card. Possible Values: Credit, Debit, Prepaid, Charge, DeferredDebit

productCode
string (CardProductCode) [ 1 .. 4 ] characters
Example: "F"

Specifies the product code of payment card.

digitalIndicator
boolean (DigitalCardIndicator)

Indicates whether the payment card is digital or physical.

number
string (PrimaryAccountNumber) [ 1 .. 19 ] characters
Example: "1234567890123456789"

Primary Account Number (PAN) of the card.

cardHolder
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Card holder person Id

cardHolderType
string (CardHolderType) [ 1 .. 35 ] characters
Example: "Primary"

Specifies the card holder type of payment card. Possible Values: Primary, Additional

nameOnCard
string [ 1 .. 350 ] characters
Example: "Jane Birkin"

Specifies the name on the card if overriding the name from the card holder.

referenceAccount
string [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Account used as a reference for the card creation. Could be a cash or loan account owned by the primary card holder.

Array of objects (CardRelatedAccount)

Account that provides the payment card transactions. The account is the funding source for the card. Could be a cash or loan account linked to the debit card or a credit card account. A card can have one or many accounts.

Array
accountId
string (AccountId) [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Identification assigned by the account service institution (Servicer).

accountNumber
string (AccountNumber) <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN).

startDate
string <= 7 characters ^\d{4}-([0]\d|1[0-2])$
Example: "2022-12"

Year and month the card is available for use.

expiryDate
string <= 7 characters ^\d{4}-([0]\d|1[0-2])$
Example: "2022-12"

Year and month the card expires.

securityCode
string <= 35 characters
Example: "103"

Security code written on the card, sometimes called card security code (CSC).

pin
string <= 35 characters
Example: "1031"

PIN is the 4 digit security code that is used to authenticate the user and allow them access to the associated accounts of the card.

sequenceNumber
string <= 20 characters
Example: "1"

Identifies a card inside a set of cards with the same number (or PAN).

brand
string <= 35 characters
Example: "Visa"

Brand name of the card.

Array of objects (Limit)
Array
name
string [ 1 .. 60 ] characters
Example: "creditLimit"

Name of the limit in PascalCase. Possible values: overdraft, creditLimit

limitTypeCode
string (LimitType) <= 35 characters
Example: "DirectDebit"

Specifies the type of risk management limit. Possible ISO 20020 compliant values are: Bilateral, NetBilateral, IndirectBilateral, Global, MandatoryBilateral, DiscretionaryBilateral, DirectDebit, SingleCustomerDirectDebit, SingleFinancialInstitutionDirectDebit, TotalDailyCustomerDirectDebit, TotalDailyFinancialInstitutionDirectDebit, AutoCollateralisation, UnsecuredCredit, ExternalGuarantee

channelType
string [ 1 .. 30 ] characters

Channel type for which this limit applies. Possible values: Online, ATM

amount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount limit

percentage
string (Percentage) <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Value expressed as a percentage, for example, 0.7 is %70; 0.3333 is %33.33. total number of digits: 11 number of digits in fractional part: 10 Max Value: 1

validFrom
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

validUntil
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

usedAmount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount limit used

usedPercentage
string (Percentage) <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Value expressed as a percentage, for example, 0.7 is %70; 0.3333 is %33.33. total number of digits: 11 number of digits in fractional part: 10 Max Value: 1

status
string (LimitStatus) <= 35 characters
Example: "Requested"

Specifies the current status of a limit. Possible ISO 20020 compliant values are: Enabled, Disabled, Deleted, Requested

object (Frequency)

Specifies an event frequency

Array of objects (InterestCalculation)
Array
fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

name
string (InterestName) [ 1 .. 35 ] characters
Example: "LatePayment"

Name of the interest that applies to the account. For instance, Overdraft, LatePayment.

dayCountBasis
string (InterestComputationMethod) [ 1 .. 50 ] characters
Example: "30360AmericanBasicRule"

Specifies the method used to compute accruing interest of a financial instrument. Some ISO 20022 compliant values are: 30360AmericanBasicRule, IC30365, IC30Actual, Actual360, Actual365Fixed, ActualActualICMA, IC30E360orEuroBondBasismodel1, ActualActualISDA, Actual365LorActuActubasisRule, ActualActualAFB, IC30360ICMAor30360basicrule, IC30E2360orEurobondbasismodel2, IC30E3360orEurobondbasismodel3, Actual365NL, Narrative, ActualActualUltimo, IC30EPlus360, Actual364, Business252, Actual360NL, OneOne, Other

rate
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

The actual interest rate used for the payment of the interest for the specified interest period.

interestRateType
string (InterestRateType) [ 1 .. 35 ] characters
Example: "Fixed"

Specifies the type of interest rate. Some ISO 20022 compliant values are: Fixed, Forfeit, Variable, Scheduled, Unscheduled, Discount, FixedRateUnderlyingExposureForLife, FixedRateUnderlyingExposureWithCompulsoryFutureSwitchToFloating, FixedWithFuturePeriodicResets, FloatingLinkedToIndex, FloatingRateUnderlyingExposureForLife, FloatingRateUnderlyingExposureWithCap, FloatingRateUnderlyingExposureWithFloor, FloatingRateUnderlyingExposureWithFloorAndCap, Modular, ObligorSwapped, Other, SwicthOptionality

object (Frequency)

Specifies an event frequency

object (Frequency)

Specifies an event frequency

object (VariableInterestCalculation)

Specifies the parameters to be used for variable interest.

Array of objects (Restriction)
Array
name
string [ 1 .. 60 ] characters
Example: "externalTransferAllowed"

Name of the restriction in PascalCase. Possible values: externalTransferAllowed, urgentTransferAllowed

restrictionPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
validFrom
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

validUntil
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

Array of objects (ChargeCalculation)
Array
fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

name
string (ChargeName) [ 1 .. 60 ] characters
Example: "cardLatePayment"

Name of the charge calculation in PascalCase. Possible values: cardLatePayment, cashAdvance

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount charged for the service.

rate
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Rate applied on a basis amount to calculate the service charge.

chargeType
string (ChargeType) [ 1 .. 35 ] characters
Example: "ManagementFee"

Type of service for which a charge is asked or paid. Some possible ISO 20022 compliant values are: BrokerageFee, Commission, BackEndLoad, FrontEndLoad, Switch, DilutionLevy, Discount, ManagementFee, TransferFee, MatchingFees, PostageCharge, RegulatoryFee, ShippingCharge, ServiceProvisionFee, SpecialConcessions, PartAcquis, Penalty, ContingencyDeferredSalesCharge, Other, Equalisation, CorrespondentBankCharge, Premium, Initial, AdvisoryFee, CustodyFee, PublicationFee, AccountingFee, SignatureService, StorageAtDestination, StorageAtOrigin, Packaging, PickUp, DangerousGoodsFee, SecurityCharge, InsurancePremium, CollectFreight, ClearanceAndHandlingAtOrigin, ClearanceAndHandlingAtDestination, AirWayBillFee, TransportCharges, UCITSCommission, SpeciallyAgreedFrontEndLoad, ADRFee, IssuanceCancellationFee, MiscellaneousFee, IssuanceFee.

calculationBasis
string (CalculationBasis) [ 1 .. 35 ] characters
Example: "Monthly"

Specifies the calculation basis of a charge or fee. Some possible ISO 20022 compliant values are: Average, Daily, Other, Monthly, Annual

bearerType
string (ChargeBearerType) [ 1 .. 35 ] characters
Example: "Shared"

Specifies which party(ies) will pay charges due for processing of the instruction. BorneByDebtor, BorneByCreditor, Shared, FollowingServiceLevel

maximumAmount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Maximum amount of money asked or paid for the charge.

object (InterestCalculation)

Set of parameters used to calculate an interest.

status
string (CardStatus) [ 1 .. 60 ] characters
Example: "Active"

Specifies the status of payment card. Some possible values are: Active, Blocked, Closed, Expedite, Expired, Inactive, Issued, Lost, Restricted, Stolen, Suspended.

statusDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
statusReason
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
supplementaryData
object (SupplementaryData)

Additional information that cannot be captured in the structured elements and/or any other specific block. If this information need to be converted in ISO Messages, must be ISO 20022 compliant: it requires development of a compliant message extension model and its components must be registered in the ISO 20022 Data Dictionary. https://www.iso20022.org/catalogue-messages/additional-content-messages/supplementary-data

cardId
string (PaymentCardId) [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Identification assigned by the card provider. A cardId is a unique identifier associated with a specific cardholder. Establishing the card ID is the first step. The card ID is used as the card reference. When a card is replaced, a new card ID must be requested for the new PAN.

productName
string (CardProductName) [ 1 .. 60 ] characters
Example: "Visa Classic"

Specifies the product name of payment card.

object (CreditCardStatement)

Credit Card statement details.

statementBalance
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

The balance calculated at the end of the billing cycle up to the payment closing date.

paymentClosingDate
string <date>
Example: "2022-04-17"

Last day of your billing cycle.

paymentDueDate
string <date>
Example: "2022-04-17"

The date by which is needed to pay the issuer to avoid interest charges.

minimumPayment
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

The minimum monthly payment is the lowest amount a customer can pay on their revolving credit account per month to remain in good standing with the credit card company.

lastPaymentDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

lastPaymentAmount
string (AmountInCents) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

Array of objects (CardProviderOffer)

Card provider offers assigned to the PAN.

Array
offerId
string (OfferId) [ 1 .. 35 ] characters
Example: "101854"

Card provider unique reference to the card payment offer.

offerTitle
string (OfferTitle) [ 1 .. 35 ] characters
Example: "Save 20%"

Short description of the offer

Responses

Request samples

Content type
application/merge-patch+json
{
  • "fundingSourceType": "Credit",
  • "productCode": "F",
  • "digitalIndicator": true,
  • "number": "1234567890123456789",
  • "cardHolder": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "cardHolderType": "Primary",
  • "nameOnCard": "Jane Birkin",
  • "referenceAccount": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "relatedAccounts": [
    ],
  • "startDate": "2022-12",
  • "expiryDate": "2022-12",
  • "securityCode": "103",
  • "pin": "1031",
  • "sequenceNumber": "1",
  • "brand": "Visa",
  • "limits": [
    ],
  • "interests": [
    ],
  • "restrictions": [
    ],
  • "charges": [
    ],
  • "status": "Active",
  • "statusDate": "2022-04-17T08:00:00Z",
  • "statusReason": "This is a description.",
  • "supplementaryData": { },
  • "cardId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "productName": "Visa Classic",
  • "creditCardStatement": {
    },
  • "offers": [
    ]
}

Response samples

Content type
application/json
{
  • "fundingSourceType": "Credit",
  • "productCode": "F",
  • "digitalIndicator": true,
  • "number": "1234567890123456789",
  • "cardHolder": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "cardHolderType": "Primary",
  • "nameOnCard": "Jane Birkin",
  • "referenceAccount": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "relatedAccounts": [
    ],
  • "startDate": "2022-12",
  • "expiryDate": "2022-12",
  • "securityCode": "103",
  • "pin": "1031",
  • "sequenceNumber": "1",
  • "brand": "Visa",
  • "limits": [
    ],
  • "interests": [
    ],
  • "restrictions": [
    ],
  • "charges": [
    ],
  • "status": "Active",
  • "statusDate": "2022-04-17T08:00:00Z",
  • "statusReason": "This is a description.",
  • "supplementaryData": { },
  • "cardId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "productName": "Visa Classic",
  • "creditCardStatement": {
    },
  • "offers": [
    ]
}

Retrieves Card Accounts

Authorizations:
jwtopenIdConnect
path Parameters
cardId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Card Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "cardId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "fundingSourceType": "Credit",
  • "productName": "Visa Classic",
  • "productCode": "F",
  • "digitalIndicator": true,
  • "number": "1234567890123456789",
  • "accounts": [
    ]
}

Retrieves Card Holder

Authorizations:
jwtopenIdConnect
path Parameters
cardId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Card Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "uSDocumentedIndicator": true,
  • "identifiers": [
    ],
  • "name": "Jane Birkin",
  • "shortName": "Jane",
  • "relatedParties": [
    ],
  • "postalAddresses": [
    ],
  • "residenceType": "Domestic",
  • "taxInformation": {
    },
  • "powerOfAttorney": {
    },
  • "supplementaryData": { },
  • "settings": {
    },
  • "restrictions": [
    ],
  • "placeAndDateOfBirth": {
    },
  • "signature": "string",
  • "contact": {
    },
  • "headOfHousehold": true,
  • "civilStatus": "Single",
  • "structuredName": {
    },
  • "gender": "Female",
  • "profession": "Artist",
  • "jobTitle": "Head of Documentation",
  • "residentialStatus": "Permanent",
  • "minorIndicator": true,
  • "citizenships": [
    ],
  • "countryOfResidence": "US",
  • "profile": {
    },
  • "partySettings": {
    },
  • "personId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "status": "Queued"
}

Retrieves Card Holder Transactions

Authorizations:
jwtopenIdConnect
path Parameters
cardId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Card Identification

query Parameters
transactionId.eq
string (TransactionId) [ 1 .. 36 ] characters
Example: transactionId.eq=0dd926fe-1ca2-11ed-861d-0242ac120002

Unique reference as assigned by the account servicing institution to unambiguously identify the transaction.

amount.lte
string (AmountInCents) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: amount.lte=100

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

amount.gte
string (AmountInCents) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: amount.gte=100

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

creationDate.lte
string <date> (Date)
Example: creationDate.lte=2022-04-17

Input cycle date less than or equal

creationDate.gte
string <date> (Date)
Example: creationDate.gte=2022-04-17

Input cycle date greater than or equal

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "accountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "accountNumber": "012345678",
  • "accountType": "Current",
  • "currency": "USD",
  • "currentBalance": "100",
  • "availableBalance": "100",
  • "transactions": [
    ]
}

Loans

Loan Management

Opens a Loan

Authorizations:
jwtopenIdConnect
header Parameters
idempotencyId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Request Body schema: application/json
servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: "SEA_1"

Identification of the account servicer institution at branch level or operation level.

loanType
required
string (LoanType) [ 1 .. 35 ] characters
Example: "Personal"

Type of the account. Some possible BIAN compliant values are: Personal, Consumer,
Corporate, Lease, Syndicated, Mortgage, Conforming, Merchandising, LinesOfCredit, RevolvingCredit.

accountOwnershipType
required
string (AccountOwnershipType) [ 1 .. 35 ] characters
Example: "Owner"

Specifies the type of account ownership. Possible ISO 20022 compliant values names are: JointAccountWithSurvivorshipRights, JointAccountInCommon, CustodialAccount, SingleOwnerAccount, JointAccount, Corporation, FormalPartnership, FormalTrust, Nominee, NonProfitOrganisation, OtherNonIndividual, EUResidualEntity, GovernmentOrganization, LimitedLiabilityCompany, RegisteredInvestmentCompany, Entrepreneurial, Unincorporated, LimitedPartnership, BareOwner, Owner, Usufructuary, Fiduciary

productId
string (ProductId) [ 1 .. 36 ] characters
Example: "PD_CA_0002"
name
string (AccountName) [ 1 .. 70 ] characters
Example: "Hermes PD_CA 0002"

Name of the account. It provides an additional means of identification, and is designated by the account servicer in agreement with the account owner.

accountPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
currency
string (CurrencyCode) = 3 characters ^([A-Z]{3})?$
Example: "USD"

Three contiguous letters for the representation of currencies and funds. Valid currency codes are registered with the ISO 4217 Maintenance Agency.

object (LoanContract)

Contract by which an amount of money in exchange for future repayment of the principal amount along with interest or other finance charges.

documentId
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
documentReference
string [ 1 .. 35 ] characters

Document location.

version
string [ 1 .. 18 ] characters

Document version indentification.

signOffDate
string <date>
Example: "2022-04-17"

Signoff date of the document.

issueDate
string <date>
Example: "2022-04-17"

Issue date of the document.

purpose
string [ 1 .. 35 ] characters

Specifies the function of the document.

fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

object (Jurisdiction)

Area with a set of laws under the control of a system which are different from neighbouring areas

countrySubdivision
string [ 1 .. 35 ] characters
Example: "Oregon"
townName
string [ 1 .. 35 ] characters
Example: "Tualatin"
country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Loan amount as defined in the contract.

borrower
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Party that is specified as the buyer for this loan agreement.

lender
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Party that is specified as the seller for this loan agreement.

maturityDate
string <date>
Example: "2022-04-17"

Planned final repayment date at the time of issuance.

object

Planned final repayment date at the time of issuance.

documentId
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
documentReference
string [ 1 .. 35 ] characters

Document location.

version
string [ 1 .. 18 ] characters

Document version indentification.

signOffDate
string <date>
Example: "2022-04-17"

Signoff date of the document.

issueDate
string <date>
Example: "2022-04-17"

Issue date of the document.

purpose
string [ 1 .. 35 ] characters

Specifies the function of the document.

Array of objects (InterestCalculation)
Array
fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

name
string (InterestName) [ 1 .. 35 ] characters
Example: "LatePayment"

Name of the interest that applies to the account. For instance, Overdraft, LatePayment.

dayCountBasis
string (InterestComputationMethod) [ 1 .. 50 ] characters
Example: "30360AmericanBasicRule"

Specifies the method used to compute accruing interest of a financial instrument. Some ISO 20022 compliant values are: 30360AmericanBasicRule, IC30365, IC30Actual, Actual360, Actual365Fixed, ActualActualICMA, IC30E360orEuroBondBasismodel1, ActualActualISDA, Actual365LorActuActubasisRule, ActualActualAFB, IC30360ICMAor30360basicrule, IC30E2360orEurobondbasismodel2, IC30E3360orEurobondbasismodel3, Actual365NL, Narrative, ActualActualUltimo, IC30EPlus360, Actual364, Business252, Actual360NL, OneOne, Other

rate
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

The actual interest rate used for the payment of the interest for the specified interest period.

interestRateType
string (InterestRateType) [ 1 .. 35 ] characters
Example: "Fixed"

Specifies the type of interest rate. Some ISO 20022 compliant values are: Fixed, Forfeit, Variable, Scheduled, Unscheduled, Discount, FixedRateUnderlyingExposureForLife, FixedRateUnderlyingExposureWithCompulsoryFutureSwitchToFloating, FixedWithFuturePeriodicResets, FloatingLinkedToIndex, FloatingRateUnderlyingExposureForLife, FloatingRateUnderlyingExposureWithCap, FloatingRateUnderlyingExposureWithFloor, FloatingRateUnderlyingExposureWithFloorAndCap, Modular, ObligorSwapped, Other, SwicthOptionality

object (Frequency)

Specifies an event frequency

object (Frequency)

Specifies an event frequency

object (VariableInterestCalculation)

Specifies the parameters to be used for variable interest.

Array of objects (ChargeCalculation)
Array
fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

name
string (ChargeName) [ 1 .. 60 ] characters
Example: "cardLatePayment"

Name of the charge calculation in PascalCase. Possible values: cardLatePayment, cashAdvance

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount charged for the service.

rate
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Rate applied on a basis amount to calculate the service charge.

chargeType
string (ChargeType) [ 1 .. 35 ] characters
Example: "ManagementFee"

Type of service for which a charge is asked or paid. Some possible ISO 20022 compliant values are: BrokerageFee, Commission, BackEndLoad, FrontEndLoad, Switch, DilutionLevy, Discount, ManagementFee, TransferFee, MatchingFees, PostageCharge, RegulatoryFee, ShippingCharge, ServiceProvisionFee, SpecialConcessions, PartAcquis, Penalty, ContingencyDeferredSalesCharge, Other, Equalisation, CorrespondentBankCharge, Premium, Initial, AdvisoryFee, CustodyFee, PublicationFee, AccountingFee, SignatureService, StorageAtDestination, StorageAtOrigin, Packaging, PickUp, DangerousGoodsFee, SecurityCharge, InsurancePremium, CollectFreight, ClearanceAndHandlingAtOrigin, ClearanceAndHandlingAtDestination, AirWayBillFee, TransportCharges, UCITSCommission, SpeciallyAgreedFrontEndLoad, ADRFee, IssuanceCancellationFee, MiscellaneousFee, IssuanceFee.

calculationBasis
string (CalculationBasis) [ 1 .. 35 ] characters
Example: "Monthly"

Specifies the calculation basis of a charge or fee. Some possible ISO 20022 compliant values are: Average, Daily, Other, Monthly, Annual

bearerType
string (ChargeBearerType) [ 1 .. 35 ] characters
Example: "Shared"

Specifies which party(ies) will pay charges due for processing of the instruction. BorneByDebtor, BorneByCreditor, Shared, FollowingServiceLevel

maximumAmount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Maximum amount of money asked or paid for the charge.

object (InterestCalculation)

Set of parameters used to calculate an interest.

Array of objects (LoanContractTranche)

Provides details on the tranches defined for the loan contract.

Array
sequenceNumber
string <= 20 characters
Example: "1"

Unique sequence number of the tranche.

expectedDate
string <date>
Example: "2022-04-17"

Expected tranche payment date.

dueDate
string <date>
Example: "2022-04-17"

Loan tranche due date.

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount of the tranche as defined in the loan contract.

object

Loan tranche duration.

object (TemporalDuration)

Describes a temporal duration.

unit
string [ 1 .. 36 ] characters
Example: "Months"

Unit that describes the duration.

value
integer <= 999

Value of the duration in number of units.

Array of objects (RepaymentSchedule)

Schedule of the principal payments and interests defined for the loan contract.

Array
repaymentScheduleId
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Unique and unambiguous identification of the payment schedule.

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount to be paid

expectedDate
string <date>
Example: "2022-04-17"

Expected date whereby the amount must be paid.

dueDate
string <date>
Example: "2022-04-17"

Latest date whereby the amount of money must be paid.

repaymentType
string (LoanPaymentType) [ 1 .. 35 ] characters
Example: "Principal"

Possible values are: Interest, Principal.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Collateral)
Array
amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Value of the collateral as an amount.

collateralType
string (CollateralType) [ 1 .. 60 ] characters

Specifies the type of collateral. Some possible values are: LetterOfCredit, Cash, Securities, PhysicalEntities, Insurance, StockCertificate, Bond, BankGuarantee, Commodity, Automobile, IndustrialVehicle, CommercialTruck, RailVehicle, NauticalCommercialVehicle, NauticalLeisureVehicle, Aeroplane, MachineTool, IndustrialEquipment, OfficeEquipment, ITEquipment, MedicalEquipment, EnergyRelatedEquipment, CommercialBuilding, ResidentialBuilding. IndustrialBuilding, OtherVehicle, OtherEquipment, OtherRealEstate, OtherGoodsOrInventory, Guarantee, OtherFinancialAsset, MixedCategories.

object (Agreement)

Agreement between two trading parties that contains information about their relative duties and rights regarding collateral.

Array of objects (SyndicatedLoan)

Loan offered by a group of lenders (called a syndicate).

Array
lenderId
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Party which provides an amount of money available to others to borrow.

lenderType
string (PartyType)
Example: "Person"

Possible values are: Person, Organization. Also other types of servicer internal entities: ServicerOfficer

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount of the part in the syndicated loan.

share
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Share part in the syndicated loan.

intraCompanyLoanIndicator
boolean
Example: false

Indicates whether the loan is an intra-company loan.

required
Array of objects (AccountParty)
Array
partyId
required
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
partyType
required
string (PartyType)
Example: "Person"

Possible values are: Person, Organization. Also other types of servicer internal entities: ServicerOfficer

partyAccountRole
required
string (AccountPartyRole) [ 1 .. 35 ] characters
Example: "AccountOwner"

Type of the account. Some possible ISO 20022 compliant values are: AccountOwner, LiquidityManager, LimitManager, PaymentManager, Reader, BackupManager, SettlementManager, FundManagementCompany, TransferAgent, FundAccountant, Registrar, InvestmentManager, Custodian, Auditor, PayingAgent, CashCorrespondent, DataProvider, FinalAgent, Investor, FirstAgent, Intermediary, Distributor, Concentrator, UnderlyingClient1, UnderlyingClient2, TransmittingAgent, FundBroker, FinancialAdvisor, ContactPersonAtInstructingPartyInstitution, ContactPersonAtExecutingPartyInstitution, NameOfAgentToOrder, PrimeBroker, Internal, LegalGuardian, DecisionMaker, Guarantor, LoanLender, LoanBorrower, LoanCoBorrower, PrimaryOwner, Trustee, CustodianForMinor, Nominee, SecondaryOwner, Executor, Beneficiary, PrimaryServicerOfficer, SecondaryServicerOfficer.

Array of objects (RelatedAccount)
Array
accountRelationType
string (AccountRelationType)

Account relation role. Possible values are: Parent, Child, Group.

accountId
string (AccountId) [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Identification assigned by the account service institution (Servicer).

accountNumber
string (AccountNumber) <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN).

Array of objects (Restriction)
Array
name
string [ 1 .. 60 ] characters
Example: "externalTransferAllowed"

Name of the restriction in PascalCase. Possible values: externalTransferAllowed, urgentTransferAllowed

restrictionPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
validFrom
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

validUntil
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

Array of objects (Limit)
Array
name
string [ 1 .. 60 ] characters
Example: "creditLimit"

Name of the limit in PascalCase. Possible values: overdraft, creditLimit

limitTypeCode
string (LimitType) <= 35 characters
Example: "DirectDebit"

Specifies the type of risk management limit. Possible ISO 20020 compliant values are: Bilateral, NetBilateral, IndirectBilateral, Global, MandatoryBilateral, DiscretionaryBilateral, DirectDebit, SingleCustomerDirectDebit, SingleFinancialInstitutionDirectDebit, TotalDailyCustomerDirectDebit, TotalDailyFinancialInstitutionDirectDebit, AutoCollateralisation, UnsecuredCredit, ExternalGuarantee

channelType
string [ 1 .. 30 ] characters

Channel type for which this limit applies. Possible values: Online, ATM

amount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount limit

percentage
string (Percentage) <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Value expressed as a percentage, for example, 0.7 is %70; 0.3333 is %33.33. total number of digits: 11 number of digits in fractional part: 10 Max Value: 1

validFrom
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

validUntil
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

usedAmount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount limit used

usedPercentage
string (Percentage) <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Value expressed as a percentage, for example, 0.7 is %70; 0.3333 is %33.33. total number of digits: 11 number of digits in fractional part: 10 Max Value: 1

status
string (LimitStatus) <= 35 characters
Example: "Requested"

Specifies the current status of a limit. Possible ISO 20020 compliant values are: Enabled, Disabled, Deleted, Requested

object (Frequency)

Specifies an event frequency

object (StatementSettings)

Specifies how often statements will be sent, in which format, to which address.

object (Frequency)

Specifies an event frequency

unit
string [ 1 .. 35 ] characters
Example: "Monthly"

Specifies a frequency. Some ISO 20022 compliant values are: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Adhoc, IntraDay, Overnight, TenDays, Fortnightly, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Hourly, TriAnnual, Bimonthly, OnDemand, Shift, TwiceAWeek, XDays, XMonths, XYears.

value
integer <= 999

Number of units, for XDays, XMonths, XYears.

communicationMethod
string (CommunicationChannelName) [ 1 .. 35 ] characters
Example: "Email"

Channel used to communicate with a party. Possible Values: Email, Fax, File, Online, PostalService, LiveSupport, ATM, IVR, Kiosk, Mobile, OnlineBanking, Phone, SMS, Card, InPerson.

format
string (DocumentFormat) [ 1 .. 35 ] characters
Example: "PDF"

Specifies a choice of format for a document. Possible Values: PDF, HTML

category
string (StatementCategory) [ 1 .. 36 ] characters
Example: "BalanceSheet"

Used to categorize the statement. Possible Values: BalanceSheet, ProfitAndLoss

subcategory
string (StatementSubcategory) [ 1 .. 36 ] characters
Example: "Cash"

Used to subcategorize the statement. Possible Values: Cash, AccountReceivable, Inventory, CurrentAssets

supplementaryData
object (SupplementaryData)

Additional information that cannot be captured in the structured elements and/or any other specific block. If this information need to be converted in ISO Messages, must be ISO 20022 compliant: it requires development of a compliant message extension model and its components must be registered in the ISO 20022 Data Dictionary. https://www.iso20022.org/catalogue-messages/additional-content-messages/supplementary-data

Responses

Request samples

Content type
application/json
{
  • "servicerBranchId": "SEA_1",
  • "loanType": "Personal",
  • "accountOwnershipType": "Owner",
  • "productId": "PD_CA_0002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "contract": {
    },
  • "parties": [
    ],
  • "relatedAccounts": [
    ],
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "statementSettings": {
    },
  • "supplementaryData": { }
}

Response samples

Content type
application/json
{
  • "accountNumber": "012345678",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "servicerBranchId": "SEA_1",
  • "loanType": "Personal",
  • "accountOwnershipType": "Owner",
  • "productId": "PD_CA_0002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "contract": {
    },
  • "parties": [
    ],
  • "relatedAccounts": [
    ],
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "statementSettings": {
    },
  • "supplementaryData": { },
  • "status": "Withdrawn",
  • "statusDateAndTime": "2022-04-17T08:00:00Z",
  • "substatus": "string",
  • "openDate": "2022-04-17",
  • "fundedDate": "2022-04-17",
  • "disbursalDate": "2022-04-17",
  • "balances": [
    ],
  • "transactions": [
    ],
  • "accountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "relatedCards": [
    ],
  • "principalAmount": "100",
  • "accruedCapitalisationAmount": "100",
  • "nextPayment": {
    },
  • "lastPayment": {
    }
}

Retrieves a Loan

Authorizations:
jwtopenIdConnect
path Parameters
loanId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Loan Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "accountNumber": "012345678",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "servicerBranchId": "SEA_1",
  • "loanType": "Personal",
  • "accountOwnershipType": "Owner",
  • "productId": "PD_CA_0002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "contract": {
    },
  • "parties": [
    ],
  • "relatedAccounts": [
    ],
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "statementSettings": {
    },
  • "supplementaryData": { },
  • "status": "Withdrawn",
  • "statusDateAndTime": "2022-04-17T08:00:00Z",
  • "substatus": "string",
  • "openDate": "2022-04-17",
  • "fundedDate": "2022-04-17",
  • "disbursalDate": "2022-04-17",
  • "balances": [
    ],
  • "transactions": [
    ],
  • "accountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "relatedCards": [
    ],
  • "principalAmount": "100",
  • "accruedCapitalisationAmount": "100",
  • "nextPayment": {
    },
  • "lastPayment": {
    }
}

Updates a Loan

Use the JSON Merge Patch standard https://tools.ietf.org/html/rfc7396

Authorizations:
jwtopenIdConnect
path Parameters
loanId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Loan Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Request Body schema: application/merge-patch+json
accountNumber
string (AccountNumber) <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN).

Array of objects (RoutingNumber)
Array
number
string (ABANumber) = 9 characters
Example: "012345678"

The routing number (sometimes referred to as an ABA routing number, regarding the American Bankers Association) is a sequence of nine digits used by banks to identify specific financial institutions within the United States.

routingNumberType
string (RoutingNumberType) = 9 characters
Example: "ACH"

Different types of payments may require different bank routing numbers. Some possible values: ACH, WIRE, ElectronicCheck, PaperCheck

Array of objects (AccountIdentification)
Array
identification
string [ 1 .. 34 ] characters

Identification assigned by an institution.

schemeName
string [ 1 .. 35 ] characters
Example: "BBANIdentifier"

Name of the identification scheme, in PascalCase. Possible ISO 20022 compliant values names are: IssuerIdentificationNumber, BBANIdentifier, CHIPSUniversalIdentifier, UPICIdentifier, IBANIdentifier

issuer
string [ 1 .. 35 ] characters

Entity that assigns the identification.

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: "SEA_1"

Identification of the account servicer institution at branch level or operation level.

loanType
required
string (LoanType) [ 1 .. 35 ] characters
Example: "Personal"

Type of the account. Some possible BIAN compliant values are: Personal, Consumer,
Corporate, Lease, Syndicated, Mortgage, Conforming, Merchandising, LinesOfCredit, RevolvingCredit.

accountOwnershipType
required
string (AccountOwnershipType) [ 1 .. 35 ] characters
Example: "Owner"

Specifies the type of account ownership. Possible ISO 20022 compliant values names are: JointAccountWithSurvivorshipRights, JointAccountInCommon, CustodialAccount, SingleOwnerAccount, JointAccount, Corporation, FormalPartnership, FormalTrust, Nominee, NonProfitOrganisation, OtherNonIndividual, EUResidualEntity, GovernmentOrganization, LimitedLiabilityCompany, RegisteredInvestmentCompany, Entrepreneurial, Unincorporated, LimitedPartnership, BareOwner, Owner, Usufructuary, Fiduciary

productId
string (ProductId) [ 1 .. 36 ] characters
Example: "PD_CA_0002"
name
string (AccountName) [ 1 .. 70 ] characters
Example: "Hermes PD_CA 0002"

Name of the account. It provides an additional means of identification, and is designated by the account servicer in agreement with the account owner.

accountPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
currency
string (CurrencyCode) = 3 characters ^([A-Z]{3})?$
Example: "USD"

Three contiguous letters for the representation of currencies and funds. Valid currency codes are registered with the ISO 4217 Maintenance Agency.

object (LoanContract)

Contract by which an amount of money in exchange for future repayment of the principal amount along with interest or other finance charges.

documentId
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
documentReference
string [ 1 .. 35 ] characters

Document location.

version
string [ 1 .. 18 ] characters

Document version indentification.

signOffDate
string <date>
Example: "2022-04-17"

Signoff date of the document.

issueDate
string <date>
Example: "2022-04-17"

Issue date of the document.

purpose
string [ 1 .. 35 ] characters

Specifies the function of the document.

fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

object (Jurisdiction)

Area with a set of laws under the control of a system which are different from neighbouring areas

countrySubdivision
string [ 1 .. 35 ] characters
Example: "Oregon"
townName
string [ 1 .. 35 ] characters
Example: "Tualatin"
country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Loan amount as defined in the contract.

borrower
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Party that is specified as the buyer for this loan agreement.

lender
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Party that is specified as the seller for this loan agreement.

maturityDate
string <date>
Example: "2022-04-17"

Planned final repayment date at the time of issuance.

object

Planned final repayment date at the time of issuance.

documentId
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
documentReference
string [ 1 .. 35 ] characters

Document location.

version
string [ 1 .. 18 ] characters

Document version indentification.

signOffDate
string <date>
Example: "2022-04-17"

Signoff date of the document.

issueDate
string <date>
Example: "2022-04-17"

Issue date of the document.

purpose
string [ 1 .. 35 ] characters

Specifies the function of the document.

Array of objects (InterestCalculation)
Array
fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

name
string (InterestName) [ 1 .. 35 ] characters
Example: "LatePayment"

Name of the interest that applies to the account. For instance, Overdraft, LatePayment.

dayCountBasis
string (InterestComputationMethod) [ 1 .. 50 ] characters
Example: "30360AmericanBasicRule"

Specifies the method used to compute accruing interest of a financial instrument. Some ISO 20022 compliant values are: 30360AmericanBasicRule, IC30365, IC30Actual, Actual360, Actual365Fixed, ActualActualICMA, IC30E360orEuroBondBasismodel1, ActualActualISDA, Actual365LorActuActubasisRule, ActualActualAFB, IC30360ICMAor30360basicrule, IC30E2360orEurobondbasismodel2, IC30E3360orEurobondbasismodel3, Actual365NL, Narrative, ActualActualUltimo, IC30EPlus360, Actual364, Business252, Actual360NL, OneOne, Other

rate
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

The actual interest rate used for the payment of the interest for the specified interest period.

interestRateType
string (InterestRateType) [ 1 .. 35 ] characters
Example: "Fixed"

Specifies the type of interest rate. Some ISO 20022 compliant values are: Fixed, Forfeit, Variable, Scheduled, Unscheduled, Discount, FixedRateUnderlyingExposureForLife, FixedRateUnderlyingExposureWithCompulsoryFutureSwitchToFloating, FixedWithFuturePeriodicResets, FloatingLinkedToIndex, FloatingRateUnderlyingExposureForLife, FloatingRateUnderlyingExposureWithCap, FloatingRateUnderlyingExposureWithFloor, FloatingRateUnderlyingExposureWithFloorAndCap, Modular, ObligorSwapped, Other, SwicthOptionality

object (Frequency)

Specifies an event frequency

object (Frequency)

Specifies an event frequency

object (VariableInterestCalculation)

Specifies the parameters to be used for variable interest.

Array of objects (ChargeCalculation)
Array
fromDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period starts.

upToDateTime
string <date>
Example: "2022-04-17"

Date and time at which the contract validity period ends.

name
string (ChargeName) [ 1 .. 60 ] characters
Example: "cardLatePayment"

Name of the charge calculation in PascalCase. Possible values: cardLatePayment, cashAdvance

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount charged for the service.

rate
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Rate applied on a basis amount to calculate the service charge.

chargeType
string (ChargeType) [ 1 .. 35 ] characters
Example: "ManagementFee"

Type of service for which a charge is asked or paid. Some possible ISO 20022 compliant values are: BrokerageFee, Commission, BackEndLoad, FrontEndLoad, Switch, DilutionLevy, Discount, ManagementFee, TransferFee, MatchingFees, PostageCharge, RegulatoryFee, ShippingCharge, ServiceProvisionFee, SpecialConcessions, PartAcquis, Penalty, ContingencyDeferredSalesCharge, Other, Equalisation, CorrespondentBankCharge, Premium, Initial, AdvisoryFee, CustodyFee, PublicationFee, AccountingFee, SignatureService, StorageAtDestination, StorageAtOrigin, Packaging, PickUp, DangerousGoodsFee, SecurityCharge, InsurancePremium, CollectFreight, ClearanceAndHandlingAtOrigin, ClearanceAndHandlingAtDestination, AirWayBillFee, TransportCharges, UCITSCommission, SpeciallyAgreedFrontEndLoad, ADRFee, IssuanceCancellationFee, MiscellaneousFee, IssuanceFee.

calculationBasis
string (CalculationBasis) [ 1 .. 35 ] characters
Example: "Monthly"

Specifies the calculation basis of a charge or fee. Some possible ISO 20022 compliant values are: Average, Daily, Other, Monthly, Annual

bearerType
string (ChargeBearerType) [ 1 .. 35 ] characters
Example: "Shared"

Specifies which party(ies) will pay charges due for processing of the instruction. BorneByDebtor, BorneByCreditor, Shared, FollowingServiceLevel

maximumAmount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Maximum amount of money asked or paid for the charge.

object (InterestCalculation)

Set of parameters used to calculate an interest.

Array of objects (LoanContractTranche)

Provides details on the tranches defined for the loan contract.

Array
sequenceNumber
string <= 20 characters
Example: "1"

Unique sequence number of the tranche.

expectedDate
string <date>
Example: "2022-04-17"

Expected tranche payment date.

dueDate
string <date>
Example: "2022-04-17"

Loan tranche due date.

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount of the tranche as defined in the loan contract.

object

Loan tranche duration.

object (TemporalDuration)

Describes a temporal duration.

unit
string [ 1 .. 36 ] characters
Example: "Months"

Unit that describes the duration.

value
integer <= 999

Value of the duration in number of units.

Array of objects (RepaymentSchedule)

Schedule of the principal payments and interests defined for the loan contract.

Array
repaymentScheduleId
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Unique and unambiguous identification of the payment schedule.

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount to be paid

expectedDate
string <date>
Example: "2022-04-17"

Expected date whereby the amount must be paid.

dueDate
string <date>
Example: "2022-04-17"

Latest date whereby the amount of money must be paid.

repaymentType
string (LoanPaymentType) [ 1 .. 35 ] characters
Example: "Principal"

Possible values are: Interest, Principal.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Collateral)
Array
amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Value of the collateral as an amount.

collateralType
string (CollateralType) [ 1 .. 60 ] characters

Specifies the type of collateral. Some possible values are: LetterOfCredit, Cash, Securities, PhysicalEntities, Insurance, StockCertificate, Bond, BankGuarantee, Commodity, Automobile, IndustrialVehicle, CommercialTruck, RailVehicle, NauticalCommercialVehicle, NauticalLeisureVehicle, Aeroplane, MachineTool, IndustrialEquipment, OfficeEquipment, ITEquipment, MedicalEquipment, EnergyRelatedEquipment, CommercialBuilding, ResidentialBuilding. IndustrialBuilding, OtherVehicle, OtherEquipment, OtherRealEstate, OtherGoodsOrInventory, Guarantee, OtherFinancialAsset, MixedCategories.

object (Agreement)

Agreement between two trading parties that contains information about their relative duties and rights regarding collateral.

Array of objects (SyndicatedLoan)

Loan offered by a group of lenders (called a syndicate).

Array
lenderId
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Party which provides an amount of money available to others to borrow.

lenderType
string (PartyType)
Example: "Person"

Possible values are: Person, Organization. Also other types of servicer internal entities: ServicerOfficer

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount of the part in the syndicated loan.

share
string <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Share part in the syndicated loan.

intraCompanyLoanIndicator
boolean
Example: false

Indicates whether the loan is an intra-company loan.

required
Array of objects (AccountParty)
Array
partyId
required
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
partyType
required
string (PartyType)
Example: "Person"

Possible values are: Person, Organization. Also other types of servicer internal entities: ServicerOfficer

partyAccountRole
required
string (AccountPartyRole) [ 1 .. 35 ] characters
Example: "AccountOwner"

Type of the account. Some possible ISO 20022 compliant values are: AccountOwner, LiquidityManager, LimitManager, PaymentManager, Reader, BackupManager, SettlementManager, FundManagementCompany, TransferAgent, FundAccountant, Registrar, InvestmentManager, Custodian, Auditor, PayingAgent, CashCorrespondent, DataProvider, FinalAgent, Investor, FirstAgent, Intermediary, Distributor, Concentrator, UnderlyingClient1, UnderlyingClient2, TransmittingAgent, FundBroker, FinancialAdvisor, ContactPersonAtInstructingPartyInstitution, ContactPersonAtExecutingPartyInstitution, NameOfAgentToOrder, PrimeBroker, Internal, LegalGuardian, DecisionMaker, Guarantor, LoanLender, LoanBorrower, LoanCoBorrower, PrimaryOwner, Trustee, CustodianForMinor, Nominee, SecondaryOwner, Executor, Beneficiary, PrimaryServicerOfficer, SecondaryServicerOfficer.

Array of objects (RelatedAccount)
Array
accountRelationType
string (AccountRelationType)

Account relation role. Possible values are: Parent, Child, Group.

accountId
string (AccountId) [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Identification assigned by the account service institution (Servicer).

accountNumber
string (AccountNumber) <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN).

Array of objects (Restriction)
Array
name
string [ 1 .. 60 ] characters
Example: "externalTransferAllowed"

Name of the restriction in PascalCase. Possible values: externalTransferAllowed, urgentTransferAllowed

restrictionPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
validFrom
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

validUntil
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

Array of objects (Limit)
Array
name
string [ 1 .. 60 ] characters
Example: "creditLimit"

Name of the limit in PascalCase. Possible values: overdraft, creditLimit

limitTypeCode
string (LimitType) <= 35 characters
Example: "DirectDebit"

Specifies the type of risk management limit. Possible ISO 20020 compliant values are: Bilateral, NetBilateral, IndirectBilateral, Global, MandatoryBilateral, DiscretionaryBilateral, DirectDebit, SingleCustomerDirectDebit, SingleFinancialInstitutionDirectDebit, TotalDailyCustomerDirectDebit, TotalDailyFinancialInstitutionDirectDebit, AutoCollateralisation, UnsecuredCredit, ExternalGuarantee

channelType
string [ 1 .. 30 ] characters

Channel type for which this limit applies. Possible values: Online, ATM

amount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount limit

percentage
string (Percentage) <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Value expressed as a percentage, for example, 0.7 is %70; 0.3333 is %33.33. total number of digits: 11 number of digits in fractional part: 10 Max Value: 1

validFrom
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

validUntil
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

usedAmount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount limit used

usedPercentage
string (Percentage) <= 23 characters ^((([0])([.][0-9]{0,10}))|[1])?$
Example: "0.7"

Value expressed as a percentage, for example, 0.7 is %70; 0.3333 is %33.33. total number of digits: 11 number of digits in fractional part: 10 Max Value: 1

status
string (LimitStatus) <= 35 characters
Example: "Requested"

Specifies the current status of a limit. Possible ISO 20020 compliant values are: Enabled, Disabled, Deleted, Requested

object (Frequency)

Specifies an event frequency

object (StatementSettings)

Specifies how often statements will be sent, in which format, to which address.

object (Frequency)

Specifies an event frequency

unit
string [ 1 .. 35 ] characters
Example: "Monthly"

Specifies a frequency. Some ISO 20022 compliant values are: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Adhoc, IntraDay, Overnight, TenDays, Fortnightly, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Hourly, TriAnnual, Bimonthly, OnDemand, Shift, TwiceAWeek, XDays, XMonths, XYears.

value
integer <= 999

Number of units, for XDays, XMonths, XYears.

communicationMethod
string (CommunicationChannelName) [ 1 .. 35 ] characters
Example: "Email"

Channel used to communicate with a party. Possible Values: Email, Fax, File, Online, PostalService, LiveSupport, ATM, IVR, Kiosk, Mobile, OnlineBanking, Phone, SMS, Card, InPerson.

format
string (DocumentFormat) [ 1 .. 35 ] characters
Example: "PDF"

Specifies a choice of format for a document. Possible Values: PDF, HTML

category
string (StatementCategory) [ 1 .. 36 ] characters
Example: "BalanceSheet"

Used to categorize the statement. Possible Values: BalanceSheet, ProfitAndLoss

subcategory
string (StatementSubcategory) [ 1 .. 36 ] characters
Example: "Cash"

Used to subcategorize the statement. Possible Values: Cash, AccountReceivable, Inventory, CurrentAssets

supplementaryData
object (SupplementaryData)

Additional information that cannot be captured in the structured elements and/or any other specific block. If this information need to be converted in ISO Messages, must be ISO 20022 compliant: it requires development of a compliant message extension model and its components must be registered in the ISO 20022 Data Dictionary. https://www.iso20022.org/catalogue-messages/additional-content-messages/supplementary-data

status
string (LoanStatus) [ 1 .. 17 ] characters
Example: "Withdrawn"

Specifies the current state of an account. Possible values names are: Pending, Form, Denied, Review, Approve, Withdrawn, Disable, Funded, Deleted

statusDateAndTime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
substatus
string [ 1 .. 35 ] characters

Status defined by the loan servicer.

openDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

fundedDate
string <date>
Example: "2022-04-17"

Date on which the loan was funded or closed

disbursalDate
string <date>
Example: "2022-04-17"

Date on which loan amount is disbursed.

Array of objects (Balance)
Array
balanceName
string (BalanceName) [ 1 .. 17 ] characters
Example: "Available"

Specifies the nature of the balance. Possible ISO 20022 compliant value names are: Current, Available, Pending, Blocked.

amount
string (AmountInCents) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

currency
string (CurrencyCode) = 3 characters ^([A-Z]{3})?$
Example: "USD"

Three contiguous letters for the representation of currencies and funds. Valid currency codes are registered with the ISO 4217 Maintenance Agency.

calculationDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Specifies the date and time at which the balance is calculated.

Array of objects (NumberOfTransactions)
Array
codeType
string [ 1 .. 50 ] characters
Example: "DetailBAI"

Name of the code in PascalCase form. Possible values are: DetailBAI, SummaryBAI, MT940

codeName
string [ 1 .. 50 ] characters
Example: "Incoming Wire"

Code value description

code
string [ 1 .. 35 ] characters
Example: "195"

Code value to identify the type of transaction.

status
string (TransactionStatus) [ 1 .. 35 ] characters
Example: "Booked"

Specifies the status of an entry on the books of the account servicer. Some possible ISO 20022 compliant values are: Booked, Future, Information, Pending.

number
integer

Number of individual transactions.

controlSum
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Total of all individual amounts.

accountId
string (AccountId) [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Identification assigned by the account service institution (Servicer).

Array of objects (RelatedCard)

Payment cards related to the account. Debit cards, for loans or current accounts. Credit cards, for credit card accounts.

Array
cardId
string (Id) [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
cardHolderName
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

cardHolderType
string (CardHolderType) [ 1 .. 35 ] characters
Example: "Primary"

Specifies the card holder type of payment card. Possible Values: Primary, Additional

principalAmount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount of money borrowed, or part of that amount which remains unpaid (excluding interest).

accruedCapitalisationAmount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount of unpaid interest (on bonds which have defaulted and have subsequently restructured), which is capitalized and added to the original principal amount of the bond.

object (RepaymentSchedule)

An amount that must be paid no sooner than the expected payment date and no later than the due date.

repaymentScheduleId
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Unique and unambiguous identification of the payment schedule.

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount to be paid

expectedDate
string <date>
Example: "2022-04-17"

Expected date whereby the amount must be paid.

dueDate
string <date>
Example: "2022-04-17"

Latest date whereby the amount of money must be paid.

repaymentType
string (LoanPaymentType) [ 1 .. 35 ] characters
Example: "Principal"

Possible values are: Interest, Principal.

object (CreditTransferDetail)

Further details on the credit transfer instruction

paymentMethod
string (PaymentMethod) [ 1 .. 35 ] characters
Example: "CreditTransfer"

Specifies the means of payment that will be used to move the amount of money. Possible ISO 20022 compliant values are: Check, CreditTransfer

paymentType
string (PaymentType) [ 1 .. 35 ] characters
Example: "On-Us"

Specifies the type of Payment. Possible values: LiquidityTransfer, On-Us, ACH, Wire

creditorAccountId
string (AccountId) [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Identification assigned by the account service institution (Servicer).

object (PaymentIdentifiers)

Set of elements used to reference a payment instruction.

object (PaymentProcessingDetail)

Provides further details of the type of payment.

chargeBearerType
string (ChargeBearerType) [ 1 .. 35 ] characters
Example: "Shared"

Specifies which party(ies) will pay charges due for processing of the instruction. BorneByDebtor, BorneByCreditor, Shared, FollowingServiceLevel

object (PartyIdentification)
object (Repayment)

An amount that must be paid no sooner than the expected payment date and no later than the due date.

repaymentScheduleId
string [ 1 .. 36 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Unique and unambiguous identification of the payment schedule.

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount to be paid

expectedDate
string <date>
Example: "2022-04-17"

Expected date whereby the amount must be paid.

dueDate
string <date>
Example: "2022-04-17"

Latest date whereby the amount of money must be paid.

repaymentType
string (LoanPaymentType) [ 1 .. 35 ] characters
Example: "Principal"

Possible values are: Interest, Principal.

object (CreditTransferDetail)

Further details on the credit transfer instruction

paymentMethod
string (PaymentMethod) [ 1 .. 35 ] characters
Example: "CreditTransfer"

Specifies the means of payment that will be used to move the amount of money. Possible ISO 20022 compliant values are: Check, CreditTransfer

paymentType
string (PaymentType) [ 1 .. 35 ] characters
Example: "On-Us"

Specifies the type of Payment. Possible values: LiquidityTransfer, On-Us, ACH, Wire

creditorAccountId
string (AccountId) [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Identification assigned by the account service institution (Servicer).

object (PaymentIdentifiers)

Set of elements used to reference a payment instruction.

object (PaymentProcessingDetail)

Provides further details of the type of payment.

chargeBearerType
string (ChargeBearerType) [ 1 .. 35 ] characters
Example: "Shared"

Specifies which party(ies) will pay charges due for processing of the instruction. BorneByDebtor, BorneByCreditor, Shared, FollowingServiceLevel

object (PartyIdentification)
paymentDate
string <date>
Example: "2022-04-17"

Payment date

Responses

Request samples

Content type
application/merge-patch+json
{
  • "accountNumber": "012345678",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "servicerBranchId": "SEA_1",
  • "loanType": "Personal",
  • "accountOwnershipType": "Owner",
  • "productId": "PD_CA_0002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "contract": {
    },
  • "parties": [
    ],
  • "relatedAccounts": [
    ],
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "statementSettings": {
    },
  • "supplementaryData": { },
  • "status": "Withdrawn",
  • "statusDateAndTime": "2022-04-17T08:00:00Z",
  • "substatus": "string",
  • "openDate": "2022-04-17",
  • "fundedDate": "2022-04-17",
  • "disbursalDate": "2022-04-17",
  • "balances": [
    ],
  • "transactions": [
    ],
  • "accountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "relatedCards": [
    ],
  • "principalAmount": "100",
  • "accruedCapitalisationAmount": "100",
  • "nextPayment": {
    },
  • "lastPayment": {
    }
}

Response samples

Content type
application/json
{
  • "accountNumber": "012345678",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "servicerBranchId": "SEA_1",
  • "loanType": "Personal",
  • "accountOwnershipType": "Owner",
  • "productId": "PD_CA_0002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "contract": {
    },
  • "parties": [
    ],
  • "relatedAccounts": [
    ],
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "statementSettings": {
    },
  • "supplementaryData": { },
  • "status": "Withdrawn",
  • "statusDateAndTime": "2022-04-17T08:00:00Z",
  • "substatus": "string",
  • "openDate": "2022-04-17",
  • "fundedDate": "2022-04-17",
  • "disbursalDate": "2022-04-17",
  • "balances": [
    ],
  • "transactions": [
    ],
  • "accountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "relatedCards": [
    ],
  • "principalAmount": "100",
  • "accruedCapitalisationAmount": "100",
  • "nextPayment": {
    },
  • "lastPayment": {
    }
}

Retrieves Loan Balances

Authorizations:
jwtopenIdConnect
path Parameters
loanId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Loan Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "loanId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "accountNumber": "012345678",
  • "balances": [
    ]
}

Retrieves Loan Transactions

Authorizations:
jwtopenIdConnect
path Parameters
loanId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Loan Identification

query Parameters
transactionId.eq
string (TransactionId) [ 1 .. 36 ] characters
Example: transactionId.eq=0dd926fe-1ca2-11ed-861d-0242ac120002

Unique reference as assigned by the account servicing institution to unambiguously identify the transaction.

amount.lte
string (AmountInCents) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: amount.lte=100

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

amount.gte
string (AmountInCents) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: amount.gte=100

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

creationDate.lte
string <date> (Date)
Example: creationDate.lte=2022-04-17

Creation date less than or equal

creationDate.gte
string <date> (Date)
Example: creationDate.gte=2022-04-17

Creation date greater than or equal

cursor
string

Specifies an opaque string value ( "no meaning" string value) at which start retrieving transactions. For instance, limit=5&cursor=62aef884fbe3470ce7d9a92140b09b17

limit
string

Specifies the number of resources to return in one request, specified as an integer from 1 to 100.

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Pagination-Cursor
required
string

Pagination Cursor

Pagination-Total
required
string

Total number of resources.

Responses

Response samples

Content type
application/json
{
  • "loanId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "accountNumber": "012345678",
  • "loanType": "Personal",
  • "currency": "USD",
  • "currentBalance": "100",
  • "availableBalance": "100",
  • "transactions": [
    ]
}

Retrieves Loan Identifiers

Authorizations:
jwtopenIdConnect
path Parameters
loanId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Loan Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "accountNumber": "012345678",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "loanId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "loanType": "Personal"
}

Retrieves Loan Parties

Authorizations:
jwtopenIdConnect
path Parameters
loanId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Loan Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "loanId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "accountNumber": "012345678",
  • "parties": [
    ]
}

Retrieves Loan Owners

Authorizations:
jwtopenIdConnect
path Parameters
loanId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Loan Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "accountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "accountNumber": "012345678",
  • "owners": [
    ]
}

Retrieves Loan Cards

Authorizations:
jwtopenIdConnect
path Parameters
loanId
required
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Loan Identification

header Parameters
servicerId
string (Id) [ 1 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "loanId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "accountNumber": "012345678",
  • "cards": [
    ]
}