Skip to main content
API docs by Redocly

PortX ORCA Account Management (0.13.1)

Download OpenAPI specification:Download

E-mail: betiana.darderes@portx.io

PortX 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

Retrieves a list of accounts matching the parameters.

Authorizations:
jwtopenIdConnect
query Parameters
accountId.eq
string (Id) [ 1 .. 300 ] characters
Example: accountId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002
partyId.eq
string (Id) [ 1 .. 300 ] characters
Example: partyId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002

Returns the customer accounts

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

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

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

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

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

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

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

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

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

An account related person with same last name.

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

An account related person with same first name.

party.name.inc
string

A related party name includes the substring provided.

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

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

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

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

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

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

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Opens an Account

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

Idempotency identifier used by the client when making repeated calls

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

Account Servicer Identification (Bank)

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

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

Core-Validation-Mode
string

<ENFORCING|PERMISSIVE|DISABLED> Indicates how the API validates requests against the core validation request policy. ENFORCING: The API validates all requests against the core validation request policy. The API only sends requests that pass validation to the back-end core service. PERMISSIVE: The API validates all requests against the validation request policy. The API sends all requests to the back-end service, regardless of whether they pass or fail the core validation. DISABLED: The API does not validate any requests against the validation request policy. The API gateway sends all requests to the core back-end service.

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

Identification of the account servicer institution at branch level or center level. To overlay the codes to produce a unique identifier the following expresion is used: BranchRegionCode-BranchSubdivisionCode.

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

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

accountType
required
string [ 1 .. 60 ] characters
Example: "Checking"

Type of the account. Some possible ISO 20022 compliant values are: Checking, CardAccount, CashPayment, Charges, CashIncome, Commission, ClearingParticipantSettlementAccount, LimitedLiquiditySavingsAccount, MarginalLending, MoneyMarket, NonResidentExternal, Overdraft, OverNightDeposit, Settlement, Salary, Savings, Tax, TransactingAccount, CashTrading, VirtualAccount, CreditCard, DebitCard, Universal, Investment, EpurseCard, CertificateOfDeposit, MoneyMarketChecking, RetirementAccount, RetireeReimbursementAccount, StockOrBond, PrePaid, FleetCard, Cash, DebitAccount, CreditAccount, Benefit, HealthSavingsAccount, FlexibleSpendingAccount, ForBenefitOf, Estate, ClientTrustAccount, LawyersTrustAccount, KeoghPlanAccount, UniformTransfersToMinorsAct, UniformGiftsToMinorsAct, ReserveFunds, SelfDirectedBrokerage, IRA, Annuity, ExternalAccount, Loan, CommercialLoan, MortgageLoan, SafeDepositBox.

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
number
string [ 1 .. 40 ] characters

Identification assigned by an institution or internally to connect to other applications.

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

Name of the identification scheme, in PascalCase. Possible ISO 20022 compliant values names are: IssuerIdentificationNumber, BBANIdentifier, CHIPSUniversalIdentifier, UPICIdentifier, IBANIdentifier. Other possible values: CreditBackIdentification, UniversalLoanIdentifier, HMDAUniversalLoanIdentifier, CommitmentNumber, RecordNumber, FlexDataRecordNumber, RegistrationNumber, ExternalAccountId, MortgageNumber, DepartmentNumber.

issuer
string [ 1 .. 35 ] characters

Entity that assigns the identification.

securedIndicator
boolean

Indicates whether the Account is secure.

securedType
string (SecuredAccountType) [ 1 .. 17 ] characters
Example: "Collateral"

Indicates how the account is secured. Possible Values: Collateral, Agent

object (AccountPaymentDetails)

Account payment information.

numberOfPayments
integer

Number of payments.

object (RepaymentSchedule)

Generic transaction code definition.

Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

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

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects (PaymentIdentification)
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

object (Repayment)

Generic transaction code definition.

Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

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

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

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

Identification of the Payment.

reversalIndicator
boolean (ReversalIndicator)

Indicates whether or not the transaction is the result of a reversal. Usage: This element should only be present if the entry is the result of a reversal. If the CreditDebitIndicator is Credit and ReversalIndicator is Yes, the original operation was a debit entry. If the CreditDebitIndicator is Debit and ReversalIndicator is Yes, the original operation was a credit entry.

object (RemittanceInformation)

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system.

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

Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit entry. Usage: If entry status is pending and value date is present, then the value date refers to an expected/requested value date.

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

Date and time when an entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.

Array of objects (TransactionCharge)

All charges and taxes applied to the transaction. Also can include interests if the bank does not discrimate between them.

Array of objects (TransactionInterest)

All interests included in the transaction amount.

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

Original date on which the payment was posted to the account.

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

Amount payed.

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

Date of the billing cycle for the account.

paymentReason
string (PaymentPurpose) [ 1 .. 60 ] characters
Example: "CashManagementTransfer"

Underlying reason for the payment transaction. Possible Values: Allowance, LoanPrincipal, CashManagementTransfer, LoanStandardPayment, LoanPayment, LoanAdditionalPayment, LoanInterest, OverageInterest, OveragePrincipal, EscrowPayment, FeePayment.

paymentName
string [ 1 .. 35 ] characters

Human readable pascal case identifier of the payment concept. Possible values: CurrentLoanNextPayment.

object (RepaymentSchedule)

Generic transaction code definition.

Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

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

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects (PaymentIdentification)
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

object (RepaymentSchedule)

Generic transaction code definition.

Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

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

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects (PaymentIdentification)
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

Array of objects (Repayment)

All the payments done, scheduled or not.

Array
Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

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

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

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

Identification of the Payment.

reversalIndicator
boolean (ReversalIndicator)

Indicates whether or not the transaction is the result of a reversal. Usage: This element should only be present if the entry is the result of a reversal. If the CreditDebitIndicator is Credit and ReversalIndicator is Yes, the original operation was a debit entry. If the CreditDebitIndicator is Debit and ReversalIndicator is Yes, the original operation was a credit entry.

object (RemittanceInformation)

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system.

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

Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit entry. Usage: If entry status is pending and value date is present, then the value date refers to an expected/requested value date.

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

Date and time when an entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.

Array of objects (TransactionCharge)

All charges and taxes applied to the transaction. Also can include interests if the bank does not discrimate between them.

Array of objects (TransactionInterest)

All interests included in the transaction amount.

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

Original date on which the payment was posted to the account.

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

Amount payed.

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

Date of the billing cycle for the account.

paymentReason
string (PaymentPurpose) [ 1 .. 60 ] characters
Example: "CashManagementTransfer"

Underlying reason for the payment transaction. Possible Values: Allowance, LoanPrincipal, CashManagementTransfer, LoanStandardPayment, LoanPayment, LoanAdditionalPayment, LoanInterest, OverageInterest, OveragePrincipal, EscrowPayment, FeePayment.

paymentName
string [ 1 .. 35 ] characters

Human readable pascal case identifier of the payment concept. Possible values: CurrentLoanNextPayment.

object (Frequency)

How often principal payments are due.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

object (Frequency)

How often interest payments are due.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

draftDayAdjuster
integer <= 31
Example: 30

Number of days before or after an automatic payment is debited from an account.

automaticIndicator
boolean

Indicates whether, prior to the loan going past due, a payment is automatic generated.

paymentType
string (PaymentType) [ 1 .. 35 ] characters
Example: "OnUs"

Specifies the type of Payment. Possible values: LiquidityTransfer, OnUs, ACH, Wire, NotOnUs.

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

First payment date

object (RepaymentBillDetails)

Billing information of the payment

billingOption
string <= 60 characters

AutomaticPayment, LumpSumPayment, NegotiatedBillingOptio, AcceleratedBillingOption.

billingDay
integer <= 31
Example: 30

Identifies the day of the month that billing statements are generated.

rebillStatus
string (RepaymentBillStatus) [ 1 .. 40 ] characters
Example: "RebillRequest"

Indicates whether a payment will be recalculated, rebilled and notified to the customer. Possible values: NoRequest, RebillRequest, ReNotifyCustomer.

rebillInterestIndicator
boolean

Indicates whether interest will be rebilled when transactions occur during the forecast period.

leadDays
integer

Identifies the time between creating a receivable and the due date.

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

The statement date interest was billed.

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

The due date of the next interest payment due that is not past due.

object (Frequency)

How often principal payments are billed.

Array of objects (Balance)

Bill balances

object (AccountPayout)

Distribution of funds or assets to an individual or entity. In relation to investments, loans, insurance policies, and retirement accounts.

object (Frequency)

Indicates the schedule for paying to accounts.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

paymentType
string (AccountPaymentMethodType) [ 1 .. 35 ] characters
Example: "Compound"

Specifies the type of interest payment. Possible values are: Compound, Checking, Savings, Check, Capitalize, TransferToAccount, CertificateOfDeposit, Deposit, DepositLoan, Loan.

paymentTypeOptions
Array of strings
Example: ["Primary"]
paymentName
string [ 1 .. 35 ] characters

Human readable pascal case identifier of the payment concept. Possible values: CreditBack, Interest.

accountId
string [ 1 .. 300 ] characters
Example: "033-DDA-123456"

The account id that receives interest credits.

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

The reference number of the interest pay to the account.

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

Last payment date

lastPaid
string (PositiveAmount) <= 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

Array of objects (GenericCode)

Additional payment codes. Posible values: PaymentCalculus, specifies how the credit back portion of an automatic service charge is calculated. PaymentReference, additional payment reference to link with other parts of the system.

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

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

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
payoutType
string (AccountPayoutType) [ 1 .. 35 ] characters

Account payout can be classified into two main categories: immediate and deferred. Possible Values: Immediate, Deferred.

payoutName
string (AccountPayoutName) [ 1 .. 35 ] characters
Example: "ClubPay"

Payout nature of the Account. Possible Values: ClubPay.

payoutOption
string (AccountPayoutOption) [ 1 .. 35 ] characters

Distinguishes options in payouts products. Possible values: Fixed, Variable

amount
string (PositiveAmount) <= 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

enableIndicator
boolean

Indicates whether the account payouts are disbursed or not.

payoutsNumber
integer

Total number of payouts

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

Cash surrender value (net) available if contract is surrendered

changePercentage
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Percentage of the accumulated value to be paid to the payee each year.

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

Amount of the accumulated value to be paid to the payee each year.

object

Duration of payout frequency

unit
required
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 (Balance)
Array
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

balanceName
string (BalanceName) [ 1 .. 50 ] characters
Example: "Available"

Specifies the nature of the balance. Possible values: Current, Available, Pending, Opening, Blocked, Previous, RelatedBalance, OnHold, PendingLedger, Collected, LastAnniversary, CurrentAccrued, PreviousAccrued, CurrentWithLastCalculus, CarriedAdjustment, PaidWithPenalties, Accrued, Penalty, Fees, Withholding, CollectionLedger, LastLedger, CurrentLedger, Ledger, MinimumAvailable, MinimumLedger, Withheld, CurrentBooked, CurrentBook, LastDeposit, FloatAmount, Average, RegulationDDAvailable. Loan Balances: CashProceeds, the amount that a customer actually received, exclusive of insurance premiums, fees, and unearned discount; FinancedExpenses, indicates the amount of expenses an institution has financed for a borrower; TotalInterest; AdditionalInterest, if the date of the first payment is beyond one month from the note date, the interest for the odd days will be earned during the first interest period; DeferredUnsecuredPrincipal, is the outstanding balance of an unsecured debt. The DUPB includes any accrued interest that is yet to be paid by the borrower. The deferral typically occurs due to bankruptcy or debt relief proceedings, which temporarily halt collection efforts by the original creditor; Charge Balances: Earned, RealTimeDeliveryMaximum, Current, Financed, Prepaid, CurrentEarned, CurrentEarnedOtherEscrow, InterestPaidToDate, InterestPaidThisYear, InterestPaidPreviousYear, InterestPaidLastStatement, InterestPaidThisYear, RevolvingCreditPaid, BasePaidToDate, TotalPastDue, Escrow, AppliedEscrow, UnpaidEscrow, EscrowBucket, Principal, Interest, Fees, BilledFees, OtherEscrow, FinalAmount, FinalInterestAmount, Chapter4PreviousYear, Payments: Delinquent, FixPayment, Transaction, LoanPayOff, PrincipalAndInterest, AvailableCash, AvailableCheck, AvailableCredit, Sweep, Float, MemoLedger, Memo, AvailablePending, LedgerPending.

amount
string (Amount) <= 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

count
integer

Number of transactions added to the amount.

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 (GenericCode)

Bank defined codes to classify balances. Possible values: BalanceCategory, BalanceType, PartyAgreementNumber.

ownershipType
required
string (AccountOwnershipType) [ 1 .. 100 ] characters
Example: "SingleOwnerAccount"

Specifies the type of account ownership. Possible ISO 20022 compliant values names are: JointAccountWithSurvivorshipRights, JointAccountWithSurvivorshipRightsPayableOnDeath, JointAccountInCommon, CustodialAccount, FinancialInstitution, SingleOwnerAccount, JointAccount, JointAnd, Corporation, Organization, Business, FormalPartnership, FormalTrust, Nominee, NonProfitOrganization, NotForProfitOrganization, ForProfit, EUResidualEntity, USGovernmentOrganization, NonUSGovernmentOrganization, GovernmentOrganization, LimitedLiabilityCompany, RegisteredInvestmentCompany, Entrepreneurial, Unincorporated, LimitedPartnership, LimitedLiabilityPartnership, BareOwner, Usufructuary, Fiduciary, ServicerEmployeeAccount, BusinessTrust, FamilyTrust, Estate, PublicFunds, NonUSGovernmentOrganization, Church, Club. More general possible values: Direct, Indirect, ConvenienceAccount, CommunityProperty, CommunityPropertyWithSurvivorshipRights, TottenTrust, PayableOnDeath, UniformTransfersToMinorsAct, UniformGiftsToMinorsAct, InTrustFor, RepresentativePayee, ProfessionalAssociation.

balanceType
string (Balance Type)
Example: "Asset"

Account Balance Type. Possible Values: Asset, positive transaction amount increases balance; Liability, positive transaction amount decreases balance; Equity.

productId
string (ProductId) [ 1 .. 36 ] characters
Example: "PD_CA_0002"

Identification of the product offered by a financial institution to its customers.

pricingStrategyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
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 (Amount) <= 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

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

Initial desposit date

object (AccountContract)

Account contractual details between the owners and the account servicer.

documentReference
string [ 1 .. 35 ] characters

Document location.

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

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

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

object (Jurisdiction)

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

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

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

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

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

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

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

object (ContactDetails)

Specifies the contact details of a person.

object (StructuredName)

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

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

Preferred name to contact the person

firstContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
lastContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (Phone)
Array of objects (Email)
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 Organization or building.

Array of objects (CommunicationChannel)
preferredMethod
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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, Default.

object (AccountContractRelatedParty)
partyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
partyType
string (PartyType)
Example: "Person"

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

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.

agreementType
string (AgreementType)

Document or agreement type. Possible values: CardAgreement, AccountContract.

agreementSubtype
string [ 1 .. 60 ] characters

Agreement detailed category.

documentId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
Array of objects (GenericIdentification)

Unique indentification of the collateral. Possible scheme names: NoteNumber.

Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification.

schemeName
required
string [ 1 .. 35 ] characters

Name of the identification scheme.

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.

status
string (AccountContractStatus) [ 1 .. 35 ] characters
Example: "Active"

Specifies the current status of an account contract. Possible values are: Active, Expired, GracePeriod, Terminated, Waiver.

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 (MasterAgreement)

A master agreement is a document that outlines the terms and conditions of an agreement between two or more parties. It's common to use a master agreement when there are multiple agreements in place with one company.

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

Account at Master Agreement level used as a reference for the Loan opening. Payments are auto-debited from this account.

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

Account at Master Agreement level used as a reference for the Loan opening. Payments are auto-debited from this account.

documentReference
string [ 1 .. 35 ] characters

Document location.

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

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

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

object

The payment term for the account premium.

object (TemporalDuration)

Describes a temporal duration.

timesExtended
integer <= 100

The number of times the loan has been extended over its term.

timesRenewed
integer <= 100

The number of times the loan has been renewed over its term.

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

Amount of the customer premium.

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

Total amount of money the user is insured for.

productId
string (ProductId) [ 1 .. 36 ] characters
Example: "PD_CA_0002"

Identification of the product offered by a financial institution to its customers.

Array of objects (GenericCode)
Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

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

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
Array of objects (SpotDate)

Contract dates. Possible values: LossMitigation

Array
name
string (SpotDateName) [ 1 .. 40 ] characters
Example: "Expiration"

Possible values por projected dates: Forecast, Expiration, LastNonFinancial, Escheat. Possible values for past dates: IRALastRollOver. Other possible values: EffectiveDate, ResponseByDate.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
required
Array of objects (AccountDetailedParty)
Array
Array of objects (GenericIdentification)
Array of objects (GenericCode)

Codes to link the party with other systems or to classify the party. Possible values: RemoteDepositRisk.

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.

nameTemplateId
string (NameTemplateId) [ 1 .. 36 ] characters
Example: "1"

Template used to display the party name. This is an external id provided by the account servicer.

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.

object (PlaceAndDateOfBirth)

Date and place of birth of a person.

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

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

status
string (PartyStatus) [ 1 .. 35 ] characters
Example: "GoodStanding"

Specifies the current primary status of a party. Possible values are: GoodStanding, FraudAlert, BadCustomer, Active, Delinquent, Default, HighRisk, UnderReview, HotCarded, WildCarded. Other possible values: PersonalBankruptcy, GrowingConcern, WatchLoan, InReceivership, Chapter11, Liquidation.

statusDateAndTime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
coveredByMilitaryLendingActIndicator
boolean

Indicates if the borrower is covered under the Military Lending Act.

militaryMemberIndicator
boolean

Indicates whether the person is is service member/military.

object (DateTimePeriod)
object (Employment)
object (Audit)

Resource Audit Information. Captures the creation, modification and maintenance details.

Array of objects (PostalAddress)
object (StructuredName)

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

Array of objects (Phone)
organizationType
string (OrganizationType)
Example: "Corporation"

Specifies the legal standing of the organization. Possible values are: Government, NonGoverment NonUSGovernmentOrganization, USGovernmentOrganization FinancialInstitution, SoleProprietorship, UnincorporatedAssociation, LimitedLiabilityPartnership, LimitedLiabilityCompany, SingleMemberLimitedLiabilityCompany, LimitedPartnership, FormalPartnership, GeneralPartnership, Business, Corporation, NotForProfit, ForProfit, NonProfitCorporation, NonProfit, Club, Supranational, Sovereign, Municipal, Province, State, County, National, ExemptionTrust, LivingTrust, EmployeeTrust, RevocableTrust, IrrovocableTrust, NakedTrust, FamilyTrust, BussinesTrust, CliffordTrust, FormalTrust, PublicAgency, Association, Church, PublicFunds. International & Foreign Business Entities: PersonaFisica, SociedadCivil, SociedadAnonimaCapitalVariable, SociedadResponsabilidadLimitada, SociedadAnonimaCapitalVariable.

customerType
string (CustomerType)
Example: "Consumer"

A customer type of a bank account can be classified into different categories based on the account's features, purpose, and benefits. Possible Values: Personal, Business, Consumer, Organization, ThirdParty, Estate, Employee, ForeignConsumer.

taxReportingIndicator
boolean

Account tax reporting typically involves obtaining and submitting records related to your tax obligations. For individuals, this may include income, qualifying deductions, and investment gains or losses. Businesses, on the other hand, have additional complexities, such as tracking funds directed towards specific business expenses and shareholders.

taxStatus
string
Example: "Exempt"

Exempt, Retain, ExemptExpired, VoluntaryWithholding, Chapter3, Chapter4, C-Corp, S-Corp, Certified, W-8Required, NotCertified.

Array of objects (PaymentCardDescriptor)
Array of objects (Balance)

Balances related to the party

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

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

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

Type of the account party role. Some possibles values are: Comaker, Cosigner, AccountOwner, AccountSigner, ATMDebitCardHolder, CreditCardHolder, LiquidityManager, Endorser, 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, Minor, Nominee, SecondaryOwner, Executor, Beneficiary, PrimaryServicerOfficer, SecondaryServicerOfficer, AccountOpenningOfficer, CustomerServiceOfficer, PowerOfAttorney, ContingentBeneficiary, Fiduciary, ControlPerson, AuthorizedPerson, Dealer, DoingBusinessAs, Grantor, SecondaryTrustee, RepresentativePayee, RestrictedOwner.

partyAccountRoleCode
string
Example: "50"

Bank defined party account role.

beneficiaryPercentage
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Percentage value of the ownership that the party has in the account.

beneficiaryAmount
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Actual dollar amount of the liability for this account.

accountOwnerRelation
string [ 1 .. 40 ] characters
Example: "PrimaryServicerOfficer"

Identifies how the party is related to the owner of the account.

Array of objects (Restriction)

Party restrictions on the account capabilities

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)
Example: "SubAccount"

Account relation role. Possible values are: Parent, EscrowAccount, SubAccount, ControlAccount, CrossAccount, ChargeAccount, AssociatedAccount, IRAAccount, CombinedStatement, SecondaryCombinedStatement, SummaryAccount, FundingSource, CompensatingAccount. Payment related values: Authorized, Counterpart

accountId
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

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

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

accountType
string (RelatedAccountType) [ 1 .. 60 ] characters
Example: "Checking"

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

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.

productId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
Array of objects (GenericCode)

Account related codes

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

Account used as a reference for the account opening.

Array of objects (SpotDate)
Array
name
string (SpotDateName) [ 1 .. 40 ] characters
Example: "Expiration"

Possible values por projected dates: Forecast, Expiration, LastNonFinancial, Escheat. Possible values for past dates: IRALastRollOver. Other possible values: EffectiveDate, ResponseByDate.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
initialFundingSource
string (FundingSource) [ 1 .. 60 ] characters
Example: "CreditTransfer"

Source of funds for the account. Possible values: CreditTransfer, NewCustomer, FundsFromExistingCustomer

Array of objects (SpotDate)

Projected account dates. Possible values: AnticipatedPayOff.

Array
name
string (SpotDateName) [ 1 .. 40 ] characters
Example: "Expiration"

Possible values por projected dates: Forecast, Expiration, LastNonFinancial, Escheat. Possible values for past dates: IRALastRollOver. Other possible values: EffectiveDate, ResponseByDate.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (Restriction)
Array
name
required
string [ 1 .. 60 ] characters
Example: "WireTransferIn"

Name of the restriction in PascalCase. Possible values: TransferIn, TransferOut, WireTransferIn, WireTransferOut, ACHTransferIn, ACHTransferOut, ForeignIncomingWires, ForeignOutgoingWires, ACHTransfers, InternetBankingTransfer, InternetView, InternetInquiry, ForeignOutgoingIran, Withdrawals, Renew, Transfers, AdvanceTransfer, OnlineBanking, ElectronicBanking, InvestmentAllowed, InvestmentSetUpAllowed, DebitCardAllowed, CheckOrderAllowed, AutomaticSweep, AccountManagement

restrictionPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
enableIndicator
boolean
Example: true

Indicates whether the capability is allowed or not.

disableConditions
Array of strings (ConditionName) [ items [ 1 .. 36 ] characters ]
Example: ["LessThanMinAmount"]

Conditions that disabel the restriction.

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.

status
string (RestrictionStatus) [ 1 .. 36 ] characters
Example: "Pending"

Specifies the status of a restriction enablement request. Possible values: Enable, Pending, InquiryOnly, Disable, Requested.

Array of objects (Limit)
Array
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

name
required
string [ 1 .. 60 ] characters
Example: "CreditLimit"

Name of the limit in PascalCase. Possible values: NSF, UncollectedFunds, Overdraft, CreditLimit, CreditCard, Withdraw, CreditCardWithdraw, ForeignFeesWaived, CreditTransactions, DebitTransactions, ATMSurchargeReimbursement, CashAdvance, ACHInTransfers, ACHOutTransfers, OverdraftProgram, Threshold, MinimumTransfer, MinimumAdvance, DomesticWireTransferIn, DomesticWireTransferOut, ForeignWireTransferIn, ForeignWireTransferOut.

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

Specifies the type of risk management limit. Bilateral, NetBilateral, IndirectBilateral, Global, MandatoryBilateral, DiscretionaryBilateral, DirectDebit, SingleCustomerDirectDebit, SingleFinancialInstitutionDirectDebit, TotalDailyCustomerDirectDebit, TotalDailyFinancialInstitutionDirectDebit, AutoCollateralisation, UnsecuredCredit, ExternalGuarantee, Revolving, NotRevolving.

channelType
string [ 1 .. 30 ] characters

Channel type for which this limit applies. Possible values: OnlineATM, OfflineATM, ATM, SaleTerminal, : Check, ACHDebit, DebitCard, BillPayment.

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

Amount limit

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

Amount limit currency.

number
integer

Number limit.

enableIndicator
boolean
Example: true

Indicates whether the limit is enabled or not.

feesConsentIndicator
boolean
Example: true

Indicates that the institution received customer consent to assess fees when the limit is exceeded.

percentageIndicator
boolean

Indicates if the limit is calculated as a percentage.

percentage
string (Percentage) <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Value expressed as a positive or negative percentage, rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. total number of digits: 11 number of digits in fractional part: 10 Max Value: 100

temporaryIndicator
boolean
Example: true

Indicates whether the limit is temporary or not.

object (DateTimePeriod)
object (Frequency)

Renewal frequency

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

Amount limit used

usedNumber
integer

Number limit used.

usedPercentage
string (Percentage) <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Value expressed as a positive or negative percentage, rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. total number of digits: 11 number of digits in fractional part: 10 Max Value: 100

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

Specifies the current status of a limit. Possible values are: Enabled, Disabled, Deleted, Requested, NotAuthorized (The limit is not authorized by the customer). Other values: CustomerEnrolled, CustomerNotEnrolled, InstitutionEnrolled.

statusDateAndtime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
object (LimitHistory)

Historic values of a Limit

Array of objects (Balance)
Array of objects (GenericCode)

Additional limits codes.

accessConditions
Array of strings (ConditionName) [ items [ 1 .. 36 ] characters ]
Example: ["LessThanMinAmount"]

Limit access condition. Possible values: BeforeTransfers, AfterTransfers: Overdraft Limit is accessed before or after automatic transfers. Other values: POSTransactions, ATMTransactions, when the customer authorize the payment of ATM or POS transactions, if the transaction was to overdraw the account.

notificationOptions
Array of strings
Example: ["Exception"]
Array of objects (AccountPayment)

Payments methods to cover the amount limit overdraft.

object (FinancialStatement)

Specifies financial statement details.

object (Frequency)

The frequency of the regular statement.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

object (Frequency)

The next frequency of the regular statement.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

Array of objects (StatementCommunicationChannel)
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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

Communication value such as phone number or email address.

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

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

printOnNextCycleIndicator
boolean

Indicates whether the statement will be produced at the end of the next statement cycle.

Array of objects (GenericCode)

Codes to determine configurarion options for alerts and notifications. Possible code names: NoticeOption.

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

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

Array of objects (GenericCode)

Codes related to statements or internal handling codes associated with the statement. Possible Values: CombinedCode, SpecialStatement, DetailsFormat, StatementGroup, ProfitabilityOption.

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

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

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
Array of objects (GenericIdentification)

Identification of statement instances and related. Possible values: schemeName: LastCombinedStatement, CombinedStatementAccountId

Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification.

schemeName
required
string [ 1 .. 35 ] characters

Name of the identification scheme.

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.

templateCode
string (StatementTemplateId) [ 1 .. 36 ] characters
Example: "1"

Template used to create the statement document. This is an external code provided by the account servicer.

object (Period)
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

object (Period)
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

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

The date of the last statement.

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

The date of the next statement.

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

The date on which service charges will be applied to an account

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

The date of the statement previous from the last.

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

The date of the last regular statement.

truncationOptions
Array of strings
Example: ["ItemsIncluded"]
accountNameIndicator
boolean

Indicates whether the account name is printed on the statement.

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, Default.

combineType
string [ 1 .. 36 ] characters
Example: "SavingsStatement"

Indicates whether account transactions are printed on a combined statement. Possible combinations: CheckingStatement, SavingsStatement, PrimaryAccount, SecondaryAccount.

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

profitabilityModelId
string (StatementModelId) [ 1 .. 36 ] characters
Example: "1"

Model used to calculate customer profitability. This is an external id provided by the account servicer.

lastIRAStatementDate
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 (InterestCalculation)
Array
name
string (InterestName) [ 1 .. 40 ] characters
Example: "Deposit"

Name in PascalCase of the interest that applies to the account. For instance, Deposit. Also identifications of the interest or charge.

interestCode
string <= 50 characters

Interest calculation code used by the account servicer.

dayCountBasis
string (InterestDayCountBasis) [ 1 .. 50 ] characters
Example: "Actual360"

An interest day count basis is a method used to calculate interest accrual over a period of time for loans and bonds. The method involves determining the number of days over which interest is being calculated, known as the accrual period. The resulting accrual period is then divided by a certain number to calculate the daily interest rate, which is applied to the principal balance to determine the interest payment. Possible Values: ActualActual, Actual360, Actual365, 365365, 360360, Monthly78ths, 365360, ActualSchedule, ScheduleSchedule.

calculationMethodOption
string (InterestComputationParameter) [ 1 .. 50 ] characters
Example: "LastInterest"

Specifies a parameter that apply at the interest day count basis. Possible Values: LastInterest, EqualPayment, InterestAndPrincipal, InterestSeparatedm, Amortized, AddOn, NegativeAmortization, Simple, FHLMC.

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

An accrued date is a hypothetical point in time when the interest should have been paid.

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

lastInterestDate
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

The period funds are earning interest.

enableIndicator
boolean
Example: true

Indicates whether the interest is enabled for automatic charge.

compoundingMethod
string [ 1 .. 35 ] characters
Example: "Deposit"

Indicates the compounding method used for interest calculations.

object (Frequency)

Frequency of the interest calculation and compounded during the term.

object (Frequency)

Specifies an event frequency

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

Total interest that has accumulated over a day.

object

Details on the interest payment.

Array of objects (Balance)

Total amounts related to an interest. Possible Values: CurrentEarned, 2021AsOfDate, 2020AsOfDate, 2019AsOfDate, CutOffAvailable, CutOffAverageAvailable, CutOffAverageLedger, CutOffAverageMinimumLedger, CutOffLedger, CutOffMinimumLedger

object (InterestRenewalDetails)

Detailed interest attributes related to rate change at maturity.

object (InterestCycle)

Set of parameters used to calculate an interest cycle.

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

The amount of automatic interest that was last posted to the account.

reportingIndicator
boolean

Identifies whether interest earned or paid is reportable.

reportingOptions
Array of strings (InterestReportingOption) [ items [ 1 .. 35 ] characters ]
Example: ["Deposit"]
object (TaxForm)

Information of the form requested by the tax payer.

object (Frequency)

The frequency used in calculating the Regulation DD Annual Percentage Yield (APY) when the financial institution requires interest to be withdrawn (i.e. compounding interest is not an option.) The Regulation DD Compound Frequency overrides the interest frequency only in computing the APY. For example, an account with interest paid monthly by check but disclosed as annual compounding.

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

Annual Percentage Yield (APY) is a measure used in finance to express the total return on an investment, taking into account both the interest earned and the appreciation in the investment's value, over a specified period. It is expressed as a percentage and is often used for fixed income securities such as bonds, and money market accounts.

daysSinceLastAnniversary
integer

The number of calendar days processed since the last anniversary date

Array of objects (InterestCalculationRate)

Rates involve on interest calculation.

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

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

rateTieredType
string (InterestTieredRateType) [ 1 .. 35 ] characters
Example: "Whole"

Specifies the type of tiered interest rate. Possible values: Whole, Split, Dynamic.

rateAmountType
string (BalanceName) [ 1 .. 50 ] characters
Example: "Available"

Specifies the nature of the balance. Possible values: Current, Available, Pending, Opening, Blocked, Previous, RelatedBalance, OnHold, PendingLedger, Collected, LastAnniversary, CurrentAccrued, PreviousAccrued, CurrentWithLastCalculus, CarriedAdjustment, PaidWithPenalties, Accrued, Penalty, Fees, Withholding, CollectionLedger, LastLedger, CurrentLedger, Ledger, MinimumAvailable, MinimumLedger, Withheld, CurrentBooked, CurrentBook, LastDeposit, FloatAmount, Average, RegulationDDAvailable. Loan Balances: CashProceeds, the amount that a customer actually received, exclusive of insurance premiums, fees, and unearned discount; FinancedExpenses, indicates the amount of expenses an institution has financed for a borrower; TotalInterest; AdditionalInterest, if the date of the first payment is beyond one month from the note date, the interest for the odd days will be earned during the first interest period; DeferredUnsecuredPrincipal, is the outstanding balance of an unsecured debt. The DUPB includes any accrued interest that is yet to be paid by the borrower. The deferral typically occurs due to bankruptcy or debt relief proceedings, which temporarily halt collection efforts by the original creditor; Charge Balances: Earned, RealTimeDeliveryMaximum, Current, Financed, Prepaid, CurrentEarned, CurrentEarnedOtherEscrow, InterestPaidToDate, InterestPaidThisYear, InterestPaidPreviousYear, InterestPaidLastStatement, InterestPaidThisYear, RevolvingCreditPaid, BasePaidToDate, TotalPastDue, Escrow, AppliedEscrow, UnpaidEscrow, EscrowBucket, Principal, Interest, Fees, BilledFees, OtherEscrow, FinalAmount, FinalInterestAmount, Chapter4PreviousYear, Payments: Delinquent, FixPayment, Transaction, LoanPayOff, PrincipalAndInterest, AvailableCash, AvailableCheck, AvailableCredit, Sweep, Float, MemoLedger, Memo, AvailablePending, LedgerPending.

pastDueOptions
Array of strings[ items [ 1 .. 70 ] characters ]

Indicates how the Past Due Rate is applied to past due loans. After a loan payment is past due after certain days, interest is earned retroactively from the payment due date.

Array of objects (VariableInterestChanges)
Array of objects (ChargeCalculation)
Array
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

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

Unique identifier of charge.

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

Name of the charge calculation in PascalCase. Possible values: Fee, Overdraft, CardLatePayment, CashAdvance, LatePayment, CashWithdrawal, EarlyWithdrawal, Dormant, EIM, NonSufficientFunds, ATM, BillPayment, FDIC, Overdraft, OverdraftInterest, OverdraftCourtesy, ReturnedItem, DeclinedCheck. Service Charge values: AutomaticActivityCharge, MaintenanceActivityCharge, MaintenanceServiceCharge. ServiceCharge, ServiceChargeCreditBack. Also other external codes to identify the charge.

status
string (ChargeStatus) <= 40 characters
Example: "Charged"

Specifies the current status of the charge. Possible values are: Charged, Waived, AnalysisAddenda, AddendaCharged, AddendaChargedOnCycleDay.

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

Amount charged for the service.

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

Charge currency

rate
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

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, 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, Fee, Insurance, NonTaxable, Recurring, Taxable.

exemptIndicator
boolean

Indicates whether the account is exempt of the charge.

exemptPeriodsNumber
integer

Indicates the number of charge periods that the account is exempt from charges.

Array of objects (GenericCode)

Additional charge codes. Possible values: CalculationCodeNumber, ServiceChargePrefix, ServiceChargeCode.

calculationMethodCode
string [ 1 .. 60 ] characters

Servicer charge calculation code in Pascal Case. Possible values: FIFO, older payment past due. LIFO, most recent payment past due. Also could be a Bank defined string.

calculationMethodOptions
Array of strings (ChargeCalculationMethodOption) [ items [ 1 .. 70 ] characters ]

Indicates other calculation method options for charge calculation.

options
Array of strings (ChargeOptions) [ items [ 1 .. 50 ] characters ]
Example: ["NSFDefault"]
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, Monthly, Annual, FullTerm, RemainingTerm, Monthly78th

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.

maximumNumber
integer

Maximum Number of charges.

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

Minimum amount of money asked or paid for the charge.

enableIndicator
boolean
Example: true

Indicates whether the charge is enabled for automatic charge.

object (InterestCalculationDescriptor)

Set of parameters used to calculate an interest.

debitIndicator
boolean

Indicates whether the charge is automatically debited from the defined account.

Array of objects (AccountPayment)

Payments methods to waive o to pay back the charge.

object (Frequency)

Specifies an event frequency

Array of objects (Balance)
description
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
Array of objects (Tax)
Array
taxType
string (TaxType) [ 1 .. 35 ] characters
Example: "TaxCredit"

Specifies the type of tax. Possible ISO values are: ValueAddedTaxOfZeroRate, Provincial, NationalTax, StateTax, WithholdingTax, CapitalGainTax, InterimProfitTax, StampDuty, WealthTax, InheritanceTax, SolidaritySurcharge, TaxCredit, Equalisation, GiftTax, ConsumptionTax, AlternativeMinimumTax, LocalTax, NationalFederalTax, PaymentLevyTax, StockExchangeTax, TransactionTax, TransferTax, ValueAddedTax, LocalBrokerCommission, ExecutingBrokerCommission, EUTaxRetention, Aktiengewinn1, Aktiengewinn2, Zwischengewinn, CustomsTax, Mietgewinn, GermanLocalTax3, GermanLocalTax4, GermanLocalTax2, WithholdingOfForeignTax, WithholdingOfLocalTax, CapitalLossCredit, FederalWithholding, StatelWithholding.

name
string (TaxName) [ 1 .. 60 ] characters
Example: "Sales"

Name of the tax in PascalCase. Possible values: Sales.

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

Rate applied on a basis amount to calculate the withholding.

debitIndicator
boolean

Indicates whether the tax is automatically debited from the defined account.

taxReportingIndicator
boolean

Flag to indicate that the tax should be reported to the party.

Array of objects (Balance)

Total amounts related to the tax type

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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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

Communication value such as phone number or email address.

channelPurpose
string (CommunicationChannelPurpose) [ 1 .. 40 ] characters
Example: "PrivacyNotices"

Communication purpose of the channel. Possible values: Alerts, PrivacyNotices, NegativeBalance, OverdraftProtection, ACHNotice, ChargeBack, BalanceOnReceipt, RegulationCCNotice, RateChange, MaturityNotice, InterestNotice, RegularNotice, PastDueNotice, HUDNotice, PaymentChange, AutomaticPayment, PastDueFirstNotice, PastDueSecondNotice, PastDueNoticeGuarantor, CardHolderAuthorization, Delivery, DocumentDistribution.

codeWord
string

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

alertIndicator
boolean

Indicates whether the channel is used for enterprise alerts to the customer.

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

The party authorized to use the communcation channel

Array of objects (GenericCode)

Codes to determine configurarion options for alerts and notifications. Possible code names: NoticeOption.

status
string (AlertStatus) [ 1 .. 35 ] characters
Example: "Warning"

Alert status. Possible values: Sent, SentLastNight, Pending, Enable, Disable, FraudAlert. Possible values for CreditBureauAlert: IdentityTheft.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

object

The lead time between the event and the alert notification.

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

Text to appear in alerts and notices.

Array of objects (SpotDate)
contactCount
integer

Number of contacts.

object (Frequency)

Specifies an event frequency

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

This id gives the ability to view a party’s total relationship with the bank. The relationship Id ties multiple parties and accounts together. This code is also used to reduce mailing costs during marketing campaigns to avoid sending duplicate materials to parties residing at the same address.

Array of objects (GenericAccountCode)
Array
name
string <= 50 characters
Example: "AccountingGroup"

Name of the code. Possible values are: AccountingGroup, CostCenter, DistributionGroup. Also values that may be overlayed on the identification: AccountSubtype, AccountType. Also MICR numbers: MicrAccountNumber, The account number portion of a draft or line of credit MICR line. Other possible values: TaxIncentiveType, Preferredlanguage, FundsDelayedReason, DeliveryMethod.

value
required
string [ 1 .. 35 ] characters
Example: "195"

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
object (AccountPrintOptions)
accountTitle
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
accountTitleOption
string (AccountTitlePrintOption) [ 1 .. 35 ] characters

Options to indicate the multiple lists of account owner names. Possible Values: TitleNotPrinted, TitlePrintsBeforeNames, TitlePrintsAfterNames

checkNameOption
string (CheckPrintOption) [ 1 .. 35 ] characters

Options to indicate the multiple lists of account owner names. Possible Values: JointAnd, JointOr.

balanceOnReceiptOverride
string (BalanceOnReceiptOptions) [ 1 .. 35 ] characters

Indicates whether the account balance is printed on teller terminal and ATM receipts. Possible Values: PrintWhenPositive, PrintWhenNegative, AlwaysPrint, NotPrint

nameIndicator
boolean

Indicates whether the account name is printed on account statements.

handlingLevels
Array of strings (PrintHandlingLevel) [ items [ 1 .. 35 ] characters ]
Array of objects (GenericPrintOption)
Array
name
string (PrintOptionName) [ 1 .. 35 ] characters

Name of the print Option. Possible Values: ACHTransaction

options
Array of strings (PrintOption) [ items [ 1 .. 35 ] characters ]
object (AccountBillDetails)

Billing information of the payment

billingDay
integer <= 31
Example: 30

Identifies the day of the month that billing statements are generated.

billOption
string
Example: "Individual"

Indicates whether billing occurs for the account at the company level (consolidated) or at the individual account level. Possible values: Consolidated, Individual.

Array of objects (Balance)

Bill balances

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

Date and time at which the period starts.

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

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

balanceName
string (BalanceName) [ 1 .. 50 ] characters
Example: "Available"

Specifies the nature of the balance. Possible values: Current, Available, Pending, Opening, Blocked, Previous, RelatedBalance, OnHold, PendingLedger, Collected, LastAnniversary, CurrentAccrued, PreviousAccrued, CurrentWithLastCalculus, CarriedAdjustment, PaidWithPenalties, Accrued, Penalty, Fees, Withholding, CollectionLedger, LastLedger, CurrentLedger, Ledger, MinimumAvailable, MinimumLedger, Withheld, CurrentBooked, CurrentBook, LastDeposit, FloatAmount, Average, RegulationDDAvailable. Loan Balances: CashProceeds, the amount that a customer actually received, exclusive of insurance premiums, fees, and unearned discount; FinancedExpenses, indicates the amount of expenses an institution has financed for a borrower; TotalInterest; AdditionalInterest, if the date of the first payment is beyond one month from the note date, the interest for the odd days will be earned during the first interest period; DeferredUnsecuredPrincipal, is the outstanding balance of an unsecured debt. The DUPB includes any accrued interest that is yet to be paid by the borrower. The deferral typically occurs due to bankruptcy or debt relief proceedings, which temporarily halt collection efforts by the original creditor; Charge Balances: Earned, RealTimeDeliveryMaximum, Current, Financed, Prepaid, CurrentEarned, CurrentEarnedOtherEscrow, InterestPaidToDate, InterestPaidThisYear, InterestPaidPreviousYear, InterestPaidLastStatement, InterestPaidThisYear, RevolvingCreditPaid, BasePaidToDate, TotalPastDue, Escrow, AppliedEscrow, UnpaidEscrow, EscrowBucket, Principal, Interest, Fees, BilledFees, OtherEscrow, FinalAmount, FinalInterestAmount, Chapter4PreviousYear, Payments: Delinquent, FixPayment, Transaction, LoanPayOff, PrincipalAndInterest, AvailableCash, AvailableCheck, AvailableCredit, Sweep, Float, MemoLedger, Memo, AvailablePending, LedgerPending.

amount
string (Amount) <= 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

count
integer

Number of transactions added to the amount.

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 (GenericCode)

Bank defined codes to classify balances. Possible values: BalanceCategory, BalanceType, PartyAgreementNumber.

object (Collateral)

Assets pledged by a debtor to secure a loan or an exposure and subject to seizure in the event of default.

collateralId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
value
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Value of the collateral as an amount.

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

The Ineligible Amount is a non-lien dollar amount that is subtracted from the Collateral Value or Net Appraised Value.

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

The collateral dollar amount that cannot be exceeded when calculating the Loan Amount.

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

The Collateral Net Appraised Value (CNAV) is a critical aspect of real estate appraisal and mortgage financing. It represents the difference between the fair market value (FMV) of the collateral and the outstanding mortgage debt on the property.

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

The date the property was last appraised.

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

The last time the collateral was reviewed.

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

The next time the collateral will be reviewed.

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

The price paid for the property.

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, Airplane, MachineTool, IndustrialEquipment, OfficeEquipment, ITEquipment, MedicalEquipment, EnergyRelatedEquipment, CommercialBuilding, ResidentialBuilding. IndustrialBuilding, OtherVehicle, OtherEquipment, OtherRealEstate, OtherGoodsOrInventory, Guarantee, OtherFinancialAsset, MixedCategories.

disposalCostPercentage
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Identifies disposal (selling) costs as a percentage of the Net Appraised Value and Collateral Value. Disposal costs are subtracted from the Net Appraised Value to calculate the net disposal value. The costs are also subtracted from the Collateral Value to calculate the net collateral value.

maximumLoanAmountPercentage
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

The percentage of the Collateral Value used to determine the Loan Amount. This percentage cannot be greater than 100.00%

marketMarginPercentage
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

A percentage subtracted from the Market Price to calculate the Collateral Value.

Array of objects (LoanCollateralRatioFormula)
Array
name
string

Name of the formula.

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

The ratio used to determine underwriting criteria of the property.

Array of objects (LoanCollateralLien)
Array
name
string

Name of the lien.

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

The amount of the lien.

Array of objects (GenericCode)

Codes to classify collaterals. Possible code names: MarketPricing, OwnerOccupied, PropertyType, Location.

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

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

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
numberOfUnits
integer

A collateral number of units refers to the number of individual properties that are being used as security for the loan.

object (Agreement)

Agreement between two trading parties that contains information about their relative duties and rights regarding collateral.

documentReference
string [ 1 .. 35 ] characters

Document location.

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

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

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

object (Jurisdiction)

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

object (ContactDetails)

Specifies the contact details of a person.

object (AccountContractRelatedParty)
agreementType
string (AgreementType)

Document or agreement type. Possible values: CardAgreement, AccountContract.

agreementSubtype
string [ 1 .. 60 ] characters

Agreement detailed category.

object

Postal address of the collateral residential building.

addressCode
string

This code is used to identify parties that share the same address or to associate an existing address with a specific party. Providing this code eliminates the need to separately enter the address details.

addressBookIndicator
string

If true, the address is kept in the system even if the person is no longer a customer.

addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible values are: PhysicalAddress, Postal, POBox, Residential, Permanent, Temporary, Alternative, Previous.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible values are: MailTo, DeliveryTo, Billing, Tax, ForeignTaxRecipient PlaceOfOperation, PlaceOfRegistration, placeOfFormation, Marketing, Statements, Business, Administrative, PreviousPlace, Headquarter, BranchStore, Branch, Property, Military, Secondary, Personal, Annex, Inquiry.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

careOf
string [ 1 .. 100 ] characters
Example: "C/O Company Name"

Identifies an addressee that is accepting the correspondence for the intended recipient. Using care of ensures the correspondence reaches the right recipient rather than getting returned to the sender.

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

Identification of a division of a large Organization or building.

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

Identification of a sub-division of a large Organization 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 Organization, where letters are kept until called for.

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

Building room number.

postCode
string (PostCode) [ 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. In US may consists of two parts: the five-digit ZIP Code '97062' and the ZIP+4 Code '6884'.

carrierRoute
string (CarrierRoute) [ 1 .. 4 ] characters
Example: "C001"

A Carrier Route is a designated geographic area assigned to individual postal carriers by the United States Postal Service (USPS) to facilitate efficient mail delivery within specific regions.

censusTract
string (CensusTract) = 5 characters
Example: "12345"

A census tract, census area, census district or meshblock is a geographic region defined for the purpose of taking a census

censusBlock
string (CensusBlock) = 4 characters
Example: "1234"

Census blocks are used to partition counties into smaller areas for the purpose of collecting and presenting census data.

cBSACode
string (CBSACode) = 5 characters
Example: "49780"

Core-based statistical area. Metropolitan statistical area (MSA) is the formal definition of a region that consists of a city and surrounding communities that are linked by social and economic factors. Micropolitan Statistical Areas (MISA) are CBSAs associated with at least one urban cluster that has a population of at least 10,000, but less than 50,000. The micropolitan statistical area comprises the central county or counties or equivalent entities containing the core, plus adjacent outlying counties having a high degree of social and economic integration with the central county as measured through commuting.

cBSAType
string (CBSAType) [ 1 .. 10 ] characters
Example: "MSA"

Type of Core-based statistical area. Possible values: MSA, MISA

foreignIndicator
boolean

Indicates whether the postal address is from a foreign country.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

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

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

Specific location name within the town.

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

Identifies a subdivision within a country sub-division.

countyName
string [ 1 .. 35 ] characters
Example: "Cook"

Identifies a county 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.

temporaryIndicator
boolean
Example: true

Indicates whether the address is temporary or not.

object

The period of use of the address information. Could be also used as a recurring anual period.

Array of objects (GenericCode)

Codes related to postal address or internal handling codes associated with the address. Possible Values: HandlingCode, HandlingCodeOption, AddressFormat.

Array of objects (GenericIdentification)

Postal address identifiers are used to identify parties that share the same address or to associate an existing address with a specific party. Possible scheme name values: AddressIdentifier.

Array of objects (GenericIdentification)

Unique indentification of the collateral. Possible scheme names: CollateralNumber, UCCFileNumber.

Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification.

schemeName
required
string [ 1 .. 35 ] characters

Name of the identification scheme.

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.

status
string (CollateralStatus) [ 1 .. 36 ] characters
Example: "Secured"

Specifies the collateral status. Possible Values: Secured, UnderSecured, OverSecured, Repossessed, PartiallySecured.

statusDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
descriptionLines
Array of strings[ items [ 1 .. 200 ] characters ]
Example: ["This is a description."]
collateralOwnershipId
string [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Specifies who is the owner of the collateral.

object (AccountContactDetails)

Specifies the contact details of a person.

object (StructuredName)

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

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

Person given first name.

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

Person given middle name.

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

Person surname.

middleInitial
string [ 1 .. 10 ] characters
Example: "J."

Person middle initial.

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. Generation order should be expressed with roman numerals: I, II, III, IV, V.

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

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

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

Preferred name to contact the person

firstContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
lastContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (PostalAddress)
Array
addressCode
string

This code is used to identify parties that share the same address or to associate an existing address with a specific party. Providing this code eliminates the need to separately enter the address details.

addressBookIndicator
string

If true, the address is kept in the system even if the person is no longer a customer.

addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible values are: PhysicalAddress, Postal, POBox, Residential, Permanent, Temporary, Alternative, Previous.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible values are: MailTo, DeliveryTo, Billing, Tax, ForeignTaxRecipient PlaceOfOperation, PlaceOfRegistration, placeOfFormation, Marketing, Statements, Business, Administrative, PreviousPlace, Headquarter, BranchStore, Branch, Property, Military, Secondary, Personal, Annex, Inquiry.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

careOf
string [ 1 .. 100 ] characters
Example: "C/O Company Name"

Identifies an addressee that is accepting the correspondence for the intended recipient. Using care of ensures the correspondence reaches the right recipient rather than getting returned to the sender.

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

Identification of a division of a large Organization or building.

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

Identification of a sub-division of a large Organization 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 Organization, where letters are kept until called for.

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

Building room number.

postCode
string (PostCode) [ 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. In US may consists of two parts: the five-digit ZIP Code '97062' and the ZIP+4 Code '6884'.

carrierRoute
string (CarrierRoute) [ 1 .. 4 ] characters
Example: "C001"

A Carrier Route is a designated geographic area assigned to individual postal carriers by the United States Postal Service (USPS) to facilitate efficient mail delivery within specific regions.

censusTract
string (CensusTract) = 5 characters
Example: "12345"

A census tract, census area, census district or meshblock is a geographic region defined for the purpose of taking a census

censusBlock
string (CensusBlock) = 4 characters
Example: "1234"

Census blocks are used to partition counties into smaller areas for the purpose of collecting and presenting census data.

cBSACode
string (CBSACode) = 5 characters
Example: "49780"

Core-based statistical area. Metropolitan statistical area (MSA) is the formal definition of a region that consists of a city and surrounding communities that are linked by social and economic factors. Micropolitan Statistical Areas (MISA) are CBSAs associated with at least one urban cluster that has a population of at least 10,000, but less than 50,000. The micropolitan statistical area comprises the central county or counties or equivalent entities containing the core, plus adjacent outlying counties having a high degree of social and economic integration with the central county as measured through commuting.

cBSAType
string (CBSAType) [ 1 .. 10 ] characters
Example: "MSA"

Type of Core-based statistical area. Possible values: MSA, MISA

foreignIndicator
boolean

Indicates whether the postal address is from a foreign country.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

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

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

Specific location name within the town.

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

Identifies a subdivision within a country sub-division.

countyName
string [ 1 .. 35 ] characters
Example: "Cook"

Identifies a county 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.

temporaryIndicator
boolean
Example: true

Indicates whether the address is temporary or not.

object

The period of use of the address information. Could be also used as a recurring anual period.

Array of objects (GenericCode)

Codes related to postal address or internal handling codes associated with the address. Possible Values: HandlingCode, HandlingCodeOption, AddressFormat.

Array of objects (GenericIdentification)

Postal address identifiers are used to identify parties that share the same address or to associate an existing address with a specific party. Possible scheme name values: AddressIdentifier.

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

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

extension
string <= 5 characters

Phone Number Extension.

country
string (CountryCallingCode) <= 3 characters

Country calling codes, country dial-in codes, international subscriber dialing (ISD) codes, or most commonly, telephone country codes. Country codes are defined by the International Telecommunication Union (ITU) in ITU-T standards E.123 and E.164. The prefixes enable international direct dialing (IDD).

phoneType
string [ 1 .. 35 ] characters

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

phonePurpose
string [ 1 .. 35 ] characters

Purpose of the phone address. Possible values are: Business, Personal, International, Alternative, PersonalInternational, BusinessInternational

foreignIndicator
boolean

Indicates whether is a foreign phone number

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

object (TimeOfTheDay)
comment
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
object

The period of use of the phone information.

Array of objects (GenericCode)
Array of objects (GenericIdentification)

Phone identifiers are used to identify parties that share the same phone or to associate an existing phones with a specific party. Possible scheme name values: PhoneIdentifier.

lastUpdatedDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
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, Business, Administrative, Personal

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

Array of objects (GenericIdentification)

Email identifiers are used to identify parties that share the same email or to associate an existing email with a specific party. Possible scheme name values: EmailIdentifier.

lastUpdatedDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
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 Organization or building.

preferredMethod
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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, Default.

object (AccountRenewal)

Information related to the account renewal

renewalType
string (AccountRenewalType) [ 1 .. 70 ] characters

The renewal type indicates whether an account automatically renews at maturity. Possible Values: NoTerm, indicates the account has no term; Automatic, indicates automatically renewal; SingleMaturity, indicates not automatically renewed; NoRenewalAllowed.

object (Frequency)

Renewal frequency

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

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

Account renewal rate.

productId
string [ 1 .. 36 ] characters
Example: "PD_CA_0002"

Renewal product

graceDays
integer

The time period when customer can cancel renewal

gracePeriodIndicator
boolean

Indicates whether the account is within the grace period.

lastRenewalDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (ServicerAlert)

Account alerts to be received by the account servicer.

Array
alertName
string (AlertName) [ 1 .. 35 ] characters
Example: "CreditBureauAlert"

Service alert human readable identifier in Pascal case. An alert notification received by the bank. Possible values: CreditBureauAlert, CustomerAlert, PaymentCard, LostBook, TwoSignaturesRequired, PledgedAsCollateral, DeathOnAccount, Bankruptcy, NoDisclosure, Caution, DuplicateBookIssued, PowerOfAttorney, DoNotReopen.

alertType
string (AlertType) [ 1 .. 35 ] characters
Example: "Warning"

An alert notification type. Possible values: Warning, Urgent, Teller.

alertCode
string [ 1 .. 36 ] characters

Service alert identifier or code, used to arrange multiple alerts and warnings in a sequence.

message
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
lastAlertDate
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.

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 (AccountHistory)

History attribute values.

originalOpenDate
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 (TemporalDuration)

Describes a temporal duration.

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

Unit that describes the duration.

value
integer <= 999

Value of the duration in number of units.

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

lastMaturedDate
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 (AccountDetailedStatus)

Specifies the current state of an account.

statusName
string (AccountStatus) [ 1 .. 35 ] characters
Example: "Active"

Specifies the current primary status of an account. Possible values are: Enabled, Dormant, Disable, Deleted, Pending, Form. Pending, Denied, Review, Approve, ChargeOff, Active, PaymentPastDue, Bankruptcy, AuthorizationProhibited, InterestProhibited, Closed, Restricted, Assumed, New, ZeroBalanceAccount.

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

Reason for the status. Possible Values: AbortedClearingTimeout, AbortedClearingFatalError, AbortedSettlementTimeout, AbortedSettlementFatalError,TimeoutCreditorAgent, TimeoutInstructedAgent, OfflineAgent, OfflineCreditorAgent, ErrorCreditorAgent, ErrorInstructedAgent, TimeoutDebtorAgent,IncorrectAccountNumber, InvalidDebtorAccountNumber,InvalidCreditorAccountNumber, ClosedAccountNumber,ClosedDebtorAccountNumber, BlockedAccount,ClosedCreditorAccountNumber, InvalidBranchCode,InvalidAccountCurrency, InvalidDebtorAccountCurrency,InvalidCreditorAccountCurrency, InvalidAccountType,InvalidDebtorAccountType,InvalidCreditorAccountType,AccountDetailsChanged, CardNumberInvalid, TransactionForbidden, InvalidBankOperationCode, TransactionNotSupported, InvalidAgentCountry, InvalidDebtorAgentCountry, InvalidCreditorAgentCountry, UnsuccesfulDirectDebit, InvalidAccessRights,PaymentNotReceived, AgentSuspended,CreditorAgentSuspended, NotAllowedBookTransfer, ForbiddenReturnPayment, IncorrectAgent, ZeroAmount, NotAllowedAmount, NotAllowedCurrency, InsufficientFunds, Duplication, TooLowAmount, BlockedAmount, WrongAmount, InvalidControlSum, InvalidTransactionCurrency, InvalidAmount, AmountExceedsClearingSystemLimit, AmountExceedsAgreedLimit, AmountBelowClearingSystemMinimum, InvalidGroupControlSum, InvalidPaymentInfoControlSum, InvalidNumberOfTransactions,InvalidGroupNumberOfTransactions, InvalidPaymentInfoNumberOfTransactions, LimitExceeded, ZeroAmountNotApplied, AmountExceedsSettlementLimit, InconsistenWithEndCustomer, MissingCreditorAddress, UnrecognisedInitiatingParty, UnknownEndCustomer, MissingDebtorAddress, MissingDebtorName, InvalidCountry, InvalidDebtorCountry, InvalidCreditorCountry, InvalidCountryOfResidence, InvalidDebtorCountryOfResidence, InvalidCreditorCountryOfResidence, InvalidIdentificationCode, InvalidDebtorIdentificationCode, InvalidCreditorIdentificationCode, InvalidContactDetails, InvalidChargeBearerCode, InvalidNameLength, MissingName, MissingCreditorName, AccountProxyInvalid, CheckERI, RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture, RequestedExecutionDateOrRequestedCollectionDateTooFarInPast, ElementIsNotToBeUsedAtB-andC-Level, MandateChangesNotAllowed, InformationOnMandateChangesMissing, CreditorIdentifierIncorrect, CreditorIdentifierNotUnambiguouslyAtTransaction-Level, OriginalDebtorAccountIsNotToBeUsed, OriginalDebtorAgentIsNotToBeUsed, ElementContentIncludesMoreThan140Characters, ElementContentFormallyIncorrect, ElementNotAdmitted, ValuesWillBeSetToNextTARGETday, DecimalPointsNotCompatibleWithCurrency, RequiredCompulsoryElementMissing, COREandB2BwithinOnemessage, ChequeSettledOnCreditorAccount, CreditorBankIsNotRegistered, IncorrectCurrency, RequestedByCustomer, DebtorBankIsNotRegistered,ElectronicSignaturesCorrect, OrderCancelled, OrderNotCancelled, OrderRejected, OrderForwardedForPostprocessing, TransferOrder, ProcessingOK, DecompressionError, DecryptionError, DataSignRequested, UnknownDataSignFormat, SignerCertificateRevoked, SignerCertificateNotValid, IncorrectSignerCertificate, SignerCertificationAuthoritySignerNotValid, NotAllowedPayment, NotAllowedAccount, NotAllowedNumberOfTransaction, Signer1CertificateRevoked, Signer1CertificateNotValid, IncorrectSigner1Certificate, SignerCertificationAuthoritySigner1NotValid, UserDoesNotExist, IdenticalSignatureFound, PublicKeyVersionIncorrect, DifferentOrderDataInSignatures, RepeatOrder, ElectronicSignatureRightsInsufficient, Signer2CertificateRevoked, Signer2CertificateNotValid, IncorrectSigner2Certificate, SignerCertificationAuthoritySigner2NotValid, WaitingTimeExpired, OrderFileDeleted, UserSignedMultipleTimes, UserNotYetActivated, InvalidDate, InvalidCreationDate, InvalidNonProcessingDate, FutureDateNotSupported, InvalidCutOffDate, ExecutionDateChanged, DuplicateMessageID, DuplicatePaymentInformationID, DuplicateTransaction, DuplicateEndToEndID, DuplicateInstructionID, DuplicatePayment, CorrespondentBankNotPossible, BalanceInfoRequest, SettlementFailed, SettlementSystemNotAvailable, ERIOptionNotSupported, InvalidFileFormat, SyntaxError, InvalidPaymentTypeInformation, InvalidServiceLevelCode, InvalidLocalInstrumentCode, InvalidCategoryPurposeCode, InvalidPurpose, InvalidEndToEndId, InvalidChequeNumber, BankSystemProcessingError, ClearingRequestAborted, PaymentTransferredAndTracked, PaymentTransferredAndNotTracked, CreditDebitNotConfirmed, CreditPendingDocuments, CreditPendingFunds, DeliveredWithServiceLevel, DeliveredWIthoutServiceLevel, CorrespondingOriginalFileStillNotSent, NoMandate, MissingMandatoryInformationInMandate, CollectionNotDue, RefundRequestByEndCustomer, EndCustomerDeceased, NotSpecifiedReasonCustomerGenerated, NotSpecifiedReasonAgentGenerated, Narrative, NoERI, BankIdentifierIncorrect, InvalidBankIdentifier, InvalidDebtorBankIdentifier, InvalidCreditorBankIdentifier, InvalidBICIdentifier, InvalidDebtorBICIdentifier, InvalidCreditorBICIdentifier, InvalidClearingSystemMemberIdentifier, InvalidDebtorClearingSystemMemberIdentifier, InvalidCreditorClearingSystemMemberIdentifier, InvalidIntermediaryAgent, MissingCreditorSchemeId, RMessageConflict, ReceiverCustomerInformation,NotUniqueTransactionReference, MissingDebtorAccountOrIdentification, MissingDebtorNameOrAddress, MissingCreditorNameOrAddress, RegulatoryReason, RegulatoryInformationInvalid, TaxInformationInvalid, RemittanceInformationInvalid, RemittanceInformationTruncated, InvalidStructuredCreditorReference, InvalidCharacterSet, InvalidDebtorAgentServiceID, InvalidPartyID, ValidRequestForCancellationAcknowledged, UETRFlaggedForCancellation, NetworkStopOfUETR, RequestForCancellationForwarded, RequestForCancellationDeliveryAcknowledgement, SpecificServiceOfferedByDebtorAgent, SpecificServiceOfferedByCreditorAgent, ServiceofClearingSystem, CreditorNotOnWhitelistOfDebtor, CreditorOnBlacklistOfDebtor, MaximumNumberOfDirectDebitTransactionsExceeded, MaximumDirectDebitTransactionAmountExceeded, TransmissonAborted, NoDataAvailable, FileNonReadable, IncorrectFileStructure, TokenInvalid, SenderTokenNotFound, ReceiverTokenNotFound, TokenMissing, TokenCounterpartyMismatch, TokenSingleUse, TokenSuspended, TokenValueLimitExceeded, TokenExpired, InvalidCutOffTime, TransmissionSuccessful, TransferToSignByHand, AuthorisationCancelled, FollowingCancellationRequest, Fraud, NotCompliantGeneric, NoAnswerFromCustomer, ReturnUponUnableToApply, UnduePayment, AlreadyAcceptedRTP, AlreadyExpiredRTP, AlreadyRefusedRTP, AlreadyRejectedRTP, AttachementsNotSupported, ExpiryDateTimeReached, ExpiryDateTooLong, FraudulentOrigin, IncorrectExpiryDateTime, InitialRTPNeverReceived, NonAgreedRTP, NoPaymentGuarantee, PayerOrPayerRTPSPNotReachable, RTPNotSupportedForDebtor, RTPReceivedCanBeProcessed, RTPServiceProviderIdentifierIncorrect, TypeOfPaymentInstrumentNotSupported, UnknownCreditor, OriginalTransactionNotEligibleForRequestedReturn, RequestForCancellationNotFound, SettlementNotReceived

reasonDescription
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
Array of objects (GenericStatus)

Detailed account status. Possible Values: RegulationDD, Analysis, NewClassCode

Array
statusType
string [ 1 .. 50 ] characters
Example: "RegulationDD"

Pascal case status type. Possible Values: NSFInstruction, RegulationDD, IRA. Pays, InBox, CashReserve, ChargeOff, RestrictedAccount, AccountVerification, ClassCode, LegalEntity, PrivacyNoticed

statusName
string [ 1 .. 50 ] characters
Example: "Active"

Pascal case status name. Possibles Values for IRA status type: NotEligible, Eligible, DistributionDisability, DistributionDeath, DistributionNormal, AccountLinked, AccountNotLinked. Possible values for Pays: Enable, Disable; InBox: NewMessage, Empty; CashReserve: HasCashReserve, DoNotHave; RestrictedAccount: IsRestricted, NotRestricted; ChargeOff: BankSubmitted, Automatic, IntegratedProcessingAutomatic, IntegratedProcessingClosed. PassbookSavings: NotOnline, Online, Manual. AccountVerification: Valid, NotValid. OverdraftProtection: Enable, Disable. ClassCode: New, NotNew. DefaultStatus: Inminent, NotDefault. LegalEntity: LegalEntityCustomer. PrivacyNoticed: CustomerCanBeDisclosed, CustomerOptOut, CustomerNotOptOut

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

Pascal case status reason. Possible Values: NSFInstruction, RegulationDD, IRA.

Array of objects (ProcessEvent)

Account process event list defined by the account servicer.

Array
name
string [ 1 .. 35 ] characters

Human readable pascal case identifier of the process event. Possible list values: YearEndProcessed, MonthEndProcessed, ManuallyControlled

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
Array of objects (SpotDate)
Array of objects (GenericCode)

Codes related to the external provider account. Possible Values: LookUpReference

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.

externalAccountIndicator
boolean

Indicates whether an account is an external entity.

collateralIndicator
boolean

Indicates whether an account has been pledged as collateral.

negotiableIndicator
boolean

Indicates whether an account is a negotiable instrument.

closeOption
string [ 1 .. 34 ] characters

Option for closing an account. Possible Values: DoNotCloseAutomatically, CloseAutomatically

profitabilityAnalysisStatus
string [ 1 .. 34 ] characters

Profit analysis status. Possible values: High, Low, NotAnalyzed, Analyzed, SystemClosed.

nonSufficientFundsInstruction
string [ 1 .. 34 ] characters

Manual NSF decision.

nonSufficientFunds
string [ 1 .. 34 ] characters

Automatic NSF decision.

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

Array of objects (Comment)

Bank comnents of the account.

Array
name
string [ 1 .. 35 ] characters
text
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
object (AccountProfile)
profileType
string [ 1 .. 40 ] characters
Example: "Personal"

Account profile category. Possible Values: Personal, NonPersonal.

riskLevel
string [ 1 .. 35 ] characters
Example: "High"

Laundering risk level

qualityScore
string (QualityScore) [ 2 .. 10 ] characters

The quality score is based on a borrower's credit history, collateral, and the likelihood of repayment.

Array of objects (RiskMeasure)
Array
name
string (CreditRankingScaleName) [ 1 .. 35 ] characters
Example: "StandardAndPoors"

Most commonly used credit ranking scales. Possible Values: StandardAndPoors, MoodysInvestors. Also other values: Original, 1, 2, 3, Current.

level
string (RiskLevel) [ 1 .. 35 ] characters
Example: "High"

Specifies the customer’s money laundering risk. Possible values: VeryLow, Low, Medium, Medium toHigh, ModerateHigh, High, ExtremelyHigh, NoDetermine.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (GenericCode)

Additional risk measure codes. Possible values: RiskRatingCode

Array of objects (CreditRankingScale)

Borrower credit ranking scores

Array
name
string (CreditRankingScaleName) [ 1 .. 35 ] characters
Example: "StandardAndPoors"

Most commonly used credit ranking scales. Possible Values: StandardAndPoors, MoodysInvestors. Also other values: Original, 1, 2, 3, Current.

score
string [ 2 .. 10 ] characters
Example: "AAA"
date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (GenericCode)

Additional ranking scale codes. Possible values: RiskRatingCode

object (BankruptcyProfile)
chapter
string [ 1 .. 10 ] characters
Example: "11"

The section on the Bankruptcy Code that sets out the rules and procedures for a particular type of bankruptcy. Possible Values: 7, 11, 13, 12, and 9.

status
string [ 1 .. 40 ] characters
Example: "Petition"

Bankruptcy status. Possible values: Petition, Discharged, DebtReaffirmation, DebtReaffirmationRescinded, PlanConfirmed, PlanCompleted, Withdrawn.

statementOption
string [ 1 .. 40 ] characters
Example: "RegularBillingStatement"

Statement option. Possible Values: RegularBillingStatement, BankruptcyBillingStatement

object (Frequency)

Indicates the frequency that the history profile payment status is established. Values are dependent upon credit bureau standards.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

paymentHistoryOption
string [ 1 .. 40 ] characters
Example: "NotRecalculate"

Indicates whether the Payment History Profile will be recalculated. Possible Values: Default, NotRecalculate, RecalculateAndSetToDefault, RecalculateAndSetToNot.

Array of objects (Balance)

Amount balances related to the credit profile. Possible Values: CreditHighBalance.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

balanceName
string (BalanceName) [ 1 .. 50 ] characters
Example: "Available"

Specifies the nature of the balance. Possible values: Current, Available, Pending, Opening, Blocked, Previous, RelatedBalance, OnHold, PendingLedger, Collected, LastAnniversary, CurrentAccrued, PreviousAccrued, CurrentWithLastCalculus, CarriedAdjustment, PaidWithPenalties, Accrued, Penalty, Fees, Withholding, CollectionLedger, LastLedger, CurrentLedger, Ledger, MinimumAvailable, MinimumLedger, Withheld, CurrentBooked, CurrentBook, LastDeposit, FloatAmount, Average, RegulationDDAvailable. Loan Balances: CashProceeds, the amount that a customer actually received, exclusive of insurance premiums, fees, and unearned discount; FinancedExpenses, indicates the amount of expenses an institution has financed for a borrower; TotalInterest; AdditionalInterest, if the date of the first payment is beyond one month from the note date, the interest for the odd days will be earned during the first interest period; DeferredUnsecuredPrincipal, is the outstanding balance of an unsecured debt. The DUPB includes any accrued interest that is yet to be paid by the borrower. The deferral typically occurs due to bankruptcy or debt relief proceedings, which temporarily halt collection efforts by the original creditor; Charge Balances: Earned, RealTimeDeliveryMaximum, Current, Financed, Prepaid, CurrentEarned, CurrentEarnedOtherEscrow, InterestPaidToDate, InterestPaidThisYear, InterestPaidPreviousYear, InterestPaidLastStatement, InterestPaidThisYear, RevolvingCreditPaid, BasePaidToDate, TotalPastDue, Escrow, AppliedEscrow, UnpaidEscrow, EscrowBucket, Principal, Interest, Fees, BilledFees, OtherEscrow, FinalAmount, FinalInterestAmount, Chapter4PreviousYear, Payments: Delinquent, FixPayment, Transaction, LoanPayOff, PrincipalAndInterest, AvailableCash, AvailableCheck, AvailableCredit, Sweep, Float, MemoLedger, Memo, AvailablePending, LedgerPending.

amount
string (Amount) <= 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

count
integer

Number of transactions added to the amount.

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 (GenericCode)

Bank defined codes to classify balances. Possible values: BalanceCategory, BalanceType, PartyAgreementNumber.

customerType
string (CustomerType)
Example: "Consumer"

A customer type of a bank account can be classified into different categories based on the account's features, purpose, and benefits. Possible Values: Personal, Business, Consumer, Organization, ThirdParty, Estate, Employee, ForeignConsumer.

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

Array of objects (CreditRankingScale)
creditReportAddressIndicatorCode
string

is a code or marker used by credit reporting agencies to indicate a match or mismatch between the address supplied in an inquiry and the address they have on file for a consumer.

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

Information provided by the Consumer Credit Report.

consumerCreditReportDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
eCOACode
string

The ECOA code indicates how customer account information is reported to the Credit Bureau in keeping with the Equal Credit Opportunity Act.

Array of objects (Product)

Product information at account level.

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

Unique identification of a product within a product type.

pricingStrategyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
name
required
string [ 1 .. 40 ] characters
Example: "Visa Business Card"

Commercial product name within a product type.

description
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
productType
string [ 1 .. 35 ] characters
Example: "PaymentCard"

Type or nature of a product. Possible Values: Loan, PaymentCard, CheckingAccount, HealthSavingsAccount, RepricingPlan.

productSubType
string [ 1 .. 35 ] characters
Example: "BusinessCard"

Commercial product subtype within a product type.

Array of objects (Restriction)
Array of objects (SpotDate)
Array of objects (Limit)
Array of objects (ChargeCalculation)
parties
Array of strings (ProductPartyRelationType) [ items [ 1 .. 40 ] characters ]
Example: ["ParentProvider"]
status
string (ProductStatus) [ 1 .. 35 ] characters
Example: "GoodStanding"

Specifies the current status of a product. Possible values are: Enable, Disable.

statusDateAndTime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (GenericCode)

Product configuration codes. Possible Values: WebBrand, WaterfieldService, MajorAccountType: Major Account Type code for Employee Qualified Plan, MinorAccountType: Minor Account Type code to use for Employee Qualified Plan, CheckingMajor: Checking Major to be used and linked to Employee Qualified Plan account, CheckingMinor: Checking Minor to be used and linked to Employee Qualified Plan account. Other values: NationalCreditUnionAdministration.

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

Array of objects (DocumentDescriptor)

Documents related to the Account.

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

Document location.

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

Responses

Request samples

Content type
application/json
{
  • "accountBranchId": "SEA_1",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "securedIndicator": true,
  • "securedType": "Collateral",
  • "payment": {
    },
  • "payout": {
    },
  • "ownershipType": "SingleOwnerAccount",
  • "balanceType": "Asset",
  • "productId": "PD_CA_0002",
  • "pricingStrategyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "initialAmount": "100",
  • "depositDate": "2022-04-17",
  • "contract": {
    },
  • "parties": [
    ],
  • "maturityDate": "2022-04-17",
  • "relatedAccounts": [
    ],
  • "referenceAccount": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "pastDates": [
    ],
  • "initialFundingSource": "CreditTransfer",
  • "projectedDates": [
    ],
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "statement": {
    },
  • "interests": [
    ],
  • "charges": [
    ],
  • "taxes": [
    ],
  • "communicationChannels": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "codes": [
    ],
  • "print": {
    },
  • "bill": {
    },
  • "collateral": {
    },
  • "contact": {
    },
  • "renewal": {
    },
  • "servicerAlerts": [
    ],
  • "history": {
    },
  • "status": {
    },
  • "supplementaryData": { },
  • "comments": [
    ],
  • "profile": {
    },
  • "products": [
    ],
  • "documents": [
    ]
}

Response samples

Content type
{
  • "accountBranchId": "SEA_1",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "securedIndicator": true,
  • "securedType": "Collateral",
  • "payment": {
    },
  • "payout": {
    },
  • "ownershipType": "SingleOwnerAccount",
  • "balanceType": "Asset",
  • "productId": "PD_CA_0002",
  • "pricingStrategyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "initialAmount": "100",
  • "depositDate": "2022-04-17",
  • "contract": {
    },
  • "parties": [
    ],
  • "maturityDate": "2022-04-17",
  • "relatedAccounts": [
    ],
  • "referenceAccount": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "pastDates": [
    ],
  • "initialFundingSource": "CreditTransfer",
  • "projectedDates": [
    ],
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "statement": {
    },
  • "interests": [
    ],
  • "charges": [
    ],
  • "taxes": [
    ],
  • "communicationChannels": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "codes": [
    ],
  • "print": {
    },
  • "bill": {
    },
  • "collateral": {
    },
  • "contact": {
    },
  • "renewal": {
    },
  • "servicerAlerts": [
    ],
  • "history": {
    },
  • "status": {
    },
  • "supplementaryData": { },
  • "comments": [
    ],
  • "profile": {
    },
  • "products": [
    ],
  • "documents": [
    ],
  • "amountCalculationDate": "2022-04-17T08:00:00Z",
  • "transactionDates": [
    ],
  • "balances": [
    ],
  • "plasticCount": 0,
  • "cards": [
    ],
  • "accountId": "033-DDA-123456",
  • "standingOrders": [
    ],
  • "audit": {
    }
}

Retrieves an Account

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

Account Identification

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

Account Servicer Identification (Bank)

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

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

Responses

Response samples

Content type
application/json
{
  • "accountBranchId": "SEA_1",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "securedIndicator": true,
  • "securedType": "Collateral",
  • "payment": {
    },
  • "payout": {
    },
  • "ownershipType": "SingleOwnerAccount",
  • "balanceType": "Asset",
  • "productId": "PD_CA_0002",
  • "pricingStrategyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "initialAmount": "100",
  • "depositDate": "2022-04-17",
  • "contract": {
    },
  • "parties": [
    ],
  • "maturityDate": "2022-04-17",
  • "relatedAccounts": [
    ],
  • "referenceAccount": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "pastDates": [
    ],
  • "initialFundingSource": "CreditTransfer",
  • "projectedDates": [
    ],
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "statement": {
    },
  • "interests": [
    ],
  • "charges": [
    ],
  • "taxes": [
    ],
  • "communicationChannels": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "codes": [
    ],
  • "print": {
    },
  • "bill": {
    },
  • "collateral": {
    },
  • "contact": {
    },
  • "renewal": {
    },
  • "servicerAlerts": [
    ],
  • "history": {
    },
  • "status": {
    },
  • "supplementaryData": { },
  • "comments": [
    ],
  • "profile": {
    },
  • "products": [
    ],
  • "documents": [
    ],
  • "amountCalculationDate": "2022-04-17T08:00:00Z",
  • "transactionDates": [
    ],
  • "balances": [
    ],
  • "plasticCount": 0,
  • "cards": [
    ],
  • "accountId": "033-DDA-123456",
  • "standingOrders": [
    ],
  • "audit": {
    }
}

Replaces an Account by Id.

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

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

Account Identification

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

Account Servicer Identification (Bank)

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

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

Core-Validation-Mode
string

<ENFORCING|PERMISSIVE|DISABLED> Indicates how the API validates requests against the core validation request policy. ENFORCING: The API validates all requests against the core validation request policy. The API only sends requests that pass validation to the back-end core service. PERMISSIVE: The API validates all requests against the validation request policy. The API sends all requests to the back-end service, regardless of whether they pass or fail the core validation. DISABLED: The API does not validate any requests against the validation request policy. The API gateway sends all requests to the core back-end service.

Request Body schema: application/json
accountBranchId
string [ 1 .. 36 ] characters
Example: "SEA_1"

Identification of the account servicer institution at branch level or center level. To overlay the codes to produce a unique identifier the following expresion is used: BranchRegionCode-BranchSubdivisionCode.

accountNumber
string <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

accountType
required
string [ 1 .. 60 ] characters
Example: "Checking"

Type of the account. Some possible ISO 20022 compliant values are: Checking, CardAccount, CashPayment, Charges, CashIncome, Commission, ClearingParticipantSettlementAccount, LimitedLiquiditySavingsAccount, MarginalLending, MoneyMarket, NonResidentExternal, Overdraft, OverNightDeposit, Settlement, Salary, Savings, Tax, TransactingAccount, CashTrading, VirtualAccount, CreditCard, DebitCard, Universal, Investment, EpurseCard, CertificateOfDeposit, MoneyMarketChecking, RetirementAccount, RetireeReimbursementAccount, StockOrBond, PrePaid, FleetCard, Cash, DebitAccount, CreditAccount, Benefit, HealthSavingsAccount, FlexibleSpendingAccount, ForBenefitOf, Estate, ClientTrustAccount, LawyersTrustAccount, KeoghPlanAccount, UniformTransfersToMinorsAct, UniformGiftsToMinorsAct, ReserveFunds, SelfDirectedBrokerage, IRA, Annuity, ExternalAccount, Loan, CommercialLoan, MortgageLoan, SafeDepositBox.

Array of objects
Array
number
string = 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 = 9 characters
Example: "ACH"

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

Array of objects
Array
number
string [ 1 .. 40 ] characters

Identification assigned by an institution or internally to connect to other applications.

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

Name of the identification scheme, in PascalCase. Possible ISO 20022 compliant values names are: IssuerIdentificationNumber, BBANIdentifier, CHIPSUniversalIdentifier, UPICIdentifier, IBANIdentifier. Other possible values: CreditBackIdentification, UniversalLoanIdentifier, HMDAUniversalLoanIdentifier, CommitmentNumber, RecordNumber, FlexDataRecordNumber, RegistrationNumber, ExternalAccountId, MortgageNumber, DepartmentNumber.

issuer
string [ 1 .. 35 ] characters

Entity that assigns the identification.

securedIndicator
boolean

Indicates whether the Account is secure.

securedType
string (SecuredAccountType) [ 1 .. 17 ] characters
Example: "Collateral"

Indicates how the account is secured. Possible Values: Collateral, Agent

object (AccountPaymentDetails)

Account payment information.

numberOfPayments
integer

Number of payments.

object (RepaymentSchedule)

Generic transaction code definition.

Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

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

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects (PaymentIdentification)
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

object (Repayment)

Generic transaction code definition.

Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

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

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

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

Identification of the Payment.

reversalIndicator
boolean (ReversalIndicator)

Indicates whether or not the transaction is the result of a reversal. Usage: This element should only be present if the entry is the result of a reversal. If the CreditDebitIndicator is Credit and ReversalIndicator is Yes, the original operation was a debit entry. If the CreditDebitIndicator is Debit and ReversalIndicator is Yes, the original operation was a credit entry.

object (RemittanceInformation)

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system.

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

Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit entry. Usage: If entry status is pending and value date is present, then the value date refers to an expected/requested value date.

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

Date and time when an entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.

Array of objects (TransactionCharge)

All charges and taxes applied to the transaction. Also can include interests if the bank does not discrimate between them.

Array of objects (TransactionInterest)

All interests included in the transaction amount.

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

Original date on which the payment was posted to the account.

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

Amount payed.

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

Date of the billing cycle for the account.

paymentReason
string (PaymentPurpose) [ 1 .. 60 ] characters
Example: "CashManagementTransfer"

Underlying reason for the payment transaction. Possible Values: Allowance, LoanPrincipal, CashManagementTransfer, LoanStandardPayment, LoanPayment, LoanAdditionalPayment, LoanInterest, OverageInterest, OveragePrincipal, EscrowPayment, FeePayment.

paymentName
string [ 1 .. 35 ] characters

Human readable pascal case identifier of the payment concept. Possible values: CurrentLoanNextPayment.

object (RepaymentSchedule)

Generic transaction code definition.

Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

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

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects (PaymentIdentification)
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

object (RepaymentSchedule)

Generic transaction code definition.

Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

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

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects (PaymentIdentification)
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

Array of objects (Repayment)

All the payments done, scheduled or not.

Array
Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

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

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

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

Identification of the Payment.

reversalIndicator
boolean (ReversalIndicator)

Indicates whether or not the transaction is the result of a reversal. Usage: This element should only be present if the entry is the result of a reversal. If the CreditDebitIndicator is Credit and ReversalIndicator is Yes, the original operation was a debit entry. If the CreditDebitIndicator is Debit and ReversalIndicator is Yes, the original operation was a credit entry.

object (RemittanceInformation)

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system.

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

Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit entry. Usage: If entry status is pending and value date is present, then the value date refers to an expected/requested value date.

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

Date and time when an entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.

Array of objects (TransactionCharge)

All charges and taxes applied to the transaction. Also can include interests if the bank does not discrimate between them.

Array of objects (TransactionInterest)

All interests included in the transaction amount.

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

Original date on which the payment was posted to the account.

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

Amount payed.

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

Date of the billing cycle for the account.

paymentReason
string (PaymentPurpose) [ 1 .. 60 ] characters
Example: "CashManagementTransfer"

Underlying reason for the payment transaction. Possible Values: Allowance, LoanPrincipal, CashManagementTransfer, LoanStandardPayment, LoanPayment, LoanAdditionalPayment, LoanInterest, OverageInterest, OveragePrincipal, EscrowPayment, FeePayment.

paymentName
string [ 1 .. 35 ] characters

Human readable pascal case identifier of the payment concept. Possible values: CurrentLoanNextPayment.

object (Frequency)

How often principal payments are due.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

object (Frequency)

How often interest payments are due.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

draftDayAdjuster
integer <= 31
Example: 30

Number of days before or after an automatic payment is debited from an account.

automaticIndicator
boolean

Indicates whether, prior to the loan going past due, a payment is automatic generated.

paymentType
string (PaymentType) [ 1 .. 35 ] characters
Example: "OnUs"

Specifies the type of Payment. Possible values: LiquidityTransfer, OnUs, ACH, Wire, NotOnUs.

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

First payment date

object (RepaymentBillDetails)

Billing information of the payment

billingOption
string <= 60 characters

AutomaticPayment, LumpSumPayment, NegotiatedBillingOptio, AcceleratedBillingOption.

billingDay
integer <= 31
Example: 30

Identifies the day of the month that billing statements are generated.

rebillStatus
string (RepaymentBillStatus) [ 1 .. 40 ] characters
Example: "RebillRequest"

Indicates whether a payment will be recalculated, rebilled and notified to the customer. Possible values: NoRequest, RebillRequest, ReNotifyCustomer.

rebillInterestIndicator
boolean

Indicates whether interest will be rebilled when transactions occur during the forecast period.

leadDays
integer

Identifies the time between creating a receivable and the due date.

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

The statement date interest was billed.

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

The due date of the next interest payment due that is not past due.

object (Frequency)

How often principal payments are billed.

Array of objects (Balance)

Bill balances

object (AccountPayout)

Distribution of funds or assets to an individual or entity. In relation to investments, loans, insurance policies, and retirement accounts.

object (Frequency)

Indicates the schedule for paying to accounts.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

paymentType
string (AccountPaymentMethodType) [ 1 .. 35 ] characters
Example: "Compound"

Specifies the type of interest payment. Possible values are: Compound, Checking, Savings, Check, Capitalize, TransferToAccount, CertificateOfDeposit, Deposit, DepositLoan, Loan.

paymentTypeOptions
Array of strings
Example: ["Primary"]
paymentName
string [ 1 .. 35 ] characters

Human readable pascal case identifier of the payment concept. Possible values: CreditBack, Interest.

accountId
string [ 1 .. 300 ] characters
Example: "033-DDA-123456"

The account id that receives interest credits.

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

The reference number of the interest pay to the account.

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

Last payment date

lastPaid
string (PositiveAmount) <= 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

Array of objects (GenericCode)

Additional payment codes. Posible values: PaymentCalculus, specifies how the credit back portion of an automatic service charge is calculated. PaymentReference, additional payment reference to link with other parts of the system.

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

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

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
payoutType
string (AccountPayoutType) [ 1 .. 35 ] characters

Account payout can be classified into two main categories: immediate and deferred. Possible Values: Immediate, Deferred.

payoutName
string (AccountPayoutName) [ 1 .. 35 ] characters
Example: "ClubPay"

Payout nature of the Account. Possible Values: ClubPay.

payoutOption
string (AccountPayoutOption) [ 1 .. 35 ] characters

Distinguishes options in payouts products. Possible values: Fixed, Variable

amount
string (PositiveAmount) <= 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

enableIndicator
boolean

Indicates whether the account payouts are disbursed or not.

payoutsNumber
integer

Total number of payouts

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

Cash surrender value (net) available if contract is surrendered

changePercentage
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Percentage of the accumulated value to be paid to the payee each year.

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

Amount of the accumulated value to be paid to the payee each year.

object

Duration of payout frequency

unit
required
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 (Balance)
Array
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

balanceName
string (BalanceName) [ 1 .. 50 ] characters
Example: "Available"

Specifies the nature of the balance. Possible values: Current, Available, Pending, Opening, Blocked, Previous, RelatedBalance, OnHold, PendingLedger, Collected, LastAnniversary, CurrentAccrued, PreviousAccrued, CurrentWithLastCalculus, CarriedAdjustment, PaidWithPenalties, Accrued, Penalty, Fees, Withholding, CollectionLedger, LastLedger, CurrentLedger, Ledger, MinimumAvailable, MinimumLedger, Withheld, CurrentBooked, CurrentBook, LastDeposit, FloatAmount, Average, RegulationDDAvailable. Loan Balances: CashProceeds, the amount that a customer actually received, exclusive of insurance premiums, fees, and unearned discount; FinancedExpenses, indicates the amount of expenses an institution has financed for a borrower; TotalInterest; AdditionalInterest, if the date of the first payment is beyond one month from the note date, the interest for the odd days will be earned during the first interest period; DeferredUnsecuredPrincipal, is the outstanding balance of an unsecured debt. The DUPB includes any accrued interest that is yet to be paid by the borrower. The deferral typically occurs due to bankruptcy or debt relief proceedings, which temporarily halt collection efforts by the original creditor; Charge Balances: Earned, RealTimeDeliveryMaximum, Current, Financed, Prepaid, CurrentEarned, CurrentEarnedOtherEscrow, InterestPaidToDate, InterestPaidThisYear, InterestPaidPreviousYear, InterestPaidLastStatement, InterestPaidThisYear, RevolvingCreditPaid, BasePaidToDate, TotalPastDue, Escrow, AppliedEscrow, UnpaidEscrow, EscrowBucket, Principal, Interest, Fees, BilledFees, OtherEscrow, FinalAmount, FinalInterestAmount, Chapter4PreviousYear, Payments: Delinquent, FixPayment, Transaction, LoanPayOff, PrincipalAndInterest, AvailableCash, AvailableCheck, AvailableCredit, Sweep, Float, MemoLedger, Memo, AvailablePending, LedgerPending.

amount
string (Amount) <= 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

count
integer

Number of transactions added to the amount.

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 (GenericCode)

Bank defined codes to classify balances. Possible values: BalanceCategory, BalanceType, PartyAgreementNumber.

ownershipType
required
string (AccountOwnershipType) [ 1 .. 100 ] characters
Example: "SingleOwnerAccount"

Specifies the type of account ownership. Possible ISO 20022 compliant values names are: JointAccountWithSurvivorshipRights, JointAccountWithSurvivorshipRightsPayableOnDeath, JointAccountInCommon, CustodialAccount, FinancialInstitution, SingleOwnerAccount, JointAccount, JointAnd, Corporation, Organization, Business, FormalPartnership, FormalTrust, Nominee, NonProfitOrganization, NotForProfitOrganization, ForProfit, EUResidualEntity, USGovernmentOrganization, NonUSGovernmentOrganization, GovernmentOrganization, LimitedLiabilityCompany, RegisteredInvestmentCompany, Entrepreneurial, Unincorporated, LimitedPartnership, LimitedLiabilityPartnership, BareOwner, Usufructuary, Fiduciary, ServicerEmployeeAccount, BusinessTrust, FamilyTrust, Estate, PublicFunds, NonUSGovernmentOrganization, Church, Club. More general possible values: Direct, Indirect, ConvenienceAccount, CommunityProperty, CommunityPropertyWithSurvivorshipRights, TottenTrust, PayableOnDeath, UniformTransfersToMinorsAct, UniformGiftsToMinorsAct, InTrustFor, RepresentativePayee, ProfessionalAssociation.

balanceType
string (Balance Type)
Example: "Asset"

Account Balance Type. Possible Values: Asset, positive transaction amount increases balance; Liability, positive transaction amount decreases balance; Equity.

productId
string (ProductId) [ 1 .. 36 ] characters
Example: "PD_CA_0002"

Identification of the product offered by a financial institution to its customers.

pricingStrategyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
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 (Amount) <= 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

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

Initial desposit date

object (AccountContract)

Account contractual details between the owners and the account servicer.

documentReference
string [ 1 .. 35 ] characters

Document location.

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

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

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

object (Jurisdiction)

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

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

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

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

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

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

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

object (ContactDetails)

Specifies the contact details of a person.

object (StructuredName)

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

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

Preferred name to contact the person

firstContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
lastContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (Phone)
Array of objects (Email)
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 Organization or building.

Array of objects (CommunicationChannel)
preferredMethod
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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, Default.

object (AccountContractRelatedParty)
partyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
partyType
string (PartyType)
Example: "Person"

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

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.

agreementType
string (AgreementType)

Document or agreement type. Possible values: CardAgreement, AccountContract.

agreementSubtype
string [ 1 .. 60 ] characters

Agreement detailed category.

documentId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
Array of objects (GenericIdentification)

Unique indentification of the collateral. Possible scheme names: NoteNumber.

Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification.

schemeName
required
string [ 1 .. 35 ] characters

Name of the identification scheme.

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.

status
string (AccountContractStatus) [ 1 .. 35 ] characters
Example: "Active"

Specifies the current status of an account contract. Possible values are: Active, Expired, GracePeriod, Terminated, Waiver.

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 (MasterAgreement)

A master agreement is a document that outlines the terms and conditions of an agreement between two or more parties. It's common to use a master agreement when there are multiple agreements in place with one company.

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

Account at Master Agreement level used as a reference for the Loan opening. Payments are auto-debited from this account.

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

Account at Master Agreement level used as a reference for the Loan opening. Payments are auto-debited from this account.

documentReference
string [ 1 .. 35 ] characters

Document location.

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

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

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

object

The payment term for the account premium.

object (TemporalDuration)

Describes a temporal duration.

timesExtended
integer <= 100

The number of times the loan has been extended over its term.

timesRenewed
integer <= 100

The number of times the loan has been renewed over its term.

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

Amount of the customer premium.

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

Total amount of money the user is insured for.

productId
string (ProductId) [ 1 .. 36 ] characters
Example: "PD_CA_0002"

Identification of the product offered by a financial institution to its customers.

Array of objects (GenericCode)
Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

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

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
Array of objects (SpotDate)

Contract dates. Possible values: LossMitigation

Array
name
string (SpotDateName) [ 1 .. 40 ] characters
Example: "Expiration"

Possible values por projected dates: Forecast, Expiration, LastNonFinancial, Escheat. Possible values for past dates: IRALastRollOver. Other possible values: EffectiveDate, ResponseByDate.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
required
Array of objects (AccountDetailedParty)
Array
Array of objects (GenericIdentification)
Array of objects (GenericCode)

Codes to link the party with other systems or to classify the party. Possible values: RemoteDepositRisk.

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.

nameTemplateId
string (NameTemplateId) [ 1 .. 36 ] characters
Example: "1"

Template used to display the party name. This is an external id provided by the account servicer.

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.

object (PlaceAndDateOfBirth)

Date and place of birth of a person.

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

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

status
string (PartyStatus) [ 1 .. 35 ] characters
Example: "GoodStanding"

Specifies the current primary status of a party. Possible values are: GoodStanding, FraudAlert, BadCustomer, Active, Delinquent, Default, HighRisk, UnderReview, HotCarded, WildCarded. Other possible values: PersonalBankruptcy, GrowingConcern, WatchLoan, InReceivership, Chapter11, Liquidation.

statusDateAndTime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
coveredByMilitaryLendingActIndicator
boolean

Indicates if the borrower is covered under the Military Lending Act.

militaryMemberIndicator
boolean

Indicates whether the person is is service member/military.

object (DateTimePeriod)
object (Employment)
object (Audit)

Resource Audit Information. Captures the creation, modification and maintenance details.

Array of objects (PostalAddress)
object (StructuredName)

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

Array of objects (Phone)
organizationType
string (OrganizationType)
Example: "Corporation"

Specifies the legal standing of the organization. Possible values are: Government, NonGoverment NonUSGovernmentOrganization, USGovernmentOrganization FinancialInstitution, SoleProprietorship, UnincorporatedAssociation, LimitedLiabilityPartnership, LimitedLiabilityCompany, SingleMemberLimitedLiabilityCompany, LimitedPartnership, FormalPartnership, GeneralPartnership, Business, Corporation, NotForProfit, ForProfit, NonProfitCorporation, NonProfit, Club, Supranational, Sovereign, Municipal, Province, State, County, National, ExemptionTrust, LivingTrust, EmployeeTrust, RevocableTrust, IrrovocableTrust, NakedTrust, FamilyTrust, BussinesTrust, CliffordTrust, FormalTrust, PublicAgency, Association, Church, PublicFunds. International & Foreign Business Entities: PersonaFisica, SociedadCivil, SociedadAnonimaCapitalVariable, SociedadResponsabilidadLimitada, SociedadAnonimaCapitalVariable.

customerType
string (CustomerType)
Example: "Consumer"

A customer type of a bank account can be classified into different categories based on the account's features, purpose, and benefits. Possible Values: Personal, Business, Consumer, Organization, ThirdParty, Estate, Employee, ForeignConsumer.

taxReportingIndicator
boolean

Account tax reporting typically involves obtaining and submitting records related to your tax obligations. For individuals, this may include income, qualifying deductions, and investment gains or losses. Businesses, on the other hand, have additional complexities, such as tracking funds directed towards specific business expenses and shareholders.

taxStatus
string
Example: "Exempt"

Exempt, Retain, ExemptExpired, VoluntaryWithholding, Chapter3, Chapter4, C-Corp, S-Corp, Certified, W-8Required, NotCertified.

Array of objects (PaymentCardDescriptor)
Array of objects (Balance)

Balances related to the party

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

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

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

Type of the account party role. Some possibles values are: Comaker, Cosigner, AccountOwner, AccountSigner, ATMDebitCardHolder, CreditCardHolder, LiquidityManager, Endorser, 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, Minor, Nominee, SecondaryOwner, Executor, Beneficiary, PrimaryServicerOfficer, SecondaryServicerOfficer, AccountOpenningOfficer, CustomerServiceOfficer, PowerOfAttorney, ContingentBeneficiary, Fiduciary, ControlPerson, AuthorizedPerson, Dealer, DoingBusinessAs, Grantor, SecondaryTrustee, RepresentativePayee, RestrictedOwner.

partyAccountRoleCode
string
Example: "50"

Bank defined party account role.

beneficiaryPercentage
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Percentage value of the ownership that the party has in the account.

beneficiaryAmount
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Actual dollar amount of the liability for this account.

accountOwnerRelation
string [ 1 .. 40 ] characters
Example: "PrimaryServicerOfficer"

Identifies how the party is related to the owner of the account.

Array of objects (Restriction)

Party restrictions on the account capabilities

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)
Example: "SubAccount"

Account relation role. Possible values are: Parent, EscrowAccount, SubAccount, ControlAccount, CrossAccount, ChargeAccount, AssociatedAccount, IRAAccount, CombinedStatement, SecondaryCombinedStatement, SummaryAccount, FundingSource, CompensatingAccount. Payment related values: Authorized, Counterpart

accountId
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

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

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

accountType
string (RelatedAccountType) [ 1 .. 60 ] characters
Example: "Checking"

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

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.

productId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
Array of objects (GenericCode)

Account related codes

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

Account used as a reference for the account opening.

Array of objects (SpotDate)
Array
name
string (SpotDateName) [ 1 .. 40 ] characters
Example: "Expiration"

Possible values por projected dates: Forecast, Expiration, LastNonFinancial, Escheat. Possible values for past dates: IRALastRollOver. Other possible values: EffectiveDate, ResponseByDate.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
initialFundingSource
string (FundingSource) [ 1 .. 60 ] characters
Example: "CreditTransfer"

Source of funds for the account. Possible values: CreditTransfer, NewCustomer, FundsFromExistingCustomer

Array of objects (SpotDate)

Projected account dates. Possible values: AnticipatedPayOff.

Array
name
string (SpotDateName) [ 1 .. 40 ] characters
Example: "Expiration"

Possible values por projected dates: Forecast, Expiration, LastNonFinancial, Escheat. Possible values for past dates: IRALastRollOver. Other possible values: EffectiveDate, ResponseByDate.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (Restriction)
Array
name
required
string [ 1 .. 60 ] characters
Example: "WireTransferIn"

Name of the restriction in PascalCase. Possible values: TransferIn, TransferOut, WireTransferIn, WireTransferOut, ACHTransferIn, ACHTransferOut, ForeignIncomingWires, ForeignOutgoingWires, ACHTransfers, InternetBankingTransfer, InternetView, InternetInquiry, ForeignOutgoingIran, Withdrawals, Renew, Transfers, AdvanceTransfer, OnlineBanking, ElectronicBanking, InvestmentAllowed, InvestmentSetUpAllowed, DebitCardAllowed, CheckOrderAllowed, AutomaticSweep, AccountManagement

restrictionPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
enableIndicator
boolean
Example: true

Indicates whether the capability is allowed or not.

disableConditions
Array of strings (ConditionName) [ items [ 1 .. 36 ] characters ]
Example: ["LessThanMinAmount"]

Conditions that disabel the restriction.

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.

status
string (RestrictionStatus) [ 1 .. 36 ] characters
Example: "Pending"

Specifies the status of a restriction enablement request. Possible values: Enable, Pending, InquiryOnly, Disable, Requested.

Array of objects (Limit)
Array
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

name
required
string [ 1 .. 60 ] characters
Example: "CreditLimit"

Name of the limit in PascalCase. Possible values: NSF, UncollectedFunds, Overdraft, CreditLimit, CreditCard, Withdraw, CreditCardWithdraw, ForeignFeesWaived, CreditTransactions, DebitTransactions, ATMSurchargeReimbursement, CashAdvance, ACHInTransfers, ACHOutTransfers, OverdraftProgram, Threshold, MinimumTransfer, MinimumAdvance, DomesticWireTransferIn, DomesticWireTransferOut, ForeignWireTransferIn, ForeignWireTransferOut.

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

Specifies the type of risk management limit. Bilateral, NetBilateral, IndirectBilateral, Global, MandatoryBilateral, DiscretionaryBilateral, DirectDebit, SingleCustomerDirectDebit, SingleFinancialInstitutionDirectDebit, TotalDailyCustomerDirectDebit, TotalDailyFinancialInstitutionDirectDebit, AutoCollateralisation, UnsecuredCredit, ExternalGuarantee, Revolving, NotRevolving.

channelType
string [ 1 .. 30 ] characters

Channel type for which this limit applies. Possible values: OnlineATM, OfflineATM, ATM, SaleTerminal, : Check, ACHDebit, DebitCard, BillPayment.

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

Amount limit

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

Amount limit currency.

number
integer

Number limit.

enableIndicator
boolean
Example: true

Indicates whether the limit is enabled or not.

feesConsentIndicator
boolean
Example: true

Indicates that the institution received customer consent to assess fees when the limit is exceeded.

percentageIndicator
boolean

Indicates if the limit is calculated as a percentage.

percentage
string (Percentage) <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Value expressed as a positive or negative percentage, rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. total number of digits: 11 number of digits in fractional part: 10 Max Value: 100

temporaryIndicator
boolean
Example: true

Indicates whether the limit is temporary or not.

object (DateTimePeriod)
object (Frequency)

Renewal frequency

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

Amount limit used

usedNumber
integer

Number limit used.

usedPercentage
string (Percentage) <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Value expressed as a positive or negative percentage, rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. total number of digits: 11 number of digits in fractional part: 10 Max Value: 100

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

Specifies the current status of a limit. Possible values are: Enabled, Disabled, Deleted, Requested, NotAuthorized (The limit is not authorized by the customer). Other values: CustomerEnrolled, CustomerNotEnrolled, InstitutionEnrolled.

statusDateAndtime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
object (LimitHistory)

Historic values of a Limit

Array of objects (Balance)
Array of objects (GenericCode)

Additional limits codes.

accessConditions
Array of strings (ConditionName) [ items [ 1 .. 36 ] characters ]
Example: ["LessThanMinAmount"]

Limit access condition. Possible values: BeforeTransfers, AfterTransfers: Overdraft Limit is accessed before or after automatic transfers. Other values: POSTransactions, ATMTransactions, when the customer authorize the payment of ATM or POS transactions, if the transaction was to overdraw the account.

notificationOptions
Array of strings
Example: ["Exception"]
Array of objects (AccountPayment)

Payments methods to cover the amount limit overdraft.

object (FinancialStatement)

Specifies financial statement details.

object (Frequency)

The frequency of the regular statement.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

object (Frequency)

The next frequency of the regular statement.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

Array of objects (StatementCommunicationChannel)
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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

Communication value such as phone number or email address.

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

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

printOnNextCycleIndicator
boolean

Indicates whether the statement will be produced at the end of the next statement cycle.

Array of objects (GenericCode)

Codes to determine configurarion options for alerts and notifications. Possible code names: NoticeOption.

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

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

Array of objects (GenericCode)

Codes related to statements or internal handling codes associated with the statement. Possible Values: CombinedCode, SpecialStatement, DetailsFormat, StatementGroup, ProfitabilityOption.

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

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

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
Array of objects (GenericIdentification)

Identification of statement instances and related. Possible values: schemeName: LastCombinedStatement, CombinedStatementAccountId

Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification.

schemeName
required
string [ 1 .. 35 ] characters

Name of the identification scheme.

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.

templateCode
string (StatementTemplateId) [ 1 .. 36 ] characters
Example: "1"

Template used to create the statement document. This is an external code provided by the account servicer.

object (Period)
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

object (Period)
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

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

The date of the last statement.

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

The date of the next statement.

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

The date on which service charges will be applied to an account

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

The date of the statement previous from the last.

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

The date of the last regular statement.

truncationOptions
Array of strings
Example: ["ItemsIncluded"]
accountNameIndicator
boolean

Indicates whether the account name is printed on the statement.

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, Default.

combineType
string [ 1 .. 36 ] characters
Example: "SavingsStatement"

Indicates whether account transactions are printed on a combined statement. Possible combinations: CheckingStatement, SavingsStatement, PrimaryAccount, SecondaryAccount.

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

profitabilityModelId
string (StatementModelId) [ 1 .. 36 ] characters
Example: "1"

Model used to calculate customer profitability. This is an external id provided by the account servicer.

lastIRAStatementDate
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 (InterestCalculation)
Array
name
string (InterestName) [ 1 .. 40 ] characters
Example: "Deposit"

Name in PascalCase of the interest that applies to the account. For instance, Deposit. Also identifications of the interest or charge.

interestCode
string <= 50 characters

Interest calculation code used by the account servicer.

dayCountBasis
string (InterestDayCountBasis) [ 1 .. 50 ] characters
Example: "Actual360"

An interest day count basis is a method used to calculate interest accrual over a period of time for loans and bonds. The method involves determining the number of days over which interest is being calculated, known as the accrual period. The resulting accrual period is then divided by a certain number to calculate the daily interest rate, which is applied to the principal balance to determine the interest payment. Possible Values: ActualActual, Actual360, Actual365, 365365, 360360, Monthly78ths, 365360, ActualSchedule, ScheduleSchedule.

calculationMethodOption
string (InterestComputationParameter) [ 1 .. 50 ] characters
Example: "LastInterest"

Specifies a parameter that apply at the interest day count basis. Possible Values: LastInterest, EqualPayment, InterestAndPrincipal, InterestSeparatedm, Amortized, AddOn, NegativeAmortization, Simple, FHLMC.

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

An accrued date is a hypothetical point in time when the interest should have been paid.

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

lastInterestDate
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

The period funds are earning interest.

enableIndicator
boolean
Example: true

Indicates whether the interest is enabled for automatic charge.

compoundingMethod
string [ 1 .. 35 ] characters
Example: "Deposit"

Indicates the compounding method used for interest calculations.

object (Frequency)

Frequency of the interest calculation and compounded during the term.

object (Frequency)

Specifies an event frequency

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

Total interest that has accumulated over a day.

object

Details on the interest payment.

Array of objects (Balance)

Total amounts related to an interest. Possible Values: CurrentEarned, 2021AsOfDate, 2020AsOfDate, 2019AsOfDate, CutOffAvailable, CutOffAverageAvailable, CutOffAverageLedger, CutOffAverageMinimumLedger, CutOffLedger, CutOffMinimumLedger

object (InterestRenewalDetails)

Detailed interest attributes related to rate change at maturity.

object (InterestCycle)

Set of parameters used to calculate an interest cycle.

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

The amount of automatic interest that was last posted to the account.

reportingIndicator
boolean

Identifies whether interest earned or paid is reportable.

reportingOptions
Array of strings (InterestReportingOption) [ items [ 1 .. 35 ] characters ]
Example: ["Deposit"]
object (TaxForm)

Information of the form requested by the tax payer.

object (Frequency)

The frequency used in calculating the Regulation DD Annual Percentage Yield (APY) when the financial institution requires interest to be withdrawn (i.e. compounding interest is not an option.) The Regulation DD Compound Frequency overrides the interest frequency only in computing the APY. For example, an account with interest paid monthly by check but disclosed as annual compounding.

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

Annual Percentage Yield (APY) is a measure used in finance to express the total return on an investment, taking into account both the interest earned and the appreciation in the investment's value, over a specified period. It is expressed as a percentage and is often used for fixed income securities such as bonds, and money market accounts.

daysSinceLastAnniversary
integer

The number of calendar days processed since the last anniversary date

Array of objects (InterestCalculationRate)

Rates involve on interest calculation.

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

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

rateTieredType
string (InterestTieredRateType) [ 1 .. 35 ] characters
Example: "Whole"

Specifies the type of tiered interest rate. Possible values: Whole, Split, Dynamic.

rateAmountType
string (BalanceName) [ 1 .. 50 ] characters
Example: "Available"

Specifies the nature of the balance. Possible values: Current, Available, Pending, Opening, Blocked, Previous, RelatedBalance, OnHold, PendingLedger, Collected, LastAnniversary, CurrentAccrued, PreviousAccrued, CurrentWithLastCalculus, CarriedAdjustment, PaidWithPenalties, Accrued, Penalty, Fees, Withholding, CollectionLedger, LastLedger, CurrentLedger, Ledger, MinimumAvailable, MinimumLedger, Withheld, CurrentBooked, CurrentBook, LastDeposit, FloatAmount, Average, RegulationDDAvailable. Loan Balances: CashProceeds, the amount that a customer actually received, exclusive of insurance premiums, fees, and unearned discount; FinancedExpenses, indicates the amount of expenses an institution has financed for a borrower; TotalInterest; AdditionalInterest, if the date of the first payment is beyond one month from the note date, the interest for the odd days will be earned during the first interest period; DeferredUnsecuredPrincipal, is the outstanding balance of an unsecured debt. The DUPB includes any accrued interest that is yet to be paid by the borrower. The deferral typically occurs due to bankruptcy or debt relief proceedings, which temporarily halt collection efforts by the original creditor; Charge Balances: Earned, RealTimeDeliveryMaximum, Current, Financed, Prepaid, CurrentEarned, CurrentEarnedOtherEscrow, InterestPaidToDate, InterestPaidThisYear, InterestPaidPreviousYear, InterestPaidLastStatement, InterestPaidThisYear, RevolvingCreditPaid, BasePaidToDate, TotalPastDue, Escrow, AppliedEscrow, UnpaidEscrow, EscrowBucket, Principal, Interest, Fees, BilledFees, OtherEscrow, FinalAmount, FinalInterestAmount, Chapter4PreviousYear, Payments: Delinquent, FixPayment, Transaction, LoanPayOff, PrincipalAndInterest, AvailableCash, AvailableCheck, AvailableCredit, Sweep, Float, MemoLedger, Memo, AvailablePending, LedgerPending.

pastDueOptions
Array of strings[ items [ 1 .. 70 ] characters ]

Indicates how the Past Due Rate is applied to past due loans. After a loan payment is past due after certain days, interest is earned retroactively from the payment due date.

Array of objects (VariableInterestChanges)
Array of objects (ChargeCalculation)
Array
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

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

Unique identifier of charge.

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

Name of the charge calculation in PascalCase. Possible values: Fee, Overdraft, CardLatePayment, CashAdvance, LatePayment, CashWithdrawal, EarlyWithdrawal, Dormant, EIM, NonSufficientFunds, ATM, BillPayment, FDIC, Overdraft, OverdraftInterest, OverdraftCourtesy, ReturnedItem, DeclinedCheck. Service Charge values: AutomaticActivityCharge, MaintenanceActivityCharge, MaintenanceServiceCharge. ServiceCharge, ServiceChargeCreditBack. Also other external codes to identify the charge.

status
string (ChargeStatus) <= 40 characters
Example: "Charged"

Specifies the current status of the charge. Possible values are: Charged, Waived, AnalysisAddenda, AddendaCharged, AddendaChargedOnCycleDay.

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

Amount charged for the service.

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

Charge currency

rate
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

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, 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, Fee, Insurance, NonTaxable, Recurring, Taxable.

exemptIndicator
boolean

Indicates whether the account is exempt of the charge.

exemptPeriodsNumber
integer

Indicates the number of charge periods that the account is exempt from charges.

Array of objects (GenericCode)

Additional charge codes. Possible values: CalculationCodeNumber, ServiceChargePrefix, ServiceChargeCode.

calculationMethodCode
string [ 1 .. 60 ] characters

Servicer charge calculation code in Pascal Case. Possible values: FIFO, older payment past due. LIFO, most recent payment past due. Also could be a Bank defined string.

calculationMethodOptions
Array of strings (ChargeCalculationMethodOption) [ items [ 1 .. 70 ] characters ]

Indicates other calculation method options for charge calculation.

options
Array of strings (ChargeOptions) [ items [ 1 .. 50 ] characters ]
Example: ["NSFDefault"]
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, Monthly, Annual, FullTerm, RemainingTerm, Monthly78th

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.

maximumNumber
integer

Maximum Number of charges.

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

Minimum amount of money asked or paid for the charge.

enableIndicator
boolean
Example: true

Indicates whether the charge is enabled for automatic charge.

object (InterestCalculationDescriptor)

Set of parameters used to calculate an interest.

debitIndicator
boolean

Indicates whether the charge is automatically debited from the defined account.

Array of objects (AccountPayment)

Payments methods to waive o to pay back the charge.

object (Frequency)

Specifies an event frequency

Array of objects (Balance)
description
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
Array of objects (Tax)
Array
taxType
string (TaxType) [ 1 .. 35 ] characters
Example: "TaxCredit"

Specifies the type of tax. Possible ISO values are: ValueAddedTaxOfZeroRate, Provincial, NationalTax, StateTax, WithholdingTax, CapitalGainTax, InterimProfitTax, StampDuty, WealthTax, InheritanceTax, SolidaritySurcharge, TaxCredit, Equalisation, GiftTax, ConsumptionTax, AlternativeMinimumTax, LocalTax, NationalFederalTax, PaymentLevyTax, StockExchangeTax, TransactionTax, TransferTax, ValueAddedTax, LocalBrokerCommission, ExecutingBrokerCommission, EUTaxRetention, Aktiengewinn1, Aktiengewinn2, Zwischengewinn, CustomsTax, Mietgewinn, GermanLocalTax3, GermanLocalTax4, GermanLocalTax2, WithholdingOfForeignTax, WithholdingOfLocalTax, CapitalLossCredit, FederalWithholding, StatelWithholding.

name
string (TaxName) [ 1 .. 60 ] characters
Example: "Sales"

Name of the tax in PascalCase. Possible values: Sales.

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

Rate applied on a basis amount to calculate the withholding.

debitIndicator
boolean

Indicates whether the tax is automatically debited from the defined account.

taxReportingIndicator
boolean

Flag to indicate that the tax should be reported to the party.

Array of objects (Balance)

Total amounts related to the tax type

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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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

Communication value such as phone number or email address.

channelPurpose
string (CommunicationChannelPurpose) [ 1 .. 40 ] characters
Example: "PrivacyNotices"

Communication purpose of the channel. Possible values: Alerts, PrivacyNotices, NegativeBalance, OverdraftProtection, ACHNotice, ChargeBack, BalanceOnReceipt, RegulationCCNotice, RateChange, MaturityNotice, InterestNotice, RegularNotice, PastDueNotice, HUDNotice, PaymentChange, AutomaticPayment, PastDueFirstNotice, PastDueSecondNotice, PastDueNoticeGuarantor, CardHolderAuthorization, Delivery, DocumentDistribution.

codeWord
string

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

alertIndicator
boolean

Indicates whether the channel is used for enterprise alerts to the customer.

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

The party authorized to use the communcation channel

Array of objects (GenericCode)

Codes to determine configurarion options for alerts and notifications. Possible code names: NoticeOption.

status
string (AlertStatus) [ 1 .. 35 ] characters
Example: "Warning"

Alert status. Possible values: Sent, SentLastNight, Pending, Enable, Disable, FraudAlert. Possible values for CreditBureauAlert: IdentityTheft.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

object

The lead time between the event and the alert notification.

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

Text to appear in alerts and notices.

Array of objects (SpotDate)
contactCount
integer

Number of contacts.

object (Frequency)

Specifies an event frequency

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

This id gives the ability to view a party’s total relationship with the bank. The relationship Id ties multiple parties and accounts together. This code is also used to reduce mailing costs during marketing campaigns to avoid sending duplicate materials to parties residing at the same address.

Array of objects (GenericAccountCode)
Array
name
string <= 50 characters
Example: "AccountingGroup"

Name of the code. Possible values are: AccountingGroup, CostCenter, DistributionGroup. Also values that may be overlayed on the identification: AccountSubtype, AccountType. Also MICR numbers: MicrAccountNumber, The account number portion of a draft or line of credit MICR line. Other possible values: TaxIncentiveType, Preferredlanguage, FundsDelayedReason, DeliveryMethod.

value
required
string [ 1 .. 35 ] characters
Example: "195"

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
object (AccountPrintOptions)
accountTitle
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
accountTitleOption
string (AccountTitlePrintOption) [ 1 .. 35 ] characters

Options to indicate the multiple lists of account owner names. Possible Values: TitleNotPrinted, TitlePrintsBeforeNames, TitlePrintsAfterNames

checkNameOption
string (CheckPrintOption) [ 1 .. 35 ] characters

Options to indicate the multiple lists of account owner names. Possible Values: JointAnd, JointOr.

balanceOnReceiptOverride
string (BalanceOnReceiptOptions) [ 1 .. 35 ] characters

Indicates whether the account balance is printed on teller terminal and ATM receipts. Possible Values: PrintWhenPositive, PrintWhenNegative, AlwaysPrint, NotPrint

nameIndicator
boolean

Indicates whether the account name is printed on account statements.

handlingLevels
Array of strings (PrintHandlingLevel) [ items [ 1 .. 35 ] characters ]
Array of objects (GenericPrintOption)
Array
name
string (PrintOptionName) [ 1 .. 35 ] characters

Name of the print Option. Possible Values: ACHTransaction

options
Array of strings (PrintOption) [ items [ 1 .. 35 ] characters ]
object (AccountBillDetails)

Billing information of the payment

billingDay
integer <= 31
Example: 30

Identifies the day of the month that billing statements are generated.

billOption
string
Example: "Individual"

Indicates whether billing occurs for the account at the company level (consolidated) or at the individual account level. Possible values: Consolidated, Individual.

Array of objects (Balance)

Bill balances

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

Date and time at which the period starts.

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

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

balanceName
string (BalanceName) [ 1 .. 50 ] characters
Example: "Available"

Specifies the nature of the balance. Possible values: Current, Available, Pending, Opening, Blocked, Previous, RelatedBalance, OnHold, PendingLedger, Collected, LastAnniversary, CurrentAccrued, PreviousAccrued, CurrentWithLastCalculus, CarriedAdjustment, PaidWithPenalties, Accrued, Penalty, Fees, Withholding, CollectionLedger, LastLedger, CurrentLedger, Ledger, MinimumAvailable, MinimumLedger, Withheld, CurrentBooked, CurrentBook, LastDeposit, FloatAmount, Average, RegulationDDAvailable. Loan Balances: CashProceeds, the amount that a customer actually received, exclusive of insurance premiums, fees, and unearned discount; FinancedExpenses, indicates the amount of expenses an institution has financed for a borrower; TotalInterest; AdditionalInterest, if the date of the first payment is beyond one month from the note date, the interest for the odd days will be earned during the first interest period; DeferredUnsecuredPrincipal, is the outstanding balance of an unsecured debt. The DUPB includes any accrued interest that is yet to be paid by the borrower. The deferral typically occurs due to bankruptcy or debt relief proceedings, which temporarily halt collection efforts by the original creditor; Charge Balances: Earned, RealTimeDeliveryMaximum, Current, Financed, Prepaid, CurrentEarned, CurrentEarnedOtherEscrow, InterestPaidToDate, InterestPaidThisYear, InterestPaidPreviousYear, InterestPaidLastStatement, InterestPaidThisYear, RevolvingCreditPaid, BasePaidToDate, TotalPastDue, Escrow, AppliedEscrow, UnpaidEscrow, EscrowBucket, Principal, Interest, Fees, BilledFees, OtherEscrow, FinalAmount, FinalInterestAmount, Chapter4PreviousYear, Payments: Delinquent, FixPayment, Transaction, LoanPayOff, PrincipalAndInterest, AvailableCash, AvailableCheck, AvailableCredit, Sweep, Float, MemoLedger, Memo, AvailablePending, LedgerPending.

amount
string (Amount) <= 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

count
integer

Number of transactions added to the amount.

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 (GenericCode)

Bank defined codes to classify balances. Possible values: BalanceCategory, BalanceType, PartyAgreementNumber.

object (Collateral)

Assets pledged by a debtor to secure a loan or an exposure and subject to seizure in the event of default.

collateralId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
value
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Value of the collateral as an amount.

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

The Ineligible Amount is a non-lien dollar amount that is subtracted from the Collateral Value or Net Appraised Value.

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

The collateral dollar amount that cannot be exceeded when calculating the Loan Amount.

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

The Collateral Net Appraised Value (CNAV) is a critical aspect of real estate appraisal and mortgage financing. It represents the difference between the fair market value (FMV) of the collateral and the outstanding mortgage debt on the property.

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

The date the property was last appraised.

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

The last time the collateral was reviewed.

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

The next time the collateral will be reviewed.

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

The price paid for the property.

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, Airplane, MachineTool, IndustrialEquipment, OfficeEquipment, ITEquipment, MedicalEquipment, EnergyRelatedEquipment, CommercialBuilding, ResidentialBuilding. IndustrialBuilding, OtherVehicle, OtherEquipment, OtherRealEstate, OtherGoodsOrInventory, Guarantee, OtherFinancialAsset, MixedCategories.

disposalCostPercentage
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Identifies disposal (selling) costs as a percentage of the Net Appraised Value and Collateral Value. Disposal costs are subtracted from the Net Appraised Value to calculate the net disposal value. The costs are also subtracted from the Collateral Value to calculate the net collateral value.

maximumLoanAmountPercentage
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

The percentage of the Collateral Value used to determine the Loan Amount. This percentage cannot be greater than 100.00%

marketMarginPercentage
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

A percentage subtracted from the Market Price to calculate the Collateral Value.

Array of objects (LoanCollateralRatioFormula)
Array
name
string

Name of the formula.

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

The ratio used to determine underwriting criteria of the property.

Array of objects (LoanCollateralLien)
Array
name
string

Name of the lien.

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

The amount of the lien.

Array of objects (GenericCode)

Codes to classify collaterals. Possible code names: MarketPricing, OwnerOccupied, PropertyType, Location.

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

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

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
numberOfUnits
integer

A collateral number of units refers to the number of individual properties that are being used as security for the loan.

object (Agreement)

Agreement between two trading parties that contains information about their relative duties and rights regarding collateral.

documentReference
string [ 1 .. 35 ] characters

Document location.

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

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

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

object (Jurisdiction)

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

object (ContactDetails)

Specifies the contact details of a person.

object (AccountContractRelatedParty)
agreementType
string (AgreementType)

Document or agreement type. Possible values: CardAgreement, AccountContract.

agreementSubtype
string [ 1 .. 60 ] characters

Agreement detailed category.

object

Postal address of the collateral residential building.

addressCode
string

This code is used to identify parties that share the same address or to associate an existing address with a specific party. Providing this code eliminates the need to separately enter the address details.

addressBookIndicator
string

If true, the address is kept in the system even if the person is no longer a customer.

addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible values are: PhysicalAddress, Postal, POBox, Residential, Permanent, Temporary, Alternative, Previous.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible values are: MailTo, DeliveryTo, Billing, Tax, ForeignTaxRecipient PlaceOfOperation, PlaceOfRegistration, placeOfFormation, Marketing, Statements, Business, Administrative, PreviousPlace, Headquarter, BranchStore, Branch, Property, Military, Secondary, Personal, Annex, Inquiry.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

careOf
string [ 1 .. 100 ] characters
Example: "C/O Company Name"

Identifies an addressee that is accepting the correspondence for the intended recipient. Using care of ensures the correspondence reaches the right recipient rather than getting returned to the sender.

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

Identification of a division of a large Organization or building.

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

Identification of a sub-division of a large Organization 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 Organization, where letters are kept until called for.

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

Building room number.

postCode
string (PostCode) [ 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. In US may consists of two parts: the five-digit ZIP Code '97062' and the ZIP+4 Code '6884'.

carrierRoute
string (CarrierRoute) [ 1 .. 4 ] characters
Example: "C001"

A Carrier Route is a designated geographic area assigned to individual postal carriers by the United States Postal Service (USPS) to facilitate efficient mail delivery within specific regions.

censusTract
string (CensusTract) = 5 characters
Example: "12345"

A census tract, census area, census district or meshblock is a geographic region defined for the purpose of taking a census

censusBlock
string (CensusBlock) = 4 characters
Example: "1234"

Census blocks are used to partition counties into smaller areas for the purpose of collecting and presenting census data.

cBSACode
string (CBSACode) = 5 characters
Example: "49780"

Core-based statistical area. Metropolitan statistical area (MSA) is the formal definition of a region that consists of a city and surrounding communities that are linked by social and economic factors. Micropolitan Statistical Areas (MISA) are CBSAs associated with at least one urban cluster that has a population of at least 10,000, but less than 50,000. The micropolitan statistical area comprises the central county or counties or equivalent entities containing the core, plus adjacent outlying counties having a high degree of social and economic integration with the central county as measured through commuting.

cBSAType
string (CBSAType) [ 1 .. 10 ] characters
Example: "MSA"

Type of Core-based statistical area. Possible values: MSA, MISA

foreignIndicator
boolean

Indicates whether the postal address is from a foreign country.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

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

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

Specific location name within the town.

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

Identifies a subdivision within a country sub-division.

countyName
string [ 1 .. 35 ] characters
Example: "Cook"

Identifies a county 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.

temporaryIndicator
boolean
Example: true

Indicates whether the address is temporary or not.

object

The period of use of the address information. Could be also used as a recurring anual period.

Array of objects (GenericCode)

Codes related to postal address or internal handling codes associated with the address. Possible Values: HandlingCode, HandlingCodeOption, AddressFormat.

Array of objects (GenericIdentification)

Postal address identifiers are used to identify parties that share the same address or to associate an existing address with a specific party. Possible scheme name values: AddressIdentifier.

Array of objects (GenericIdentification)

Unique indentification of the collateral. Possible scheme names: CollateralNumber, UCCFileNumber.

Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification.

schemeName
required
string [ 1 .. 35 ] characters

Name of the identification scheme.

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.

status
string (CollateralStatus) [ 1 .. 36 ] characters
Example: "Secured"

Specifies the collateral status. Possible Values: Secured, UnderSecured, OverSecured, Repossessed, PartiallySecured.

statusDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
descriptionLines
Array of strings[ items [ 1 .. 200 ] characters ]
Example: ["This is a description."]
collateralOwnershipId
string [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Specifies who is the owner of the collateral.

object (AccountContactDetails)

Specifies the contact details of a person.

object (StructuredName)

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

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

Person given first name.

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

Person given middle name.

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

Person surname.

middleInitial
string [ 1 .. 10 ] characters
Example: "J."

Person middle initial.

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. Generation order should be expressed with roman numerals: I, II, III, IV, V.

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

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

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

Preferred name to contact the person

firstContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
lastContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (PostalAddress)
Array
addressCode
string

This code is used to identify parties that share the same address or to associate an existing address with a specific party. Providing this code eliminates the need to separately enter the address details.

addressBookIndicator
string

If true, the address is kept in the system even if the person is no longer a customer.

addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible values are: PhysicalAddress, Postal, POBox, Residential, Permanent, Temporary, Alternative, Previous.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible values are: MailTo, DeliveryTo, Billing, Tax, ForeignTaxRecipient PlaceOfOperation, PlaceOfRegistration, placeOfFormation, Marketing, Statements, Business, Administrative, PreviousPlace, Headquarter, BranchStore, Branch, Property, Military, Secondary, Personal, Annex, Inquiry.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

careOf
string [ 1 .. 100 ] characters
Example: "C/O Company Name"

Identifies an addressee that is accepting the correspondence for the intended recipient. Using care of ensures the correspondence reaches the right recipient rather than getting returned to the sender.

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

Identification of a division of a large Organization or building.

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

Identification of a sub-division of a large Organization 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 Organization, where letters are kept until called for.

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

Building room number.

postCode
string (PostCode) [ 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. In US may consists of two parts: the five-digit ZIP Code '97062' and the ZIP+4 Code '6884'.

carrierRoute
string (CarrierRoute) [ 1 .. 4 ] characters
Example: "C001"

A Carrier Route is a designated geographic area assigned to individual postal carriers by the United States Postal Service (USPS) to facilitate efficient mail delivery within specific regions.

censusTract
string (CensusTract) = 5 characters
Example: "12345"

A census tract, census area, census district or meshblock is a geographic region defined for the purpose of taking a census

censusBlock
string (CensusBlock) = 4 characters
Example: "1234"

Census blocks are used to partition counties into smaller areas for the purpose of collecting and presenting census data.

cBSACode
string (CBSACode) = 5 characters
Example: "49780"

Core-based statistical area. Metropolitan statistical area (MSA) is the formal definition of a region that consists of a city and surrounding communities that are linked by social and economic factors. Micropolitan Statistical Areas (MISA) are CBSAs associated with at least one urban cluster that has a population of at least 10,000, but less than 50,000. The micropolitan statistical area comprises the central county or counties or equivalent entities containing the core, plus adjacent outlying counties having a high degree of social and economic integration with the central county as measured through commuting.

cBSAType
string (CBSAType) [ 1 .. 10 ] characters
Example: "MSA"

Type of Core-based statistical area. Possible values: MSA, MISA

foreignIndicator
boolean

Indicates whether the postal address is from a foreign country.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

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

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

Specific location name within the town.

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

Identifies a subdivision within a country sub-division.

countyName
string [ 1 .. 35 ] characters
Example: "Cook"

Identifies a county 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.

temporaryIndicator
boolean
Example: true

Indicates whether the address is temporary or not.

object

The period of use of the address information. Could be also used as a recurring anual period.

Array of objects (GenericCode)

Codes related to postal address or internal handling codes associated with the address. Possible Values: HandlingCode, HandlingCodeOption, AddressFormat.

Array of objects (GenericIdentification)

Postal address identifiers are used to identify parties that share the same address or to associate an existing address with a specific party. Possible scheme name values: AddressIdentifier.

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

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

extension
string <= 5 characters

Phone Number Extension.

country
string (CountryCallingCode) <= 3 characters

Country calling codes, country dial-in codes, international subscriber dialing (ISD) codes, or most commonly, telephone country codes. Country codes are defined by the International Telecommunication Union (ITU) in ITU-T standards E.123 and E.164. The prefixes enable international direct dialing (IDD).

phoneType
string [ 1 .. 35 ] characters

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

phonePurpose
string [ 1 .. 35 ] characters

Purpose of the phone address. Possible values are: Business, Personal, International, Alternative, PersonalInternational, BusinessInternational

foreignIndicator
boolean

Indicates whether is a foreign phone number

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

object (TimeOfTheDay)
comment
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
object

The period of use of the phone information.

Array of objects (GenericCode)
Array of objects (GenericIdentification)

Phone identifiers are used to identify parties that share the same phone or to associate an existing phones with a specific party. Possible scheme name values: PhoneIdentifier.

lastUpdatedDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
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, Business, Administrative, Personal

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

Array of objects (GenericIdentification)

Email identifiers are used to identify parties that share the same email or to associate an existing email with a specific party. Possible scheme name values: EmailIdentifier.

lastUpdatedDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
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 Organization or building.

preferredMethod
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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, Default.

object (AccountRenewal)

Information related to the account renewal

renewalType
string (AccountRenewalType) [ 1 .. 70 ] characters

The renewal type indicates whether an account automatically renews at maturity. Possible Values: NoTerm, indicates the account has no term; Automatic, indicates automatically renewal; SingleMaturity, indicates not automatically renewed; NoRenewalAllowed.

object (Frequency)

Renewal frequency

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

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

Account renewal rate.

productId
string [ 1 .. 36 ] characters
Example: "PD_CA_0002"

Renewal product

graceDays
integer

The time period when customer can cancel renewal

gracePeriodIndicator
boolean

Indicates whether the account is within the grace period.

lastRenewalDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (ServicerAlert)

Account alerts to be received by the account servicer.

Array
alertName
string (AlertName) [ 1 .. 35 ] characters
Example: "CreditBureauAlert"

Service alert human readable identifier in Pascal case. An alert notification received by the bank. Possible values: CreditBureauAlert, CustomerAlert, PaymentCard, LostBook, TwoSignaturesRequired, PledgedAsCollateral, DeathOnAccount, Bankruptcy, NoDisclosure, Caution, DuplicateBookIssued, PowerOfAttorney, DoNotReopen.

alertType
string (AlertType) [ 1 .. 35 ] characters
Example: "Warning"

An alert notification type. Possible values: Warning, Urgent, Teller.

alertCode
string [ 1 .. 36 ] characters

Service alert identifier or code, used to arrange multiple alerts and warnings in a sequence.

message
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
lastAlertDate
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.

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 (AccountHistory)

History attribute values.

originalOpenDate
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 (TemporalDuration)

Describes a temporal duration.

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

Unit that describes the duration.

value
integer <= 999

Value of the duration in number of units.

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

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

required
object (AccountDetailedStatus)

Specifies the current state of an account.

statusName
string (AccountStatus) [ 1 .. 35 ] characters
Example: "Active"

Specifies the current primary status of an account. Possible values are: Enabled, Dormant, Disable, Deleted, Pending, Form. Pending, Denied, Review, Approve, ChargeOff, Active, PaymentPastDue, Bankruptcy, AuthorizationProhibited, InterestProhibited, Closed, Restricted, Assumed, New, ZeroBalanceAccount.

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

Reason for the status. Possible Values: AbortedClearingTimeout, AbortedClearingFatalError, AbortedSettlementTimeout, AbortedSettlementFatalError,TimeoutCreditorAgent, TimeoutInstructedAgent, OfflineAgent, OfflineCreditorAgent, ErrorCreditorAgent, ErrorInstructedAgent, TimeoutDebtorAgent,IncorrectAccountNumber, InvalidDebtorAccountNumber,InvalidCreditorAccountNumber, ClosedAccountNumber,ClosedDebtorAccountNumber, BlockedAccount,ClosedCreditorAccountNumber, InvalidBranchCode,InvalidAccountCurrency, InvalidDebtorAccountCurrency,InvalidCreditorAccountCurrency, InvalidAccountType,InvalidDebtorAccountType,InvalidCreditorAccountType,AccountDetailsChanged, CardNumberInvalid, TransactionForbidden, InvalidBankOperationCode, TransactionNotSupported, InvalidAgentCountry, InvalidDebtorAgentCountry, InvalidCreditorAgentCountry, UnsuccesfulDirectDebit, InvalidAccessRights,PaymentNotReceived, AgentSuspended,CreditorAgentSuspended, NotAllowedBookTransfer, ForbiddenReturnPayment, IncorrectAgent, ZeroAmount, NotAllowedAmount, NotAllowedCurrency, InsufficientFunds, Duplication, TooLowAmount, BlockedAmount, WrongAmount, InvalidControlSum, InvalidTransactionCurrency, InvalidAmount, AmountExceedsClearingSystemLimit, AmountExceedsAgreedLimit, AmountBelowClearingSystemMinimum, InvalidGroupControlSum, InvalidPaymentInfoControlSum, InvalidNumberOfTransactions,InvalidGroupNumberOfTransactions, InvalidPaymentInfoNumberOfTransactions, LimitExceeded, ZeroAmountNotApplied, AmountExceedsSettlementLimit, InconsistenWithEndCustomer, MissingCreditorAddress, UnrecognisedInitiatingParty, UnknownEndCustomer, MissingDebtorAddress, MissingDebtorName, InvalidCountry, InvalidDebtorCountry, InvalidCreditorCountry, InvalidCountryOfResidence, InvalidDebtorCountryOfResidence, InvalidCreditorCountryOfResidence, InvalidIdentificationCode, InvalidDebtorIdentificationCode, InvalidCreditorIdentificationCode, InvalidContactDetails, InvalidChargeBearerCode, InvalidNameLength, MissingName, MissingCreditorName, AccountProxyInvalid, CheckERI, RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture, RequestedExecutionDateOrRequestedCollectionDateTooFarInPast, ElementIsNotToBeUsedAtB-andC-Level, MandateChangesNotAllowed, InformationOnMandateChangesMissing, CreditorIdentifierIncorrect, CreditorIdentifierNotUnambiguouslyAtTransaction-Level, OriginalDebtorAccountIsNotToBeUsed, OriginalDebtorAgentIsNotToBeUsed, ElementContentIncludesMoreThan140Characters, ElementContentFormallyIncorrect, ElementNotAdmitted, ValuesWillBeSetToNextTARGETday, DecimalPointsNotCompatibleWithCurrency, RequiredCompulsoryElementMissing, COREandB2BwithinOnemessage, ChequeSettledOnCreditorAccount, CreditorBankIsNotRegistered, IncorrectCurrency, RequestedByCustomer, DebtorBankIsNotRegistered,ElectronicSignaturesCorrect, OrderCancelled, OrderNotCancelled, OrderRejected, OrderForwardedForPostprocessing, TransferOrder, ProcessingOK, DecompressionError, DecryptionError, DataSignRequested, UnknownDataSignFormat, SignerCertificateRevoked, SignerCertificateNotValid, IncorrectSignerCertificate, SignerCertificationAuthoritySignerNotValid, NotAllowedPayment, NotAllowedAccount, NotAllowedNumberOfTransaction, Signer1CertificateRevoked, Signer1CertificateNotValid, IncorrectSigner1Certificate, SignerCertificationAuthoritySigner1NotValid, UserDoesNotExist, IdenticalSignatureFound, PublicKeyVersionIncorrect, DifferentOrderDataInSignatures, RepeatOrder, ElectronicSignatureRightsInsufficient, Signer2CertificateRevoked, Signer2CertificateNotValid, IncorrectSigner2Certificate, SignerCertificationAuthoritySigner2NotValid, WaitingTimeExpired, OrderFileDeleted, UserSignedMultipleTimes, UserNotYetActivated, InvalidDate, InvalidCreationDate, InvalidNonProcessingDate, FutureDateNotSupported, InvalidCutOffDate, ExecutionDateChanged, DuplicateMessageID, DuplicatePaymentInformationID, DuplicateTransaction, DuplicateEndToEndID, DuplicateInstructionID, DuplicatePayment, CorrespondentBankNotPossible, BalanceInfoRequest, SettlementFailed, SettlementSystemNotAvailable, ERIOptionNotSupported, InvalidFileFormat, SyntaxError, InvalidPaymentTypeInformation, InvalidServiceLevelCode, InvalidLocalInstrumentCode, InvalidCategoryPurposeCode, InvalidPurpose, InvalidEndToEndId, InvalidChequeNumber, BankSystemProcessingError, ClearingRequestAborted, PaymentTransferredAndTracked, PaymentTransferredAndNotTracked, CreditDebitNotConfirmed, CreditPendingDocuments, CreditPendingFunds, DeliveredWithServiceLevel, DeliveredWIthoutServiceLevel, CorrespondingOriginalFileStillNotSent, NoMandate, MissingMandatoryInformationInMandate, CollectionNotDue, RefundRequestByEndCustomer, EndCustomerDeceased, NotSpecifiedReasonCustomerGenerated, NotSpecifiedReasonAgentGenerated, Narrative, NoERI, BankIdentifierIncorrect, InvalidBankIdentifier, InvalidDebtorBankIdentifier, InvalidCreditorBankIdentifier, InvalidBICIdentifier, InvalidDebtorBICIdentifier, InvalidCreditorBICIdentifier, InvalidClearingSystemMemberIdentifier, InvalidDebtorClearingSystemMemberIdentifier, InvalidCreditorClearingSystemMemberIdentifier, InvalidIntermediaryAgent, MissingCreditorSchemeId, RMessageConflict, ReceiverCustomerInformation,NotUniqueTransactionReference, MissingDebtorAccountOrIdentification, MissingDebtorNameOrAddress, MissingCreditorNameOrAddress, RegulatoryReason, RegulatoryInformationInvalid, TaxInformationInvalid, RemittanceInformationInvalid, RemittanceInformationTruncated, InvalidStructuredCreditorReference, InvalidCharacterSet, InvalidDebtorAgentServiceID, InvalidPartyID, ValidRequestForCancellationAcknowledged, UETRFlaggedForCancellation, NetworkStopOfUETR, RequestForCancellationForwarded, RequestForCancellationDeliveryAcknowledgement, SpecificServiceOfferedByDebtorAgent, SpecificServiceOfferedByCreditorAgent, ServiceofClearingSystem, CreditorNotOnWhitelistOfDebtor, CreditorOnBlacklistOfDebtor, MaximumNumberOfDirectDebitTransactionsExceeded, MaximumDirectDebitTransactionAmountExceeded, TransmissonAborted, NoDataAvailable, FileNonReadable, IncorrectFileStructure, TokenInvalid, SenderTokenNotFound, ReceiverTokenNotFound, TokenMissing, TokenCounterpartyMismatch, TokenSingleUse, TokenSuspended, TokenValueLimitExceeded, TokenExpired, InvalidCutOffTime, TransmissionSuccessful, TransferToSignByHand, AuthorisationCancelled, FollowingCancellationRequest, Fraud, NotCompliantGeneric, NoAnswerFromCustomer, ReturnUponUnableToApply, UnduePayment, AlreadyAcceptedRTP, AlreadyExpiredRTP, AlreadyRefusedRTP, AlreadyRejectedRTP, AttachementsNotSupported, ExpiryDateTimeReached, ExpiryDateTooLong, FraudulentOrigin, IncorrectExpiryDateTime, InitialRTPNeverReceived, NonAgreedRTP, NoPaymentGuarantee, PayerOrPayerRTPSPNotReachable, RTPNotSupportedForDebtor, RTPReceivedCanBeProcessed, RTPServiceProviderIdentifierIncorrect, TypeOfPaymentInstrumentNotSupported, UnknownCreditor, OriginalTransactionNotEligibleForRequestedReturn, RequestForCancellationNotFound, SettlementNotReceived

reasonDescription
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
Array of objects (GenericStatus)

Detailed account status. Possible Values: RegulationDD, Analysis, NewClassCode

Array
statusType
string [ 1 .. 50 ] characters
Example: "RegulationDD"

Pascal case status type. Possible Values: NSFInstruction, RegulationDD, IRA. Pays, InBox, CashReserve, ChargeOff, RestrictedAccount, AccountVerification, ClassCode, LegalEntity, PrivacyNoticed

statusName
string [ 1 .. 50 ] characters
Example: "Active"

Pascal case status name. Possibles Values for IRA status type: NotEligible, Eligible, DistributionDisability, DistributionDeath, DistributionNormal, AccountLinked, AccountNotLinked. Possible values for Pays: Enable, Disable; InBox: NewMessage, Empty; CashReserve: HasCashReserve, DoNotHave; RestrictedAccount: IsRestricted, NotRestricted; ChargeOff: BankSubmitted, Automatic, IntegratedProcessingAutomatic, IntegratedProcessingClosed. PassbookSavings: NotOnline, Online, Manual. AccountVerification: Valid, NotValid. OverdraftProtection: Enable, Disable. ClassCode: New, NotNew. DefaultStatus: Inminent, NotDefault. LegalEntity: LegalEntityCustomer. PrivacyNoticed: CustomerCanBeDisclosed, CustomerOptOut, CustomerNotOptOut

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

Pascal case status reason. Possible Values: NSFInstruction, RegulationDD, IRA.

Array of objects (ProcessEvent)

Account process event list defined by the account servicer.

Array
name
string [ 1 .. 35 ] characters

Human readable pascal case identifier of the process event. Possible list values: YearEndProcessed, MonthEndProcessed, ManuallyControlled

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
Array of objects (SpotDate)
Array of objects (GenericCode)

Codes related to the external provider account. Possible Values: LookUpReference

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.

externalAccountIndicator
boolean

Indicates whether an account is an external entity.

collateralIndicator
boolean

Indicates whether an account has been pledged as collateral.

negotiableIndicator
boolean

Indicates whether an account is a negotiable instrument.

closeOption
string [ 1 .. 34 ] characters

Option for closing an account. Possible Values: DoNotCloseAutomatically, CloseAutomatically

profitabilityAnalysisStatus
string [ 1 .. 34 ] characters

Profit analysis status. Possible values: High, Low, NotAnalyzed, Analyzed, SystemClosed.

nonSufficientFundsInstruction
string [ 1 .. 34 ] characters

Manual NSF decision.

nonSufficientFunds
string [ 1 .. 34 ] characters

Automatic NSF decision.

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

Array of objects (Comment)

Bank comnents of the account.

Array
name
string [ 1 .. 35 ] characters
text
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
object (AccountProfile)
profileType
string [ 1 .. 40 ] characters
Example: "Personal"

Account profile category. Possible Values: Personal, NonPersonal.

riskLevel
string [ 1 .. 35 ] characters
Example: "High"

Laundering risk level

qualityScore
string (QualityScore) [ 2 .. 10 ] characters

The quality score is based on a borrower's credit history, collateral, and the likelihood of repayment.

Array of objects (RiskMeasure)
Array
name
string (CreditRankingScaleName) [ 1 .. 35 ] characters
Example: "StandardAndPoors"

Most commonly used credit ranking scales. Possible Values: StandardAndPoors, MoodysInvestors. Also other values: Original, 1, 2, 3, Current.

level
string (RiskLevel) [ 1 .. 35 ] characters
Example: "High"

Specifies the customer’s money laundering risk. Possible values: VeryLow, Low, Medium, Medium toHigh, ModerateHigh, High, ExtremelyHigh, NoDetermine.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (GenericCode)

Additional risk measure codes. Possible values: RiskRatingCode

Array of objects (CreditRankingScale)

Borrower credit ranking scores

Array
name
string (CreditRankingScaleName) [ 1 .. 35 ] characters
Example: "StandardAndPoors"

Most commonly used credit ranking scales. Possible Values: StandardAndPoors, MoodysInvestors. Also other values: Original, 1, 2, 3, Current.

score
string [ 2 .. 10 ] characters
Example: "AAA"
date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (GenericCode)

Additional ranking scale codes. Possible values: RiskRatingCode

object (BankruptcyProfile)
chapter
string [ 1 .. 10 ] characters
Example: "11"

The section on the Bankruptcy Code that sets out the rules and procedures for a particular type of bankruptcy. Possible Values: 7, 11, 13, 12, and 9.

status
string [ 1 .. 40 ] characters
Example: "Petition"

Bankruptcy status. Possible values: Petition, Discharged, DebtReaffirmation, DebtReaffirmationRescinded, PlanConfirmed, PlanCompleted, Withdrawn.

statementOption
string [ 1 .. 40 ] characters
Example: "RegularBillingStatement"

Statement option. Possible Values: RegularBillingStatement, BankruptcyBillingStatement

object (Frequency)

Indicates the frequency that the history profile payment status is established. Values are dependent upon credit bureau standards.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

paymentHistoryOption
string [ 1 .. 40 ] characters
Example: "NotRecalculate"

Indicates whether the Payment History Profile will be recalculated. Possible Values: Default, NotRecalculate, RecalculateAndSetToDefault, RecalculateAndSetToNot.

Array of objects (Balance)

Amount balances related to the credit profile. Possible Values: CreditHighBalance.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

balanceName
string (BalanceName) [ 1 .. 50 ] characters
Example: "Available"

Specifies the nature of the balance. Possible values: Current, Available, Pending, Opening, Blocked, Previous, RelatedBalance, OnHold, PendingLedger, Collected, LastAnniversary, CurrentAccrued, PreviousAccrued, CurrentWithLastCalculus, CarriedAdjustment, PaidWithPenalties, Accrued, Penalty, Fees, Withholding, CollectionLedger, LastLedger, CurrentLedger, Ledger, MinimumAvailable, MinimumLedger, Withheld, CurrentBooked, CurrentBook, LastDeposit, FloatAmount, Average, RegulationDDAvailable. Loan Balances: CashProceeds, the amount that a customer actually received, exclusive of insurance premiums, fees, and unearned discount; FinancedExpenses, indicates the amount of expenses an institution has financed for a borrower; TotalInterest; AdditionalInterest, if the date of the first payment is beyond one month from the note date, the interest for the odd days will be earned during the first interest period; DeferredUnsecuredPrincipal, is the outstanding balance of an unsecured debt. The DUPB includes any accrued interest that is yet to be paid by the borrower. The deferral typically occurs due to bankruptcy or debt relief proceedings, which temporarily halt collection efforts by the original creditor; Charge Balances: Earned, RealTimeDeliveryMaximum, Current, Financed, Prepaid, CurrentEarned, CurrentEarnedOtherEscrow, InterestPaidToDate, InterestPaidThisYear, InterestPaidPreviousYear, InterestPaidLastStatement, InterestPaidThisYear, RevolvingCreditPaid, BasePaidToDate, TotalPastDue, Escrow, AppliedEscrow, UnpaidEscrow, EscrowBucket, Principal, Interest, Fees, BilledFees, OtherEscrow, FinalAmount, FinalInterestAmount, Chapter4PreviousYear, Payments: Delinquent, FixPayment, Transaction, LoanPayOff, PrincipalAndInterest, AvailableCash, AvailableCheck, AvailableCredit, Sweep, Float, MemoLedger, Memo, AvailablePending, LedgerPending.

amount
string (Amount) <= 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

count
integer

Number of transactions added to the amount.

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 (GenericCode)

Bank defined codes to classify balances. Possible values: BalanceCategory, BalanceType, PartyAgreementNumber.

customerType
string (CustomerType)
Example: "Consumer"

A customer type of a bank account can be classified into different categories based on the account's features, purpose, and benefits. Possible Values: Personal, Business, Consumer, Organization, ThirdParty, Estate, Employee, ForeignConsumer.

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

Array of objects (CreditRankingScale)
creditReportAddressIndicatorCode
string

is a code or marker used by credit reporting agencies to indicate a match or mismatch between the address supplied in an inquiry and the address they have on file for a consumer.

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

Information provided by the Consumer Credit Report.

consumerCreditReportDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
eCOACode
string

The ECOA code indicates how customer account information is reported to the Credit Bureau in keeping with the Equal Credit Opportunity Act.

Array of objects (Product)

Product information at account level.

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

Unique identification of a product within a product type.

pricingStrategyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
name
required
string [ 1 .. 40 ] characters
Example: "Visa Business Card"

Commercial product name within a product type.

description
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
productType
string [ 1 .. 35 ] characters
Example: "PaymentCard"

Type or nature of a product. Possible Values: Loan, PaymentCard, CheckingAccount, HealthSavingsAccount, RepricingPlan.

productSubType
string [ 1 .. 35 ] characters
Example: "BusinessCard"

Commercial product subtype within a product type.

Array of objects (Restriction)
Array of objects (SpotDate)
Array of objects (Limit)
Array of objects (ChargeCalculation)
parties
Array of strings (ProductPartyRelationType) [ items [ 1 .. 40 ] characters ]
Example: ["ParentProvider"]
status
string (ProductStatus) [ 1 .. 35 ] characters
Example: "GoodStanding"

Specifies the current status of a product. Possible values are: Enable, Disable.

statusDateAndTime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (GenericCode)

Product configuration codes. Possible Values: WebBrand, WaterfieldService, MajorAccountType: Major Account Type code for Employee Qualified Plan, MinorAccountType: Minor Account Type code to use for Employee Qualified Plan, CheckingMajor: Checking Major to be used and linked to Employee Qualified Plan account, CheckingMinor: Checking Minor to be used and linked to Employee Qualified Plan account. Other values: NationalCreditUnionAdministration.

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

Array of objects (DocumentDescriptor)

Documents related to the Account.

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

Document location.

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

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

Specifies the date and time at which all the balances amount were calculated.

Array of objects (SpotDate)

Specifies the date and time of transaction events.

Array
name
string (SpotDateName) [ 1 .. 40 ] characters
Example: "Expiration"

Possible values por projected dates: Forecast, Expiration, LastNonFinancial, Escheat. Possible values for past dates: IRALastRollOver. Other possible values: EffectiveDate, ResponseByDate.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (Balance)
Array
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

balanceName
string (BalanceName) [ 1 .. 50 ] characters
Example: "Available"

Specifies the nature of the balance. Possible values: Current, Available, Pending, Opening, Blocked, Previous, RelatedBalance, OnHold, PendingLedger, Collected, LastAnniversary, CurrentAccrued, PreviousAccrued, CurrentWithLastCalculus, CarriedAdjustment, PaidWithPenalties, Accrued, Penalty, Fees, Withholding, CollectionLedger, LastLedger, CurrentLedger, Ledger, MinimumAvailable, MinimumLedger, Withheld, CurrentBooked, CurrentBook, LastDeposit, FloatAmount, Average, RegulationDDAvailable. Loan Balances: CashProceeds, the amount that a customer actually received, exclusive of insurance premiums, fees, and unearned discount; FinancedExpenses, indicates the amount of expenses an institution has financed for a borrower; TotalInterest; AdditionalInterest, if the date of the first payment is beyond one month from the note date, the interest for the odd days will be earned during the first interest period; DeferredUnsecuredPrincipal, is the outstanding balance of an unsecured debt. The DUPB includes any accrued interest that is yet to be paid by the borrower. The deferral typically occurs due to bankruptcy or debt relief proceedings, which temporarily halt collection efforts by the original creditor; Charge Balances: Earned, RealTimeDeliveryMaximum, Current, Financed, Prepaid, CurrentEarned, CurrentEarnedOtherEscrow, InterestPaidToDate, InterestPaidThisYear, InterestPaidPreviousYear, InterestPaidLastStatement, InterestPaidThisYear, RevolvingCreditPaid, BasePaidToDate, TotalPastDue, Escrow, AppliedEscrow, UnpaidEscrow, EscrowBucket, Principal, Interest, Fees, BilledFees, OtherEscrow, FinalAmount, FinalInterestAmount, Chapter4PreviousYear, Payments: Delinquent, FixPayment, Transaction, LoanPayOff, PrincipalAndInterest, AvailableCash, AvailableCheck, AvailableCredit, Sweep, Float, MemoLedger, Memo, AvailablePending, LedgerPending.

amount
string (Amount) <= 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

count
integer

Number of transactions added to the amount.

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 (GenericCode)

Bank defined codes to classify balances. Possible values: BalanceCategory, BalanceType, PartyAgreementNumber.

plasticCount
integer

Number of plastic cards issued which are associated to the account.

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

object (PersonDescriptor)
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.

Array of objects (PaymentCardIdentification)
productId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
number
string (PrimaryAccountNumber) [ 1 .. 19 ] characters
Example: "1234567890123456789"

Primary Account Number (PAN) of the card.

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

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

fundingSourceType
string (CardFundingSourceType) [ 1 .. 35 ] characters
Example: "Credit"

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

businessIndicator
boolean

Indicates whether the payment card is business or not.

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

Identification of the account servicer institution at branch level or center level. To overlay the codes to produce a unique identifier the following expresion is used: BranchRegionCode-BranchSubdivisionCode.

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

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.

Array of objects (RelatedAccount)

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.

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

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

statusDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
statusReasons
Array of strings (CardStatusReason) [ items [ 1 .. 60 ] characters ]
Example: ["Active"]
Array of objects (GenericCode)

Codes to classify payment cards. Possible code names: ClassCode

Array of objects (Limit)
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
paymentType
string (PaymentType) [ 1 .. 35 ] characters
Example: "OnUs"

Specifies the type of Payment. Possible values: LiquidityTransfer, OnUs, ACH, Wire, NotOnUs.

standingOrderType
string (StandingOrderType) [ 1 .. 36 ] characters
Example: "OneTime"

Standing order category. Possible values: OneTime, Recurring, Predefined, Overdraw, Dividend, Maturity, SweepIn, SweepOut, SweepInOut.

amountType
string (StandingOrderAmountType) [ 1 .. 36 ] characters
Example: "OneTime"

Type of amount of the payment. Possible values: MinimumDue, CurrentBalance, FullStatement, FixedAmount.

recurrenceDateType
string (StandingOrderDateType) [ 1 .. 36 ] characters
Example: "OneTime"

Type of recurrence date of the payment. Possible values: OnTimeDue, SpecificDay.

paymentReasons
Array of strings (PaymentPurpose) [ items [ 1 .. 60 ] characters ]
Example: ["CashManagementTransfer"]
orderSequence
integer
Example: 1

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

object (Frequency)

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.

object

Specifies the hour of the day for the time event.

object (CreditTransferDetail)

Further details on the credit transfer instruction

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

Date of the last payment.

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

Date of the next payment.

failedCount
integer

The number of times a standing order payment has failed to be processed.

delayDays
integer <= 31
Example: 30

Period between when a standing order is set to be executed and when it actually processes.

authorizationChannel
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

paymentMethod
string (PaymentMethod) [ 1 .. 35 ] characters
Example: "CreditTransfer"

Specifies the means of payment that will be used to move the amount of money. Possible values are: Check, CreditTransfer. More specific values: ECheck, CreditCard, CommercialCreditCard, CheckCard, BusinessCheck, PinlessDebit, PINDebit, POS, Cash, ACHCredit, LockBox, RemoteCapture, EFTCredit, FedWire, ACHDebit, EFT, MoneyOrder, Coupon.

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

A convenience fee refund amount refers to the money that is returned to a customer when a convenience fee is refunded. A convenience fee is an additional charge for making a payment through a particular method, such as online or over the phone, as opposed to a standard method like cash or check.

enableIndicator
boolean

Indicates whether the standing order is enabled.

minimumIndicator
boolean

Indicates whether the standing order pays the least amount required to keep the account in good standing.

depositMatchIndicator
boolean

Indicates whether a transaction qualifies for promotional offer.

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

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

statusReasonDescription
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
statusReason
string (StatusReason) [ 1 .. 36 ] characters
Example: "BlockedAccount"

Reason for the status. Possible Values: AbortedClearingTimeout, AbortedClearingFatalError, AbortedSettlementTimeout, AbortedSettlementFatalError,TimeoutCreditorAgent, TimeoutInstructedAgent, OfflineAgent, OfflineCreditorAgent, ErrorCreditorAgent, ErrorInstructedAgent, TimeoutDebtorAgent,IncorrectAccountNumber, InvalidDebtorAccountNumber,InvalidCreditorAccountNumber, ClosedAccountNumber,ClosedDebtorAccountNumber, BlockedAccount,ClosedCreditorAccountNumber, InvalidBranchCode,InvalidAccountCurrency, InvalidDebtorAccountCurrency,InvalidCreditorAccountCurrency, InvalidAccountType,InvalidDebtorAccountType,InvalidCreditorAccountType,AccountDetailsChanged, CardNumberInvalid, TransactionForbidden, InvalidBankOperationCode, TransactionNotSupported, InvalidAgentCountry, InvalidDebtorAgentCountry, InvalidCreditorAgentCountry, UnsuccesfulDirectDebit, InvalidAccessRights,PaymentNotReceived, AgentSuspended,CreditorAgentSuspended, NotAllowedBookTransfer, ForbiddenReturnPayment, IncorrectAgent, ZeroAmount, NotAllowedAmount, NotAllowedCurrency, InsufficientFunds, Duplication, TooLowAmount, BlockedAmount, WrongAmount, InvalidControlSum, InvalidTransactionCurrency, InvalidAmount, AmountExceedsClearingSystemLimit, AmountExceedsAgreedLimit, AmountBelowClearingSystemMinimum, InvalidGroupControlSum, InvalidPaymentInfoControlSum, InvalidNumberOfTransactions,InvalidGroupNumberOfTransactions, InvalidPaymentInfoNumberOfTransactions, LimitExceeded, ZeroAmountNotApplied, AmountExceedsSettlementLimit, InconsistenWithEndCustomer, MissingCreditorAddress, UnrecognisedInitiatingParty, UnknownEndCustomer, MissingDebtorAddress, MissingDebtorName, InvalidCountry, InvalidDebtorCountry, InvalidCreditorCountry, InvalidCountryOfResidence, InvalidDebtorCountryOfResidence, InvalidCreditorCountryOfResidence, InvalidIdentificationCode, InvalidDebtorIdentificationCode, InvalidCreditorIdentificationCode, InvalidContactDetails, InvalidChargeBearerCode, InvalidNameLength, MissingName, MissingCreditorName, AccountProxyInvalid, CheckERI, RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture, RequestedExecutionDateOrRequestedCollectionDateTooFarInPast, ElementIsNotToBeUsedAtB-andC-Level, MandateChangesNotAllowed, InformationOnMandateChangesMissing, CreditorIdentifierIncorrect, CreditorIdentifierNotUnambiguouslyAtTransaction-Level, OriginalDebtorAccountIsNotToBeUsed, OriginalDebtorAgentIsNotToBeUsed, ElementContentIncludesMoreThan140Characters, ElementContentFormallyIncorrect, ElementNotAdmitted, ValuesWillBeSetToNextTARGETday, DecimalPointsNotCompatibleWithCurrency, RequiredCompulsoryElementMissing, COREandB2BwithinOnemessage, ChequeSettledOnCreditorAccount, CreditorBankIsNotRegistered, IncorrectCurrency, RequestedByCustomer, DebtorBankIsNotRegistered,ElectronicSignaturesCorrect, OrderCancelled, OrderNotCancelled, OrderRejected, OrderForwardedForPostprocessing, TransferOrder, ProcessingOK, DecompressionError, DecryptionError, DataSignRequested, UnknownDataSignFormat, SignerCertificateRevoked, SignerCertificateNotValid, IncorrectSignerCertificate, SignerCertificationAuthoritySignerNotValid, NotAllowedPayment, NotAllowedAccount, NotAllowedNumberOfTransaction, Signer1CertificateRevoked, Signer1CertificateNotValid, IncorrectSigner1Certificate, SignerCertificationAuthoritySigner1NotValid, UserDoesNotExist, IdenticalSignatureFound, PublicKeyVersionIncorrect, DifferentOrderDataInSignatures, RepeatOrder, ElectronicSignatureRightsInsufficient, Signer2CertificateRevoked, Signer2CertificateNotValid, IncorrectSigner2Certificate, SignerCertificationAuthoritySigner2NotValid, WaitingTimeExpired, OrderFileDeleted, UserSignedMultipleTimes, UserNotYetActivated, InvalidDate, InvalidCreationDate, InvalidNonProcessingDate, FutureDateNotSupported, InvalidCutOffDate, ExecutionDateChanged, DuplicateMessageID, DuplicatePaymentInformationID, DuplicateTransaction, DuplicateEndToEndID, DuplicateInstructionID, DuplicatePayment, CorrespondentBankNotPossible, BalanceInfoRequest, SettlementFailed, SettlementSystemNotAvailable, ERIOptionNotSupported, InvalidFileFormat, SyntaxError, InvalidPaymentTypeInformation, InvalidServiceLevelCode, InvalidLocalInstrumentCode, InvalidCategoryPurposeCode, InvalidPurpose, InvalidEndToEndId, InvalidChequeNumber, BankSystemProcessingError, ClearingRequestAborted, PaymentTransferredAndTracked, PaymentTransferredAndNotTracked, CreditDebitNotConfirmed, CreditPendingDocuments, CreditPendingFunds, DeliveredWithServiceLevel, DeliveredWIthoutServiceLevel, CorrespondingOriginalFileStillNotSent, NoMandate, MissingMandatoryInformationInMandate, CollectionNotDue, RefundRequestByEndCustomer, EndCustomerDeceased, NotSpecifiedReasonCustomerGenerated, NotSpecifiedReasonAgentGenerated, Narrative, NoERI, BankIdentifierIncorrect, InvalidBankIdentifier, InvalidDebtorBankIdentifier, InvalidCreditorBankIdentifier, InvalidBICIdentifier, InvalidDebtorBICIdentifier, InvalidCreditorBICIdentifier, InvalidClearingSystemMemberIdentifier, InvalidDebtorClearingSystemMemberIdentifier, InvalidCreditorClearingSystemMemberIdentifier, InvalidIntermediaryAgent, MissingCreditorSchemeId, RMessageConflict, ReceiverCustomerInformation,NotUniqueTransactionReference, MissingDebtorAccountOrIdentification, MissingDebtorNameOrAddress, MissingCreditorNameOrAddress, RegulatoryReason, RegulatoryInformationInvalid, TaxInformationInvalid, RemittanceInformationInvalid, RemittanceInformationTruncated, InvalidStructuredCreditorReference, InvalidCharacterSet, InvalidDebtorAgentServiceID, InvalidPartyID, ValidRequestForCancellationAcknowledged, UETRFlaggedForCancellation, NetworkStopOfUETR, RequestForCancellationForwarded, RequestForCancellationDeliveryAcknowledgement, SpecificServiceOfferedByDebtorAgent, SpecificServiceOfferedByCreditorAgent, ServiceofClearingSystem, CreditorNotOnWhitelistOfDebtor, CreditorOnBlacklistOfDebtor, MaximumNumberOfDirectDebitTransactionsExceeded, MaximumDirectDebitTransactionAmountExceeded, TransmissonAborted, NoDataAvailable, FileNonReadable, IncorrectFileStructure, TokenInvalid, SenderTokenNotFound, ReceiverTokenNotFound, TokenMissing, TokenCounterpartyMismatch, TokenSingleUse, TokenSuspended, TokenValueLimitExceeded, TokenExpired, InvalidCutOffTime, TransmissionSuccessful, TransferToSignByHand, AuthorisationCancelled, FollowingCancellationRequest, Fraud, NotCompliantGeneric, NoAnswerFromCustomer, ReturnUponUnableToApply, UnduePayment, AlreadyAcceptedRTP, AlreadyExpiredRTP, AlreadyRefusedRTP, AlreadyRejectedRTP, AttachementsNotSupported, ExpiryDateTimeReached, ExpiryDateTooLong, FraudulentOrigin, IncorrectExpiryDateTime, InitialRTPNeverReceived, NonAgreedRTP, NoPaymentGuarantee, PayerOrPayerRTPSPNotReachable, RTPNotSupportedForDebtor, RTPReceivedCanBeProcessed, RTPServiceProviderIdentifierIncorrect, TypeOfPaymentInstrumentNotSupported, UnknownCreditor, OriginalTransactionNotEligibleForRequestedReturn, RequestForCancellationNotFound, SettlementNotReceived

Array of objects (GenericCode)

Codes related to the standing order. Possible values: ACHRecurringCalendarDay, AutoPaymentChargeDda, AutoPaymentEnrollType.

paymentDescription
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
Array of objects (Balance)

Transference blances.

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

Resource Audit Information. Captures the creation, modification and maintenance details.

status
string (AuditStatus) [ 1 .. 35 ] characters

Maintenance status of a resource. Possible values: Requested, Created, Changed, Deleted

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

creationBranchId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
object (User)

User information of a person.

personId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
userId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
userName
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

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

purpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
audit
object (Audit) Recursive

Resource Audit Information. Captures the creation, modification and maintenance details.

lastModificationChannel
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

lastModificationDate
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 (AuditChannel)

Activity audit throught communication channles

Array
lastActivityDate
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 (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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

activityType
string (AuditActivityType) [ 1 .. 35 ] characters

Maintenance activity of a resource. Possible values: Transaction, Modification, Deposit, Withdrawal, Creation, DirectDeposit, CardActivation, CardActivationByCallerId, CardActivationByCodeAndCallerId, Closure, HSACreation

amount
string (PositiveAmount) <= 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

Responses

Request samples

Content type
application/json
{
  • "accountBranchId": "SEA_1",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "securedIndicator": true,
  • "securedType": "Collateral",
  • "payment": {
    },
  • "payout": {
    },
  • "ownershipType": "SingleOwnerAccount",
  • "balanceType": "Asset",
  • "productId": "PD_CA_0002",
  • "pricingStrategyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "initialAmount": "100",
  • "depositDate": "2022-04-17",
  • "contract": {
    },
  • "parties": [
    ],
  • "maturityDate": "2022-04-17",
  • "relatedAccounts": [
    ],
  • "referenceAccount": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "pastDates": [
    ],
  • "initialFundingSource": "CreditTransfer",
  • "projectedDates": [
    ],
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "statement": {
    },
  • "interests": [
    ],
  • "charges": [
    ],
  • "taxes": [
    ],
  • "communicationChannels": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "codes": [
    ],
  • "print": {
    },
  • "bill": {
    },
  • "collateral": {
    },
  • "contact": {
    },
  • "renewal": {
    },
  • "servicerAlerts": [
    ],
  • "history": {
    },
  • "status": {
    },
  • "supplementaryData": { },
  • "comments": [
    ],
  • "profile": {
    },
  • "products": [
    ],
  • "documents": [
    ],
  • "amountCalculationDate": "2022-04-17T08:00:00Z",
  • "transactionDates": [
    ],
  • "balances": [
    ],
  • "plasticCount": 0,
  • "cards": [
    ],
  • "standingOrders": [
    ],
  • "audit": {
    }
}

Response samples

Content type
{
  • "accountBranchId": "SEA_1",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "securedIndicator": true,
  • "securedType": "Collateral",
  • "payment": {
    },
  • "payout": {
    },
  • "ownershipType": "SingleOwnerAccount",
  • "balanceType": "Asset",
  • "productId": "PD_CA_0002",
  • "pricingStrategyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "initialAmount": "100",
  • "depositDate": "2022-04-17",
  • "contract": {
    },
  • "parties": [
    ],
  • "maturityDate": "2022-04-17",
  • "relatedAccounts": [
    ],
  • "referenceAccount": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "pastDates": [
    ],
  • "initialFundingSource": "CreditTransfer",
  • "projectedDates": [
    ],
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "statement": {
    },
  • "interests": [
    ],
  • "charges": [
    ],
  • "taxes": [
    ],
  • "communicationChannels": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "codes": [
    ],
  • "print": {
    },
  • "bill": {
    },
  • "collateral": {
    },
  • "contact": {
    },
  • "renewal": {
    },
  • "servicerAlerts": [
    ],
  • "history": {
    },
  • "status": {
    },
  • "supplementaryData": { },
  • "comments": [
    ],
  • "profile": {
    },
  • "products": [
    ],
  • "documents": [
    ],
  • "amountCalculationDate": "2022-04-17T08:00:00Z",
  • "transactionDates": [
    ],
  • "balances": [
    ],
  • "plasticCount": 0,
  • "cards": [
    ],
  • "accountId": "033-DDA-123456",
  • "standingOrders": [
    ],
  • "audit": {
    }
}

Updates an Account

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

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

Account Identification

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

Account Servicer Identification (Bank)

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

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

Core-Validation-Mode
string

<ENFORCING|PERMISSIVE|DISABLED> Indicates how the API validates requests against the core validation request policy. ENFORCING: The API validates all requests against the core validation request policy. The API only sends requests that pass validation to the back-end core service. PERMISSIVE: The API validates all requests against the validation request policy. The API sends all requests to the back-end service, regardless of whether they pass or fail the core validation. DISABLED: The API does not validate any requests against the validation request policy. The API gateway sends all requests to the core back-end service.

Request Body schema: application/merge-patch+json
object

Responses

Request samples

Content type
application/merge-patch+json
{ }

Response samples

Content type
{
  • "accountBranchId": "SEA_1",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "securedIndicator": true,
  • "securedType": "Collateral",
  • "payment": {
    },
  • "payout": {
    },
  • "ownershipType": "SingleOwnerAccount",
  • "balanceType": "Asset",
  • "productId": "PD_CA_0002",
  • "pricingStrategyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "initialAmount": "100",
  • "depositDate": "2022-04-17",
  • "contract": {
    },
  • "parties": [
    ],
  • "maturityDate": "2022-04-17",
  • "relatedAccounts": [
    ],
  • "referenceAccount": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "pastDates": [
    ],
  • "initialFundingSource": "CreditTransfer",
  • "projectedDates": [
    ],
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "statement": {
    },
  • "interests": [
    ],
  • "charges": [
    ],
  • "taxes": [
    ],
  • "communicationChannels": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "codes": [
    ],
  • "print": {
    },
  • "bill": {
    },
  • "collateral": {
    },
  • "contact": {
    },
  • "renewal": {
    },
  • "servicerAlerts": [
    ],
  • "history": {
    },
  • "status": {
    },
  • "supplementaryData": { },
  • "comments": [
    ],
  • "profile": {
    },
  • "products": [
    ],
  • "documents": [
    ],
  • "amountCalculationDate": "2022-04-17T08:00:00Z",
  • "transactionDates": [
    ],
  • "balances": [
    ],
  • "plasticCount": 0,
  • "cards": [
    ],
  • "accountId": "033-DDA-123456",
  • "standingOrders": [
    ],
  • "audit": {
    }
}

Retrieves Account Balances

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

Account Identification

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

Account Servicer Identification (Bank)

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

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

Responses

Response samples

Content type
application/json
{
  • "accountId": "033-DDA-123456",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "ownershipType": "SingleOwnerAccount",
  • "balances": [
    ]
}

Retrieves Account Identifiers

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

Account Identification

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

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "accountBranchId": "SEA_1",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "accountId": "033-DDA-123456",
  • "ownershipType": "SingleOwnerAccount"
}

Retrieves Account Parties

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

Account Identification

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

Account Servicer Identification (Bank)

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

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

Responses

Response samples

Content type
application/json
{
  • "accountId": "033-DDA-123456",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "ownershipType": "SingleOwnerAccount",
  • "parties": [
    ]
}

Retrieves Account Owners

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

Account Identification

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

Account Servicer Identification (Bank)

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

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

Responses

Response samples

Content type
application/json
{
  • "accountId": "033-DDA-123456",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "ownershipType": "SingleOwnerAccount",
  • "owners": [
    ]
}

Retrieves Person Accounts

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

Person Identification

query Parameters
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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

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

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

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

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

Retrieves Person Statement

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

Person Identification

query Parameters
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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

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

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

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
{
  • "personId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "name": "Jane Birkin",
  • "legalName": "Jane",
  • "numberOfStatements": 0,
  • "identifiers": [
    ],
  • "tINStatus": "string",
  • "postalAddress": {
    },
  • "statements": [
    ]
}

Retrieves Organization Accounts

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

Organization Identification

query Parameters
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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

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

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

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

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

Retrieves Organization Statements

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

Organization Identification

query Parameters
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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

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

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

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
{
  • "organizationId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "name": "Jane Birkin",
  • "legalName": "Jane",
  • "organizationType": "Corporation",
  • "postalAddress": {
    },
  • "numberOfStatements": 0,
  • "tINStatus": "string",
  • "identifiers": [
    ],
  • "statements": [
    ]
}

Parties

Person and Organization Management

Retrieves a list of persons matching the parameters.

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.

status.eq
string (PartyStatus) [ 1 .. 35 ] characters
Example: status.eq=GoodStanding

Specifies the current primary status of a party. Possible values are: GoodStanding, FraudAlert, BadCustomer, Active, Delinquent, Default, HighRisk, UnderReview, HotCarded, WildCarded. Other possible values: PersonalBankruptcy, GrowingConcern, WatchLoan, InReceivership, Chapter11, Liquidation.

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

Any phone number equals to.

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

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

cardNumber.eq
string (PrimaryAccountNumber) [ 1 .. 19 ] characters
Example: cardNumber.eq=1234567890123456789

Primary Account Number (PAN) of the card.

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 .. 300 ] characters
Example: personId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002

System id equals to

audit.lastModificationDate.lte
string <date> (Date)
Example: audit.lastModificationDate.lte=2022-04-17

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

audit.lastModificationDate.gte
string <date> (Date)
Example: audit.lastModificationDate.gte=2022-04-17

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

cardNumber.last4
string

Card Number last four digits.

accountNumber.last4
string

Account Number last four digits.

personRole.eq
string

Retrieves persons with the role required. Possible values: CardHolder, Person.

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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

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

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

Core-Format-Mode
string

<CARD_NUMBER_MASKED|CARD_NUMBER_NOT_MASKED|ID_NOT_MASKED|ID_MASKED|NOT_MASKED|MASKED|> Indicates the format of the API Response. CARD_NUMBER_MASKED: Card number masked. CARD_NUMBER_NOT_MASKED: Card number not masked. ID_NOT_MASKED: Identifiers not masked. ID_MASKED: Identifiers masked. NOT_MASKED: All fields not masked. MASKED: All masked.

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
[
  • {
    }
]

Creates a Person

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

Idempotency identifier used by the client when making repeated calls

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

Account Servicer Identification (Bank)

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

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

Request Body schema: application/json
uSDocumentedIndicator
boolean
Array of objects (PersonIdentification)
Array
schemeName
required
string [ 1 .. 40 ] characters
Example: "SocialSecurityNumber"

Name of the identification scheme in PascalCase form. Possible values are: AlienRegistrationNumber, PassportNumber, USPassportCard CustomerIdentificationNumber, DriversLicenseNumber, EmployeeIdentificationNumber, USDriversLicenseNumber, NationalIdentityNumber, SocialSecurityNumber, TelephoneNumber, TaxIdentificationNumber, ForeignTaxIdentificationNumber, IndividualTaxpayerIdentificationNumber, PersonCommercialIdentification, StateIdentificationNumber, MilitaryIdCard, BirthMarriageCertificateNumber, MarriageCertificateNumber, BirthCertificateNumber, CountryTerritoriIdCard, DriverLicenseNumber, WageTaxStatementFormNumber, GovernmentDocumentNumber, HealthInsuranceCard, CertificateOfIncorporationNumber, CertificateOfOrganizationNumber, CertificateOfPartnershipNumber, ForwardHealthMedicaIdCard, MexicanConsularIdCard, DLNTaxExemptNumber, PhotoIdCard, PermantResidentCard, TribalIdCard, UtilityBillInvoiceNumber, VoterUniqueIdentifier, WisconsinCRISSearch, PropertyTaxBillNumber, MedicareCardId, OrganizationalDocumentNumber, CertificationOfTrustNumber, EstateDomiciliaryLetterNumber, TaxReturnFormNumber, MinorIdCard, EmploymentAuthorizationCard, StateDocumentNumber, TravelDocumentNumber, StateIssuedPermitNumber, TaxId, MemberNumber.

number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification.

issuer
string
Example: "Baltimore"

Entity that assigns the identification.

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

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

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

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.

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

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

Verification or certification date.

foreignIDIndicator
boolean

Indicates whether the identifications is from a foreign country.

taxIDIndicator
boolean

Indicates whether the identifications is Tax Id.

displayOption
string (PartyDisplayOption) [ 1 .. 35 ] characters

Indicates display options for party attributes. Possible Values: TaxIdMasked

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.

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

Official name under which the party is registered.

nameTemplateId
string (NameTemplateId) [ 1 .. 36 ] characters
Example: "1"

Template used to display the party name. This is an external id provided by the account servicer.

nameSoundExId
string (SoundExId) [ 1 .. 36 ] characters
Example: "1"

Identification of a SoundEx method develop for search attribute. SoundEx is a method used to find strings when the sound is known but the precise spelling is not. It searches out words with similar sounds based on phonetic assumptions about how certain letters are pronounced. It can be used to search names in a database, for example, where spellings and pronunciations for similar names may vary.

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

Identification of the account servicer institution at branch level or center level. To overlay the codes to produce a unique identifier the following expresion is used: BranchRegionCode-BranchSubdivisionCode.

customerSinceDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (Comment)

Bank comnents of the party.

Array
name
string [ 1 .. 35 ] characters
text
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
Array of objects (DetailedRelatedParty)
Array
Array of objects (GenericIdentification)
Array of objects (GenericCode)

Codes to link the party with other systems or to classify the party. Possible values: RemoteDepositRisk.

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.

nameTemplateId
string (NameTemplateId) [ 1 .. 36 ] characters
Example: "1"

Template used to display the party name. This is an external id provided by the account servicer.

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.

object (PlaceAndDateOfBirth)

Date and place of birth of a person.

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

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

status
string (PartyStatus) [ 1 .. 35 ] characters
Example: "GoodStanding"

Specifies the current primary status of a party. Possible values are: GoodStanding, FraudAlert, BadCustomer, Active, Delinquent, Default, HighRisk, UnderReview, HotCarded, WildCarded. Other possible values: PersonalBankruptcy, GrowingConcern, WatchLoan, InReceivership, Chapter11, Liquidation.

statusDateAndTime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
coveredByMilitaryLendingActIndicator
boolean

Indicates if the borrower is covered under the Military Lending Act.

militaryMemberIndicator
boolean

Indicates whether the person is is service member/military.

object (DateTimePeriod)
object (Employment)
object (Audit)

Resource Audit Information. Captures the creation, modification and maintenance details.

Array of objects (PostalAddress)
object (StructuredName)

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

Array of objects (Phone)
organizationType
string (OrganizationType)
Example: "Corporation"

Specifies the legal standing of the organization. Possible values are: Government, NonGoverment NonUSGovernmentOrganization, USGovernmentOrganization FinancialInstitution, SoleProprietorship, UnincorporatedAssociation, LimitedLiabilityPartnership, LimitedLiabilityCompany, SingleMemberLimitedLiabilityCompany, LimitedPartnership, FormalPartnership, GeneralPartnership, Business, Corporation, NotForProfit, ForProfit, NonProfitCorporation, NonProfit, Club, Supranational, Sovereign, Municipal, Province, State, County, National, ExemptionTrust, LivingTrust, EmployeeTrust, RevocableTrust, IrrovocableTrust, NakedTrust, FamilyTrust, BussinesTrust, CliffordTrust, FormalTrust, PublicAgency, Association, Church, PublicFunds. International & Foreign Business Entities: PersonaFisica, SociedadCivil, SociedadAnonimaCapitalVariable, SociedadResponsabilidadLimitada, SociedadAnonimaCapitalVariable.

customerType
string (CustomerType)
Example: "Consumer"

A customer type of a bank account can be classified into different categories based on the account's features, purpose, and benefits. Possible Values: Personal, Business, Consumer, Organization, ThirdParty, Estate, Employee, ForeignConsumer.

taxReportingIndicator
boolean

Account tax reporting typically involves obtaining and submitting records related to your tax obligations. For individuals, this may include income, qualifying deductions, and investment gains or losses. Businesses, on the other hand, have additional complexities, such as tracking funds directed towards specific business expenses and shareholders.

taxStatus
string
Example: "Exempt"

Exempt, Retain, ExemptExpired, VoluntaryWithholding, Chapter3, Chapter4, C-Corp, S-Corp, Certified, W-8Required, NotCertified.

Array of objects (PaymentCardDescriptor)
Array of objects (Balance)

Balances related to the party

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

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

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

Type of relation between parties. Possible values Between Organizations and persons are: ResponsibleParty, Owner, ControlPerson, ControlPersonOwner, AuthorizedPerson, BeneficialOwner, PrimaryContact, SecondaryContact, VicePresident, President, Treasurer, Secretary, Partner, GeneralPartener, CEO, CFO, COO, Conservator, Dealer, Director, MessageReceiver, Employee, Excecutor, GeneralPartner, HumanResourceRepresentative, IOLTAContact, ManagingMember, PrimaryContact, SecondaryContact, Estate. Between Persons and Organizations: Business, Organization, UnclaimedPropertyContact, UtilityContact. For Trusts: Trustor, Trustee. Between organizations: Subsidiary, ParentOrganization, Branch. Between parties and external entities: AccountOpenningOfficer, CustomerServiceOfficer, PrimaryServicerOfficer, SecondaryServicerOfficer, SalesPerson, ReferralOfficer. Between financial institutions: AffiliateFinancialInstitution, HoldingCompany. Between persons: Spouse, Aunt, Brother, Companion, Daughter, Father, Friend, Granddaughter, Grandmother, Grandfather, Grandson, Husband, Mother, Nephew, Niece, Sister, Son, Uncle, Wife, Child, Grandparent. Grandchild, Sibling, Parent, Partner, Related, InitiatingParty

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

Person’s relation became effective.

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

Person’s relation became inactive.

partyRelationDescription
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
ownershipPercentage
string <= 23 characters ^100|(([1-9][0-9]{0,1})([.][0-9]{0,8}){0,1})$...
Example: "25"

Company Ownership Percentage. If the relation Type is BeneficialOwner the ownership percentage could be added. Ownership means any person with more than 25% equity in the legal entity.

Array of objects (RelatedAccount)
Array
accountRelationType
string (AccountRelationType)
Example: "SubAccount"

Account relation role. Possible values are: Parent, EscrowAccount, SubAccount, ControlAccount, CrossAccount, ChargeAccount, AssociatedAccount, IRAAccount, CombinedStatement, SecondaryCombinedStatement, SummaryAccount, FundingSource, CompensatingAccount. Payment related values: Authorized, Counterpart

accountId
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

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

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

accountType
string (RelatedAccountType) [ 1 .. 60 ] characters
Example: "Checking"

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

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.

productId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
Array of objects (GenericCode)

Account related codes

Array of objects (PostalAddress)
Array
addressCode
string

This code is used to identify parties that share the same address or to associate an existing address with a specific party. Providing this code eliminates the need to separately enter the address details.

addressBookIndicator
string

If true, the address is kept in the system even if the person is no longer a customer.

addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible values are: PhysicalAddress, Postal, POBox, Residential, Permanent, Temporary, Alternative, Previous.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible values are: MailTo, DeliveryTo, Billing, Tax, ForeignTaxRecipient PlaceOfOperation, PlaceOfRegistration, placeOfFormation, Marketing, Statements, Business, Administrative, PreviousPlace, Headquarter, BranchStore, Branch, Property, Military, Secondary, Personal, Annex, Inquiry.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

careOf
string [ 1 .. 100 ] characters
Example: "C/O Company Name"

Identifies an addressee that is accepting the correspondence for the intended recipient. Using care of ensures the correspondence reaches the right recipient rather than getting returned to the sender.

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

Identification of a division of a large Organization or building.

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

Identification of a sub-division of a large Organization 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 Organization, where letters are kept until called for.

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

Building room number.

postCode
string (PostCode) [ 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. In US may consists of two parts: the five-digit ZIP Code '97062' and the ZIP+4 Code '6884'.

carrierRoute
string (CarrierRoute) [ 1 .. 4 ] characters
Example: "C001"

A Carrier Route is a designated geographic area assigned to individual postal carriers by the United States Postal Service (USPS) to facilitate efficient mail delivery within specific regions.

censusTract
string (CensusTract) = 5 characters
Example: "12345"

A census tract, census area, census district or meshblock is a geographic region defined for the purpose of taking a census

censusBlock
string (CensusBlock) = 4 characters
Example: "1234"

Census blocks are used to partition counties into smaller areas for the purpose of collecting and presenting census data.

cBSACode
string (CBSACode) = 5 characters
Example: "49780"

Core-based statistical area. Metropolitan statistical area (MSA) is the formal definition of a region that consists of a city and surrounding communities that are linked by social and economic factors. Micropolitan Statistical Areas (MISA) are CBSAs associated with at least one urban cluster that has a population of at least 10,000, but less than 50,000. The micropolitan statistical area comprises the central county or counties or equivalent entities containing the core, plus adjacent outlying counties having a high degree of social and economic integration with the central county as measured through commuting.

cBSAType
string (CBSAType) [ 1 .. 10 ] characters
Example: "MSA"

Type of Core-based statistical area. Possible values: MSA, MISA

foreignIndicator
boolean

Indicates whether the postal address is from a foreign country.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

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

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

Specific location name within the town.

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

Identifies a subdivision within a country sub-division.

countyName
string [ 1 .. 35 ] characters
Example: "Cook"

Identifies a county 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.

temporaryIndicator
boolean
Example: true

Indicates whether the address is temporary or not.

object

The period of use of the address information. Could be also used as a recurring anual period.

Array of objects (GenericCode)

Codes related to postal address or internal handling codes associated with the address. Possible Values: HandlingCode, HandlingCodeOption, AddressFormat.

Array of objects (GenericIdentification)

Postal address identifiers are used to identify parties that share the same address or to associate an existing address with a specific party. Possible scheme name values: AddressIdentifier.

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

Customer principal relationship. This entity gives the ability to view a party’s total relationship with the bank. The relationship Id ties multiple parties together. This code is also used to reduce mailing costs during marketing campaigns to avoid sending duplicate materials to parties residing at the same address.

relationshipLeadIndicator
boolean

The relationship lead is often the primary account owner or the party with whom the bank have the most contact.

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 .. 50 ] characters
Example: "SocialSecurityNumber"

Identifies what type of tax ID is in the TIN field. Possible Values: SocialSecurityNumber, SocialInsuranceNumber, EmployerIdentificationNumber, IndividualTaxpayerIdentificationNumber, AdoptionTaxpayerIdentificationNumber, PreparerTaxpayerIdentificationNumber, ForeignTaxID

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

taxReportingIndicator
boolean

Account tax reporting typically involves obtaining and submitting records related to your tax obligations. For individuals, this may include income, qualifying deductions, and investment gains or losses. Businesses, on the other hand, have additional complexities, such as tracking funds directed towards specific business expenses and shareholders.

interestReportingIndicator
boolean

Indicates whether or interest should be reported.

tINStatus
string
Example: "Valid"

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

object (TINVerification)

IRS information about the TIN provided.

verificationAttemps
integer <= 10
Example: 1

The Tax Identification Verification Attempts is the number of times attempts have been made to verify the tax ID number.

bNoticeDates
Array of strings <date> (Date)
Example: ["2022-04-17"]
tINResultCode
string <= 3 characters

TIN matching result codes

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

Verification or certification date.

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

taxStatus
string
Example: "Exempt"

Exempt, Retain, ExemptExpired, VoluntaryWithholding, Chapter3, Chapter4, C-Corp, S-Corp, NonProfit, Government.

exemptionCode
string <= 4 characters
Example: "0"

Indicates the reason why taxes were not withheld from the gross income being reported for a NRA. These codes are used to specify the type of income, the applicable tax treaty, or the Internal Revenue Code section that allows for the exemption from withholding. The use of these codes is subject to certain conditions and limitations, and withholding agents are responsible for verifying the NRA's eligibility for the exemption and for reporting the income and exemption codes accurately to the IRS.

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

Human readable reason why taxes were not withheld.

Array of objects (TaxForm)

Forms applied by the party

Array
formName
required
string [ 1 .. 10 ] characters
Example: "W-8"

Form name requested. Possible Values: W-8BEN, W-8BEN-E, W-8ECI, W-8EXP, W-8IMY, W-9, W-8, 1042-S, 1099-INT, 1099-OID.

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

Indicates the tax rate provided by the IRS on the form.

onFileIndicator
boolean

Indicates weather the bank establish the appropriate tax treatment of any interest or other income earned on the account related to the form.

taxStatus
string
Example: "Exempt"

Exempt, Expired, Certified, Signed

certificationDate
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
required
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
required
string (WithholdingTaxType) [ 1 .. 35 ] characters
Example: "NonResidentAlienTax"

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

withholdingRate
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Rate applied on a basis amount to calculate the withholding.

taxStatus
string

Exempt, Expired, Certified, Retain.

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

Withholding amount.

foreignIndicator
boolean

Indicates whether the party is a non-residen alien or a foreign entity.

Array of objects (TaxFormCode)

Codes provided by the IRS on forms.

Array
name
string (TaxFormName) [ 1 .. 35 ] characters

Indicates a code name provided by the IRS on the form. Possible Values: Chapter3, Chapter4, Income, Exempt, Province, CountryResidence, AmendedNumber, CountryTax

value
string <= 50 characters

Indicates the code number provided by the IRS on the form. Possible Values: Chapter4FATCAStatus, Chapter3Status, ForeignTaxForms.

recipientGIIN
string (GIIN) [ 1 .. 34 ] characters ^([A-N,P-Z,0-9]){6}\.([A-N,P-Z,0-9]){5}\.(LE|...
Example: "ADN123.FG4FE3.LE.999"

Global intermediary identification number (GIIN).

recipientPostCode
string

Code provided by the IRS on forms.

recipientTownName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

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

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 <= 2 characters

IRS country code table.

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.

documentReference
string [ 1 .. 35 ] characters

Document location.

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

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

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

object (Jurisdiction)

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

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

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

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

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

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

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

object (ContactDetails)

Specifies the contact details of a person.

object (StructuredName)

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

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

Preferred name to contact the person

firstContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
lastContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (Phone)
Array of objects (Email)
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 Organization or building.

Array of objects (CommunicationChannel)
preferredMethod
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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, Default.

object (AccountContractRelatedParty)
partyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
partyType
string (PartyType)
Example: "Person"

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

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.

agreementType
string (AgreementType)

Document or agreement type. Possible values: CardAgreement, AccountContract.

agreementSubtype
string [ 1 .. 60 ] characters

Agreement detailed category.

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

Person which is the holder of the power of attorney.

authorizedAccount
string [ 1 .. 300 ] characters
Example: "033-DDA-123456"

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

excludeMarketingIndicator
boolean
object (Audit)

Resource Audit Information. Captures the creation, modification and maintenance details.

status
string (AuditStatus) [ 1 .. 35 ] characters

Maintenance status of a resource. Possible values: Requested, Created, Changed, Deleted

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

creationBranchId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
object (User)

User information of a person.

personId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
userId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
userName
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

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

purpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
audit
object (Audit) Recursive

Resource Audit Information. Captures the creation, modification and maintenance details.

lastModificationChannel
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

lastModificationDate
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 (AuditChannel)

Activity audit throught communication channles

Array
lastActivityDate
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 (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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

activityType
string (AuditActivityType) [ 1 .. 35 ] characters

Maintenance activity of a resource. Possible values: Transaction, Modification, Deposit, Withdrawal, Creation, DirectDeposit, CardActivation, CardActivationByCallerId, CardActivationByCodeAndCallerId, Closure, HSACreation

amount
string (PositiveAmount) <= 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

Array of objects (Restriction)

Access and operation restrictions at Party level.

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

Name of the restriction in PascalCase. Possible values: TransferIn, TransferOut, WireTransferIn, WireTransferOut, ACHTransferIn, ACHTransferOut, ForeignIncomingWires, ForeignOutgoingWires, ACHTransfers, InternetBankingTransfer, InternetView, InternetInquiry, ForeignOutgoingIran, Withdrawals, Renew, Transfers, AdvanceTransfer, OnlineBanking, ElectronicBanking, InvestmentAllowed, InvestmentSetUpAllowed, DebitCardAllowed, CheckOrderAllowed, AutomaticSweep, AccountManagement

restrictionPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
enableIndicator
boolean
Example: true

Indicates whether the capability is allowed or not.

disableConditions
Array of strings (ConditionName) [ items [ 1 .. 36 ] characters ]
Example: ["LessThanMinAmount"]

Conditions that disabel the restriction.

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.

status
string (RestrictionStatus) [ 1 .. 36 ] characters
Example: "Pending"

Specifies the status of a restriction enablement request. Possible values: Enable, Pending, InquiryOnly, Disable, Requested.

Array of objects (GenericCode)

Codes to classify parties. Possible code names: Priority. For Organizations: StandardIndustryClassification, StandardIndustrySubClass AccountingGroup, CurrentRoutingNumber.

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

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

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
webPage
string^[(http(s)?):\/\/(www\.)?a-zA-Z0-9@:%._\+~#=]...
Example: "http://portx.io"

Party web page

object (PartyPrintOptions)
displayOptions
Array of strings (PartyDisplayOption) [ items [ 1 .. 35 ] characters ]
Array of objects (GenericPrintOption)
Array
name
string (PrintOptionName) [ 1 .. 35 ] characters

Name of the print Option. Possible Values: ACHTransaction

options
Array of strings (PrintOption) [ items [ 1 .. 35 ] characters ]
Array of objects (Product)

Products related with the party

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

Unique identification of a product within a product type.

pricingStrategyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
name
required
string [ 1 .. 40 ] characters
Example: "Visa Business Card"

Commercial product name within a product type.

description
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
productType
string [ 1 .. 35 ] characters
Example: "PaymentCard"

Type or nature of a product. Possible Values: Loan, PaymentCard, CheckingAccount, HealthSavingsAccount, RepricingPlan.

productSubType
string [ 1 .. 35 ] characters
Example: "BusinessCard"

Commercial product subtype within a product type.

Array of objects (Restriction)
Array of objects (SpotDate)
Array of objects (Limit)
Array of objects (ChargeCalculation)
parties
Array of strings (ProductPartyRelationType) [ items [ 1 .. 40 ] characters ]
Example: ["ParentProvider"]
status
string (ProductStatus) [ 1 .. 35 ] characters
Example: "GoodStanding"

Specifies the current status of a product. Possible values are: Enable, Disable.

statusDateAndTime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (GenericCode)

Product configuration codes. Possible Values: WebBrand, WaterfieldService, MajorAccountType: Major Account Type code for Employee Qualified Plan, MinorAccountType: Minor Account Type code to use for Employee Qualified Plan, CheckingMajor: Checking Major to be used and linked to Employee Qualified Plan account, CheckingMinor: Checking Minor to be used and linked to Employee Qualified Plan account. Other values: NationalCreditUnionAdministration.

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 (FinancialStatement)

Specifies financial statement details.

object (Frequency)

The frequency of the regular statement.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

object (Frequency)

The next frequency of the regular statement.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

Array of objects (StatementCommunicationChannel)
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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

Communication value such as phone number or email address.

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

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

printOnNextCycleIndicator
boolean

Indicates whether the statement will be produced at the end of the next statement cycle.

Array of objects (GenericCode)

Codes to determine configurarion options for alerts and notifications. Possible code names: NoticeOption.

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

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

Array of objects (GenericCode)

Codes related to statements or internal handling codes associated with the statement. Possible Values: CombinedCode, SpecialStatement, DetailsFormat, StatementGroup, ProfitabilityOption.

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

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

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
Array of objects (GenericIdentification)

Identification of statement instances and related. Possible values: schemeName: LastCombinedStatement, CombinedStatementAccountId

Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification.

schemeName
required
string [ 1 .. 35 ] characters

Name of the identification scheme.

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.

templateCode
string (StatementTemplateId) [ 1 .. 36 ] characters
Example: "1"

Template used to create the statement document. This is an external code provided by the account servicer.

object (Period)
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

object (Period)
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

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

The date of the last statement.

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

The date of the next statement.

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

The date on which service charges will be applied to an account

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

The date of the statement previous from the last.

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

The date of the last regular statement.

truncationOptions
Array of strings
Example: ["ItemsIncluded"]
accountNameIndicator
boolean

Indicates whether the account name is printed on the statement.

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, Default.

combineType
string [ 1 .. 36 ] characters
Example: "SavingsStatement"

Indicates whether account transactions are printed on a combined statement. Possible combinations: CheckingStatement, SavingsStatement, PrimaryAccount, SecondaryAccount.

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

profitabilityModelId
string (StatementModelId) [ 1 .. 36 ] characters
Example: "1"

Model used to calculate customer profitability. This is an external id provided by the account servicer.

lastIRAStatementDate
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 (DocumentDescriptor)

Documents related to the party.

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

Document location.

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

object (PlaceAndDateOfBirth)

Date and place of birth of a person.

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

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

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

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

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
Example: {"0":83,"1":109,"2":70,"3":117,"4":90,"5":83,"6":66,"7":67,"8":97,"9":88,"10":74,"11":114,"12":97,"13":87,"14":52,"15":61}

Binary data of 10K maximum, base64 encoded.

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

This field contains the key of the CISA validation record.

object (ContactDetails)

Specifies the contact details of a person.

object (StructuredName)

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

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

Person given first name.

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

Person given middle name.

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

Person surname.

middleInitial
string [ 1 .. 10 ] characters
Example: "J."

Person middle initial.

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. Generation order should be expressed with roman numerals: I, II, III, IV, V.

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

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

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

Preferred name to contact the person

firstContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
lastContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (Phone)
Array
number
required
string (PhoneNumber) ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$
Example: "+1-555-1234567"

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

extension
string <= 5 characters

Phone Number Extension.

country
string (CountryCallingCode) <= 3 characters

Country calling codes, country dial-in codes, international subscriber dialing (ISD) codes, or most commonly, telephone country codes. Country codes are defined by the International Telecommunication Union (ITU) in ITU-T standards E.123 and E.164. The prefixes enable international direct dialing (IDD).

phoneType
string [ 1 .. 35 ] characters

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

phonePurpose
string [ 1 .. 35 ] characters

Purpose of the phone address. Possible values are: Business, Personal, International, Alternative, PersonalInternational, BusinessInternational

foreignIndicator
boolean

Indicates whether is a foreign phone number

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

object (TimeOfTheDay)
comment
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
object

The period of use of the phone information.

Array of objects (GenericCode)
Array of objects (GenericIdentification)

Phone identifiers are used to identify parties that share the same phone or to associate an existing phones with a specific party. Possible scheme name values: PhoneIdentifier.

lastUpdatedDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
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, Business, Administrative, Personal

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

Array of objects (GenericIdentification)

Email identifiers are used to identify parties that share the same email or to associate an existing email with a specific party. Possible scheme name values: EmailIdentifier.

lastUpdatedDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
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 Organization or building.

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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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

Communication value such as phone number or email address.

channelPurpose
string (CommunicationChannelPurpose) [ 1 .. 40 ] characters
Example: "PrivacyNotices"

Communication purpose of the channel. Possible values: Alerts, PrivacyNotices, NegativeBalance, OverdraftProtection, ACHNotice, ChargeBack, BalanceOnReceipt, RegulationCCNotice, RateChange, MaturityNotice, InterestNotice, RegularNotice, PastDueNotice, HUDNotice, PaymentChange, AutomaticPayment, PastDueFirstNotice, PastDueSecondNotice, PastDueNoticeGuarantor, CardHolderAuthorization, Delivery, DocumentDistribution.

codeWord
string

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

alertIndicator
boolean

Indicates whether the channel is used for enterprise alerts to the customer.

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

The party authorized to use the communcation channel

Array of objects (GenericCode)

Codes to determine configurarion options for alerts and notifications. Possible code names: NoticeOption.

status
string (AlertStatus) [ 1 .. 35 ] characters
Example: "Warning"

Alert status. Possible values: Sent, SentLastNight, Pending, Enable, Disable, FraudAlert. Possible values for CreditBureauAlert: IdentityTheft.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

object

The lead time between the event and the alert notification.

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

Text to appear in alerts and notices.

Array of objects (SpotDate)
contactCount
integer

Number of contacts.

object (Frequency)

Specifies an event frequency

preferredMethod
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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, Default.

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, Widowed, StableUnion

object (StructuredName)

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

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

Person given first name.

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

Person given middle name.

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

Person surname.

middleInitial
string [ 1 .. 10 ] characters
Example: "J."

Person middle initial.

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. Generation order should be expressed with roman numerals: I, II, III, IV, V.

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

race
string (Race) [ 1 .. 35 ] characters
Example: "Director"

Categorization of humans based on shared physical qualities. Possible Values: NativeAmerican, African, Hispanic, White, Asian, NativeHawaiian, NativeAlaskan, Mixed.

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

Professional designation or occupation of a person. Possible Values: Accountant, ArtsEntertainmentRecreation, AttorneyLawyerJudge, BankingFinanceInsurance, CEOUpperMgmtPrivateCorp, CivilServiceGovernment, ConvenienceStoreOwnerManage, Doctor, EducationalServiceEducator, EngineerArchitect, Entrepreneur, FarmerRancher, GemMetalDealerJeweler, HealthCareSocialServices, Homemaker, HospitalityFoodServices, ImportExportCompany, MilitarEnlisted, ProfessionalScientificTechnicalIT, PublicSafety, RealEstateProfessional, Retail, RetiredStudentNotEmployed, Sales, ServiceIndustry, SeniorPoliticalFigures, TradeIndustry, TravelTransportation.

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

Title of the function in an organization.

educationLevel
string (EducationLevel) [ 1 .. 35 ] characters
Example: null

Possible education levels: NoFormalEducation, ElementarySchool, MiddleSchool, HighSchool, VocationalSchool, AssociateDegree, BachelorDegree, MasterDegree, DoctorateDegree, ProfessionalDegree, LessThanHighSchool, College

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

Residential status of an individual. Possible values: Rents, Owns, Lease.

immigrationStatus
string (ImmigrationStatus) [ 1 .. 35 ] characters
Example: "Permanent"

Immigration status of an individual. Possible values: Resident, NonResident, ResidentAlien, NonResidentAlien.

minorIndicator
boolean (MinorIndicator)

Indicates whether the person is a legal minor.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

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: "High"

Specifies the customer’s money laundering risk. Possible values: VeryLow, Low, Medium, Medium toHigh, ModerateHigh, High, ExtremelyHigh, NoDetermine.

Array of objects (RiskMeasure)
Array
name
string (CreditRankingScaleName) [ 1 .. 35 ] characters
Example: "StandardAndPoors"

Most commonly used credit ranking scales. Possible Values: StandardAndPoors, MoodysInvestors. Also other values: Original, 1, 2, 3, Current.

level
string (RiskLevel) [ 1 .. 35 ] characters
Example: "High"

Specifies the customer’s money laundering risk. Possible values: VeryLow, Low, Medium, Medium toHigh, ModerateHigh, High, ExtremelyHigh, NoDetermine.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (GenericCode)

Additional risk measure codes. Possible values: RiskRatingCode

bSARiskCode
integer (BSARiskCode) <= 10
Example: 0

Used to identify customers that present a risk to the bank as defined by the Bank Secrecy Act. For example, use this code to identify and monitor accounts suspected of fraud, kiting or money laundering.

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

Array of objects (CreditRankingScale)
creditReportAddressIndicatorCode
string

is a code or marker used by credit reporting agencies to indicate a match or mismatch between the address supplied in an inquiry and the address they have on file for a consumer.

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

Information provided by the Consumer Credit Report.

consumerCreditReportDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
creditBureauReportCode
string
Example: "30"

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.

eCOACode
string

The ECOA code indicates how customer account information is reported to the Credit Bureau in keeping with the Equal Credit Opportunity Act.

cTRExemptIndicator
boolean

Currency transaction report (CTR) exemption. A CTR is a report that must be filed by banks for any transaction involving currency of $10,000 or more. However, certain entities and transactions are exempt from this reporting requirement.

oFACReportingIndicator
boolean

Indicates whether the party is to be excluded from OFAC Reporting.

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
required
string [ 1 .. 36 ] characters
Example: "Months"

Unit that describes the duration.

value
integer <= 999

Value of the duration in number of units.

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

Date of Residence in the current household.

yearsAtCurrentAddress
integer
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.

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"

Used for regulatory purposes by the bank to track how long closed account history has been maintained for a customer. Possible values are: Competition, Deceased, Dissatisfied, Moved, MergedEntity, CeasedOperation

customerType
string (CustomerType)
Example: "Consumer"

A customer type of a bank account can be classified into different categories based on the account's features, purpose, and benefits. Possible Values: Personal, Business, Consumer, Organization, ThirdParty, Estate, Employee, ForeignConsumer.

Array of objects (ServicerAlert)

Customer alerts to be received by the account servicer.

Array
alertName
string (AlertName) [ 1 .. 35 ] characters
Example: "CreditBureauAlert"

Service alert human readable identifier in Pascal case. An alert notification received by the bank. Possible values: CreditBureauAlert, CustomerAlert, PaymentCard, LostBook, TwoSignaturesRequired, PledgedAsCollateral, DeathOnAccount, Bankruptcy, NoDisclosure, Caution, DuplicateBookIssued, PowerOfAttorney, DoNotReopen.

alertType
string (AlertType) [ 1 .. 35 ] characters
Example: "Warning"

An alert notification type. Possible values: Warning, Urgent, Teller.

alertCode
string [ 1 .. 36 ] characters

Service alert identifier or code, used to arrange multiple alerts and warnings in a sequence.

message
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
lastAlertDate
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.

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.

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

The insider type information is used to provide info to Regulation 0. The Regulation 0 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. Possible values: Director, Employee, Officer, PrincipalShareholder, Shareholder, Executive, ServiceCorporationEmployee, Child, Spouse, Parent, Relative, AffiliateFinancialInstitution, HoldingCompany, MainShareHolder, RelationshipInterest.

privacyNoticedIndicator
boolean
Example: true

Indicates whether the person allow distributing personal information to third parties. This field is used to identify customers that opt-out of distributing nonpublic personal information about them to third parties.

privacyNoticeOption
string (PrivacyNoticeOption) [ 1 .. 40 ] characters

Privacy notice option. Possible Values: CustomerCanBeDisclosed, CustomerOptOut

object (CustomerIdentificationProgram)

CIP requires that financial firms must obtain four pieces of identifying information about a client.

certificateDocument
Array of strings (CertificateDocumentName) [ items [ 1 .. 60 ] characters ]
Example: ["IdentityCard"]

Documents used to certify the customer identity

certificationStatus
string (CertificationStatus) [ 1 .. 60 ] characters
Example: "CertifiedLevel1"

Customer Identification Program (CIP) status. Designates the type of verification used for Customer Identification. This status could be obtained from a specific software the bank is using. Possible Values: NotCertified, CertifiedLevel1, CertifiedLevel2, CertifiedLevel3, FraudCheckOnly, Level1Check, Level2FraudCheck.

certificationDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
object (Frequency)

Specifies an event frequency

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.

militaryMemberIndicator
boolean

Indicates whether the person is is service member/military.

object (DateTimePeriod)
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

object (AmountRange)

Range an amount

minAmount
string (PositiveAmount) <= 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 (PositiveAmount) <= 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

residenceValue
string (PositiveAmount) <= 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

residenceMortgage
string (PositiveAmount) <= 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, BankEmployed.

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.

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

Professional designation or occupation of a person. Possible Values: Accountant, ArtsEntertainmentRecreation, AttorneyLawyerJudge, BankingFinanceInsurance, CEOUpperMgmtPrivateCorp, CivilServiceGovernment, ConvenienceStoreOwnerManage, Doctor, EducationalServiceEducator, EngineerArchitect, Entrepreneur, FarmerRancher, GemMetalDealerJeweler, HealthCareSocialServices, Homemaker, HospitalityFoodServices, ImportExportCompany, MilitarEnlisted, ProfessionalScientificTechnicalIT, PublicSafety, RealEstateProfessional, Retail, RetiredStudentNotEmployed, Sales, ServiceIndustry, SeniorPoliticalFigures, TradeIndustry, TravelTransportation.

employmentStatus
string

Possible Values: Contract, Employed, Homemaker, Retired, SelfEmployed, Student, Temporary, Unemployed, BankEmployed, FullTime, PartTime, PaidLeave.

object

Indicates an internal code used by the bank to determine a profession description.

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.

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

employeeIndicator
boolean

Indicates whether is a bank employee.

annualIncome
string (PositiveAmount) <= 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

monthlyIncome
string (PositiveAmount) <= 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

grossMonthPayAmount
string (PositiveAmount) <= 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

netMonthPayAmount
string (PositiveAmount) <= 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

monthPayDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
yearsOfEducation
integer
graduationDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
politicallyExposedPerson
boolean
Example: true

Indicates whether the person is a politically exposed person (PEP). Is one who has been entrusted with a prominent public function. A PEP generally presents a higher risk for potential involvement in bribery and corruption.

identityTheftServiceIndicator
boolean
Example: true

Indicates whether the person has subscribed to an Identity Theft service.

Array of objects (IdentityQuestion)
Array
question
string [ 1 .. 1025 ] characters
Example: "This is a description."

The text with the question.

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

Unique identifier of the security question used to identify the customer. Possible values: PlaceOfBirth, County, FavoriteColor, FavoriteNumber, FavoriteDate.

identityQuestionType
string (IdentityQuestionType) <= 130 characters
Example: "FavoriteColor"

Security questions. Possible Values: MotherMaidenName, CityOfBirth, HighSchoolName, FatherMiddleName, SchoolMascot, ResidenceCounty, MotherBirthMonth, 1stEmployerName, ElementarySchoolName, 1stChildMiddleName, PetName, AnniversaryDate, ResidenceCityIn2000, FirstCar, FavoriteArtist, FavoriteColor, FavoriteHobby, FavoriteMovie, FavoriteSportTeam, FavoriteTeacher

answer
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
message
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
coveredByMilitaryLendingActIndicator
boolean

Indicates if the borrower is covered under the Military Lending Act.

Responses

Request samples

Content type
application/json
{
  • "uSDocumentedIndicator": true,
  • "identifiers": [
    ],
  • "name": "Jane Birkin",
  • "shortName": "Jane",
  • "legalName": "Jane Birkin",
  • "nameTemplateId": "1",
  • "nameSoundExId": "1",
  • "partyBranchId": "SEA_1",
  • "customerSinceDate": "2022-04-17T08:00:00Z",
  • "comments": [
    ],
  • "relatedParties": [
    ],
  • "relatedAccounts": [
    ],
  • "postalAddresses": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "relationshipLeadIndicator": true,
  • "residenceType": "Domestic",
  • "taxInformation": {
    },
  • "powerOfAttorney": {
    },
  • "supplementaryData": { },
  • "excludeMarketingIndicator": true,
  • "audit": {
    },
  • "restrictions": [
    ],
  • "codes": [
    ],
  • "webPage": "http://portx.io",
  • "print": {
    },
  • "products": [
    ],
  • "statement": {
    },
  • "documents": [
    ],
  • "placeAndDateOfBirth": {
    },
  • "signature": {
    },
  • "signatureVerificationId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "contact": {
    },
  • "headOfHousehold": true,
  • "civilStatus": "Single",
  • "structuredName": {
    },
  • "gender": "Female",
  • "race": "Director",
  • "profession": "ArtsEntertainmentRecreation",
  • "jobTitle": "Head of Documentation",
  • "educationLevel": null,
  • "residentialStatus": "Permanent",
  • "immigrationStatus": "Permanent",
  • "minorIndicator": true,
  • "citizenships": [
    ],
  • "countryOfResidence": "US",
  • "profile": {
    }
}

Response samples

Content type
application/json
{
  • "uSDocumentedIndicator": true,
  • "identifiers": [
    ],
  • "name": "Jane Birkin",
  • "shortName": "Jane",
  • "legalName": "Jane Birkin",
  • "nameTemplateId": "1",
  • "nameSoundExId": "1",
  • "partyBranchId": "SEA_1",
  • "customerSinceDate": "2022-04-17T08:00:00Z",
  • "comments": [
    ],
  • "relatedParties": [
    ],
  • "relatedAccounts": [
    ],
  • "postalAddresses": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "relationshipLeadIndicator": true,
  • "residenceType": "Domestic",
  • "taxInformation": {
    },
  • "powerOfAttorney": {
    },
  • "supplementaryData": { },
  • "excludeMarketingIndicator": true,
  • "audit": {
    },
  • "restrictions": [
    ],
  • "codes": [
    ],
  • "webPage": "http://portx.io",
  • "print": {
    },
  • "products": [
    ],
  • "statement": {
    },
  • "documents": [
    ],
  • "placeAndDateOfBirth": {
    },
  • "signature": {
    },
  • "signatureVerificationId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "contact": {
    },
  • "headOfHousehold": true,
  • "civilStatus": "Single",
  • "structuredName": {
    },
  • "gender": "Female",
  • "race": "Director",
  • "profession": "ArtsEntertainmentRecreation",
  • "jobTitle": "Head of Documentation",
  • "educationLevel": null,
  • "residentialStatus": "Permanent",
  • "immigrationStatus": "Permanent",
  • "minorIndicator": true,
  • "citizenships": [
    ],
  • "countryOfResidence": "US",
  • "profile": {
    },
  • "personId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "status": "GoodStanding",
  • "users": [
    ],
  • "cards": [
    ]
}

Retrieves a Person

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

Person Identification

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

Account Servicer Identification (Bank)

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

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

Responses

Response samples

Content type
application/json
{
  • "uSDocumentedIndicator": true,
  • "identifiers": [
    ],
  • "name": "Jane Birkin",
  • "shortName": "Jane",
  • "legalName": "Jane Birkin",
  • "nameTemplateId": "1",
  • "nameSoundExId": "1",
  • "partyBranchId": "SEA_1",
  • "customerSinceDate": "2022-04-17T08:00:00Z",
  • "comments": [
    ],
  • "relatedParties": [
    ],
  • "relatedAccounts": [
    ],
  • "postalAddresses": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "relationshipLeadIndicator": true,
  • "residenceType": "Domestic",
  • "taxInformation": {
    },
  • "powerOfAttorney": {
    },
  • "supplementaryData": { },
  • "excludeMarketingIndicator": true,
  • "audit": {
    },
  • "restrictions": [
    ],
  • "codes": [
    ],
  • "webPage": "http://portx.io",
  • "print": {
    },
  • "products": [
    ],
  • "statement": {
    },
  • "documents": [
    ],
  • "placeAndDateOfBirth": {
    },
  • "signature": {
    },
  • "signatureVerificationId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "contact": {
    },
  • "headOfHousehold": true,
  • "civilStatus": "Single",
  • "structuredName": {
    },
  • "gender": "Female",
  • "race": "Director",
  • "profession": "ArtsEntertainmentRecreation",
  • "jobTitle": "Head of Documentation",
  • "educationLevel": null,
  • "residentialStatus": "Permanent",
  • "immigrationStatus": "Permanent",
  • "minorIndicator": true,
  • "citizenships": [
    ],
  • "countryOfResidence": "US",
  • "profile": {
    },
  • "personId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "status": "GoodStanding",
  • "users": [
    ],
  • "cards": [
    ]
}

Updates a Person

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

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

Person Identification

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

Account Servicer Identification (Bank)

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

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

Request Body schema: application/merge-patch+json
object

Responses

Request samples

Content type
application/merge-patch+json
{ }

Response samples

Content type
application/json
{
  • "uSDocumentedIndicator": true,
  • "identifiers": [
    ],
  • "name": "Jane Birkin",
  • "shortName": "Jane",
  • "legalName": "Jane Birkin",
  • "nameTemplateId": "1",
  • "nameSoundExId": "1",
  • "partyBranchId": "SEA_1",
  • "customerSinceDate": "2022-04-17T08:00:00Z",
  • "comments": [
    ],
  • "relatedParties": [
    ],
  • "relatedAccounts": [
    ],
  • "postalAddresses": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "relationshipLeadIndicator": true,
  • "residenceType": "Domestic",
  • "taxInformation": {
    },
  • "powerOfAttorney": {
    },
  • "supplementaryData": { },
  • "excludeMarketingIndicator": true,
  • "audit": {
    },
  • "restrictions": [
    ],
  • "codes": [
    ],
  • "webPage": "http://portx.io",
  • "print": {
    },
  • "products": [
    ],
  • "statement": {
    },
  • "documents": [
    ],
  • "placeAndDateOfBirth": {
    },
  • "signature": {
    },
  • "signatureVerificationId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "contact": {
    },
  • "headOfHousehold": true,
  • "civilStatus": "Single",
  • "structuredName": {
    },
  • "gender": "Female",
  • "race": "Director",
  • "profession": "ArtsEntertainmentRecreation",
  • "jobTitle": "Head of Documentation",
  • "educationLevel": null,
  • "residentialStatus": "Permanent",
  • "immigrationStatus": "Permanent",
  • "minorIndicator": true,
  • "citizenships": [
    ],
  • "countryOfResidence": "US",
  • "profile": {
    },
  • "personId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "status": "GoodStanding",
  • "users": [
    ],
  • "cards": [
    ]
}

Retrieves a list of organizations matching the parameters.

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 organization owns an account with the number.

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 .. 300 ] characters
Example: organizationId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002

System id equals to

audit.lastModificationDate.lte
string <date> (Date)
Example: audit.lastModificationDate.lte=2022-04-17

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

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

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

audit.lastModificationDate.gte
string <date> (Date)
Example: audit.lastModificationDate.gte=2022-04-17

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

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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

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

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

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates an Organization

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

Idempotency identifier used by the client when making repeated calls

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

Account Servicer Identification (Bank)

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

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

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

Unique and unambiguous identification.

issuer
string
Example: "UnitedStates"

Entity that assigns the identification.

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

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

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

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

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

applyDate
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>
Example: "2022-04-17"

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

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

Verification or certification date.

foreignIDIndicator
boolean

Indicates whether the identifications is from a foreign country.

taxIDIndicator
boolean

Indicates whether the identifications is Tax Id.

displayOption
string [ 1 .. 35 ] characters

Indicates display options for party attributes. Possible Values: TaxIdMasked

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

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

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.

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

Official name under which the party is registered.

nameTemplateId
string (NameTemplateId) [ 1 .. 36 ] characters
Example: "1"

Template used to display the party name. This is an external id provided by the account servicer.

nameSoundExId
string (SoundExId) [ 1 .. 36 ] characters
Example: "1"

Identification of a SoundEx method develop for search attribute. SoundEx is a method used to find strings when the sound is known but the precise spelling is not. It searches out words with similar sounds based on phonetic assumptions about how certain letters are pronounced. It can be used to search names in a database, for example, where spellings and pronunciations for similar names may vary.

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

Identification of the account servicer institution at branch level or center level. To overlay the codes to produce a unique identifier the following expresion is used: BranchRegionCode-BranchSubdivisionCode.

customerSinceDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (Comment)

Bank comnents of the party.

Array
name
string [ 1 .. 35 ] characters
text
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
Array of objects (DetailedRelatedParty)
Array
Array of objects (GenericIdentification)
Array of objects (GenericCode)

Codes to link the party with other systems or to classify the party. Possible values: RemoteDepositRisk.

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.

nameTemplateId
string (NameTemplateId) [ 1 .. 36 ] characters
Example: "1"

Template used to display the party name. This is an external id provided by the account servicer.

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.

object (PlaceAndDateOfBirth)

Date and place of birth of a person.

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

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

status
string (PartyStatus) [ 1 .. 35 ] characters
Example: "GoodStanding"

Specifies the current primary status of a party. Possible values are: GoodStanding, FraudAlert, BadCustomer, Active, Delinquent, Default, HighRisk, UnderReview, HotCarded, WildCarded. Other possible values: PersonalBankruptcy, GrowingConcern, WatchLoan, InReceivership, Chapter11, Liquidation.

statusDateAndTime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
coveredByMilitaryLendingActIndicator
boolean

Indicates if the borrower is covered under the Military Lending Act.

militaryMemberIndicator
boolean

Indicates whether the person is is service member/military.

object (DateTimePeriod)
object (Employment)
object (Audit)

Resource Audit Information. Captures the creation, modification and maintenance details.

Array of objects (PostalAddress)
object (StructuredName)

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

Array of objects (Phone)
organizationType
string (OrganizationType)
Example: "Corporation"

Specifies the legal standing of the organization. Possible values are: Government, NonGoverment NonUSGovernmentOrganization, USGovernmentOrganization FinancialInstitution, SoleProprietorship, UnincorporatedAssociation, LimitedLiabilityPartnership, LimitedLiabilityCompany, SingleMemberLimitedLiabilityCompany, LimitedPartnership, FormalPartnership, GeneralPartnership, Business, Corporation, NotForProfit, ForProfit, NonProfitCorporation, NonProfit, Club, Supranational, Sovereign, Municipal, Province, State, County, National, ExemptionTrust, LivingTrust, EmployeeTrust, RevocableTrust, IrrovocableTrust, NakedTrust, FamilyTrust, BussinesTrust, CliffordTrust, FormalTrust, PublicAgency, Association, Church, PublicFunds. International & Foreign Business Entities: PersonaFisica, SociedadCivil, SociedadAnonimaCapitalVariable, SociedadResponsabilidadLimitada, SociedadAnonimaCapitalVariable.

customerType
string (CustomerType)
Example: "Consumer"

A customer type of a bank account can be classified into different categories based on the account's features, purpose, and benefits. Possible Values: Personal, Business, Consumer, Organization, ThirdParty, Estate, Employee, ForeignConsumer.

taxReportingIndicator
boolean

Account tax reporting typically involves obtaining and submitting records related to your tax obligations. For individuals, this may include income, qualifying deductions, and investment gains or losses. Businesses, on the other hand, have additional complexities, such as tracking funds directed towards specific business expenses and shareholders.

taxStatus
string
Example: "Exempt"

Exempt, Retain, ExemptExpired, VoluntaryWithholding, Chapter3, Chapter4, C-Corp, S-Corp, Certified, W-8Required, NotCertified.

Array of objects (PaymentCardDescriptor)
Array of objects (Balance)

Balances related to the party

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

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

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

Type of relation between parties. Possible values Between Organizations and persons are: ResponsibleParty, Owner, ControlPerson, ControlPersonOwner, AuthorizedPerson, BeneficialOwner, PrimaryContact, SecondaryContact, VicePresident, President, Treasurer, Secretary, Partner, GeneralPartener, CEO, CFO, COO, Conservator, Dealer, Director, MessageReceiver, Employee, Excecutor, GeneralPartner, HumanResourceRepresentative, IOLTAContact, ManagingMember, PrimaryContact, SecondaryContact, Estate. Between Persons and Organizations: Business, Organization, UnclaimedPropertyContact, UtilityContact. For Trusts: Trustor, Trustee. Between organizations: Subsidiary, ParentOrganization, Branch. Between parties and external entities: AccountOpenningOfficer, CustomerServiceOfficer, PrimaryServicerOfficer, SecondaryServicerOfficer, SalesPerson, ReferralOfficer. Between financial institutions: AffiliateFinancialInstitution, HoldingCompany. Between persons: Spouse, Aunt, Brother, Companion, Daughter, Father, Friend, Granddaughter, Grandmother, Grandfather, Grandson, Husband, Mother, Nephew, Niece, Sister, Son, Uncle, Wife, Child, Grandparent. Grandchild, Sibling, Parent, Partner, Related, InitiatingParty

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

Person’s relation became effective.

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

Person’s relation became inactive.

partyRelationDescription
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
ownershipPercentage
string <= 23 characters ^100|(([1-9][0-9]{0,1})([.][0-9]{0,8}){0,1})$...
Example: "25"

Company Ownership Percentage. If the relation Type is BeneficialOwner the ownership percentage could be added. Ownership means any person with more than 25% equity in the legal entity.

Array of objects (RelatedAccount)
Array
accountRelationType
string (AccountRelationType)
Example: "SubAccount"

Account relation role. Possible values are: Parent, EscrowAccount, SubAccount, ControlAccount, CrossAccount, ChargeAccount, AssociatedAccount, IRAAccount, CombinedStatement, SecondaryCombinedStatement, SummaryAccount, FundingSource, CompensatingAccount. Payment related values: Authorized, Counterpart

accountId
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

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

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

accountType
string (RelatedAccountType) [ 1 .. 60 ] characters
Example: "Checking"

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

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.

productId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
Array of objects (GenericCode)

Account related codes

Array of objects (PostalAddress)
Array
addressCode
string

This code is used to identify parties that share the same address or to associate an existing address with a specific party. Providing this code eliminates the need to separately enter the address details.

addressBookIndicator
string

If true, the address is kept in the system even if the person is no longer a customer.

addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible values are: PhysicalAddress, Postal, POBox, Residential, Permanent, Temporary, Alternative, Previous.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible values are: MailTo, DeliveryTo, Billing, Tax, ForeignTaxRecipient PlaceOfOperation, PlaceOfRegistration, placeOfFormation, Marketing, Statements, Business, Administrative, PreviousPlace, Headquarter, BranchStore, Branch, Property, Military, Secondary, Personal, Annex, Inquiry.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

careOf
string [ 1 .. 100 ] characters
Example: "C/O Company Name"

Identifies an addressee that is accepting the correspondence for the intended recipient. Using care of ensures the correspondence reaches the right recipient rather than getting returned to the sender.

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

Identification of a division of a large Organization or building.

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

Identification of a sub-division of a large Organization 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 Organization, where letters are kept until called for.

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

Building room number.

postCode
string (PostCode) [ 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. In US may consists of two parts: the five-digit ZIP Code '97062' and the ZIP+4 Code '6884'.

carrierRoute
string (CarrierRoute) [ 1 .. 4 ] characters
Example: "C001"

A Carrier Route is a designated geographic area assigned to individual postal carriers by the United States Postal Service (USPS) to facilitate efficient mail delivery within specific regions.

censusTract
string (CensusTract) = 5 characters
Example: "12345"

A census tract, census area, census district or meshblock is a geographic region defined for the purpose of taking a census

censusBlock
string (CensusBlock) = 4 characters
Example: "1234"

Census blocks are used to partition counties into smaller areas for the purpose of collecting and presenting census data.

cBSACode
string (CBSACode) = 5 characters
Example: "49780"

Core-based statistical area. Metropolitan statistical area (MSA) is the formal definition of a region that consists of a city and surrounding communities that are linked by social and economic factors. Micropolitan Statistical Areas (MISA) are CBSAs associated with at least one urban cluster that has a population of at least 10,000, but less than 50,000. The micropolitan statistical area comprises the central county or counties or equivalent entities containing the core, plus adjacent outlying counties having a high degree of social and economic integration with the central county as measured through commuting.

cBSAType
string (CBSAType) [ 1 .. 10 ] characters
Example: "MSA"

Type of Core-based statistical area. Possible values: MSA, MISA

foreignIndicator
boolean

Indicates whether the postal address is from a foreign country.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

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

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

Specific location name within the town.

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

Identifies a subdivision within a country sub-division.

countyName
string [ 1 .. 35 ] characters
Example: "Cook"

Identifies a county 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.

temporaryIndicator
boolean
Example: true

Indicates whether the address is temporary or not.

object

The period of use of the address information. Could be also used as a recurring anual period.

Array of objects (GenericCode)

Codes related to postal address or internal handling codes associated with the address. Possible Values: HandlingCode, HandlingCodeOption, AddressFormat.

Array of objects (GenericIdentification)

Postal address identifiers are used to identify parties that share the same address or to associate an existing address with a specific party. Possible scheme name values: AddressIdentifier.

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

Customer principal relationship. This entity gives the ability to view a party’s total relationship with the bank. The relationship Id ties multiple parties together. This code is also used to reduce mailing costs during marketing campaigns to avoid sending duplicate materials to parties residing at the same address.

relationshipLeadIndicator
boolean

The relationship lead is often the primary account owner or the party with whom the bank have the most contact.

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 .. 50 ] characters
Example: "SocialSecurityNumber"

Identifies what type of tax ID is in the TIN field. Possible Values: SocialSecurityNumber, SocialInsuranceNumber, EmployerIdentificationNumber, IndividualTaxpayerIdentificationNumber, AdoptionTaxpayerIdentificationNumber, PreparerTaxpayerIdentificationNumber, ForeignTaxID

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

taxReportingIndicator
boolean

Account tax reporting typically involves obtaining and submitting records related to your tax obligations. For individuals, this may include income, qualifying deductions, and investment gains or losses. Businesses, on the other hand, have additional complexities, such as tracking funds directed towards specific business expenses and shareholders.

interestReportingIndicator
boolean

Indicates whether or interest should be reported.

tINStatus
string
Example: "Valid"

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

object (TINVerification)

IRS information about the TIN provided.

verificationAttemps
integer <= 10
Example: 1

The Tax Identification Verification Attempts is the number of times attempts have been made to verify the tax ID number.

bNoticeDates
Array of strings <date> (Date)
Example: ["2022-04-17"]
tINResultCode
string <= 3 characters

TIN matching result codes

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

Verification or certification date.

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

taxStatus
string
Example: "Exempt"

Exempt, Retain, ExemptExpired, VoluntaryWithholding, Chapter3, Chapter4, C-Corp, S-Corp, NonProfit, Government.

exemptionCode
string <= 4 characters
Example: "0"

Indicates the reason why taxes were not withheld from the gross income being reported for a NRA. These codes are used to specify the type of income, the applicable tax treaty, or the Internal Revenue Code section that allows for the exemption from withholding. The use of these codes is subject to certain conditions and limitations, and withholding agents are responsible for verifying the NRA's eligibility for the exemption and for reporting the income and exemption codes accurately to the IRS.

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

Human readable reason why taxes were not withheld.

Array of objects (TaxForm)

Forms applied by the party

Array
formName
required
string [ 1 .. 10 ] characters
Example: "W-8"

Form name requested. Possible Values: W-8BEN, W-8BEN-E, W-8ECI, W-8EXP, W-8IMY, W-9, W-8, 1042-S, 1099-INT, 1099-OID.

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

Indicates the tax rate provided by the IRS on the form.

onFileIndicator
boolean

Indicates weather the bank establish the appropriate tax treatment of any interest or other income earned on the account related to the form.

taxStatus
string
Example: "Exempt"

Exempt, Expired, Certified, Signed

certificationDate
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
required
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
required
string (WithholdingTaxType) [ 1 .. 35 ] characters
Example: "NonResidentAlienTax"

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

withholdingRate
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Rate applied on a basis amount to calculate the withholding.

taxStatus
string

Exempt, Expired, Certified, Retain.

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

Withholding amount.

foreignIndicator
boolean

Indicates whether the party is a non-residen alien or a foreign entity.

Array of objects (TaxFormCode)

Codes provided by the IRS on forms.

Array
name
string (TaxFormName) [ 1 .. 35 ] characters

Indicates a code name provided by the IRS on the form. Possible Values: Chapter3, Chapter4, Income, Exempt, Province, CountryResidence, AmendedNumber, CountryTax

value
string <= 50 characters

Indicates the code number provided by the IRS on the form. Possible Values: Chapter4FATCAStatus, Chapter3Status, ForeignTaxForms.

recipientGIIN
string (GIIN) [ 1 .. 34 ] characters ^([A-N,P-Z,0-9]){6}\.([A-N,P-Z,0-9]){5}\.(LE|...
Example: "ADN123.FG4FE3.LE.999"

Global intermediary identification number (GIIN).

recipientPostCode
string

Code provided by the IRS on forms.

recipientTownName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

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

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 <= 2 characters

IRS country code table.

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.

documentReference
string [ 1 .. 35 ] characters

Document location.

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

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

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

object (Jurisdiction)

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

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

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

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

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

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

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

object (ContactDetails)

Specifies the contact details of a person.

object (StructuredName)

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

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

Preferred name to contact the person

firstContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
lastContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (Phone)
Array of objects (Email)
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 Organization or building.

Array of objects (CommunicationChannel)
preferredMethod
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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, Default.

object (AccountContractRelatedParty)
partyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
partyType
string (PartyType)
Example: "Person"

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

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.

agreementType
string (AgreementType)

Document or agreement type. Possible values: CardAgreement, AccountContract.

agreementSubtype
string [ 1 .. 60 ] characters

Agreement detailed category.

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

Person which is the holder of the power of attorney.

authorizedAccount
string [ 1 .. 300 ] characters
Example: "033-DDA-123456"

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

excludeMarketingIndicator
boolean
object (Audit)

Resource Audit Information. Captures the creation, modification and maintenance details.

status
string (AuditStatus) [ 1 .. 35 ] characters

Maintenance status of a resource. Possible values: Requested, Created, Changed, Deleted

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

creationBranchId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
object (User)

User information of a person.

personId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
userId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
userName
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

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

purpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
audit
object (Audit) Recursive

Resource Audit Information. Captures the creation, modification and maintenance details.

lastModificationChannel
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

lastModificationDate
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 (AuditChannel)

Activity audit throught communication channles

Array
lastActivityDate
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 (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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

activityType
string (AuditActivityType) [ 1 .. 35 ] characters

Maintenance activity of a resource. Possible values: Transaction, Modification, Deposit, Withdrawal, Creation, DirectDeposit, CardActivation, CardActivationByCallerId, CardActivationByCodeAndCallerId, Closure, HSACreation

amount
string (PositiveAmount) <= 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

Array of objects (Restriction)

Access and operation restrictions at Party level.

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

Name of the restriction in PascalCase. Possible values: TransferIn, TransferOut, WireTransferIn, WireTransferOut, ACHTransferIn, ACHTransferOut, ForeignIncomingWires, ForeignOutgoingWires, ACHTransfers, InternetBankingTransfer, InternetView, InternetInquiry, ForeignOutgoingIran, Withdrawals, Renew, Transfers, AdvanceTransfer, OnlineBanking, ElectronicBanking, InvestmentAllowed, InvestmentSetUpAllowed, DebitCardAllowed, CheckOrderAllowed, AutomaticSweep, AccountManagement

restrictionPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
enableIndicator
boolean
Example: true

Indicates whether the capability is allowed or not.

disableConditions
Array of strings (ConditionName) [ items [ 1 .. 36 ] characters ]
Example: ["LessThanMinAmount"]

Conditions that disabel the restriction.

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.

status
string (RestrictionStatus) [ 1 .. 36 ] characters
Example: "Pending"

Specifies the status of a restriction enablement request. Possible values: Enable, Pending, InquiryOnly, Disable, Requested.

Array of objects (GenericCode)

Codes to classify parties. Possible code names: Priority. For Organizations: StandardIndustryClassification, StandardIndustrySubClass AccountingGroup, CurrentRoutingNumber.

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

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

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
webPage
string^[(http(s)?):\/\/(www\.)?a-zA-Z0-9@:%._\+~#=]...
Example: "http://portx.io"

Party web page

object (PartyPrintOptions)
displayOptions
Array of strings (PartyDisplayOption) [ items [ 1 .. 35 ] characters ]
Array of objects (GenericPrintOption)
Array
name
string (PrintOptionName) [ 1 .. 35 ] characters

Name of the print Option. Possible Values: ACHTransaction

options
Array of strings (PrintOption) [ items [ 1 .. 35 ] characters ]
Array of objects (Product)

Products related with the party

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

Unique identification of a product within a product type.

pricingStrategyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
name
required
string [ 1 .. 40 ] characters
Example: "Visa Business Card"

Commercial product name within a product type.

description
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
productType
string [ 1 .. 35 ] characters
Example: "PaymentCard"

Type or nature of a product. Possible Values: Loan, PaymentCard, CheckingAccount, HealthSavingsAccount, RepricingPlan.

productSubType
string [ 1 .. 35 ] characters
Example: "BusinessCard"

Commercial product subtype within a product type.

Array of objects (Restriction)
Array of objects (SpotDate)
Array of objects (Limit)
Array of objects (ChargeCalculation)
parties
Array of strings (ProductPartyRelationType) [ items [ 1 .. 40 ] characters ]
Example: ["ParentProvider"]
status
string (ProductStatus) [ 1 .. 35 ] characters
Example: "GoodStanding"

Specifies the current status of a product. Possible values are: Enable, Disable.

statusDateAndTime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (GenericCode)

Product configuration codes. Possible Values: WebBrand, WaterfieldService, MajorAccountType: Major Account Type code for Employee Qualified Plan, MinorAccountType: Minor Account Type code to use for Employee Qualified Plan, CheckingMajor: Checking Major to be used and linked to Employee Qualified Plan account, CheckingMinor: Checking Minor to be used and linked to Employee Qualified Plan account. Other values: NationalCreditUnionAdministration.

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 (FinancialStatement)

Specifies financial statement details.

object (Frequency)

The frequency of the regular statement.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

object (Frequency)

The next frequency of the regular statement.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

Array of objects (StatementCommunicationChannel)
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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

Communication value such as phone number or email address.

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

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

printOnNextCycleIndicator
boolean

Indicates whether the statement will be produced at the end of the next statement cycle.

Array of objects (GenericCode)

Codes to determine configurarion options for alerts and notifications. Possible code names: NoticeOption.

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

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

Array of objects (GenericCode)

Codes related to statements or internal handling codes associated with the statement. Possible Values: CombinedCode, SpecialStatement, DetailsFormat, StatementGroup, ProfitabilityOption.

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

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

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
Array of objects (GenericIdentification)

Identification of statement instances and related. Possible values: schemeName: LastCombinedStatement, CombinedStatementAccountId

Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification.

schemeName
required
string [ 1 .. 35 ] characters

Name of the identification scheme.

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.

templateCode
string (StatementTemplateId) [ 1 .. 36 ] characters
Example: "1"

Template used to create the statement document. This is an external code provided by the account servicer.

object (Period)
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

object (Period)
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

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

The date of the last statement.

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

The date of the next statement.

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

The date on which service charges will be applied to an account

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

The date of the statement previous from the last.

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

The date of the last regular statement.

truncationOptions
Array of strings
Example: ["ItemsIncluded"]
accountNameIndicator
boolean

Indicates whether the account name is printed on the statement.

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, Default.

combineType
string [ 1 .. 36 ] characters
Example: "SavingsStatement"

Indicates whether account transactions are printed on a combined statement. Possible combinations: CheckingStatement, SavingsStatement, PrimaryAccount, SecondaryAccount.

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

profitabilityModelId
string (StatementModelId) [ 1 .. 36 ] characters
Example: "1"

Model used to calculate customer profitability. This is an external id provided by the account servicer.

lastIRAStatementDate
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 (DocumentDescriptor)

Documents related to the party.

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

Document location.

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

organizationType
string (OrganizationType)
Example: "Corporation"

Specifies the legal standing of the organization. Possible values are: Government, NonGoverment NonUSGovernmentOrganization, USGovernmentOrganization FinancialInstitution, SoleProprietorship, UnincorporatedAssociation, LimitedLiabilityPartnership, LimitedLiabilityCompany, SingleMemberLimitedLiabilityCompany, LimitedPartnership, FormalPartnership, GeneralPartnership, Business, Corporation, NotForProfit, ForProfit, NonProfitCorporation, NonProfit, Club, Supranational, Sovereign, Municipal, Province, State, County, National, ExemptionTrust, LivingTrust, EmployeeTrust, RevocableTrust, IrrovocableTrust, NakedTrust, FamilyTrust, BussinesTrust, CliffordTrust, FormalTrust, PublicAgency, Association, Church, PublicFunds. International & Foreign Business Entities: PersonaFisica, SociedadCivil, SociedadAnonimaCapitalVariable, SociedadResponsabilidadLimitada, SociedadAnonimaCapitalVariable.

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

Description and purpose of an organization.

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.

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 Organization was established.

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.

nAICSCode
string (NAICSCode) ^[0-9]{2,2}
Example: "54"

The North American Industry Classification System (NAICS) is the standard used by Federal statistical agencies in classifying business establishments for the purpose of collecting, analyzing, and publishing statistical data related to the U.S. business economy.

lineOfBusiness
string [ 1 .. 35 ] characters

The line of business refers to the specific industry or market segment that a company operates. This helps to further define the target market and focus marketing efforts on reaching and serving the needs of that specific group. Possible Values: ConsumerGoods, ConsumerCervices, SmallBusiness, Corporate.

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: "High"

Specifies the customer’s money laundering risk. Possible values: VeryLow, Low, Medium, Medium toHigh, ModerateHigh, High, ExtremelyHigh, NoDetermine.

Array of objects (RiskMeasure)
Array
name
string (CreditRankingScaleName) [ 1 .. 35 ] characters
Example: "StandardAndPoors"

Most commonly used credit ranking scales. Possible Values: StandardAndPoors, MoodysInvestors. Also other values: Original, 1, 2, 3, Current.

level
string (RiskLevel) [ 1 .. 35 ] characters
Example: "High"

Specifies the customer’s money laundering risk. Possible values: VeryLow, Low, Medium, Medium toHigh, ModerateHigh, High, ExtremelyHigh, NoDetermine.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (GenericCode)

Additional risk measure codes. Possible values: RiskRatingCode

bSARiskCode
integer (BSARiskCode) <= 10
Example: 0

Used to identify customers that present a risk to the bank as defined by the Bank Secrecy Act. For example, use this code to identify and monitor accounts suspected of fraud, kiting or money laundering.

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

Array of objects (CreditRankingScale)
creditReportAddressIndicatorCode
string

is a code or marker used by credit reporting agencies to indicate a match or mismatch between the address supplied in an inquiry and the address they have on file for a consumer.

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

Information provided by the Consumer Credit Report.

consumerCreditReportDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
creditBureauReportCode
string
Example: "30"

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.

eCOACode
string

The ECOA code indicates how customer account information is reported to the Credit Bureau in keeping with the Equal Credit Opportunity Act.

cTRExemptIndicator
boolean

Currency transaction report (CTR) exemption. A CTR is a report that must be filed by banks for any transaction involving currency of $10,000 or more. However, certain entities and transactions are exempt from this reporting requirement.

oFACReportingIndicator
boolean

Indicates whether the party is to be excluded from OFAC Reporting.

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
required
string [ 1 .. 36 ] characters
Example: "Months"

Unit that describes the duration.

value
integer <= 999

Value of the duration in number of units.

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

Date of Residence in the current household.

yearsAtCurrentAddress
integer
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.

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"

Used for regulatory purposes by the bank to track how long closed account history has been maintained for a customer. Possible values are: Competition, Deceased, Dissatisfied, Moved, MergedEntity, CeasedOperation

customerType
string (CustomerType)
Example: "Consumer"

A customer type of a bank account can be classified into different categories based on the account's features, purpose, and benefits. Possible Values: Personal, Business, Consumer, Organization, ThirdParty, Estate, Employee, ForeignConsumer.

Array of objects (ServicerAlert)

Customer alerts to be received by the account servicer.

Array
alertName
string (AlertName) [ 1 .. 35 ] characters
Example: "CreditBureauAlert"

Service alert human readable identifier in Pascal case. An alert notification received by the bank. Possible values: CreditBureauAlert, CustomerAlert, PaymentCard, LostBook, TwoSignaturesRequired, PledgedAsCollateral, DeathOnAccount, Bankruptcy, NoDisclosure, Caution, DuplicateBookIssued, PowerOfAttorney, DoNotReopen.

alertType
string (AlertType) [ 1 .. 35 ] characters
Example: "Warning"

An alert notification type. Possible values: Warning, Urgent, Teller.

alertCode
string [ 1 .. 36 ] characters

Service alert identifier or code, used to arrange multiple alerts and warnings in a sequence.

message
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
lastAlertDate
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.

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.

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

The insider type information is used to provide info to Regulation 0. The Regulation 0 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. Possible values: Director, Employee, Officer, PrincipalShareholder, Shareholder, Executive, ServiceCorporationEmployee, Child, Spouse, Parent, Relative, AffiliateFinancialInstitution, HoldingCompany, MainShareHolder, RelationshipInterest.

legalEntityReportingIndicator
boolean

Indicates whether the party is required to be reported as a legal entity.

numberOfEmployees
integer
Example: 100

Number of employees of the corporation.

annualSales
string (Amount) <= 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 (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

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

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

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

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

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

hSAIndicator
boolean

Indicates whether the organization has Health Savings Account Plan

politicallyExposedOrganization
boolean
Example: true

Indicates whether the organization is a politically exposed person.

object

Business e-mails and phone numbers. Configuration of communication channels at organization level.

object (StructuredName)

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

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

Person given first name.

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

Person given middle name.

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

Person surname.

middleInitial
string [ 1 .. 10 ] characters
Example: "J."

Person middle initial.

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. Generation order should be expressed with roman numerals: I, II, III, IV, V.

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

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

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

Preferred name to contact the person

firstContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
lastContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (Phone)
Array
number
required
string (PhoneNumber) ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$
Example: "+1-555-1234567"

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

extension
string <= 5 characters

Phone Number Extension.

country
string (CountryCallingCode) <= 3 characters

Country calling codes, country dial-in codes, international subscriber dialing (ISD) codes, or most commonly, telephone country codes. Country codes are defined by the International Telecommunication Union (ITU) in ITU-T standards E.123 and E.164. The prefixes enable international direct dialing (IDD).

phoneType
string [ 1 .. 35 ] characters

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

phonePurpose
string [ 1 .. 35 ] characters

Purpose of the phone address. Possible values are: Business, Personal, International, Alternative, PersonalInternational, BusinessInternational

foreignIndicator
boolean

Indicates whether is a foreign phone number

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

object (TimeOfTheDay)
comment
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
object

The period of use of the phone information.

Array of objects (GenericCode)
Array of objects (GenericIdentification)

Phone identifiers are used to identify parties that share the same phone or to associate an existing phones with a specific party. Possible scheme name values: PhoneIdentifier.

lastUpdatedDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
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, Business, Administrative, Personal

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

Array of objects (GenericIdentification)

Email identifiers are used to identify parties that share the same email or to associate an existing email with a specific party. Possible scheme name values: EmailIdentifier.

lastUpdatedDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
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 Organization or building.

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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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

Communication value such as phone number or email address.

channelPurpose
string (CommunicationChannelPurpose) [ 1 .. 40 ] characters
Example: "PrivacyNotices"

Communication purpose of the channel. Possible values: Alerts, PrivacyNotices, NegativeBalance, OverdraftProtection, ACHNotice, ChargeBack, BalanceOnReceipt, RegulationCCNotice, RateChange, MaturityNotice, InterestNotice, RegularNotice, PastDueNotice, HUDNotice, PaymentChange, AutomaticPayment, PastDueFirstNotice, PastDueSecondNotice, PastDueNoticeGuarantor, CardHolderAuthorization, Delivery, DocumentDistribution.

codeWord
string

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

alertIndicator
boolean

Indicates whether the channel is used for enterprise alerts to the customer.

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

The party authorized to use the communcation channel

Array of objects (GenericCode)

Codes to determine configurarion options for alerts and notifications. Possible code names: NoticeOption.

status
string (AlertStatus) [ 1 .. 35 ] characters
Example: "Warning"

Alert status. Possible values: Sent, SentLastNight, Pending, Enable, Disable, FraudAlert. Possible values for CreditBureauAlert: IdentityTheft.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

object

The lead time between the event and the alert notification.

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

Text to appear in alerts and notices.

Array of objects (SpotDate)
contactCount
integer

Number of contacts.

object (Frequency)

Specifies an event frequency

preferredMethod
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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, Default.

Array of objects (SpotDate)
Array
name
string (SpotDateName) [ 1 .. 40 ] characters
Example: "Expiration"

Possible values por projected dates: Forecast, Expiration, LastNonFinancial, Escheat. Possible values for past dates: IRALastRollOver. Other possible values: EffectiveDate, ResponseByDate.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
logo
string <byte> (CommercialLogo) [ 1 .. 32768 ] characters

Commercial logo of the organization. Max length of 32K, base64 encoded.

Responses

Request samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "name": "Jane Birkin",
  • "shortName": "Jane",
  • "legalName": "Jane Birkin",
  • "nameTemplateId": "1",
  • "nameSoundExId": "1",
  • "partyBranchId": "SEA_1",
  • "customerSinceDate": "2022-04-17T08:00:00Z",
  • "comments": [
    ],
  • "relatedParties": [
    ],
  • "relatedAccounts": [
    ],
  • "postalAddresses": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "relationshipLeadIndicator": true,
  • "residenceType": "Domestic",
  • "taxInformation": {
    },
  • "powerOfAttorney": {
    },
  • "supplementaryData": { },
  • "excludeMarketingIndicator": true,
  • "audit": {
    },
  • "restrictions": [
    ],
  • "codes": [
    ],
  • "webPage": "http://portx.io",
  • "print": {
    },
  • "products": [
    ],
  • "statement": {
    },
  • "documents": [
    ],
  • "organizationType": "Corporation",
  • "organizationPurpose": "This is a description.",
  • "tradingName": "Jane",
  • "registrationDate": "2022-04-17",
  • "establishmentDate": "2022-04-17",
  • "merchantCategory": "482",
  • "nAICSCode": "54",
  • "lineOfBusiness": "string",
  • "sector": "string",
  • "organizationProfile": {
    },
  • "contact": {
    },
  • "projectedDates": [
    ],
  • "logo": "string"
}

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "name": "Jane Birkin",
  • "shortName": "Jane",
  • "legalName": "Jane Birkin",
  • "nameTemplateId": "1",
  • "nameSoundExId": "1",
  • "partyBranchId": "SEA_1",
  • "customerSinceDate": "2022-04-17T08:00:00Z",
  • "comments": [
    ],
  • "relatedParties": [
    ],
  • "relatedAccounts": [
    ],
  • "postalAddresses": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "relationshipLeadIndicator": true,
  • "residenceType": "Domestic",
  • "taxInformation": {
    },
  • "powerOfAttorney": {
    },
  • "supplementaryData": { },
  • "excludeMarketingIndicator": true,
  • "audit": {
    },
  • "restrictions": [
    ],
  • "codes": [
    ],
  • "webPage": "http://portx.io",
  • "print": {
    },
  • "products": [
    ],
  • "statement": {
    },
  • "documents": [
    ],
  • "organizationType": "Corporation",
  • "organizationPurpose": "This is a description.",
  • "tradingName": "Jane",
  • "registrationDate": "2022-04-17",
  • "establishmentDate": "2022-04-17",
  • "merchantCategory": "482",
  • "nAICSCode": "54",
  • "lineOfBusiness": "string",
  • "sector": "string",
  • "organizationProfile": {
    },
  • "contact": {
    },
  • "projectedDates": [
    ],
  • "logo": "string",
  • "organizationId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "status": "GoodStanding"
}

Retrieves an Organization

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

Organization Identification

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

Account Servicer Identification (Bank)

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

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

Responses

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "name": "Jane Birkin",
  • "shortName": "Jane",
  • "legalName": "Jane Birkin",
  • "nameTemplateId": "1",
  • "nameSoundExId": "1",
  • "partyBranchId": "SEA_1",
  • "customerSinceDate": "2022-04-17T08:00:00Z",
  • "comments": [
    ],
  • "relatedParties": [
    ],
  • "relatedAccounts": [
    ],
  • "postalAddresses": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "relationshipLeadIndicator": true,
  • "residenceType": "Domestic",
  • "taxInformation": {
    },
  • "powerOfAttorney": {
    },
  • "supplementaryData": { },
  • "excludeMarketingIndicator": true,
  • "audit": {
    },
  • "restrictions": [
    ],
  • "codes": [
    ],
  • "webPage": "http://portx.io",
  • "print": {
    },
  • "products": [
    ],
  • "statement": {
    },
  • "documents": [
    ],
  • "organizationType": "Corporation",
  • "organizationPurpose": "This is a description.",
  • "tradingName": "Jane",
  • "registrationDate": "2022-04-17",
  • "establishmentDate": "2022-04-17",
  • "merchantCategory": "482",
  • "nAICSCode": "54",
  • "lineOfBusiness": "string",
  • "sector": "string",
  • "organizationProfile": {
    },
  • "contact": {
    },
  • "projectedDates": [
    ],
  • "logo": "string",
  • "organizationId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "status": "GoodStanding"
}

Updates an Organization

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

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

Organization Identification

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

Account Servicer Identification (Bank)

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

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

Request Body schema: application/merge-patch+json
object

Responses

Request samples

Content type
application/merge-patch+json
{ }

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "name": "Jane Birkin",
  • "shortName": "Jane",
  • "legalName": "Jane Birkin",
  • "nameTemplateId": "1",
  • "nameSoundExId": "1",
  • "partyBranchId": "SEA_1",
  • "customerSinceDate": "2022-04-17T08:00:00Z",
  • "comments": [
    ],
  • "relatedParties": [
    ],
  • "relatedAccounts": [
    ],
  • "postalAddresses": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "relationshipLeadIndicator": true,
  • "residenceType": "Domestic",
  • "taxInformation": {
    },
  • "powerOfAttorney": {
    },
  • "supplementaryData": { },
  • "excludeMarketingIndicator": true,
  • "audit": {
    },
  • "restrictions": [
    ],
  • "codes": [
    ],
  • "webPage": "http://portx.io",
  • "print": {
    },
  • "products": [
    ],
  • "statement": {
    },
  • "documents": [
    ],
  • "organizationType": "Corporation",
  • "organizationPurpose": "This is a description.",
  • "tradingName": "Jane",
  • "registrationDate": "2022-04-17",
  • "establishmentDate": "2022-04-17",
  • "merchantCategory": "482",
  • "nAICSCode": "54",
  • "lineOfBusiness": "string",
  • "sector": "string",
  • "organizationProfile": {
    },
  • "contact": {
    },
  • "projectedDates": [
    ],
  • "logo": "string",
  • "organizationId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "status": "GoodStanding"
}

Transactions

Account Transactions Management

Creates a Credit Transaction

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

Account Identification

query Parameters
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
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

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

Account Servicer Identification (Bank)

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Request Body schema: application/json
transactionType
required
string (DepositTransactionType) [ 1 .. 35 ] characters
Example: "Cash"

Type of Credit Transaction: Cash, Check, Merchandise, MemoPosted

amount
required
string (Amount) <= 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 values are: CustomerCheque, CertifiedCustomerCheque, BankCheque, Draft, ElectronicDraft.

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

Check amount

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

Check currency

checkNumber
string <= 35 characters

The number on the face of the check indicating the id of that check in a series.

issuer
string
Example: "Jhon Smith"

Party that issued the check.

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

availabilityFloat
string

It refers to the time delay between when a check is deposited and when the funds become available for withdrawal. Possible Values: ImmediateWithdrawal, LocalCheck, NonLocalCheck

Array of objects (GenericIdentification)

Check identifiers. Possible scheme names: Reference.

Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification.

schemeName
required
string [ 1 .. 35 ] characters

Name of the identification scheme.

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.

imageSequence
Array of strings (FileName) [ items <= 255 characters ^[a-zA-Z0-9_\- ]+\.[a-zA-Z0-9]+$ ]
Example: ["image003.png"]

Series of images that are related and sequentially ordered.

Array of objects (GenericCode)

Codes to classify the check. Possible code names: AccountCode

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

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

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
printer
string

Check printer used.

Responses

Request samples

Content type
application/json
{
  • "transactionType": "Cash",
  • "amount": "100",
  • "exchange": {
    },
  • "check": {
    }
}

Response samples

Content type
application/json
{
  • "paymentId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "reversalIndicator": true,
  • "remittanceInformation": {
    },
  • "identifiers": [
    ],
  • "valueDate": "2022-04-17T08:00:00Z",
  • "bookingDate": "2022-04-17T08:00:00Z",
  • "charges": [
    ],
  • "interests": [
    ],
  • "transactionId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "creationDate": "2022-04-17T08:00:00Z",
  • "amount": "100",
  • "creditDebitIndicator": "Credit",
  • "description": "This is a description.",
  • "descriptionLines": [
    ],
  • "status": "Booked",
  • "statusDescription": "This is a Title.",
  • "codes": [
    ],
  • "supplementaryData": { },
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "balances": [
    ],
  • "transactionDates": [
    ],
  • "postingType": "HardPosted",
  • "check": {
    },
  • "cash": {
    },
  • "dispenser": "string",
  • "card": {
    }
}

Creates a Debit Transaction

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

Account Identification

query Parameters
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
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

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

Account Servicer Identification (Bank)

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Request Body schema: application/json
transactionType
string (WithdrawalTransactionType) [ 1 .. 35 ] characters
Example: "Cash"

Type of Debit Transaction: Cash, MemoPosted.

amount
required
string (Amount) <= 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 values are: CustomerCheque, CertifiedCustomerCheque, BankCheque, Draft, ElectronicDraft.

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

Check amount

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

Check currency

checkNumber
string <= 35 characters

The number on the face of the check indicating the id of that check in a series.

issuer
string
Example: "Jhon Smith"

Party that issued the check.

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

availabilityFloat
string

It refers to the time delay between when a check is deposited and when the funds become available for withdrawal. Possible Values: ImmediateWithdrawal, LocalCheck, NonLocalCheck

Array of objects (GenericIdentification)

Check identifiers. Possible scheme names: Reference.

Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification.

schemeName
required
string [ 1 .. 35 ] characters

Name of the identification scheme.

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.

imageSequence
Array of strings (FileName) [ items <= 255 characters ^[a-zA-Z0-9_\- ]+\.[a-zA-Z0-9]+$ ]
Example: ["image003.png"]

Series of images that are related and sequentially ordered.

Array of objects (GenericCode)

Codes to classify the check. Possible code names: AccountCode

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

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

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
printer
string

Check printer used.

Responses

Request samples

Content type
application/json
{
  • "transactionType": "Cash",
  • "amount": "100",
  • "check": {
    }
}

Response samples

Content type
application/json
{
  • "paymentId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "reversalIndicator": true,
  • "remittanceInformation": {
    },
  • "identifiers": [
    ],
  • "valueDate": "2022-04-17T08:00:00Z",
  • "bookingDate": "2022-04-17T08:00:00Z",
  • "charges": [
    ],
  • "interests": [
    ],
  • "transactionId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "creationDate": "2022-04-17T08:00:00Z",
  • "amount": "100",
  • "creditDebitIndicator": "Credit",
  • "description": "This is a description.",
  • "descriptionLines": [
    ],
  • "status": "Booked",
  • "statusDescription": "This is a Title.",
  • "codes": [
    ],
  • "supplementaryData": { },
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "balances": [
    ],
  • "transactionDates": [
    ],
  • "postingType": "HardPosted",
  • "check": {
    },
  • "cash": {
    },
  • "dispenser": "string",
  • "card": {
    }
}

Retrieves Account Transactions

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

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, MemoPosted, HardPosted, Cleared.

amount.lte
string (Amount) <= 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 (Amount) <= 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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
{
  • "accountId": "033-DDA-123456",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "ownershipType": "SingleOwnerAccount",
  • "currency": "USD",
  • "currentBalance": "100",
  • "availableBalance": "100",
  • "count": 0,
  • "transactions": [
    ]
}

Products

Financial Product Management

Retrieves Financial Products

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

Account Servicer Identification (Bank)

Responses

Response samples

Content type
application/json
{
  • "productId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "pricingStrategyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "name": "Visa Business Card",
  • "description": "This is a description.",
  • "productType": "PaymentCard",
  • "productSubType": "BusinessCard",
  • "restrictions": [
    ],
  • "projectedDates": [
    ],
  • "limits": [
    ],
  • "charges": [
    ],
  • "parties": [
    ],
  • "status": "GoodStanding",
  • "statusDateAndTime": "2022-04-17T08:00:00Z",
  • "codes": [
    ],
  • "supplementaryData": { }
}

Creates a bank product

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

Idempotency identifier used by the client when making repeated calls

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

Account Servicer Identification (Bank)

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

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

Core-Validation-Mode
string

<ENFORCING|PERMISSIVE|DISABLED> Indicates how the API validates requests against the core validation request policy. ENFORCING: The API validates all requests against the core validation request policy. The API only sends requests that pass validation to the back-end core service. PERMISSIVE: The API validates all requests against the validation request policy. The API sends all requests to the back-end service, regardless of whether they pass or fail the core validation. DISABLED: The API does not validate any requests against the validation request policy. The API gateway sends all requests to the core back-end service.

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

Identification of the account servicer institution at branch level or center level. To overlay the codes to produce a unique identifier the following expresion is used: BranchRegionCode-BranchSubdivisionCode.

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

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

accountType
required
string [ 1 .. 60 ] characters
Example: "Checking"

Type of the account. Some possible ISO 20022 compliant values are: Checking, CardAccount, CashPayment, Charges, CashIncome, Commission, ClearingParticipantSettlementAccount, LimitedLiquiditySavingsAccount, MarginalLending, MoneyMarket, NonResidentExternal, Overdraft, OverNightDeposit, Settlement, Salary, Savings, Tax, TransactingAccount, CashTrading, VirtualAccount, CreditCard, DebitCard, Universal, Investment, EpurseCard, CertificateOfDeposit, MoneyMarketChecking, RetirementAccount, RetireeReimbursementAccount, StockOrBond, PrePaid, FleetCard, Cash, DebitAccount, CreditAccount, Benefit, HealthSavingsAccount, FlexibleSpendingAccount, ForBenefitOf, Estate, ClientTrustAccount, LawyersTrustAccount, KeoghPlanAccount, UniformTransfersToMinorsAct, UniformGiftsToMinorsAct, ReserveFunds, SelfDirectedBrokerage, IRA, Annuity, ExternalAccount, Loan, CommercialLoan, MortgageLoan, SafeDepositBox.

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
number
string [ 1 .. 40 ] characters

Identification assigned by an institution or internally to connect to other applications.

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

Name of the identification scheme, in PascalCase. Possible ISO 20022 compliant values names are: IssuerIdentificationNumber, BBANIdentifier, CHIPSUniversalIdentifier, UPICIdentifier, IBANIdentifier. Other possible values: CreditBackIdentification, UniversalLoanIdentifier, HMDAUniversalLoanIdentifier, CommitmentNumber, RecordNumber, FlexDataRecordNumber, RegistrationNumber, ExternalAccountId, MortgageNumber, DepartmentNumber.

issuer
string [ 1 .. 35 ] characters

Entity that assigns the identification.

securedIndicator
boolean

Indicates whether the Account is secure.

securedType
string (SecuredAccountType) [ 1 .. 17 ] characters
Example: "Collateral"

Indicates how the account is secured. Possible Values: Collateral, Agent

object (AccountPaymentDetails)

Account payment information.

numberOfPayments
integer

Number of payments.

object (RepaymentSchedule)

Generic transaction code definition.

Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

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

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects (PaymentIdentification)
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

object (Repayment)

Generic transaction code definition.

Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

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

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

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

Identification of the Payment.

reversalIndicator
boolean (ReversalIndicator)

Indicates whether or not the transaction is the result of a reversal. Usage: This element should only be present if the entry is the result of a reversal. If the CreditDebitIndicator is Credit and ReversalIndicator is Yes, the original operation was a debit entry. If the CreditDebitIndicator is Debit and ReversalIndicator is Yes, the original operation was a credit entry.

object (RemittanceInformation)

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system.

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

Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit entry. Usage: If entry status is pending and value date is present, then the value date refers to an expected/requested value date.

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

Date and time when an entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.

Array of objects (TransactionCharge)

All charges and taxes applied to the transaction. Also can include interests if the bank does not discrimate between them.

Array of objects (TransactionInterest)

All interests included in the transaction amount.

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

Original date on which the payment was posted to the account.

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

Amount payed.

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

Date of the billing cycle for the account.

paymentReason
string (PaymentPurpose) [ 1 .. 60 ] characters
Example: "CashManagementTransfer"

Underlying reason for the payment transaction. Possible Values: Allowance, LoanPrincipal, CashManagementTransfer, LoanStandardPayment, LoanPayment, LoanAdditionalPayment, LoanInterest, OverageInterest, OveragePrincipal, EscrowPayment, FeePayment.

paymentName
string [ 1 .. 35 ] characters

Human readable pascal case identifier of the payment concept. Possible values: CurrentLoanNextPayment.

object (RepaymentSchedule)

Generic transaction code definition.

Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

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

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects (PaymentIdentification)
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

object (RepaymentSchedule)

Generic transaction code definition.

Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

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

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects (PaymentIdentification)
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

Array of objects (Repayment)

All the payments done, scheduled or not.

Array
Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

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

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

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

Identification of the Payment.

reversalIndicator
boolean (ReversalIndicator)

Indicates whether or not the transaction is the result of a reversal. Usage: This element should only be present if the entry is the result of a reversal. If the CreditDebitIndicator is Credit and ReversalIndicator is Yes, the original operation was a debit entry. If the CreditDebitIndicator is Debit and ReversalIndicator is Yes, the original operation was a credit entry.

object (RemittanceInformation)

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system.

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

Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit entry. Usage: If entry status is pending and value date is present, then the value date refers to an expected/requested value date.

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

Date and time when an entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.

Array of objects (TransactionCharge)

All charges and taxes applied to the transaction. Also can include interests if the bank does not discrimate between them.

Array of objects (TransactionInterest)

All interests included in the transaction amount.

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

Original date on which the payment was posted to the account.

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

Amount payed.

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

Date of the billing cycle for the account.

paymentReason
string (PaymentPurpose) [ 1 .. 60 ] characters
Example: "CashManagementTransfer"

Underlying reason for the payment transaction. Possible Values: Allowance, LoanPrincipal, CashManagementTransfer, LoanStandardPayment, LoanPayment, LoanAdditionalPayment, LoanInterest, OverageInterest, OveragePrincipal, EscrowPayment, FeePayment.

paymentName
string [ 1 .. 35 ] characters

Human readable pascal case identifier of the payment concept. Possible values: CurrentLoanNextPayment.

object (Frequency)

How often principal payments are due.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

object (Frequency)

How often interest payments are due.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

draftDayAdjuster
integer <= 31
Example: 30

Number of days before or after an automatic payment is debited from an account.

automaticIndicator
boolean

Indicates whether, prior to the loan going past due, a payment is automatic generated.

paymentType
string (PaymentType) [ 1 .. 35 ] characters
Example: "OnUs"

Specifies the type of Payment. Possible values: LiquidityTransfer, OnUs, ACH, Wire, NotOnUs.

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

First payment date

object (RepaymentBillDetails)

Billing information of the payment

billingOption
string <= 60 characters

AutomaticPayment, LumpSumPayment, NegotiatedBillingOptio, AcceleratedBillingOption.

billingDay
integer <= 31
Example: 30

Identifies the day of the month that billing statements are generated.

rebillStatus
string (RepaymentBillStatus) [ 1 .. 40 ] characters
Example: "RebillRequest"

Indicates whether a payment will be recalculated, rebilled and notified to the customer. Possible values: NoRequest, RebillRequest, ReNotifyCustomer.

rebillInterestIndicator
boolean

Indicates whether interest will be rebilled when transactions occur during the forecast period.

leadDays
integer

Identifies the time between creating a receivable and the due date.

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

The statement date interest was billed.

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

The due date of the next interest payment due that is not past due.

object (Frequency)

How often principal payments are billed.

Array of objects (Balance)

Bill balances

object (AccountPayout)

Distribution of funds or assets to an individual or entity. In relation to investments, loans, insurance policies, and retirement accounts.

object (Frequency)

Indicates the schedule for paying to accounts.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

paymentType
string (AccountPaymentMethodType) [ 1 .. 35 ] characters
Example: "Compound"

Specifies the type of interest payment. Possible values are: Compound, Checking, Savings, Check, Capitalize, TransferToAccount, CertificateOfDeposit, Deposit, DepositLoan, Loan.

paymentTypeOptions
Array of strings
Example: ["Primary"]
paymentName
string [ 1 .. 35 ] characters

Human readable pascal case identifier of the payment concept. Possible values: CreditBack, Interest.

accountId
string [ 1 .. 300 ] characters
Example: "033-DDA-123456"

The account id that receives interest credits.

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

The reference number of the interest pay to the account.

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

Last payment date

lastPaid
string (PositiveAmount) <= 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

Array of objects (GenericCode)

Additional payment codes. Posible values: PaymentCalculus, specifies how the credit back portion of an automatic service charge is calculated. PaymentReference, additional payment reference to link with other parts of the system.

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

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

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
payoutType
string (AccountPayoutType) [ 1 .. 35 ] characters

Account payout can be classified into two main categories: immediate and deferred. Possible Values: Immediate, Deferred.

payoutName
string (AccountPayoutName) [ 1 .. 35 ] characters
Example: "ClubPay"

Payout nature of the Account. Possible Values: ClubPay.

payoutOption
string (AccountPayoutOption) [ 1 .. 35 ] characters

Distinguishes options in payouts products. Possible values: Fixed, Variable

amount
string (PositiveAmount) <= 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

enableIndicator
boolean

Indicates whether the account payouts are disbursed or not.

payoutsNumber
integer

Total number of payouts

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

Cash surrender value (net) available if contract is surrendered

changePercentage
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Percentage of the accumulated value to be paid to the payee each year.

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

Amount of the accumulated value to be paid to the payee each year.

object

Duration of payout frequency

unit
required
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 (Balance)
Array
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

balanceName
string (BalanceName) [ 1 .. 50 ] characters
Example: "Available"

Specifies the nature of the balance. Possible values: Current, Available, Pending, Opening, Blocked, Previous, RelatedBalance, OnHold, PendingLedger, Collected, LastAnniversary, CurrentAccrued, PreviousAccrued, CurrentWithLastCalculus, CarriedAdjustment, PaidWithPenalties, Accrued, Penalty, Fees, Withholding, CollectionLedger, LastLedger, CurrentLedger, Ledger, MinimumAvailable, MinimumLedger, Withheld, CurrentBooked, CurrentBook, LastDeposit, FloatAmount, Average, RegulationDDAvailable. Loan Balances: CashProceeds, the amount that a customer actually received, exclusive of insurance premiums, fees, and unearned discount; FinancedExpenses, indicates the amount of expenses an institution has financed for a borrower; TotalInterest; AdditionalInterest, if the date of the first payment is beyond one month from the note date, the interest for the odd days will be earned during the first interest period; DeferredUnsecuredPrincipal, is the outstanding balance of an unsecured debt. The DUPB includes any accrued interest that is yet to be paid by the borrower. The deferral typically occurs due to bankruptcy or debt relief proceedings, which temporarily halt collection efforts by the original creditor; Charge Balances: Earned, RealTimeDeliveryMaximum, Current, Financed, Prepaid, CurrentEarned, CurrentEarnedOtherEscrow, InterestPaidToDate, InterestPaidThisYear, InterestPaidPreviousYear, InterestPaidLastStatement, InterestPaidThisYear, RevolvingCreditPaid, BasePaidToDate, TotalPastDue, Escrow, AppliedEscrow, UnpaidEscrow, EscrowBucket, Principal, Interest, Fees, BilledFees, OtherEscrow, FinalAmount, FinalInterestAmount, Chapter4PreviousYear, Payments: Delinquent, FixPayment, Transaction, LoanPayOff, PrincipalAndInterest, AvailableCash, AvailableCheck, AvailableCredit, Sweep, Float, MemoLedger, Memo, AvailablePending, LedgerPending.

amount
string (Amount) <= 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

count
integer

Number of transactions added to the amount.

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 (GenericCode)

Bank defined codes to classify balances. Possible values: BalanceCategory, BalanceType, PartyAgreementNumber.

ownershipType
required
string (AccountOwnershipType) [ 1 .. 100 ] characters
Example: "SingleOwnerAccount"

Specifies the type of account ownership. Possible ISO 20022 compliant values names are: JointAccountWithSurvivorshipRights, JointAccountWithSurvivorshipRightsPayableOnDeath, JointAccountInCommon, CustodialAccount, FinancialInstitution, SingleOwnerAccount, JointAccount, JointAnd, Corporation, Organization, Business, FormalPartnership, FormalTrust, Nominee, NonProfitOrganization, NotForProfitOrganization, ForProfit, EUResidualEntity, USGovernmentOrganization, NonUSGovernmentOrganization, GovernmentOrganization, LimitedLiabilityCompany, RegisteredInvestmentCompany, Entrepreneurial, Unincorporated, LimitedPartnership, LimitedLiabilityPartnership, BareOwner, Usufructuary, Fiduciary, ServicerEmployeeAccount, BusinessTrust, FamilyTrust, Estate, PublicFunds, NonUSGovernmentOrganization, Church, Club. More general possible values: Direct, Indirect, ConvenienceAccount, CommunityProperty, CommunityPropertyWithSurvivorshipRights, TottenTrust, PayableOnDeath, UniformTransfersToMinorsAct, UniformGiftsToMinorsAct, InTrustFor, RepresentativePayee, ProfessionalAssociation.

balanceType
string (Balance Type)
Example: "Asset"

Account Balance Type. Possible Values: Asset, positive transaction amount increases balance; Liability, positive transaction amount decreases balance; Equity.

productId
string (ProductId) [ 1 .. 36 ] characters
Example: "PD_CA_0002"

Identification of the product offered by a financial institution to its customers.

pricingStrategyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
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 (Amount) <= 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

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

Initial desposit date

object (AccountContract)

Account contractual details between the owners and the account servicer.

documentReference
string [ 1 .. 35 ] characters

Document location.

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

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

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

object (Jurisdiction)

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

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

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

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

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

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

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

object (ContactDetails)

Specifies the contact details of a person.

object (StructuredName)

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

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

Preferred name to contact the person

firstContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
lastContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (Phone)
Array of objects (Email)
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 Organization or building.

Array of objects (CommunicationChannel)
preferredMethod
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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, Default.

object (AccountContractRelatedParty)
partyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
partyType
string (PartyType)
Example: "Person"

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

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.

agreementType
string (AgreementType)

Document or agreement type. Possible values: CardAgreement, AccountContract.

agreementSubtype
string [ 1 .. 60 ] characters

Agreement detailed category.

documentId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
Array of objects (GenericIdentification)

Unique indentification of the collateral. Possible scheme names: NoteNumber.

Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification.

schemeName
required
string [ 1 .. 35 ] characters

Name of the identification scheme.

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.

status
string (AccountContractStatus) [ 1 .. 35 ] characters
Example: "Active"

Specifies the current status of an account contract. Possible values are: Active, Expired, GracePeriod, Terminated, Waiver.

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 (MasterAgreement)

A master agreement is a document that outlines the terms and conditions of an agreement between two or more parties. It's common to use a master agreement when there are multiple agreements in place with one company.

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

Account at Master Agreement level used as a reference for the Loan opening. Payments are auto-debited from this account.

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

Account at Master Agreement level used as a reference for the Loan opening. Payments are auto-debited from this account.

documentReference
string [ 1 .. 35 ] characters

Document location.

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

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

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

object

The payment term for the account premium.

object (TemporalDuration)

Describes a temporal duration.

timesExtended
integer <= 100

The number of times the loan has been extended over its term.

timesRenewed
integer <= 100

The number of times the loan has been renewed over its term.

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

Amount of the customer premium.

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

Total amount of money the user is insured for.

productId
string (ProductId) [ 1 .. 36 ] characters
Example: "PD_CA_0002"

Identification of the product offered by a financial institution to its customers.

Array of objects (GenericCode)
Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

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

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
Array of objects (SpotDate)

Contract dates. Possible values: LossMitigation

Array
name
string (SpotDateName) [ 1 .. 40 ] characters
Example: "Expiration"

Possible values por projected dates: Forecast, Expiration, LastNonFinancial, Escheat. Possible values for past dates: IRALastRollOver. Other possible values: EffectiveDate, ResponseByDate.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
required
Array of objects (AccountDetailedParty)
Array
Array of objects (GenericIdentification)
Array of objects (GenericCode)

Codes to link the party with other systems or to classify the party. Possible values: RemoteDepositRisk.

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.

nameTemplateId
string (NameTemplateId) [ 1 .. 36 ] characters
Example: "1"

Template used to display the party name. This is an external id provided by the account servicer.

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.

object (PlaceAndDateOfBirth)

Date and place of birth of a person.

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

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

status
string (PartyStatus) [ 1 .. 35 ] characters
Example: "GoodStanding"

Specifies the current primary status of a party. Possible values are: GoodStanding, FraudAlert, BadCustomer, Active, Delinquent, Default, HighRisk, UnderReview, HotCarded, WildCarded. Other possible values: PersonalBankruptcy, GrowingConcern, WatchLoan, InReceivership, Chapter11, Liquidation.

statusDateAndTime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
coveredByMilitaryLendingActIndicator
boolean

Indicates if the borrower is covered under the Military Lending Act.

militaryMemberIndicator
boolean

Indicates whether the person is is service member/military.

object (DateTimePeriod)
object (Employment)
object (Audit)

Resource Audit Information. Captures the creation, modification and maintenance details.

Array of objects (PostalAddress)
object (StructuredName)

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

Array of objects (Phone)
organizationType
string (OrganizationType)
Example: "Corporation"

Specifies the legal standing of the organization. Possible values are: Government, NonGoverment NonUSGovernmentOrganization, USGovernmentOrganization FinancialInstitution, SoleProprietorship, UnincorporatedAssociation, LimitedLiabilityPartnership, LimitedLiabilityCompany, SingleMemberLimitedLiabilityCompany, LimitedPartnership, FormalPartnership, GeneralPartnership, Business, Corporation, NotForProfit, ForProfit, NonProfitCorporation, NonProfit, Club, Supranational, Sovereign, Municipal, Province, State, County, National, ExemptionTrust, LivingTrust, EmployeeTrust, RevocableTrust, IrrovocableTrust, NakedTrust, FamilyTrust, BussinesTrust, CliffordTrust, FormalTrust, PublicAgency, Association, Church, PublicFunds. International & Foreign Business Entities: PersonaFisica, SociedadCivil, SociedadAnonimaCapitalVariable, SociedadResponsabilidadLimitada, SociedadAnonimaCapitalVariable.

customerType
string (CustomerType)
Example: "Consumer"

A customer type of a bank account can be classified into different categories based on the account's features, purpose, and benefits. Possible Values: Personal, Business, Consumer, Organization, ThirdParty, Estate, Employee, ForeignConsumer.

taxReportingIndicator
boolean

Account tax reporting typically involves obtaining and submitting records related to your tax obligations. For individuals, this may include income, qualifying deductions, and investment gains or losses. Businesses, on the other hand, have additional complexities, such as tracking funds directed towards specific business expenses and shareholders.

taxStatus
string
Example: "Exempt"

Exempt, Retain, ExemptExpired, VoluntaryWithholding, Chapter3, Chapter4, C-Corp, S-Corp, Certified, W-8Required, NotCertified.

Array of objects (PaymentCardDescriptor)
Array of objects (Balance)

Balances related to the party

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

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

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

Type of the account party role. Some possibles values are: Comaker, Cosigner, AccountOwner, AccountSigner, ATMDebitCardHolder, CreditCardHolder, LiquidityManager, Endorser, 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, Minor, Nominee, SecondaryOwner, Executor, Beneficiary, PrimaryServicerOfficer, SecondaryServicerOfficer, AccountOpenningOfficer, CustomerServiceOfficer, PowerOfAttorney, ContingentBeneficiary, Fiduciary, ControlPerson, AuthorizedPerson, Dealer, DoingBusinessAs, Grantor, SecondaryTrustee, RepresentativePayee, RestrictedOwner.

partyAccountRoleCode
string
Example: "50"

Bank defined party account role.

beneficiaryPercentage
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Percentage value of the ownership that the party has in the account.

beneficiaryAmount
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Actual dollar amount of the liability for this account.

accountOwnerRelation
string [ 1 .. 40 ] characters
Example: "PrimaryServicerOfficer"

Identifies how the party is related to the owner of the account.

Array of objects (Restriction)

Party restrictions on the account capabilities

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)
Example: "SubAccount"

Account relation role. Possible values are: Parent, EscrowAccount, SubAccount, ControlAccount, CrossAccount, ChargeAccount, AssociatedAccount, IRAAccount, CombinedStatement, SecondaryCombinedStatement, SummaryAccount, FundingSource, CompensatingAccount. Payment related values: Authorized, Counterpart

accountId
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

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

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

accountType
string (RelatedAccountType) [ 1 .. 60 ] characters
Example: "Checking"

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

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.

productId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
Array of objects (GenericCode)

Account related codes

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

Account used as a reference for the account opening.

Array of objects (SpotDate)
Array
name
string (SpotDateName) [ 1 .. 40 ] characters
Example: "Expiration"

Possible values por projected dates: Forecast, Expiration, LastNonFinancial, Escheat. Possible values for past dates: IRALastRollOver. Other possible values: EffectiveDate, ResponseByDate.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
initialFundingSource
string (FundingSource) [ 1 .. 60 ] characters
Example: "CreditTransfer"

Source of funds for the account. Possible values: CreditTransfer, NewCustomer, FundsFromExistingCustomer

Array of objects (SpotDate)

Projected account dates. Possible values: AnticipatedPayOff.

Array
name
string (SpotDateName) [ 1 .. 40 ] characters
Example: "Expiration"

Possible values por projected dates: Forecast, Expiration, LastNonFinancial, Escheat. Possible values for past dates: IRALastRollOver. Other possible values: EffectiveDate, ResponseByDate.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (Restriction)
Array
name
required
string [ 1 .. 60 ] characters
Example: "WireTransferIn"

Name of the restriction in PascalCase. Possible values: TransferIn, TransferOut, WireTransferIn, WireTransferOut, ACHTransferIn, ACHTransferOut, ForeignIncomingWires, ForeignOutgoingWires, ACHTransfers, InternetBankingTransfer, InternetView, InternetInquiry, ForeignOutgoingIran, Withdrawals, Renew, Transfers, AdvanceTransfer, OnlineBanking, ElectronicBanking, InvestmentAllowed, InvestmentSetUpAllowed, DebitCardAllowed, CheckOrderAllowed, AutomaticSweep, AccountManagement

restrictionPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
enableIndicator
boolean
Example: true

Indicates whether the capability is allowed or not.

disableConditions
Array of strings (ConditionName) [ items [ 1 .. 36 ] characters ]
Example: ["LessThanMinAmount"]

Conditions that disabel the restriction.

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.

status
string (RestrictionStatus) [ 1 .. 36 ] characters
Example: "Pending"

Specifies the status of a restriction enablement request. Possible values: Enable, Pending, InquiryOnly, Disable, Requested.

Array of objects (Limit)
Array
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

name
required
string [ 1 .. 60 ] characters
Example: "CreditLimit"

Name of the limit in PascalCase. Possible values: NSF, UncollectedFunds, Overdraft, CreditLimit, CreditCard, Withdraw, CreditCardWithdraw, ForeignFeesWaived, CreditTransactions, DebitTransactions, ATMSurchargeReimbursement, CashAdvance, ACHInTransfers, ACHOutTransfers, OverdraftProgram, Threshold, MinimumTransfer, MinimumAdvance, DomesticWireTransferIn, DomesticWireTransferOut, ForeignWireTransferIn, ForeignWireTransferOut.

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

Specifies the type of risk management limit. Bilateral, NetBilateral, IndirectBilateral, Global, MandatoryBilateral, DiscretionaryBilateral, DirectDebit, SingleCustomerDirectDebit, SingleFinancialInstitutionDirectDebit, TotalDailyCustomerDirectDebit, TotalDailyFinancialInstitutionDirectDebit, AutoCollateralisation, UnsecuredCredit, ExternalGuarantee, Revolving, NotRevolving.

channelType
string [ 1 .. 30 ] characters

Channel type for which this limit applies. Possible values: OnlineATM, OfflineATM, ATM, SaleTerminal, : Check, ACHDebit, DebitCard, BillPayment.

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

Amount limit

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

Amount limit currency.

number
integer

Number limit.

enableIndicator
boolean
Example: true

Indicates whether the limit is enabled or not.

feesConsentIndicator
boolean
Example: true

Indicates that the institution received customer consent to assess fees when the limit is exceeded.

percentageIndicator
boolean

Indicates if the limit is calculated as a percentage.

percentage
string (Percentage) <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Value expressed as a positive or negative percentage, rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. total number of digits: 11 number of digits in fractional part: 10 Max Value: 100

temporaryIndicator
boolean
Example: true

Indicates whether the limit is temporary or not.

object (DateTimePeriod)
object (Frequency)

Renewal frequency

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

Amount limit used

usedNumber
integer

Number limit used.

usedPercentage
string (Percentage) <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Value expressed as a positive or negative percentage, rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. total number of digits: 11 number of digits in fractional part: 10 Max Value: 100

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

Specifies the current status of a limit. Possible values are: Enabled, Disabled, Deleted, Requested, NotAuthorized (The limit is not authorized by the customer). Other values: CustomerEnrolled, CustomerNotEnrolled, InstitutionEnrolled.

statusDateAndtime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
object (LimitHistory)

Historic values of a Limit

Array of objects (Balance)
Array of objects (GenericCode)

Additional limits codes.

accessConditions
Array of strings (ConditionName) [ items [ 1 .. 36 ] characters ]
Example: ["LessThanMinAmount"]

Limit access condition. Possible values: BeforeTransfers, AfterTransfers: Overdraft Limit is accessed before or after automatic transfers. Other values: POSTransactions, ATMTransactions, when the customer authorize the payment of ATM or POS transactions, if the transaction was to overdraw the account.

notificationOptions
Array of strings
Example: ["Exception"]
Array of objects (AccountPayment)

Payments methods to cover the amount limit overdraft.

object (FinancialStatement)

Specifies financial statement details.

object (Frequency)

The frequency of the regular statement.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

object (Frequency)

The next frequency of the regular statement.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

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

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

Array of objects (StatementCommunicationChannel)
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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

Communication value such as phone number or email address.

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

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

printOnNextCycleIndicator
boolean

Indicates whether the statement will be produced at the end of the next statement cycle.

Array of objects (GenericCode)

Codes to determine configurarion options for alerts and notifications. Possible code names: NoticeOption.

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

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

Array of objects (GenericCode)

Codes related to statements or internal handling codes associated with the statement. Possible Values: CombinedCode, SpecialStatement, DetailsFormat, StatementGroup, ProfitabilityOption.

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

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

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
Array of objects (GenericIdentification)

Identification of statement instances and related. Possible values: schemeName: LastCombinedStatement, CombinedStatementAccountId

Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification.

schemeName
required
string [ 1 .. 35 ] characters

Name of the identification scheme.

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.

templateCode
string (StatementTemplateId) [ 1 .. 36 ] characters
Example: "1"

Template used to create the statement document. This is an external code provided by the account servicer.

object (Period)
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

object (Period)
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

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

The date of the last statement.

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

The date of the next statement.

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

The date on which service charges will be applied to an account

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

The date of the statement previous from the last.

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

The date of the last regular statement.

truncationOptions
Array of strings
Example: ["ItemsIncluded"]
accountNameIndicator
boolean

Indicates whether the account name is printed on the statement.

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, Default.

combineType
string [ 1 .. 36 ] characters
Example: "SavingsStatement"

Indicates whether account transactions are printed on a combined statement. Possible combinations: CheckingStatement, SavingsStatement, PrimaryAccount, SecondaryAccount.

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

profitabilityModelId
string (StatementModelId) [ 1 .. 36 ] characters
Example: "1"

Model used to calculate customer profitability. This is an external id provided by the account servicer.

lastIRAStatementDate
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 (InterestCalculation)
Array
name
string (InterestName) [ 1 .. 40 ] characters
Example: "Deposit"

Name in PascalCase of the interest that applies to the account. For instance, Deposit. Also identifications of the interest or charge.

interestCode
string <= 50 characters

Interest calculation code used by the account servicer.

dayCountBasis
string (InterestDayCountBasis) [ 1 .. 50 ] characters
Example: "Actual360"

An interest day count basis is a method used to calculate interest accrual over a period of time for loans and bonds. The method involves determining the number of days over which interest is being calculated, known as the accrual period. The resulting accrual period is then divided by a certain number to calculate the daily interest rate, which is applied to the principal balance to determine the interest payment. Possible Values: ActualActual, Actual360, Actual365, 365365, 360360, Monthly78ths, 365360, ActualSchedule, ScheduleSchedule.

calculationMethodOption
string (InterestComputationParameter) [ 1 .. 50 ] characters
Example: "LastInterest"

Specifies a parameter that apply at the interest day count basis. Possible Values: LastInterest, EqualPayment, InterestAndPrincipal, InterestSeparatedm, Amortized, AddOn, NegativeAmortization, Simple, FHLMC.

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

An accrued date is a hypothetical point in time when the interest should have been paid.

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

lastInterestDate
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

The period funds are earning interest.

enableIndicator
boolean
Example: true

Indicates whether the interest is enabled for automatic charge.

compoundingMethod
string [ 1 .. 35 ] characters
Example: "Deposit"

Indicates the compounding method used for interest calculations.

object (Frequency)

Frequency of the interest calculation and compounded during the term.

object (Frequency)

Specifies an event frequency

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

Total interest that has accumulated over a day.

object

Details on the interest payment.

Array of objects (Balance)

Total amounts related to an interest. Possible Values: CurrentEarned, 2021AsOfDate, 2020AsOfDate, 2019AsOfDate, CutOffAvailable, CutOffAverageAvailable, CutOffAverageLedger, CutOffAverageMinimumLedger, CutOffLedger, CutOffMinimumLedger

object (InterestRenewalDetails)

Detailed interest attributes related to rate change at maturity.

object (InterestCycle)

Set of parameters used to calculate an interest cycle.

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

The amount of automatic interest that was last posted to the account.

reportingIndicator
boolean

Identifies whether interest earned or paid is reportable.

reportingOptions
Array of strings (InterestReportingOption) [ items [ 1 .. 35 ] characters ]
Example: ["Deposit"]
object (TaxForm)

Information of the form requested by the tax payer.

object (Frequency)

The frequency used in calculating the Regulation DD Annual Percentage Yield (APY) when the financial institution requires interest to be withdrawn (i.e. compounding interest is not an option.) The Regulation DD Compound Frequency overrides the interest frequency only in computing the APY. For example, an account with interest paid monthly by check but disclosed as annual compounding.

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

Annual Percentage Yield (APY) is a measure used in finance to express the total return on an investment, taking into account both the interest earned and the appreciation in the investment's value, over a specified period. It is expressed as a percentage and is often used for fixed income securities such as bonds, and money market accounts.

daysSinceLastAnniversary
integer

The number of calendar days processed since the last anniversary date

Array of objects (InterestCalculationRate)

Rates involve on interest calculation.

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

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

rateTieredType
string (InterestTieredRateType) [ 1 .. 35 ] characters
Example: "Whole"

Specifies the type of tiered interest rate. Possible values: Whole, Split, Dynamic.

rateAmountType
string (BalanceName) [ 1 .. 50 ] characters
Example: "Available"

Specifies the nature of the balance. Possible values: Current, Available, Pending, Opening, Blocked, Previous, RelatedBalance, OnHold, PendingLedger, Collected, LastAnniversary, CurrentAccrued, PreviousAccrued, CurrentWithLastCalculus, CarriedAdjustment, PaidWithPenalties, Accrued, Penalty, Fees, Withholding, CollectionLedger, LastLedger, CurrentLedger, Ledger, MinimumAvailable, MinimumLedger, Withheld, CurrentBooked, CurrentBook, LastDeposit, FloatAmount, Average, RegulationDDAvailable. Loan Balances: CashProceeds, the amount that a customer actually received, exclusive of insurance premiums, fees, and unearned discount; FinancedExpenses, indicates the amount of expenses an institution has financed for a borrower; TotalInterest; AdditionalInterest, if the date of the first payment is beyond one month from the note date, the interest for the odd days will be earned during the first interest period; DeferredUnsecuredPrincipal, is the outstanding balance of an unsecured debt. The DUPB includes any accrued interest that is yet to be paid by the borrower. The deferral typically occurs due to bankruptcy or debt relief proceedings, which temporarily halt collection efforts by the original creditor; Charge Balances: Earned, RealTimeDeliveryMaximum, Current, Financed, Prepaid, CurrentEarned, CurrentEarnedOtherEscrow, InterestPaidToDate, InterestPaidThisYear, InterestPaidPreviousYear, InterestPaidLastStatement, InterestPaidThisYear, RevolvingCreditPaid, BasePaidToDate, TotalPastDue, Escrow, AppliedEscrow, UnpaidEscrow, EscrowBucket, Principal, Interest, Fees, BilledFees, OtherEscrow, FinalAmount, FinalInterestAmount, Chapter4PreviousYear, Payments: Delinquent, FixPayment, Transaction, LoanPayOff, PrincipalAndInterest, AvailableCash, AvailableCheck, AvailableCredit, Sweep, Float, MemoLedger, Memo, AvailablePending, LedgerPending.

pastDueOptions
Array of strings[ items [ 1 .. 70 ] characters ]

Indicates how the Past Due Rate is applied to past due loans. After a loan payment is past due after certain days, interest is earned retroactively from the payment due date.

Array of objects (VariableInterestChanges)
Array of objects (ChargeCalculation)
Array
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

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

Date and time at which the period ends.

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

Unique identifier of charge.

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

Name of the charge calculation in PascalCase. Possible values: Fee, Overdraft, CardLatePayment, CashAdvance, LatePayment, CashWithdrawal, EarlyWithdrawal, Dormant, EIM, NonSufficientFunds, ATM, BillPayment, FDIC, Overdraft, OverdraftInterest, OverdraftCourtesy, ReturnedItem, DeclinedCheck. Service Charge values: AutomaticActivityCharge, MaintenanceActivityCharge, MaintenanceServiceCharge. ServiceCharge, ServiceChargeCreditBack. Also other external codes to identify the charge.

status
string (ChargeStatus) <= 40 characters
Example: "Charged"

Specifies the current status of the charge. Possible values are: Charged, Waived, AnalysisAddenda, AddendaCharged, AddendaChargedOnCycleDay.

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

Amount charged for the service.

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

Charge currency

rate
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

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, 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, Fee, Insurance, NonTaxable, Recurring, Taxable.

exemptIndicator
boolean

Indicates whether the account is exempt of the charge.

exemptPeriodsNumber
integer

Indicates the number of charge periods that the account is exempt from charges.

Array of objects (GenericCode)

Additional charge codes. Possible values: CalculationCodeNumber, ServiceChargePrefix, ServiceChargeCode.

calculationMethodCode
string [ 1 .. 60 ] characters

Servicer charge calculation code in Pascal Case. Possible values: FIFO, older payment past due. LIFO, most recent payment past due. Also could be a Bank defined string.

calculationMethodOptions
Array of strings (ChargeCalculationMethodOption) [ items [ 1 .. 70 ] characters ]

Indicates other calculation method options for charge calculation.

options
Array of strings (ChargeOptions) [ items [ 1 .. 50 ] characters ]
Example: ["NSFDefault"]
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, Monthly, Annual, FullTerm, RemainingTerm, Monthly78th

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.

maximumNumber
integer

Maximum Number of charges.

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

Minimum amount of money asked or paid for the charge.

enableIndicator
boolean
Example: true

Indicates whether the charge is enabled for automatic charge.

object (InterestCalculationDescriptor)

Set of parameters used to calculate an interest.

debitIndicator
boolean

Indicates whether the charge is automatically debited from the defined account.

Array of objects (AccountPayment)

Payments methods to waive o to pay back the charge.

object (Frequency)

Specifies an event frequency

Array of objects (Balance)
description
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
Array of objects (Tax)
Array
taxType
string (TaxType) [ 1 .. 35 ] characters
Example: "TaxCredit"

Specifies the type of tax. Possible ISO values are: ValueAddedTaxOfZeroRate, Provincial, NationalTax, StateTax, WithholdingTax, CapitalGainTax, InterimProfitTax, StampDuty, WealthTax, InheritanceTax, SolidaritySurcharge, TaxCredit, Equalisation, GiftTax, ConsumptionTax, AlternativeMinimumTax, LocalTax, NationalFederalTax, PaymentLevyTax, StockExchangeTax, TransactionTax, TransferTax, ValueAddedTax, LocalBrokerCommission, ExecutingBrokerCommission, EUTaxRetention, Aktiengewinn1, Aktiengewinn2, Zwischengewinn, CustomsTax, Mietgewinn, GermanLocalTax3, GermanLocalTax4, GermanLocalTax2, WithholdingOfForeignTax, WithholdingOfLocalTax, CapitalLossCredit, FederalWithholding, StatelWithholding.

name
string (TaxName) [ 1 .. 60 ] characters
Example: "Sales"

Name of the tax in PascalCase. Possible values: Sales.

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

Rate applied on a basis amount to calculate the withholding.

debitIndicator
boolean

Indicates whether the tax is automatically debited from the defined account.

taxReportingIndicator
boolean

Flag to indicate that the tax should be reported to the party.

Array of objects (Balance)

Total amounts related to the tax type

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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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

Communication value such as phone number or email address.

channelPurpose
string (CommunicationChannelPurpose) [ 1 .. 40 ] characters
Example: "PrivacyNotices"

Communication purpose of the channel. Possible values: Alerts, PrivacyNotices, NegativeBalance, OverdraftProtection, ACHNotice, ChargeBack, BalanceOnReceipt, RegulationCCNotice, RateChange, MaturityNotice, InterestNotice, RegularNotice, PastDueNotice, HUDNotice, PaymentChange, AutomaticPayment, PastDueFirstNotice, PastDueSecondNotice, PastDueNoticeGuarantor, CardHolderAuthorization, Delivery, DocumentDistribution.

codeWord
string

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

alertIndicator
boolean

Indicates whether the channel is used for enterprise alerts to the customer.

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

The party authorized to use the communcation channel

Array of objects (GenericCode)

Codes to determine configurarion options for alerts and notifications. Possible code names: NoticeOption.

status
string (AlertStatus) [ 1 .. 35 ] characters
Example: "Warning"

Alert status. Possible values: Sent, SentLastNight, Pending, Enable, Disable, FraudAlert. Possible values for CreditBureauAlert: IdentityTheft.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

object

The lead time between the event and the alert notification.

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

Text to appear in alerts and notices.

Array of objects (SpotDate)
contactCount
integer

Number of contacts.

object (Frequency)

Specifies an event frequency

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

This id gives the ability to view a party’s total relationship with the bank. The relationship Id ties multiple parties and accounts together. This code is also used to reduce mailing costs during marketing campaigns to avoid sending duplicate materials to parties residing at the same address.

Array of objects (GenericAccountCode)
Array
name
string <= 50 characters
Example: "AccountingGroup"

Name of the code. Possible values are: AccountingGroup, CostCenter, DistributionGroup. Also values that may be overlayed on the identification: AccountSubtype, AccountType. Also MICR numbers: MicrAccountNumber, The account number portion of a draft or line of credit MICR line. Other possible values: TaxIncentiveType, Preferredlanguage, FundsDelayedReason, DeliveryMethod.

value
required
string [ 1 .. 35 ] characters
Example: "195"

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
object (AccountPrintOptions)
accountTitle
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
accountTitleOption
string (AccountTitlePrintOption) [ 1 .. 35 ] characters

Options to indicate the multiple lists of account owner names. Possible Values: TitleNotPrinted, TitlePrintsBeforeNames, TitlePrintsAfterNames

checkNameOption
string (CheckPrintOption) [ 1 .. 35 ] characters

Options to indicate the multiple lists of account owner names. Possible Values: JointAnd, JointOr.

balanceOnReceiptOverride
string (BalanceOnReceiptOptions) [ 1 .. 35 ] characters

Indicates whether the account balance is printed on teller terminal and ATM receipts. Possible Values: PrintWhenPositive, PrintWhenNegative, AlwaysPrint, NotPrint

nameIndicator
boolean

Indicates whether the account name is printed on account statements.

handlingLevels
Array of strings (PrintHandlingLevel) [ items [ 1 .. 35 ] characters ]
Array of objects (GenericPrintOption)
Array
name
string (PrintOptionName) [ 1 .. 35 ] characters

Name of the print Option. Possible Values: ACHTransaction

options
Array of strings (PrintOption) [ items [ 1 .. 35 ] characters ]
object (AccountBillDetails)

Billing information of the payment

billingDay
integer <= 31
Example: 30

Identifies the day of the month that billing statements are generated.

billOption
string
Example: "Individual"

Indicates whether billing occurs for the account at the company level (consolidated) or at the individual account level. Possible values: Consolidated, Individual.

Array of objects (Balance)

Bill balances

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

Date and time at which the period starts.

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

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

balanceName
string (BalanceName) [ 1 .. 50 ] characters
Example: "Available"

Specifies the nature of the balance. Possible values: Current, Available, Pending, Opening, Blocked, Previous, RelatedBalance, OnHold, PendingLedger, Collected, LastAnniversary, CurrentAccrued, PreviousAccrued, CurrentWithLastCalculus, CarriedAdjustment, PaidWithPenalties, Accrued, Penalty, Fees, Withholding, CollectionLedger, LastLedger, CurrentLedger, Ledger, MinimumAvailable, MinimumLedger, Withheld, CurrentBooked, CurrentBook, LastDeposit, FloatAmount, Average, RegulationDDAvailable. Loan Balances: CashProceeds, the amount that a customer actually received, exclusive of insurance premiums, fees, and unearned discount; FinancedExpenses, indicates the amount of expenses an institution has financed for a borrower; TotalInterest; AdditionalInterest, if the date of the first payment is beyond one month from the note date, the interest for the odd days will be earned during the first interest period; DeferredUnsecuredPrincipal, is the outstanding balance of an unsecured debt. The DUPB includes any accrued interest that is yet to be paid by the borrower. The deferral typically occurs due to bankruptcy or debt relief proceedings, which temporarily halt collection efforts by the original creditor; Charge Balances: Earned, RealTimeDeliveryMaximum, Current, Financed, Prepaid, CurrentEarned, CurrentEarnedOtherEscrow, InterestPaidToDate, InterestPaidThisYear, InterestPaidPreviousYear, InterestPaidLastStatement, InterestPaidThisYear, RevolvingCreditPaid, BasePaidToDate, TotalPastDue, Escrow, AppliedEscrow, UnpaidEscrow, EscrowBucket, Principal, Interest, Fees, BilledFees, OtherEscrow, FinalAmount, FinalInterestAmount, Chapter4PreviousYear, Payments: Delinquent, FixPayment, Transaction, LoanPayOff, PrincipalAndInterest, AvailableCash, AvailableCheck, AvailableCredit, Sweep, Float, MemoLedger, Memo, AvailablePending, LedgerPending.

amount
string (Amount) <= 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

count
integer

Number of transactions added to the amount.

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 (GenericCode)

Bank defined codes to classify balances. Possible values: BalanceCategory, BalanceType, PartyAgreementNumber.

object (Collateral)

Assets pledged by a debtor to secure a loan or an exposure and subject to seizure in the event of default.

collateralId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
value
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Value of the collateral as an amount.

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

The Ineligible Amount is a non-lien dollar amount that is subtracted from the Collateral Value or Net Appraised Value.

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

The collateral dollar amount that cannot be exceeded when calculating the Loan Amount.

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

The Collateral Net Appraised Value (CNAV) is a critical aspect of real estate appraisal and mortgage financing. It represents the difference between the fair market value (FMV) of the collateral and the outstanding mortgage debt on the property.

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

The date the property was last appraised.

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

The last time the collateral was reviewed.

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

The next time the collateral will be reviewed.

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

The price paid for the property.

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, Airplane, MachineTool, IndustrialEquipment, OfficeEquipment, ITEquipment, MedicalEquipment, EnergyRelatedEquipment, CommercialBuilding, ResidentialBuilding. IndustrialBuilding, OtherVehicle, OtherEquipment, OtherRealEstate, OtherGoodsOrInventory, Guarantee, OtherFinancialAsset, MixedCategories.

disposalCostPercentage
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Identifies disposal (selling) costs as a percentage of the Net Appraised Value and Collateral Value. Disposal costs are subtracted from the Net Appraised Value to calculate the net disposal value. The costs are also subtracted from the Collateral Value to calculate the net collateral value.

maximumLoanAmountPercentage
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

The percentage of the Collateral Value used to determine the Loan Amount. This percentage cannot be greater than 100.00%

marketMarginPercentage
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

A percentage subtracted from the Market Price to calculate the Collateral Value.

Array of objects (LoanCollateralRatioFormula)
Array
name
string

Name of the formula.

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

The ratio used to determine underwriting criteria of the property.

Array of objects (LoanCollateralLien)
Array
name
string

Name of the lien.

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

The amount of the lien.

Array of objects (GenericCode)

Codes to classify collaterals. Possible code names: MarketPricing, OwnerOccupied, PropertyType, Location.

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

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

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
numberOfUnits
integer

A collateral number of units refers to the number of individual properties that are being used as security for the loan.

object (Agreement)

Agreement between two trading parties that contains information about their relative duties and rights regarding collateral.

documentReference
string [ 1 .. 35 ] characters

Document location.

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

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

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

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

Date and time at which the period starts.

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

Date and time at which the period ends.

object (Jurisdiction)

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

object (ContactDetails)

Specifies the contact details of a person.

object (AccountContractRelatedParty)
agreementType
string (AgreementType)

Document or agreement type. Possible values: CardAgreement, AccountContract.

agreementSubtype
string [ 1 .. 60 ] characters

Agreement detailed category.

object

Postal address of the collateral residential building.

addressCode
string

This code is used to identify parties that share the same address or to associate an existing address with a specific party. Providing this code eliminates the need to separately enter the address details.

addressBookIndicator
string

If true, the address is kept in the system even if the person is no longer a customer.

addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible values are: PhysicalAddress, Postal, POBox, Residential, Permanent, Temporary, Alternative, Previous.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible values are: MailTo, DeliveryTo, Billing, Tax, ForeignTaxRecipient PlaceOfOperation, PlaceOfRegistration, placeOfFormation, Marketing, Statements, Business, Administrative, PreviousPlace, Headquarter, BranchStore, Branch, Property, Military, Secondary, Personal, Annex, Inquiry.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

careOf
string [ 1 .. 100 ] characters
Example: "C/O Company Name"

Identifies an addressee that is accepting the correspondence for the intended recipient. Using care of ensures the correspondence reaches the right recipient rather than getting returned to the sender.

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

Identification of a division of a large Organization or building.

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

Identification of a sub-division of a large Organization 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 Organization, where letters are kept until called for.

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

Building room number.

postCode
string (PostCode) [ 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. In US may consists of two parts: the five-digit ZIP Code '97062' and the ZIP+4 Code '6884'.

carrierRoute
string (CarrierRoute) [ 1 .. 4 ] characters
Example: "C001"

A Carrier Route is a designated geographic area assigned to individual postal carriers by the United States Postal Service (USPS) to facilitate efficient mail delivery within specific regions.

censusTract
string (CensusTract) = 5 characters
Example: "12345"

A census tract, census area, census district or meshblock is a geographic region defined for the purpose of taking a census

censusBlock
string (CensusBlock) = 4 characters
Example: "1234"

Census blocks are used to partition counties into smaller areas for the purpose of collecting and presenting census data.

cBSACode
string (CBSACode) = 5 characters
Example: "49780"

Core-based statistical area. Metropolitan statistical area (MSA) is the formal definition of a region that consists of a city and surrounding communities that are linked by social and economic factors. Micropolitan Statistical Areas (MISA) are CBSAs associated with at least one urban cluster that has a population of at least 10,000, but less than 50,000. The micropolitan statistical area comprises the central county or counties or equivalent entities containing the core, plus adjacent outlying counties having a high degree of social and economic integration with the central county as measured through commuting.

cBSAType
string (CBSAType) [ 1 .. 10 ] characters
Example: "MSA"

Type of Core-based statistical area. Possible values: MSA, MISA

foreignIndicator
boolean

Indicates whether the postal address is from a foreign country.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

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

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

Specific location name within the town.

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

Identifies a subdivision within a country sub-division.

countyName
string [ 1 .. 35 ] characters
Example: "Cook"

Identifies a county 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.

temporaryIndicator
boolean
Example: true

Indicates whether the address is temporary or not.

object

The period of use of the address information. Could be also used as a recurring anual period.

Array of objects (GenericCode)

Codes related to postal address or internal handling codes associated with the address. Possible Values: HandlingCode, HandlingCodeOption, AddressFormat.

Array of objects (GenericIdentification)

Postal address identifiers are used to identify parties that share the same address or to associate an existing address with a specific party. Possible scheme name values: AddressIdentifier.

Array of objects (GenericIdentification)

Unique indentification of the collateral. Possible scheme names: CollateralNumber, UCCFileNumber.

Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification.

schemeName
required
string [ 1 .. 35 ] characters

Name of the identification scheme.

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.

status
string (CollateralStatus) [ 1 .. 36 ] characters
Example: "Secured"

Specifies the collateral status. Possible Values: Secured, UnderSecured, OverSecured, Repossessed, PartiallySecured.

statusDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
descriptionLines
Array of strings[ items [ 1 .. 200 ] characters ]
Example: ["This is a description."]
collateralOwnershipId
string [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Specifies who is the owner of the collateral.

object (AccountContactDetails)

Specifies the contact details of a person.

object (StructuredName)

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

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

Person given first name.

middleName
string [ 1 .. 200 ] characters
Example: "Joe"

Person given middle name.

lastName
required
string [ 1 .. 200 ] characters
Example: "Smith"

Person surname.

middleInitial
string [ 1 .. 10 ] characters
Example: "J."

Person middle initial.

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. Generation order should be expressed with roman numerals: I, II, III, IV, V.

prefix
string [ 1 .. 20 ] characters
Example: "Dr."

Name prefixes are typically Dr., Mr., Mrs., Ms.

name
string [ 1 .. 350 ] characters
Example: "Jane Birkin"

Preferred name to contact the person

firstContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
lastContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (PostalAddress)
Array
addressCode
string

This code is used to identify parties that share the same address or to associate an existing address with a specific party. Providing this code eliminates the need to separately enter the address details.

addressBookIndicator
string

If true, the address is kept in the system even if the person is no longer a customer.

addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible values are: PhysicalAddress, Postal, POBox, Residential, Permanent, Temporary, Alternative, Previous.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible values are: MailTo, DeliveryTo, Billing, Tax, ForeignTaxRecipient PlaceOfOperation, PlaceOfRegistration, placeOfFormation, Marketing, Statements, Business, Administrative, PreviousPlace, Headquarter, BranchStore, Branch, Property, Military, Secondary, Personal, Annex, Inquiry.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

careOf
string [ 1 .. 100 ] characters
Example: "C/O Company Name"

Identifies an addressee that is accepting the correspondence for the intended recipient. Using care of ensures the correspondence reaches the right recipient rather than getting returned to the sender.

department
string [ 1 .. 70 ] characters
Example: "A"

Identification of a division of a large Organization or building.

subDepartment
string [ 1 .. 70 ] characters
Example: "B"

Identification of a sub-division of a large Organization 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 Organization, where letters are kept until called for.

room
string [ 1 .. 70 ] characters
Example: "22"

Building room number.

postCode
string (PostCode) [ 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. In US may consists of two parts: the five-digit ZIP Code '97062' and the ZIP+4 Code '6884'.

carrierRoute
string (CarrierRoute) [ 1 .. 4 ] characters
Example: "C001"

A Carrier Route is a designated geographic area assigned to individual postal carriers by the United States Postal Service (USPS) to facilitate efficient mail delivery within specific regions.

censusTract
string (CensusTract) = 5 characters
Example: "12345"

A census tract, census area, census district or meshblock is a geographic region defined for the purpose of taking a census

censusBlock
string (CensusBlock) = 4 characters
Example: "1234"

Census blocks are used to partition counties into smaller areas for the purpose of collecting and presenting census data.

cBSACode
string (CBSACode) = 5 characters
Example: "49780"

Core-based statistical area. Metropolitan statistical area (MSA) is the formal definition of a region that consists of a city and surrounding communities that are linked by social and economic factors. Micropolitan Statistical Areas (MISA) are CBSAs associated with at least one urban cluster that has a population of at least 10,000, but less than 50,000. The micropolitan statistical area comprises the central county or counties or equivalent entities containing the core, plus adjacent outlying counties having a high degree of social and economic integration with the central county as measured through commuting.

cBSAType
string (CBSAType) [ 1 .. 10 ] characters
Example: "MSA"

Type of Core-based statistical area. Possible values: MSA, MISA

foreignIndicator
boolean

Indicates whether the postal address is from a foreign country.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

Name of a built-up area, with defined boundaries, and a local government. Also city name.

townLocationName
string [ 1 .. 35 ] characters
Example: "Clackamas"

Specific location name within the town.

districtName
string [ 1 .. 35 ] characters
Example: "Columbia"

Identifies a subdivision within a country sub-division.

countyName
string [ 1 .. 35 ] characters
Example: "Cook"

Identifies a county 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.

temporaryIndicator
boolean
Example: true

Indicates whether the address is temporary or not.

object

The period of use of the address information. Could be also used as a recurring anual period.

Array of objects (GenericCode)

Codes related to postal address or internal handling codes associated with the address. Possible Values: HandlingCode, HandlingCodeOption, AddressFormat.

Array of objects (GenericIdentification)

Postal address identifiers are used to identify parties that share the same address or to associate an existing address with a specific party. Possible scheme name values: AddressIdentifier.

Array of objects (Phone)
Array
number
required
string (PhoneNumber) ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$
Example: "+1-555-1234567"

The collection of information which identifies a specific phone or FAX number as defined by telecom services.

extension
string <= 5 characters

Phone Number Extension.

country
string (CountryCallingCode) <= 3 characters

Country calling codes, country dial-in codes, international subscriber dialing (ISD) codes, or most commonly, telephone country codes. Country codes are defined by the International Telecommunication Union (ITU) in ITU-T standards E.123 and E.164. The prefixes enable international direct dialing (IDD).

phoneType
string [ 1 .. 35 ] characters

Type of phone address. Possible values are:
Mobile, Landline, Fax, Pager, Modem.

phonePurpose
string [ 1 .. 35 ] characters

Purpose of the phone address. Possible values are: Business, Personal, International, Alternative, PersonalInternational, BusinessInternational

foreignIndicator
boolean

Indicates whether is a foreign phone number

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

object (TimeOfTheDay)
comment
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
object

The period of use of the phone information.

Array of objects (GenericCode)
Array of objects (GenericIdentification)

Phone identifiers are used to identify parties that share the same phone or to associate an existing phones with a specific party. Possible scheme name values: PhoneIdentifier.

lastUpdatedDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
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, Business, Administrative, Personal

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

Array of objects (GenericIdentification)

Email identifiers are used to identify parties that share the same email or to associate an existing email with a specific party. Possible scheme name values: EmailIdentifier.

lastUpdatedDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
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 Organization or building.

preferredMethod
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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, Default.

object (AccountRenewal)

Information related to the account renewal

renewalType
string (AccountRenewalType) [ 1 .. 70 ] characters

The renewal type indicates whether an account automatically renews at maturity. Possible Values: NoTerm, indicates the account has no term; Automatic, indicates automatically renewal; SingleMaturity, indicates not automatically renewed; NoRenewalAllowed.

object (Frequency)

Renewal frequency

fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

cycle
string [ 1 .. 35 ] characters
Example: "Monthly"

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

rate
string <= 23 characters ^100|(([1-9][0-9]{0,1})([.][0-9]{0,8}){0,1})$...
Example: "25"

Account renewal rate.

productId
string [ 1 .. 36 ] characters
Example: "PD_CA_0002"

Renewal product

graceDays
integer

The time period when customer can cancel renewal

gracePeriodIndicator
boolean

Indicates whether the account is within the grace period.

lastRenewalDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (ServicerAlert)

Account alerts to be received by the account servicer.

Array
alertName
string (AlertName) [ 1 .. 35 ] characters
Example: "CreditBureauAlert"

Service alert human readable identifier in Pascal case. An alert notification received by the bank. Possible values: CreditBureauAlert, CustomerAlert, PaymentCard, LostBook, TwoSignaturesRequired, PledgedAsCollateral, DeathOnAccount, Bankruptcy, NoDisclosure, Caution, DuplicateBookIssued, PowerOfAttorney, DoNotReopen.

alertType
string (AlertType) [ 1 .. 35 ] characters
Example: "Warning"

An alert notification type. Possible values: Warning, Urgent, Teller.

alertCode
string [ 1 .. 36 ] characters

Service alert identifier or code, used to arrange multiple alerts and warnings in a sequence.

message
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
lastAlertDate
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.

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 (AccountHistory)

History attribute values.

originalOpenDate
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 (TemporalDuration)

Describes a temporal duration.

unit
required
string [ 1 .. 36 ] characters
Example: "Months"

Unit that describes the duration.

value
integer <= 999

Value of the duration in number of units.

originalMaturityDate
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.

lastMaturedDate
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 (AccountDetailedStatus)

Specifies the current state of an account.

statusName
string (AccountStatus) [ 1 .. 35 ] characters
Example: "Active"

Specifies the current primary status of an account. Possible values are: Enabled, Dormant, Disable, Deleted, Pending, Form. Pending, Denied, Review, Approve, ChargeOff, Active, PaymentPastDue, Bankruptcy, AuthorizationProhibited, InterestProhibited, Closed, Restricted, Assumed, New, ZeroBalanceAccount.

statusDateAndTime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
reason
string (StatusReason) [ 1 .. 36 ] characters
Example: "BlockedAccount"

Reason for the status. Possible Values: AbortedClearingTimeout, AbortedClearingFatalError, AbortedSettlementTimeout, AbortedSettlementFatalError,TimeoutCreditorAgent, TimeoutInstructedAgent, OfflineAgent, OfflineCreditorAgent, ErrorCreditorAgent, ErrorInstructedAgent, TimeoutDebtorAgent,IncorrectAccountNumber, InvalidDebtorAccountNumber,InvalidCreditorAccountNumber, ClosedAccountNumber,ClosedDebtorAccountNumber, BlockedAccount,ClosedCreditorAccountNumber, InvalidBranchCode,InvalidAccountCurrency, InvalidDebtorAccountCurrency,InvalidCreditorAccountCurrency, InvalidAccountType,InvalidDebtorAccountType,InvalidCreditorAccountType,AccountDetailsChanged, CardNumberInvalid, TransactionForbidden, InvalidBankOperationCode, TransactionNotSupported, InvalidAgentCountry, InvalidDebtorAgentCountry, InvalidCreditorAgentCountry, UnsuccesfulDirectDebit, InvalidAccessRights,PaymentNotReceived, AgentSuspended,CreditorAgentSuspended, NotAllowedBookTransfer, ForbiddenReturnPayment, IncorrectAgent, ZeroAmount, NotAllowedAmount, NotAllowedCurrency, InsufficientFunds, Duplication, TooLowAmount, BlockedAmount, WrongAmount, InvalidControlSum, InvalidTransactionCurrency, InvalidAmount, AmountExceedsClearingSystemLimit, AmountExceedsAgreedLimit, AmountBelowClearingSystemMinimum, InvalidGroupControlSum, InvalidPaymentInfoControlSum, InvalidNumberOfTransactions,InvalidGroupNumberOfTransactions, InvalidPaymentInfoNumberOfTransactions, LimitExceeded, ZeroAmountNotApplied, AmountExceedsSettlementLimit, InconsistenWithEndCustomer, MissingCreditorAddress, UnrecognisedInitiatingParty, UnknownEndCustomer, MissingDebtorAddress, MissingDebtorName, InvalidCountry, InvalidDebtorCountry, InvalidCreditorCountry, InvalidCountryOfResidence, InvalidDebtorCountryOfResidence, InvalidCreditorCountryOfResidence, InvalidIdentificationCode, InvalidDebtorIdentificationCode, InvalidCreditorIdentificationCode, InvalidContactDetails, InvalidChargeBearerCode, InvalidNameLength, MissingName, MissingCreditorName, AccountProxyInvalid, CheckERI, RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture, RequestedExecutionDateOrRequestedCollectionDateTooFarInPast, ElementIsNotToBeUsedAtB-andC-Level, MandateChangesNotAllowed, InformationOnMandateChangesMissing, CreditorIdentifierIncorrect, CreditorIdentifierNotUnambiguouslyAtTransaction-Level, OriginalDebtorAccountIsNotToBeUsed, OriginalDebtorAgentIsNotToBeUsed, ElementContentIncludesMoreThan140Characters, ElementContentFormallyIncorrect, ElementNotAdmitted, ValuesWillBeSetToNextTARGETday, DecimalPointsNotCompatibleWithCurrency, RequiredCompulsoryElementMissing, COREandB2BwithinOnemessage, ChequeSettledOnCreditorAccount, CreditorBankIsNotRegistered, IncorrectCurrency, RequestedByCustomer, DebtorBankIsNotRegistered,ElectronicSignaturesCorrect, OrderCancelled, OrderNotCancelled, OrderRejected, OrderForwardedForPostprocessing, TransferOrder, ProcessingOK, DecompressionError, DecryptionError, DataSignRequested, UnknownDataSignFormat, SignerCertificateRevoked, SignerCertificateNotValid, IncorrectSignerCertificate, SignerCertificationAuthoritySignerNotValid, NotAllowedPayment, NotAllowedAccount, NotAllowedNumberOfTransaction, Signer1CertificateRevoked, Signer1CertificateNotValid, IncorrectSigner1Certificate, SignerCertificationAuthoritySigner1NotValid, UserDoesNotExist, IdenticalSignatureFound, PublicKeyVersionIncorrect, DifferentOrderDataInSignatures, RepeatOrder, ElectronicSignatureRightsInsufficient, Signer2CertificateRevoked, Signer2CertificateNotValid, IncorrectSigner2Certificate, SignerCertificationAuthoritySigner2NotValid, WaitingTimeExpired, OrderFileDeleted, UserSignedMultipleTimes, UserNotYetActivated, InvalidDate, InvalidCreationDate, InvalidNonProcessingDate, FutureDateNotSupported, InvalidCutOffDate, ExecutionDateChanged, DuplicateMessageID, DuplicatePaymentInformationID, DuplicateTransaction, DuplicateEndToEndID, DuplicateInstructionID, DuplicatePayment, CorrespondentBankNotPossible, BalanceInfoRequest, SettlementFailed, SettlementSystemNotAvailable, ERIOptionNotSupported, InvalidFileFormat, SyntaxError, InvalidPaymentTypeInformation, InvalidServiceLevelCode, InvalidLocalInstrumentCode, InvalidCategoryPurposeCode, InvalidPurpose, InvalidEndToEndId, InvalidChequeNumber, BankSystemProcessingError, ClearingRequestAborted, PaymentTransferredAndTracked, PaymentTransferredAndNotTracked, CreditDebitNotConfirmed, CreditPendingDocuments, CreditPendingFunds, DeliveredWithServiceLevel, DeliveredWIthoutServiceLevel, CorrespondingOriginalFileStillNotSent, NoMandate, MissingMandatoryInformationInMandate, CollectionNotDue, RefundRequestByEndCustomer, EndCustomerDeceased, NotSpecifiedReasonCustomerGenerated, NotSpecifiedReasonAgentGenerated, Narrative, NoERI, BankIdentifierIncorrect, InvalidBankIdentifier, InvalidDebtorBankIdentifier, InvalidCreditorBankIdentifier, InvalidBICIdentifier, InvalidDebtorBICIdentifier, InvalidCreditorBICIdentifier, InvalidClearingSystemMemberIdentifier, InvalidDebtorClearingSystemMemberIdentifier, InvalidCreditorClearingSystemMemberIdentifier, InvalidIntermediaryAgent, MissingCreditorSchemeId, RMessageConflict, ReceiverCustomerInformation,NotUniqueTransactionReference, MissingDebtorAccountOrIdentification, MissingDebtorNameOrAddress, MissingCreditorNameOrAddress, RegulatoryReason, RegulatoryInformationInvalid, TaxInformationInvalid, RemittanceInformationInvalid, RemittanceInformationTruncated, InvalidStructuredCreditorReference, InvalidCharacterSet, InvalidDebtorAgentServiceID, InvalidPartyID, ValidRequestForCancellationAcknowledged, UETRFlaggedForCancellation, NetworkStopOfUETR, RequestForCancellationForwarded, RequestForCancellationDeliveryAcknowledgement, SpecificServiceOfferedByDebtorAgent, SpecificServiceOfferedByCreditorAgent, ServiceofClearingSystem, CreditorNotOnWhitelistOfDebtor, CreditorOnBlacklistOfDebtor, MaximumNumberOfDirectDebitTransactionsExceeded, MaximumDirectDebitTransactionAmountExceeded, TransmissonAborted, NoDataAvailable, FileNonReadable, IncorrectFileStructure, TokenInvalid, SenderTokenNotFound, ReceiverTokenNotFound, TokenMissing, TokenCounterpartyMismatch, TokenSingleUse, TokenSuspended, TokenValueLimitExceeded, TokenExpired, InvalidCutOffTime, TransmissionSuccessful, TransferToSignByHand, AuthorisationCancelled, FollowingCancellationRequest, Fraud, NotCompliantGeneric, NoAnswerFromCustomer, ReturnUponUnableToApply, UnduePayment, AlreadyAcceptedRTP, AlreadyExpiredRTP, AlreadyRefusedRTP, AlreadyRejectedRTP, AttachementsNotSupported, ExpiryDateTimeReached, ExpiryDateTooLong, FraudulentOrigin, IncorrectExpiryDateTime, InitialRTPNeverReceived, NonAgreedRTP, NoPaymentGuarantee, PayerOrPayerRTPSPNotReachable, RTPNotSupportedForDebtor, RTPReceivedCanBeProcessed, RTPServiceProviderIdentifierIncorrect, TypeOfPaymentInstrumentNotSupported, UnknownCreditor, OriginalTransactionNotEligibleForRequestedReturn, RequestForCancellationNotFound, SettlementNotReceived

reasonDescription
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
Array of objects (GenericStatus)

Detailed account status. Possible Values: RegulationDD, Analysis, NewClassCode

Array
statusType
string [ 1 .. 50 ] characters
Example: "RegulationDD"

Pascal case status type. Possible Values: NSFInstruction, RegulationDD, IRA. Pays, InBox, CashReserve, ChargeOff, RestrictedAccount, AccountVerification, ClassCode, LegalEntity, PrivacyNoticed

statusName
string [ 1 .. 50 ] characters
Example: "Active"

Pascal case status name. Possibles Values for IRA status type: NotEligible, Eligible, DistributionDisability, DistributionDeath, DistributionNormal, AccountLinked, AccountNotLinked. Possible values for Pays: Enable, Disable; InBox: NewMessage, Empty; CashReserve: HasCashReserve, DoNotHave; RestrictedAccount: IsRestricted, NotRestricted; ChargeOff: BankSubmitted, Automatic, IntegratedProcessingAutomatic, IntegratedProcessingClosed. PassbookSavings: NotOnline, Online, Manual. AccountVerification: Valid, NotValid. OverdraftProtection: Enable, Disable. ClassCode: New, NotNew. DefaultStatus: Inminent, NotDefault. LegalEntity: LegalEntityCustomer. PrivacyNoticed: CustomerCanBeDisclosed, CustomerOptOut, CustomerNotOptOut

dateAndTime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
reasonComment
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
statusReason
string [ 1 .. 50 ] characters
Example: "RegulationDD"

Pascal case status reason. Possible Values: NSFInstruction, RegulationDD, IRA.

Array of objects (ProcessEvent)

Account process event list defined by the account servicer.

Array
name
string [ 1 .. 35 ] characters

Human readable pascal case identifier of the process event. Possible list values: YearEndProcessed, MonthEndProcessed, ManuallyControlled

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
Array of objects (SpotDate)
Array of objects (GenericCode)

Codes related to the external provider account. Possible Values: LookUpReference

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.

externalAccountIndicator
boolean

Indicates whether an account is an external entity.

collateralIndicator
boolean

Indicates whether an account has been pledged as collateral.

negotiableIndicator
boolean

Indicates whether an account is a negotiable instrument.

closeOption
string [ 1 .. 34 ] characters

Option for closing an account. Possible Values: DoNotCloseAutomatically, CloseAutomatically

profitabilityAnalysisStatus
string [ 1 .. 34 ] characters

Profit analysis status. Possible values: High, Low, NotAnalyzed, Analyzed, SystemClosed.

nonSufficientFundsInstruction
string [ 1 .. 34 ] characters

Manual NSF decision.

nonSufficientFunds
string [ 1 .. 34 ] characters

Automatic NSF decision.

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

Array of objects (Comment)

Bank comnents of the account.

Array
name
string [ 1 .. 35 ] characters
text
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
object (AccountProfile)
profileType
string [ 1 .. 40 ] characters
Example: "Personal"

Account profile category. Possible Values: Personal, NonPersonal.

riskLevel
string [ 1 .. 35 ] characters
Example: "High"

Laundering risk level

qualityScore
string (QualityScore) [ 2 .. 10 ] characters

The quality score is based on a borrower's credit history, collateral, and the likelihood of repayment.

Array of objects (RiskMeasure)
Array
name
string (CreditRankingScaleName) [ 1 .. 35 ] characters
Example: "StandardAndPoors"

Most commonly used credit ranking scales. Possible Values: StandardAndPoors, MoodysInvestors. Also other values: Original, 1, 2, 3, Current.

level
string (RiskLevel) [ 1 .. 35 ] characters
Example: "High"

Specifies the customer’s money laundering risk. Possible values: VeryLow, Low, Medium, Medium toHigh, ModerateHigh, High, ExtremelyHigh, NoDetermine.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (GenericCode)

Additional risk measure codes. Possible values: RiskRatingCode

Array of objects (CreditRankingScale)

Borrower credit ranking scores

Array
name
string (CreditRankingScaleName) [ 1 .. 35 ] characters
Example: "StandardAndPoors"

Most commonly used credit ranking scales. Possible Values: StandardAndPoors, MoodysInvestors. Also other values: Original, 1, 2, 3, Current.

score
string [ 2 .. 10 ] characters
Example: "AAA"
date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (GenericCode)

Additional ranking scale codes. Possible values: RiskRatingCode

object (BankruptcyProfile)
chapter
string [ 1 .. 10 ] characters
Example: "11"

The section on the Bankruptcy Code that sets out the rules and procedures for a particular type of bankruptcy. Possible Values: 7, 11, 13, 12, and 9.

status
string [ 1 .. 40 ] characters
Example: "Petition"

Bankruptcy status. Possible values: Petition, Discharged, DebtReaffirmation, DebtReaffirmationRescinded, PlanConfirmed, PlanCompleted, Withdrawn.

statementOption
string [ 1 .. 40 ] characters
Example: "RegularBillingStatement"

Statement option. Possible Values: RegularBillingStatement, BankruptcyBillingStatement

object (Frequency)

Indicates the frequency that the history profile payment status is established. Values are dependent upon credit bureau standards.

fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

cycle
string [ 1 .. 35 ] characters
Example: "Monthly"

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

paymentHistoryOption
string [ 1 .. 40 ] characters
Example: "NotRecalculate"

Indicates whether the Payment History Profile will be recalculated. Possible Values: Default, NotRecalculate, RecalculateAndSetToDefault, RecalculateAndSetToNot.

Array of objects (Balance)

Amount balances related to the credit profile. Possible Values: CreditHighBalance.

Array
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

balanceName
string (BalanceName) [ 1 .. 50 ] characters
Example: "Available"

Specifies the nature of the balance. Possible values: Current, Available, Pending, Opening, Blocked, Previous, RelatedBalance, OnHold, PendingLedger, Collected, LastAnniversary, CurrentAccrued, PreviousAccrued, CurrentWithLastCalculus, CarriedAdjustment, PaidWithPenalties, Accrued, Penalty, Fees, Withholding, CollectionLedger, LastLedger, CurrentLedger, Ledger, MinimumAvailable, MinimumLedger, Withheld, CurrentBooked, CurrentBook, LastDeposit, FloatAmount, Average, RegulationDDAvailable. Loan Balances: CashProceeds, the amount that a customer actually received, exclusive of insurance premiums, fees, and unearned discount; FinancedExpenses, indicates the amount of expenses an institution has financed for a borrower; TotalInterest; AdditionalInterest, if the date of the first payment is beyond one month from the note date, the interest for the odd days will be earned during the first interest period; DeferredUnsecuredPrincipal, is the outstanding balance of an unsecured debt. The DUPB includes any accrued interest that is yet to be paid by the borrower. The deferral typically occurs due to bankruptcy or debt relief proceedings, which temporarily halt collection efforts by the original creditor; Charge Balances: Earned, RealTimeDeliveryMaximum, Current, Financed, Prepaid, CurrentEarned, CurrentEarnedOtherEscrow, InterestPaidToDate, InterestPaidThisYear, InterestPaidPreviousYear, InterestPaidLastStatement, InterestPaidThisYear, RevolvingCreditPaid, BasePaidToDate, TotalPastDue, Escrow, AppliedEscrow, UnpaidEscrow, EscrowBucket, Principal, Interest, Fees, BilledFees, OtherEscrow, FinalAmount, FinalInterestAmount, Chapter4PreviousYear, Payments: Delinquent, FixPayment, Transaction, LoanPayOff, PrincipalAndInterest, AvailableCash, AvailableCheck, AvailableCredit, Sweep, Float, MemoLedger, Memo, AvailablePending, LedgerPending.

amount
string (Amount) <= 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

count
integer

Number of transactions added to the amount.

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 (GenericCode)

Bank defined codes to classify balances. Possible values: BalanceCategory, BalanceType, PartyAgreementNumber.

customerType
string (CustomerType)
Example: "Consumer"

A customer type of a bank account can be classified into different categories based on the account's features, purpose, and benefits. Possible Values: Personal, Business, Consumer, Organization, ThirdParty, Estate, Employee, ForeignConsumer.

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

Array of objects (CreditRankingScale)
creditReportAddressIndicatorCode
string

is a code or marker used by credit reporting agencies to indicate a match or mismatch between the address supplied in an inquiry and the address they have on file for a consumer.

creditReportAddressIndicatorDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
consumerCreditReportInformation
string [ 1 .. 1025 ] characters
Example: "This is a description."

Information provided by the Consumer Credit Report.

consumerCreditReportDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
eCOACode
string

The ECOA code indicates how customer account information is reported to the Credit Bureau in keeping with the Equal Credit Opportunity Act.

Array of objects (Product)

Product information at account level.

Array
productId
required
string [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Unique identification of a product within a product type.

pricingStrategyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
name
required
string [ 1 .. 40 ] characters
Example: "Visa Business Card"

Commercial product name within a product type.

description
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
productType
string [ 1 .. 35 ] characters
Example: "PaymentCard"

Type or nature of a product. Possible Values: Loan, PaymentCard, CheckingAccount, HealthSavingsAccount, RepricingPlan.

productSubType
string [ 1 .. 35 ] characters
Example: "BusinessCard"

Commercial product subtype within a product type.

Array of objects (Restriction)
Array of objects (SpotDate)
Array of objects (Limit)
Array of objects (ChargeCalculation)
parties
Array of strings (ProductPartyRelationType) [ items [ 1 .. 40 ] characters ]
Example: ["ParentProvider"]
status
string (ProductStatus) [ 1 .. 35 ] characters
Example: "GoodStanding"

Specifies the current status of a product. Possible values are: Enable, Disable.

statusDateAndTime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (GenericCode)

Product configuration codes. Possible Values: WebBrand, WaterfieldService, MajorAccountType: Major Account Type code for Employee Qualified Plan, MinorAccountType: Minor Account Type code to use for Employee Qualified Plan, CheckingMajor: Checking Major to be used and linked to Employee Qualified Plan account, CheckingMinor: Checking Minor to be used and linked to Employee Qualified Plan account. Other values: NationalCreditUnionAdministration.

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

Array of objects (DocumentDescriptor)

Documents related to the Account.

Array
documentId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
documentReference
string [ 1 .. 35 ] characters

Document location.

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

Responses

Request samples

Content type
application/json
{
  • "accountBranchId": "SEA_1",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "securedIndicator": true,
  • "securedType": "Collateral",
  • "payment": {
    },
  • "payout": {
    },
  • "ownershipType": "SingleOwnerAccount",
  • "balanceType": "Asset",
  • "productId": "PD_CA_0002",
  • "pricingStrategyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "initialAmount": "100",
  • "depositDate": "2022-04-17",
  • "contract": {
    },
  • "parties": [
    ],
  • "maturityDate": "2022-04-17",
  • "relatedAccounts": [
    ],
  • "referenceAccount": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "pastDates": [
    ],
  • "initialFundingSource": "CreditTransfer",
  • "projectedDates": [
    ],
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "statement": {
    },
  • "interests": [
    ],
  • "charges": [
    ],
  • "taxes": [
    ],
  • "communicationChannels": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "codes": [
    ],
  • "print": {
    },
  • "bill": {
    },
  • "collateral": {
    },
  • "contact": {
    },
  • "renewal": {
    },
  • "servicerAlerts": [
    ],
  • "history": {
    },
  • "status": {
    },
  • "supplementaryData": { },
  • "comments": [
    ],
  • "profile": {
    },
  • "products": [
    ],
  • "documents": [
    ]
}

Response samples

Content type
{
  • "productId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "pricingStrategyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "name": "Visa Business Card",
  • "description": "This is a description.",
  • "productType": "PaymentCard",
  • "productSubType": "BusinessCard",
  • "restrictions": [
    ],
  • "projectedDates": [
    ],
  • "limits": [
    ],
  • "charges": [
    ],
  • "parties": [
    ],
  • "status": "GoodStanding",
  • "statusDateAndTime": "2022-04-17T08:00:00Z",
  • "codes": [
    ],
  • "supplementaryData": { }
}

Retrieves a product

Authorizations:
jwtopenIdConnect
path Parameters
productId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002
header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "productId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "pricingStrategyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "name": "Visa Business Card",
  • "description": "This is a description.",
  • "productType": "PaymentCard",
  • "productSubType": "BusinessCard",
  • "restrictions": [
    ],
  • "projectedDates": [
    ],
  • "limits": [
    ],
  • "charges": [
    ],
  • "parties": [
    ],
  • "status": "GoodStanding",
  • "statusDateAndTime": "2022-04-17T08:00:00Z",
  • "codes": [
    ],
  • "supplementaryData": { }
}

Cards

Card Management

Retrieves Account Cards

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

Account Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "accountId": "033-DDA-123456",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "ownershipType": "SingleOwnerAccount",
  • "cards": [
    ]
}

Requires a Payment Card Activation

Requires a Payment Card Activation

Authorizations:
jwtopenIdConnect
path Parameters
cardId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Card Identification

header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
Array of objects (PaymentCardIdentification)
Array
number
string [ 1 .. 34 ] characters

Identification assigned by an institution or internally to connect to other applications.

schemeName
string [ 1 .. 40 ] characters
Example: "MemberNumber"

Name of the identification scheme, in PascalCase. Possible values are: MemberNumber, CardNumber, NonTransToken, CardIdentifier.

issuer
string [ 1 .. 35 ] characters

Entity that assigns the identification.

Responses

Request samples

Content type
application/json
{
  • "identifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "fundingSourceType": "Credit",
  • "productId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "pricingStrategyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "businessIndicator": true,
  • "digitalIndicator": true,
  • "cardBranchId": "SEA_1",
  • "number": "1234567890123456789",
  • "cardHolderType": "Primary",
  • "nameOnCard": "Jane Birkin",
  • "businessNameOnCard": "Jane Birkin",
  • "art": {
    },
  • "referenceAccountId": "033-DDA-123456",
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "startDate": "2022-04-17",
  • "expiryDate": "2022-12",
  • "orderedDate": "2022-04-17",
  • "activationDates": [
    ],
  • "activationAttempts": 0,
  • "securityCode": "103",
  • "pIN": "1031",
  • "pINRetries": 3,
  • "sequenceNumber": "1",
  • "brand": "Visa",
  • "limits": [
    ],
  • "interests": [
    ],
  • "restrictions": [
    ],
  • "charges": [
    ],
  • "algorithms": [
    ],
  • "codes": [
    ],
  • "cardHolder": {
    },
  • "supplementaryData": { },
  • "cardId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "statement": {
    },
  • "offers": [
    ],
  • "status": "Active",
  • "statusDate": "2022-04-17T08:00:00Z",
  • "statusReason": "Active",
  • "history": {
    },
  • "servicerAlerts": [
    ]
}

Retrieves the cards associated with a specific person.

Authorizations:
jwtopenIdConnect
path Parameters
personId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Person Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "personId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "personName": "Jane Birkin",
  • "cards": [
    ]
}

Creates a card associated with a specific person.

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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Person Identification

header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
Array of objects (PaymentCardIdentification)
Array
number
string [ 1 .. 34 ] characters

Identification assigned by an institution or internally to connect to other applications.

schemeName
string [ 1 .. 40 ] characters
Example: "MemberNumber"

Name of the identification scheme, in PascalCase. Possible values are: MemberNumber, CardNumber, NonTransToken, CardIdentifier.

issuer
string [ 1 .. 35 ] characters

Entity that assigns the identification.

relationshipId
string [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Customer principal relationship. This entity gives the ability to view a party’s total relationship with the bank. The relationship Id ties multiple parties and financial instruments together.

fundingSourceType
string (CardFundingSourceType) [ 1 .. 35 ] characters
Example: "Credit"

Specifies the funding source type of payment card. Possible Values: Credit, Debit, Prepaid, Charge, DeferredDebit, CreditGateway, External.

productId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
pricingStrategyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
businessIndicator
boolean

Indicates whether the payment card is business or not.

digitalIndicator
boolean (DigitalCardIndicator)

Indicates whether the payment card is digital or physical.

cardBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: "SEA_1"

Identification of the account servicer institution at branch level or center level. To overlay the codes to produce a unique identifier the following expresion is used: BranchRegionCode-BranchSubdivisionCode.

number
string (PrimaryAccountNumber) [ 1 .. 19 ] characters
Example: "1234567890123456789"

Primary Account Number (PAN) of the card.

cardHolderType
string (CardHolderType) [ 1 .. 35 ] characters
Example: "Primary"

Specifies the card holder type of payment card. Possible Values: Primary, Additional, Authorized, Guarantor.

nameOnCard
string [ 1 .. 350 ] characters
Example: "Jane Birkin"

Specifies the name on the card if overriding the name from the card holder.

businessNameOnCard
string [ 1 .. 350 ] characters
Example: "Jane Birkin"

Specifies the business name on the card.

object (PaymentCardArt)

Art associated with the card

styleId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
label
string

Display label for the specific image

imageUri
string <uri>

The URI link of a PNG, JPG or GIF image with proportions defined by ISO 8710 ID-1 with 340x210 ratio and width no greater than 512 pixels. The image at this URI must be accessible at all times, with no additional authentication headers. Typically this is an image resource located in the data provider's public web site or Content Delivery Network

referenceAccountId
string [ 1 .. 300 ] characters
Example: "033-DDA-123456"

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 (RelatedAccount)

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
accountRelationType
string (AccountRelationType)
Example: "SubAccount"

Account relation role. Possible values are: Parent, EscrowAccount, SubAccount, ControlAccount, CrossAccount, ChargeAccount, AssociatedAccount, IRAAccount, CombinedStatement, SecondaryCombinedStatement, SummaryAccount, FundingSource, CompensatingAccount. Payment related values: Authorized, Counterpart

accountId
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

accountNumber
string (AccountNumber) <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

accountType
string (RelatedAccountType) [ 1 .. 60 ] characters
Example: "Checking"

Type of the account. Some possible ISO 20022 compliant values are: Checking, CardAccount, CashPayment, Charges, CashIncome, Commission, ClearingParticipantSettlementAccount, LimitedLiquiditySavingsAccount, MarginalLending, MoneyMarket, NonResidentExternal, Overdraft, OverNightDeposit, Settlement, Salary, Savings, Tax, TransactingAccount, CashTrading, VirtualAccount, CreditCard, DebitCard, Universal, Investment, EpurseCard, CertificateOfDeposit, MoneyMarketChecking, RetirementAccount, StockOrBond, PrePaid, FleetCard, Cash, DebitAccount, CreditAccount, Benefit, HealthSavingsAccount, FlexibleSpendingAccount, ForBenefitOf, Estate, ClientTrustAccount, LawyersTrustAccount, KeoghPlanAccount, UniformTransfersToMinorsAct, UniformGiftsToMinorsAct, ReserveFunds, SelfDirectedBrokerage, Loan, Ledger.

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.

productId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
Array of objects (GenericCode)

Account related codes

Array of objects (PaymentCardRelatedParty)
Array
partyId
required
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
partyType
required
string (PartyType)
Example: "Person"

Possible values are: Person, Organization. Also other types of servicer entities: ServicerOfficer, ExternalOrganization, Referral.

partyAccountRole
required
string (PaymentCardPartyRole) [ 1 .. 36 ] characters
Example: "Additional"

Payment Card party roles. Possible Values: Primary, Additional, Authorized, Guarantor, Organization.

partyAccountRoleCode
string
Example: "50"

Bank defined party account role.

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.

Array of objects (GenericIdentification)
object (StructuredName)

The structured name is used to initialize the person name with the format

startDate
string <date>
Example: "2022-04-17"

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.

orderedDate
string <date>
Example: "2022-04-17"

Date the card is ordered

Array of objects (SpotDate)
Array
name
string (SpotDateName) [ 1 .. 40 ] characters
Example: "Expiration"

Possible values por projected dates: Forecast, Expiration, LastNonFinancial, Escheat. Possible values for past dates: IRALastRollOver. Other possible values: EffectiveDate, ResponseByDate.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
activationAttempts
number

Indicates the number of activation attempts since the last reset. Applies to debit cards only.

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.

pINRetries
number <= 99
Example: 3

Pin Retries Allowed

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
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

name
required
string [ 1 .. 60 ] characters
Example: "CreditLimit"

Name of the limit in PascalCase. Possible values: NSF, UncollectedFunds, Overdraft, CreditLimit, CreditCard, Withdraw, CreditCardWithdraw, ForeignFeesWaived, CreditTransactions, DebitTransactions, ATMSurchargeReimbursement, CashAdvance, ACHInTransfers, ACHOutTransfers, OverdraftProgram, Threshold, MinimumTransfer, MinimumAdvance, DomesticWireTransferIn, DomesticWireTransferOut, ForeignWireTransferIn, ForeignWireTransferOut.

limitType
string (LimitType) <= 35 characters
Example: "DirectDebit"

Specifies the type of risk management limit. Bilateral, NetBilateral, IndirectBilateral, Global, MandatoryBilateral, DiscretionaryBilateral, DirectDebit, SingleCustomerDirectDebit, SingleFinancialInstitutionDirectDebit, TotalDailyCustomerDirectDebit, TotalDailyFinancialInstitutionDirectDebit, AutoCollateralisation, UnsecuredCredit, ExternalGuarantee, Revolving, NotRevolving.

channelType
string [ 1 .. 30 ] characters

Channel type for which this limit applies. Possible values: OnlineATM, OfflineATM, ATM, SaleTerminal, : Check, ACHDebit, DebitCard, BillPayment.

amount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount limit

currency
string = 3 characters ^([A-Z]{3})?$
Example: "USD"

Amount limit currency.

number
integer

Number limit.

enableIndicator
boolean
Example: true

Indicates whether the limit is enabled or not.

feesConsentIndicator
boolean
Example: true

Indicates that the institution received customer consent to assess fees when the limit is exceeded.

percentageIndicator
boolean

Indicates if the limit is calculated as a percentage.

percentage
string (Percentage) <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Value expressed as a positive or negative percentage, rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. total number of digits: 11 number of digits in fractional part: 10 Max Value: 100

temporaryIndicator
boolean
Example: true

Indicates whether the limit is temporary or not.

object (DateTimePeriod)
object (Frequency)

Renewal frequency

usedAmount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount limit used

usedNumber
integer

Number limit used.

usedPercentage
string (Percentage) <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Value expressed as a positive or negative percentage, rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. total number of digits: 11 number of digits in fractional part: 10 Max Value: 100

status
string (LimitStatus) <= 35 characters
Example: "Requested"

Specifies the current status of a limit. Possible values are: Enabled, Disabled, Deleted, Requested, NotAuthorized (The limit is not authorized by the customer). Other values: CustomerEnrolled, CustomerNotEnrolled, InstitutionEnrolled.

statusDateAndtime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
object (LimitHistory)

Historic values of a Limit

Array of objects (Balance)
Array of objects (GenericCode)

Additional limits codes.

accessConditions
Array of strings (ConditionName) [ items [ 1 .. 36 ] characters ]
Example: ["LessThanMinAmount"]

Limit access condition. Possible values: BeforeTransfers, AfterTransfers: Overdraft Limit is accessed before or after automatic transfers. Other values: POSTransactions, ATMTransactions, when the customer authorize the payment of ATM or POS transactions, if the transaction was to overdraw the account.

notificationOptions
Array of strings
Example: ["Exception"]
Array of objects (AccountPayment)

Payments methods to cover the amount limit overdraft.

Array of objects (InterestCalculationDescriptor)
Array
name
string (InterestName) [ 1 .. 40 ] characters
Example: "Deposit"

Name in PascalCase of the interest that applies to the account. For instance, Deposit. Also identifications of the interest or charge.

code
string <= 50 characters

Interest code used by the account servicer.

enableIndicator
boolean
Example: true

Indicates whether the interest is enabled for automatic charge.

dayCountBasis
string (InterestDayCountBasis) [ 1 .. 50 ] characters
Example: "Actual360"

An interest day count basis is a method used to calculate interest accrual over a period of time for loans and bonds. The method involves determining the number of days over which interest is being calculated, known as the accrual period. The resulting accrual period is then divided by a certain number to calculate the daily interest rate, which is applied to the principal balance to determine the interest payment. Possible Values: ActualActual, Actual360, Actual365, 365365, 360360, Monthly78ths, 365360, ActualSchedule, ScheduleSchedule.

calculationMethodOption
string (InterestComputationParameter) [ 1 .. 50 ] characters
Example: "LastInterest"

Specifies a parameter that apply at the interest day count basis. Possible Values: LastInterest, EqualPayment, InterestAndPrincipal, InterestSeparatedm, Amortized, AddOn, NegativeAmortization, Simple, FHLMC.

nextInterestDate
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

The period funds are earning interest.

object (Frequency)

Specifies an event frequency

Array of objects (Balance)

Total amounts related to an interest

rateName
string (RateName) [ 1 .. 40 ] characters
Example: "Actual"

Specifies the name of the rate. Possible values: Prior, Original, Actual, LastAnniversary, Effective, Current, Future, Base, Floor, Ceiling, OverSplit, UnderSplit.

rateTierName
string (RateName) [ 1 .. 40 ] characters
Example: "Actual"

Specifies the name of the rate. Possible values: Prior, Original, Actual, LastAnniversary, Effective, Current, Future, Base, Floor, Ceiling, OverSplit, UnderSplit.

percentage
string (Percentage) <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Value expressed as a positive or negative percentage, rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. total number of digits: 11 number of digits in fractional part: 10 Max Value: 100

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Maximum amount range

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.

Array of objects (Restriction)
Array
name
required
string [ 1 .. 60 ] characters
Example: "WireTransferIn"

Name of the restriction in PascalCase. Possible values: TransferIn, TransferOut, WireTransferIn, WireTransferOut, ACHTransferIn, ACHTransferOut, ForeignIncomingWires, ForeignOutgoingWires, ACHTransfers, InternetBankingTransfer, InternetView, InternetInquiry, ForeignOutgoingIran, Withdrawals, Renew, Transfers, AdvanceTransfer, OnlineBanking, ElectronicBanking, InvestmentAllowed, InvestmentSetUpAllowed, DebitCardAllowed, CheckOrderAllowed, AutomaticSweep, AccountManagement

restrictionPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
enableIndicator
boolean
Example: true

Indicates whether the capability is allowed or not.

disableConditions
Array of strings (ConditionName) [ items [ 1 .. 36 ] characters ]
Example: ["LessThanMinAmount"]

Conditions that disabel the restriction.

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.

status
string (RestrictionStatus) [ 1 .. 36 ] characters
Example: "Pending"

Specifies the status of a restriction enablement request. Possible values: Enable, Pending, InquiryOnly, Disable, Requested.

Array of objects (ChargeCalculationDescriptor)
Array
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

name
string (ChargeName) [ 1 .. 60 ] characters
Example: "CardLatePayment"

Name of the charge calculation in PascalCase. Possible values: Fee, Overdraft, CardLatePayment, CashAdvance, LatePayment, CashWithdrawal, EarlyWithdrawal, Dormant, EIM, NonSufficientFunds, ATM, BillPayment, FDIC, Overdraft, OverdraftInterest, OverdraftCourtesy, ReturnedItem, DeclinedCheck. Service Charge values: AutomaticActivityCharge, MaintenanceActivityCharge, MaintenanceServiceCharge. ServiceCharge, ServiceChargeCreditBack. Also other external codes to identify the charge.

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,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

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, 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, Fee, Insurance, NonTaxable, Recurring, Taxable.

exemptIndicator
boolean

Indicates whether the account is exempt of the charge.

Array of objects (Algorithm)
Array
name
string [ 1 .. 35 ] characters

Name to describe the algorithm provided. Possible Values: ICSF

target
string [ 1 .. 35 ] characters

Attribute name of the algorithm. Possible Values: pIN

enableIndicator
boolean

Indicates whether the offset has been calculated.

offset
string [ 1 .. 60 ] characters

An attribute offset is a value that is the difference between two attributes. For example, a PIN offset may be the difference between a PIN that is chosen by the customer and one that is assigned by an institution.

Array of objects (GenericCode)

Codes to classify payment cards. Possible code names: ClassCode

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

value
string [ 1 .. 35 ] characters
Example: "195"

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
object

Card holder person description

personId
string [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Person identifier code assigned by the account service institution.

Array of objects (PersonIdentification)
Array
schemeName
required
string [ 1 .. 40 ] characters
Example: "SocialSecurityNumber"

Name of the identification scheme in PascalCase form. Possible values are: AlienRegistrationNumber, PassportNumber, USPassportCard CustomerIdentificationNumber, DriversLicenseNumber, EmployeeIdentificationNumber, USDriversLicenseNumber, NationalIdentityNumber, SocialSecurityNumber, TelephoneNumber, TaxIdentificationNumber, ForeignTaxIdentificationNumber, IndividualTaxpayerIdentificationNumber, PersonCommercialIdentification, StateIdentificationNumber, MilitaryIdCard, BirthMarriageCertificateNumber, MarriageCertificateNumber, BirthCertificateNumber, CountryTerritoriIdCard, DriverLicenseNumber, WageTaxStatementFormNumber, GovernmentDocumentNumber, HealthInsuranceCard, CertificateOfIncorporationNumber, CertificateOfOrganizationNumber, CertificateOfPartnershipNumber, ForwardHealthMedicaIdCard, MexicanConsularIdCard, DLNTaxExemptNumber, PhotoIdCard, PermantResidentCard, TribalIdCard, UtilityBillInvoiceNumber, VoterUniqueIdentifier, WisconsinCRISSearch, PropertyTaxBillNumber, MedicareCardId, OrganizationalDocumentNumber, CertificationOfTrustNumber, EstateDomiciliaryLetterNumber, TaxReturnFormNumber, MinorIdCard, EmploymentAuthorizationCard, StateDocumentNumber, TravelDocumentNumber, StateIssuedPermitNumber, TaxId, MemberNumber.

number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification.

issuer
string
Example: "Baltimore"

Entity that assigns the identification.

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

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).

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.

applyDate
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.

verificationDate
string <date>
Example: "2022-04-17"

Verification or certification date.

foreignIDIndicator
boolean

Indicates whether the identifications is from a foreign country.

taxIDIndicator
boolean

Indicates whether the identifications is Tax Id.

displayOption
string (PartyDisplayOption) [ 1 .. 35 ] characters

Indicates display options for party attributes. Possible Values: TaxIdMasked

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.

object (PlaceAndDateOfBirth)

Date and place of birth of a person.

countrySubdivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

Name of a built-up area, with defined boundaries, and a local government. Also city name.

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.

gender
string (Gender) [ 1 .. 36 ] characters
Example: "Female"

Specifies the gender of the person. Possible Values: Female, Male, NonBinary

status
string (PartyStatus) [ 1 .. 35 ] characters
Example: "GoodStanding"

Specifies the current primary status of a party. Possible values are: GoodStanding, FraudAlert, BadCustomer, Active, Delinquent, Default, HighRisk, UnderReview, HotCarded, WildCarded. Other possible values: PersonalBankruptcy, GrowingConcern, WatchLoan, InReceivership, Chapter11, Liquidation.

coveredByMilitaryLendingActIndicator
boolean

Indicates if the borrower is covered under the Military Lending Act.

militaryMemberIndicator
boolean

Indicates whether the person is is service member/military.

object (DateTimePeriod)
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

object (Audit)

Resource Audit Information. Captures the creation, modification and maintenance details.

status
string (AuditStatus) [ 1 .. 35 ] characters

Maintenance status of a resource. Possible values: Requested, Created, Changed, Deleted

creationDate
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.

creationBranchId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
object (User)

User information of a person.

lastModificationChannel
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

lastModificationDate
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 (AuditChannel)

Activity audit throught communication channles

Array of objects (PostalAddress)
Array
addressCode
string

This code is used to identify parties that share the same address or to associate an existing address with a specific party. Providing this code eliminates the need to separately enter the address details.

addressBookIndicator
string

If true, the address is kept in the system even if the person is no longer a customer.

addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible values are: PhysicalAddress, Postal, POBox, Residential, Permanent, Temporary, Alternative, Previous.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible values are: MailTo, DeliveryTo, Billing, Tax, ForeignTaxRecipient PlaceOfOperation, PlaceOfRegistration, placeOfFormation, Marketing, Statements, Business, Administrative, PreviousPlace, Headquarter, BranchStore, Branch, Property, Military, Secondary, Personal, Annex, Inquiry.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

careOf
string [ 1 .. 100 ] characters
Example: "C/O Company Name"

Identifies an addressee that is accepting the correspondence for the intended recipient. Using care of ensures the correspondence reaches the right recipient rather than getting returned to the sender.

department
string [ 1 .. 70 ] characters
Example: "A"

Identification of a division of a large Organization or building.

subDepartment
string [ 1 .. 70 ] characters
Example: "B"

Identification of a sub-division of a large Organization 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 Organization, where letters are kept until called for.

room
string [ 1 .. 70 ] characters
Example: "22"

Building room number.

postCode
string (PostCode) [ 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. In US may consists of two parts: the five-digit ZIP Code '97062' and the ZIP+4 Code '6884'.

carrierRoute
string (CarrierRoute) [ 1 .. 4 ] characters
Example: "C001"

A Carrier Route is a designated geographic area assigned to individual postal carriers by the United States Postal Service (USPS) to facilitate efficient mail delivery within specific regions.

censusTract
string (CensusTract) = 5 characters
Example: "12345"

A census tract, census area, census district or meshblock is a geographic region defined for the purpose of taking a census

censusBlock
string (CensusBlock) = 4 characters
Example: "1234"

Census blocks are used to partition counties into smaller areas for the purpose of collecting and presenting census data.

cBSACode
string (CBSACode) = 5 characters
Example: "49780"

Core-based statistical area. Metropolitan statistical area (MSA) is the formal definition of a region that consists of a city and surrounding communities that are linked by social and economic factors. Micropolitan Statistical Areas (MISA) are CBSAs associated with at least one urban cluster that has a population of at least 10,000, but less than 50,000. The micropolitan statistical area comprises the central county or counties or equivalent entities containing the core, plus adjacent outlying counties having a high degree of social and economic integration with the central county as measured through commuting.

cBSAType
string (CBSAType) [ 1 .. 10 ] characters
Example: "MSA"

Type of Core-based statistical area. Possible values: MSA, MISA

foreignIndicator
boolean

Indicates whether the postal address is from a foreign country.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

Name of a built-up area, with defined boundaries, and a local government. Also city name.

townLocationName
string [ 1 .. 35 ] characters
Example: "Clackamas"

Specific location name within the town.

districtName
string [ 1 .. 35 ] characters
Example: "Columbia"

Identifies a subdivision within a country sub-division.

countyName
string [ 1 .. 35 ] characters
Example: "Cook"

Identifies a county 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.

temporaryIndicator
boolean
Example: true

Indicates whether the address is temporary or not.

object

The period of use of the address information. Could be also used as a recurring anual period.

Array of objects (GenericCode)

Codes related to postal address or internal handling codes associated with the address. Possible Values: HandlingCode, HandlingCodeOption, AddressFormat.

Array of objects (GenericIdentification)

Postal address identifiers are used to identify parties that share the same address or to associate an existing address with a specific party. Possible scheme name values: AddressIdentifier.

object (StructuredName)

The structured name is used to initialize the person name with the format

firstName
required
string [ 1 .. 200 ] characters
Example: "Mary"

Person given first name.

middleName
string [ 1 .. 200 ] characters
Example: "Joe"

Person given middle name.

lastName
required
string [ 1 .. 200 ] characters
Example: "Smith"

Person surname.

middleInitial
string [ 1 .. 10 ] characters
Example: "J."

Person middle initial.

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. Generation order should be expressed with roman numerals: I, II, III, IV, V.

prefix
string [ 1 .. 20 ] characters
Example: "Dr."

Name prefixes are typically Dr., Mr., Mrs., Ms.

Array of objects (Phone)
Array
number
required
string (PhoneNumber) ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$
Example: "+1-555-1234567"

The collection of information which identifies a specific phone or FAX number as defined by telecom services.

extension
string <= 5 characters

Phone Number Extension.

country
string (CountryCallingCode) <= 3 characters

Country calling codes, country dial-in codes, international subscriber dialing (ISD) codes, or most commonly, telephone country codes. Country codes are defined by the International Telecommunication Union (ITU) in ITU-T standards E.123 and E.164. The prefixes enable international direct dialing (IDD).

phoneType
string [ 1 .. 35 ] characters

Type of phone address. Possible values are:
Mobile, Landline, Fax, Pager, Modem.

phonePurpose
string [ 1 .. 35 ] characters

Purpose of the phone address. Possible values are: Business, Personal, International, Alternative, PersonalInternational, BusinessInternational

foreignIndicator
boolean

Indicates whether is a foreign phone number

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

object (TimeOfTheDay)
comment
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
object

The period of use of the phone information.

Array of objects (GenericCode)
Array of objects (GenericIdentification)

Phone identifiers are used to identify parties that share the same phone or to associate an existing phones with a specific party. Possible scheme name values: PhoneIdentifier.

lastUpdatedDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
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, Business, Administrative, Personal

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

Array of objects (GenericIdentification)

Email identifiers are used to identify parties that share the same email or to associate an existing email with a specific party. Possible scheme name values: EmailIdentifier.

lastUpdatedDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
employeeIndicator
boolean

Indicates whether is a bank employee.

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
{
  • "identifiers": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "fundingSourceType": "Credit",
  • "productId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "pricingStrategyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "businessIndicator": true,
  • "digitalIndicator": true,
  • "cardBranchId": "SEA_1",
  • "number": "1234567890123456789",
  • "cardHolderType": "Primary",
  • "nameOnCard": "Jane Birkin",
  • "businessNameOnCard": "Jane Birkin",
  • "art": {
    },
  • "referenceAccountId": "033-DDA-123456",
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "startDate": "2022-04-17",
  • "expiryDate": "2022-12",
  • "orderedDate": "2022-04-17",
  • "activationDates": [
    ],
  • "activationAttempts": 0,
  • "securityCode": "103",
  • "pIN": "1031",
  • "pINRetries": 3,
  • "sequenceNumber": "1",
  • "brand": "Visa",
  • "limits": [
    ],
  • "interests": [
    ],
  • "restrictions": [
    ],
  • "charges": [
    ],
  • "algorithms": [
    ],
  • "codes": [
    ],
  • "cardHolder": {
    },
  • "supplementaryData": { }
}

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "fundingSourceType": "Credit",
  • "productId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "pricingStrategyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "businessIndicator": true,
  • "digitalIndicator": true,
  • "cardBranchId": "SEA_1",
  • "number": "1234567890123456789",
  • "cardHolderType": "Primary",
  • "nameOnCard": "Jane Birkin",
  • "businessNameOnCard": "Jane Birkin",
  • "art": {
    },
  • "referenceAccountId": "033-DDA-123456",
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "startDate": "2022-04-17",
  • "expiryDate": "2022-12",
  • "orderedDate": "2022-04-17",
  • "activationDates": [
    ],
  • "activationAttempts": 0,
  • "securityCode": "103",
  • "pIN": "1031",
  • "pINRetries": 3,
  • "sequenceNumber": "1",
  • "brand": "Visa",
  • "limits": [
    ],
  • "interests": [
    ],
  • "restrictions": [
    ],
  • "charges": [
    ],
  • "algorithms": [
    ],
  • "codes": [
    ],
  • "cardHolder": {
    },
  • "supplementaryData": { },
  • "cardId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "statement": {
    },
  • "offers": [
    ],
  • "status": "Active",
  • "statusDate": "2022-04-17T08:00:00Z",
  • "statusReason": "Active",
  • "history": {
    },
  • "servicerAlerts": [
    ]
}

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, CreditGateway, External.

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.

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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieves a Card

Authorizations:
jwtopenIdConnect
path Parameters
cardId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Card Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "fundingSourceType": "Credit",
  • "productId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "pricingStrategyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "businessIndicator": true,
  • "digitalIndicator": true,
  • "cardBranchId": "SEA_1",
  • "number": "1234567890123456789",
  • "cardHolderType": "Primary",
  • "nameOnCard": "Jane Birkin",
  • "businessNameOnCard": "Jane Birkin",
  • "art": {
    },
  • "referenceAccountId": "033-DDA-123456",
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "startDate": "2022-04-17",
  • "expiryDate": "2022-12",
  • "orderedDate": "2022-04-17",
  • "activationDates": [
    ],
  • "activationAttempts": 0,
  • "securityCode": "103",
  • "pIN": "1031",
  • "pINRetries": 3,
  • "sequenceNumber": "1",
  • "brand": "Visa",
  • "limits": [
    ],
  • "interests": [
    ],
  • "restrictions": [
    ],
  • "charges": [
    ],
  • "algorithms": [
    ],
  • "codes": [
    ],
  • "cardHolder": {
    },
  • "supplementaryData": { },
  • "cardId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "statement": {
    },
  • "offers": [
    ],
  • "status": "Active",
  • "statusDate": "2022-04-17T08:00:00Z",
  • "statusReason": "Active",
  • "history": {
    },
  • "servicerAlerts": [
    ]
}

Updates a Card

Use the JSON Merge Patch standard https://tools.ietf.org/html/rfc7396

Authorizations:
jwtopenIdConnect
path Parameters
cardId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Card Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/merge-patch+json
object

Responses

Request samples

Content type
application/merge-patch+json
{ }

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "fundingSourceType": "Credit",
  • "productId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "pricingStrategyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "businessIndicator": true,
  • "digitalIndicator": true,
  • "cardBranchId": "SEA_1",
  • "number": "1234567890123456789",
  • "cardHolderType": "Primary",
  • "nameOnCard": "Jane Birkin",
  • "businessNameOnCard": "Jane Birkin",
  • "art": {
    },
  • "referenceAccountId": "033-DDA-123456",
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "startDate": "2022-04-17",
  • "expiryDate": "2022-12",
  • "orderedDate": "2022-04-17",
  • "activationDates": [
    ],
  • "activationAttempts": 0,
  • "securityCode": "103",
  • "pIN": "1031",
  • "pINRetries": 3,
  • "sequenceNumber": "1",
  • "brand": "Visa",
  • "limits": [
    ],
  • "interests": [
    ],
  • "restrictions": [
    ],
  • "charges": [
    ],
  • "algorithms": [
    ],
  • "codes": [
    ],
  • "cardHolder": {
    },
  • "supplementaryData": { },
  • "cardId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "statement": {
    },
  • "offers": [
    ],
  • "status": "Active",
  • "statusDate": "2022-04-17T08:00:00Z",
  • "statusReason": "Active",
  • "history": {
    },
  • "servicerAlerts": [
    ]
}

Retrieves Card Accounts

Authorizations:
jwtopenIdConnect
path Parameters
cardId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Card Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "cardId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "fundingSourceType": "Credit",
  • "productName": "Visa Classic",
  • "productId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "digitalIndicator": true,
  • "number": "1234567890123456789",
  • "accounts": [
    ]
}

Retrieves Card Holder

Authorizations:
jwtopenIdConnect
path Parameters
cardId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Card Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "uSDocumentedIndicator": true,
  • "identifiers": [
    ],
  • "name": "Jane Birkin",
  • "shortName": "Jane",
  • "legalName": "Jane Birkin",
  • "nameTemplateId": "1",
  • "nameSoundExId": "1",
  • "partyBranchId": "SEA_1",
  • "customerSinceDate": "2022-04-17T08:00:00Z",
  • "comments": [
    ],
  • "relatedParties": [
    ],
  • "relatedAccounts": [
    ],
  • "postalAddresses": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "relationshipLeadIndicator": true,
  • "residenceType": "Domestic",
  • "taxInformation": {
    },
  • "powerOfAttorney": {
    },
  • "supplementaryData": { },
  • "excludeMarketingIndicator": true,
  • "audit": {
    },
  • "restrictions": [
    ],
  • "codes": [
    ],
  • "webPage": "http://portx.io",
  • "print": {
    },
  • "products": [
    ],
  • "statement": {
    },
  • "documents": [
    ],
  • "placeAndDateOfBirth": {
    },
  • "signature": {
    },
  • "signatureVerificationId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "contact": {
    },
  • "headOfHousehold": true,
  • "civilStatus": "Single",
  • "structuredName": {
    },
  • "gender": "Female",
  • "race": "Director",
  • "profession": "ArtsEntertainmentRecreation",
  • "jobTitle": "Head of Documentation",
  • "educationLevel": null,
  • "residentialStatus": "Permanent",
  • "immigrationStatus": "Permanent",
  • "minorIndicator": true,
  • "citizenships": [
    ],
  • "countryOfResidence": "US",
  • "profile": {
    },
  • "personId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "status": "GoodStanding",
  • "users": [
    ],
  • "cards": [
    ]
}

Retrieves Card Holder Transactions

Authorizations:
jwtopenIdConnect
path Parameters
cardId
required
string (Id) [ 1 .. 300 ] 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 (Amount) <= 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 (Amount) <= 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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Core-Content-Mode
string

<SUMMARIZED|DETAILED> Indicates how the API requests the content against the core content capabilities. SUMMARIZED: Significant aspects of the content in detail. DETAILED: Expanded or enriched fields.

Responses

Response samples

Content type
[
  • {
    }
]

Loans

Loan Management

Retrieves personal loan exposure.

Authorizations:
jwtopenIdConnect
path Parameters
personId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Person Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "personId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "personName": "Jane Birkin",
  • "personStatus": "GoodStanding",
  • "taxInformation": {
    },
  • "creditRankingScales": [
    ],
  • "balances": [
    ],
  • "loans": [
    ]
}

Retrieves a list of loan accounts matching the parameters.

Authorizations:
jwtopenIdConnect
query Parameters
accountId.eq
string (Id) [ 1 .. 300 ] characters
Example: accountId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002
accountOwnershipType.eq
string
loanType.eq
string
loanBranchCode.eq
string
status.eq
string (AccountStatus) [ 1 .. 35 ] characters
Example: status.eq=Active

Specifies the current primary status of an account. Possible values are: Enabled, Dormant, Disable, Deleted, Pending, Form. Pending, Denied, Review, Approve, ChargeOff, Active, PaymentPastDue, Bankruptcy, AuthorizationProhibited, InterestProhibited, Closed, Restricted, Assumed, New, ZeroBalanceAccount.

accountNumber.eq
string (AccountNumber) <= 30 characters
Example: accountNumber.eq=012345678

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Opens a Loan

Authorizations:
jwtopenIdConnect
header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
loanBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: "SEA_1"

Identification of the account servicer institution at branch level or center level. To overlay the codes to produce a unique identifier the following expresion is used: BranchRegionCode-BranchSubdivisionCode.

accountNumber
string (AccountNumber) <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

loanType
required
string [ 1 .. 35 ] characters
Example: "Personal"

Type of the account. Possible BIAN compliant values are: Loan, Personal, ConsumerLoan, CommercialLoan, Corporate, Lease, Syndicated, MortgageLoan, Conforming, Merchandising, LineOfCredit, RevolvingCredit, LoanAgainstSecurities, DirectDepositAdvance, DemandDepositLoan, InstallmentLoan, LoanInProcess, EscrowConstruction, Escrow, HomeEquityLoan

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
number
string [ 1 .. 40 ] characters

Identification assigned by an institution or internally to connect to other applications.

schemeName
string [ 1 .. 40 ] characters
Example: "BBANIdentifier"

Name of the identification scheme, in PascalCase. Possible ISO 20022 compliant values names are: IssuerIdentificationNumber, BBANIdentifier, CHIPSUniversalIdentifier, UPICIdentifier, IBANIdentifier. Other possible values: CreditBackIdentification, UniversalLoanIdentifier, HMDAUniversalLoanIdentifier, CommitmentNumber, RecordNumber, FlexDataRecordNumber, RegistrationNumber, ExternalAccountId, MortgageNumber, DepartmentNumber.

issuer
string [ 1 .. 35 ] characters

Entity that assigns the identification.

recourseType
string (LoanRecourseType) [ 1 .. 35 ] characters
Example: "FullRecourse"

For indirect loans, the Recourse Code indicates the type of recourse that the financial institution has on the loan. Possible Values: NoRecourse, PartialRecourse, FullRecourse, FullRepurchase, PartialRepurchase, LimitedRepurchase, AsPerAgreement.

balanceType
string (Balance Type)
Example: "Asset"

Account Balance Type. Possible Values: Asset, positive transaction amount increases balance; Liability, positive transaction amount decreases balance; Equity.

lendingRelationType
string (LoanLendingRelationType) [ 1 .. 35 ] characters
Example: "Direct"

Type of lending relationship betweent the lender and the borrower. Possible Values: Direct, Dealer, BoughtParticipation, SoldParticipation, ServicedParticipation, Indirect.

securedLoanIndicator
boolean

Indicates whether the Loan is secure.

ownershipType
required
string (AccountOwnershipType) [ 1 .. 100 ] characters
Example: "SingleOwnerAccount"

Specifies the type of account ownership. Possible ISO 20022 compliant values names are: JointAccountWithSurvivorshipRights, JointAccountWithSurvivorshipRightsPayableOnDeath, JointAccountInCommon, CustodialAccount, FinancialInstitution, SingleOwnerAccount, JointAccount, JointAnd, Corporation, Organization, Business, FormalPartnership, FormalTrust, Nominee, NonProfitOrganization, NotForProfitOrganization, ForProfit, EUResidualEntity, USGovernmentOrganization, NonUSGovernmentOrganization, GovernmentOrganization, LimitedLiabilityCompany, RegisteredInvestmentCompany, Entrepreneurial, Unincorporated, LimitedPartnership, LimitedLiabilityPartnership, BareOwner, Usufructuary, Fiduciary, ServicerEmployeeAccount, BusinessTrust, FamilyTrust, Estate, PublicFunds, NonUSGovernmentOrganization, Church, Club. More general possible values: Direct, Indirect, ConvenienceAccount, CommunityProperty, CommunityPropertyWithSurvivorshipRights, TottenTrust, PayableOnDeath, UniformTransfersToMinorsAct, UniformGiftsToMinorsAct, InTrustFor, RepresentativePayee, ProfessionalAssociation.

productId
string (ProductId) [ 1 .. 36 ] characters
Example: "PD_CA_0002"

Identification of the product offered by a financial institution to its customers.

pricingStrategyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
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.

documentReference
string [ 1 .. 35 ] characters

Document location.

format
string (DocumentFormat) [ 1 .. 35 ] characters
Example: "PDF"

Specifies a choice of format for a document. Possible Values: PDF, HTML.

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

object (Jurisdiction)

Area with a set of laws under the control of a system which are different from neighbouring areas

countrySubdivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

Name of a built-up area, with defined boundaries, and a local government. Also city name.

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

object (ContactDetails)

Specifies the contact details of a person.

object (StructuredName)

The structured name is used to initialize the person name with the format

name
string [ 1 .. 350 ] characters
Example: "Jane Birkin"

Preferred name to contact the person

firstContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
lastContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (Phone)
Array of objects (Email)
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 Organization or building.

Array of objects (CommunicationChannel)
preferredMethod
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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, Default.

object (AccountContractRelatedParty)
partyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
partyType
string (PartyType)
Example: "Person"

Possible values are: Person, Organization. Also other types of servicer entities: ServicerOfficer, ExternalOrganization, Referral.

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.

agreementType
string (AgreementType)

Document or agreement type. Possible values: CardAgreement, AccountContract.

agreementSubtype
string [ 1 .. 60 ] characters

Agreement detailed category.

contractType
string (LoanContractType) [ 1 .. 40 ] characters
Example: "Regular"

Type of the loan contract. Possible values: Regular, MasterAgreement, MasterCommitment, LineOfCredit, LetterOfCredit, Tranche, MasterMorgage.

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Loan amount as defined in the contract.

creditReduceByOptions
string (LimitSubstractOptions) [ 1 .. 35 ] characters

Indicates which balance is subtracted determine the available limit. Possible values: CurrentPrincipalBalance, CurrentMaximumCredit, FundsNotAvailableAfterPayOff, FundsAvailableAtPayOff, LongTermDebtAdvances.

borrower
string [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Party that is specified as the buyer for this loan agreement.

lender
string [ 1 .. 300 ] 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.

effectiveDate
string <date>
Example: "2022-04-17"

The day a loan contract originally took effect and the day interest began to accrue.

object (MasterAgreement)

A master agreement is a document that outlines the terms and conditions of an agreement between two or more parties. It's common to use a master agreement when there are multiple agreements in place with one company.

accountId
string [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Account at Master Agreement level used as a reference for the Loan opening. Payments are auto-debited from this account.

availableCredit
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Account at Master Agreement level used as a reference for the Loan opening. Payments are auto-debited from this account.

documentReference
string [ 1 .. 35 ] characters

Document location.

format
string (DocumentFormat) [ 1 .. 35 ] characters
Example: "PDF"

Specifies a choice of format for a document. Possible Values: PDF, HTML.

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

object (MasterAgreement)

A master agreement is a document that outlines the terms and conditions of an agreement between two or more parties. It's common to use a master agreement when there are multiple agreements in place with one company.

accountId
string [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Account at Master Agreement level used as a reference for the Loan opening. Payments are auto-debited from this account.

availableCredit
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Account at Master Agreement level used as a reference for the Loan opening. Payments are auto-debited from this account.

documentReference
string [ 1 .. 35 ] characters

Document location.

format
string (DocumentFormat) [ 1 .. 35 ] characters
Example: "PDF"

Specifies a choice of format for a document. Possible Values: PDF, HTML.

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

object (LoanCollateral)

Provides details of contract collaterals

totalValue
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Total of the collaterals as an amount.

loanToValueRatio
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

The original loan amount divided by the original collateral value. For loans with maximum credit, the ratio is the original maximum credit divided by the original collateral value.

requiredPledge
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

The pledge is the physical collateral, it is provided by the borrower as security for the loan. The required Pledge LTV on loans serves as a measure to ensure the stability of the banking system. By establishing a maximum LTV ratio, banks can maintain a level of resilience to potential risks associated with loans.

Array of objects (Collateral)
Array of objects (InterestCalculation)
Array
name
string (InterestName) [ 1 .. 40 ] characters
Example: "Deposit"

Name in PascalCase of the interest that applies to the account. For instance, Deposit. Also identifications of the interest or charge.

interestCode
string <= 50 characters

Interest calculation code used by the account servicer.

dayCountBasis
string (InterestDayCountBasis) [ 1 .. 50 ] characters
Example: "Actual360"

An interest day count basis is a method used to calculate interest accrual over a period of time for loans and bonds. The method involves determining the number of days over which interest is being calculated, known as the accrual period. The resulting accrual period is then divided by a certain number to calculate the daily interest rate, which is applied to the principal balance to determine the interest payment. Possible Values: ActualActual, Actual360, Actual365, 365365, 360360, Monthly78ths, 365360, ActualSchedule, ScheduleSchedule.

calculationMethodOption
string (InterestComputationParameter) [ 1 .. 50 ] characters
Example: "LastInterest"

Specifies a parameter that apply at the interest day count basis. Possible Values: LastInterest, EqualPayment, InterestAndPrincipal, InterestSeparatedm, Amortized, AddOn, NegativeAmortization, Simple, FHLMC.

accruedDate
string <date>
Example: "2022-04-17"

An accrued date is a hypothetical point in time when the interest should have been paid.

nextInterestDate
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.

lastInterestDate
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

The period funds are earning interest.

enableIndicator
boolean
Example: true

Indicates whether the interest is enabled for automatic charge.

compoundingMethod
string [ 1 .. 35 ] characters
Example: "Deposit"

Indicates the compounding method used for interest calculations.

object (Frequency)

Frequency of the interest calculation and compounded during the term.

object (Frequency)

Specifies an event frequency

oneDayInterest
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Total interest that has accumulated over a day.

object

Details on the interest payment.

Array of objects (Balance)

Total amounts related to an interest. Possible Values: CurrentEarned, 2021AsOfDate, 2020AsOfDate, 2019AsOfDate, CutOffAvailable, CutOffAverageAvailable, CutOffAverageLedger, CutOffAverageMinimumLedger, CutOffLedger, CutOffMinimumLedger

object (InterestRenewalDetails)

Detailed interest attributes related to rate change at maturity.

object (InterestCycle)

Set of parameters used to calculate an interest cycle.

lastCalculus
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

The amount of automatic interest that was last posted to the account.

reportingIndicator
boolean

Identifies whether interest earned or paid is reportable.

reportingOptions
Array of strings (InterestReportingOption) [ items [ 1 .. 35 ] characters ]
Example: ["Deposit"]
object (TaxForm)

Information of the form requested by the tax payer.

object (Frequency)

The frequency used in calculating the Regulation DD Annual Percentage Yield (APY) when the financial institution requires interest to be withdrawn (i.e. compounding interest is not an option.) The Regulation DD Compound Frequency overrides the interest frequency only in computing the APY. For example, an account with interest paid monthly by check but disclosed as annual compounding.

annualPercentageYield
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Annual Percentage Yield (APY) is a measure used in finance to express the total return on an investment, taking into account both the interest earned and the appreciation in the investment's value, over a specified period. It is expressed as a percentage and is often used for fixed income securities such as bonds, and money market accounts.

daysSinceLastAnniversary
integer

The number of calendar days processed since the last anniversary date

Array of objects (InterestCalculationRate)

Rates involve on interest calculation.

rateType
string (InterestRateType) [ 1 .. 35 ] characters
Example: "Fixed"

Specifies the type of interest rate. Some ISO 20022 compliant values are: Fixed, Forfeit, Variable, StepUp, Scheduled, Unscheduled, Discount, FixedRateUnderlyingExposureForLife, FixedRateUnderlyingExposureWithCompulsoryFutureSwitchToFloating, FixedWithFuturePeriodicResets, FloatingLinkedToIndex, FloatingRateUnderlyingExposureForLife, FloatingRateUnderlyingExposureWithCap, FloatingRateUnderlyingExposureWithFloor, FloatingRateUnderlyingExposureWithFloorAndCap, Modular, ObligorSwapped, SwicthOptionality, Tiered, StepFrequency, RateIndex, IndexFrequency.

rateTieredType
string (InterestTieredRateType) [ 1 .. 35 ] characters
Example: "Whole"

Specifies the type of tiered interest rate. Possible values: Whole, Split, Dynamic.

rateAmountType
string (BalanceName) [ 1 .. 50 ] characters
Example: "Available"

Specifies the nature of the balance. Possible values: Current, Available, Pending, Opening, Blocked, Previous, RelatedBalance, OnHold, PendingLedger, Collected, LastAnniversary, CurrentAccrued, PreviousAccrued, CurrentWithLastCalculus, CarriedAdjustment, PaidWithPenalties, Accrued, Penalty, Fees, Withholding, CollectionLedger, LastLedger, CurrentLedger, Ledger, MinimumAvailable, MinimumLedger, Withheld, CurrentBooked, CurrentBook, LastDeposit, FloatAmount, Average, RegulationDDAvailable. Loan Balances: CashProceeds, the amount that a customer actually received, exclusive of insurance premiums, fees, and unearned discount; FinancedExpenses, indicates the amount of expenses an institution has financed for a borrower; TotalInterest; AdditionalInterest, if the date of the first payment is beyond one month from the note date, the interest for the odd days will be earned during the first interest period; DeferredUnsecuredPrincipal, is the outstanding balance of an unsecured debt. The DUPB includes any accrued interest that is yet to be paid by the borrower. The deferral typically occurs due to bankruptcy or debt relief proceedings, which temporarily halt collection efforts by the original creditor; Charge Balances: Earned, RealTimeDeliveryMaximum, Current, Financed, Prepaid, CurrentEarned, CurrentEarnedOtherEscrow, InterestPaidToDate, InterestPaidThisYear, InterestPaidPreviousYear, InterestPaidLastStatement, InterestPaidThisYear, RevolvingCreditPaid, BasePaidToDate, TotalPastDue, Escrow, AppliedEscrow, UnpaidEscrow, EscrowBucket, Principal, Interest, Fees, BilledFees, OtherEscrow, FinalAmount, FinalInterestAmount, Chapter4PreviousYear, Payments: Delinquent, FixPayment, Transaction, LoanPayOff, PrincipalAndInterest, AvailableCash, AvailableCheck, AvailableCredit, Sweep, Float, MemoLedger, Memo, AvailablePending, LedgerPending.

pastDueOptions
Array of strings[ items [ 1 .. 70 ] characters ]

Indicates how the Past Due Rate is applied to past due loans. After a loan payment is past due after certain days, interest is earned retroactively from the payment due date.

Array of objects (VariableInterestChanges)
Array of objects (ChargeCalculation)
Array
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

chargeId
string [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Unique identifier of charge.

name
string (ChargeName) [ 1 .. 60 ] characters
Example: "CardLatePayment"

Name of the charge calculation in PascalCase. Possible values: Fee, Overdraft, CardLatePayment, CashAdvance, LatePayment, CashWithdrawal, EarlyWithdrawal, Dormant, EIM, NonSufficientFunds, ATM, BillPayment, FDIC, Overdraft, OverdraftInterest, OverdraftCourtesy, ReturnedItem, DeclinedCheck. Service Charge values: AutomaticActivityCharge, MaintenanceActivityCharge, MaintenanceServiceCharge. ServiceCharge, ServiceChargeCreditBack. Also other external codes to identify the charge.

status
string (ChargeStatus) <= 40 characters
Example: "Charged"

Specifies the current status of the charge. Possible values are: Charged, Waived, AnalysisAddenda, AddendaCharged, AddendaChargedOnCycleDay.

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount charged for the service.

currency
string = 3 characters ^([A-Z]{3})?$
Example: "USD"

Charge currency

rate
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

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, 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, Fee, Insurance, NonTaxable, Recurring, Taxable.

exemptIndicator
boolean

Indicates whether the account is exempt of the charge.

exemptPeriodsNumber
integer

Indicates the number of charge periods that the account is exempt from charges.

Array of objects (GenericCode)

Additional charge codes. Possible values: CalculationCodeNumber, ServiceChargePrefix, ServiceChargeCode.

calculationMethodCode
string [ 1 .. 60 ] characters

Servicer charge calculation code in Pascal Case. Possible values: FIFO, older payment past due. LIFO, most recent payment past due. Also could be a Bank defined string.

calculationMethodOptions
Array of strings (ChargeCalculationMethodOption) [ items [ 1 .. 70 ] characters ]

Indicates other calculation method options for charge calculation.

options
Array of strings (ChargeOptions) [ items [ 1 .. 50 ] characters ]
Example: ["NSFDefault"]
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, Monthly, Annual, FullTerm, RemainingTerm, Monthly78th

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.

maximumNumber
integer

Maximum Number of charges.

minimumAmount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Minimum amount of money asked or paid for the charge.

enableIndicator
boolean
Example: true

Indicates whether the charge is enabled for automatic charge.

object (InterestCalculationDescriptor)

Set of parameters used to calculate an interest.

debitIndicator
boolean

Indicates whether the charge is automatically debited from the defined account.

Array of objects (AccountPayment)

Payments methods to waive o to pay back the charge.

object (Frequency)

Specifies an event frequency

Array of objects (Balance)
description
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
trialPeriodAmount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount during the trial period. The loan trial period is typically an agreed-upon phase within the loan contract during which the borrower has the option to explore and experience the loan product without being committed to the full loan amount.

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

The loan term is the period of time that a loan is repaid, calculated from the date of the initial loan disbursement.

object (TemporalDuration)

Describes a temporal duration.

timesExtended
integer <= 100

The number of times the loan has been extended over its term.

timesRenewed
integer <= 100

The number of times the loan has been renewed over its term.

Array of objects (AlternativeTerm)
Array of objects (RepaymentSchedule)

Schedule of the principal payments and interests defined for the loan contract.

Array
Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

minimumDueAmount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects (PaymentIdentification)
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

billingOption
string <= 60 characters

AutomaticPayment: This billing option allows the borrower to choose the "automatic payment" method for their loan. The borrower will specify their preferred payment day, usually the 1st or the last day of the month. The lender will automatically debit the borrower's bank account on the specified payment day, without the need for any manual intervention. RegularBilling: In this billing option, the borrower will be responsible for making their loan payments manually. The borrower must pay the interest and the principal amount at regular intervals, usually monthly, quarterly, or annually. LumpSumPayment: In this billing option, the borrower is required to pay off the entire loan balance in a single payment, usually at the end of the loan term. This payment includes both the outstanding principal amount and the accumulated interest. NegotiatedBillingOption: In this option, the lender and the borrower may negotiate and agree on a unique payment schedule that best suits their individual financial situations. This option may involve customized payment frequencies, additional payment fees, or a combination of automatic and manual payment options. AcceleratedBillingOption: In this billing option, the borrower may choose to make extra loan payments, either as a lump sum or over a specific period. This can potentially reduce the overall interest payments and loan repayment period.

Array of objects (SyndicatedLoanLender)

Loan offered by a group of lenders (called a syndicate).

Array
lenderId
required
string [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Party which provides an amount of money available to others to borrow.

lenderType
required
string (PartyType)
Example: "Person"

Possible values are: Person, Organization. Also other types of servicer entities: ServicerOfficer, ExternalOrganization, Referral.

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 ^100|(([1-9][0-9]{0,1})([.][0-9]{0,8}){0,1})$...
Example: "25"

Share part in the syndicated loan.

intraCompanyLoanIndicator
boolean
Example: false

Indicates whether the loan is an intra-company loan.

agreementAccountId
string [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Account used as a reference for the Loan opening. Payments are auto-debited from this account.

required
Array of objects (AccountDetailedParty)
Array
Array of objects (GenericIdentification)
Array of objects (GenericCode)

Codes to link the party with other systems or to classify the party. Possible values: RemoteDepositRisk.

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.

nameTemplateId
string (NameTemplateId) [ 1 .. 36 ] characters
Example: "1"

Template used to display the party name. This is an external id provided by the account servicer.

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.

object (PlaceAndDateOfBirth)

Date and place of birth of a person.

gender
string (Gender) [ 1 .. 36 ] characters
Example: "Female"

Specifies the gender of the person. Possible Values: Female, Male, NonBinary

status
string (PartyStatus) [ 1 .. 35 ] characters
Example: "GoodStanding"

Specifies the current primary status of a party. Possible values are: GoodStanding, FraudAlert, BadCustomer, Active, Delinquent, Default, HighRisk, UnderReview, HotCarded, WildCarded. Other possible values: PersonalBankruptcy, GrowingConcern, WatchLoan, InReceivership, Chapter11, Liquidation.

statusDateAndTime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
coveredByMilitaryLendingActIndicator
boolean

Indicates if the borrower is covered under the Military Lending Act.

militaryMemberIndicator
boolean

Indicates whether the person is is service member/military.

object (DateTimePeriod)
object (Employment)
object (Audit)

Resource Audit Information. Captures the creation, modification and maintenance details.

Array of objects (PostalAddress)
object (StructuredName)

The structured name is used to initialize the person name with the format

Array of objects (Phone)
organizationType
string (OrganizationType)
Example: "Corporation"

Specifies the legal standing of the organization. Possible values are: Government, NonGoverment NonUSGovernmentOrganization, USGovernmentOrganization FinancialInstitution, SoleProprietorship, UnincorporatedAssociation, LimitedLiabilityPartnership, LimitedLiabilityCompany, SingleMemberLimitedLiabilityCompany, LimitedPartnership, FormalPartnership, GeneralPartnership, Business, Corporation, NotForProfit, ForProfit, NonProfitCorporation, NonProfit, Club, Supranational, Sovereign, Municipal, Province, State, County, National, ExemptionTrust, LivingTrust, EmployeeTrust, RevocableTrust, IrrovocableTrust, NakedTrust, FamilyTrust, BussinesTrust, CliffordTrust, FormalTrust, PublicAgency, Association, Church, PublicFunds. International & Foreign Business Entities: PersonaFisica, SociedadCivil, SociedadAnonimaCapitalVariable, SociedadResponsabilidadLimitada, SociedadAnonimaCapitalVariable.

customerType
string (CustomerType)
Example: "Consumer"

A customer type of a bank account can be classified into different categories based on the account's features, purpose, and benefits. Possible Values: Personal, Business, Consumer, Organization, ThirdParty, Estate, Employee, ForeignConsumer.

taxReportingIndicator
boolean

Account tax reporting typically involves obtaining and submitting records related to your tax obligations. For individuals, this may include income, qualifying deductions, and investment gains or losses. Businesses, on the other hand, have additional complexities, such as tracking funds directed towards specific business expenses and shareholders.

taxStatus
string
Example: "Exempt"

Exempt, Retain, ExemptExpired, VoluntaryWithholding, Chapter3, Chapter4, C-Corp, S-Corp, Certified, W-8Required, NotCertified.

Array of objects (PaymentCardDescriptor)
Array of objects (Balance)

Balances related to the party

Array of objects (SpotDate)
Array of objects (IdentityQuestion)
partyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
partyType
string (PartyType)
Example: "Person"

Possible values are: Person, Organization. Also other types of servicer entities: ServicerOfficer, ExternalOrganization, Referral.

partyAccountRole
string (AccountPartyRole) [ 1 .. 35 ] characters
Example: "AccountOwner"

Type of the account party role. Some possibles values are: Comaker, Cosigner, AccountOwner, AccountSigner, ATMDebitCardHolder, CreditCardHolder, LiquidityManager, Endorser, 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, Minor, Nominee, SecondaryOwner, Executor, Beneficiary, PrimaryServicerOfficer, SecondaryServicerOfficer, AccountOpenningOfficer, CustomerServiceOfficer, PowerOfAttorney, ContingentBeneficiary, Fiduciary, ControlPerson, AuthorizedPerson, Dealer, DoingBusinessAs, Grantor, SecondaryTrustee, RepresentativePayee, RestrictedOwner.

partyAccountRoleCode
string
Example: "50"

Bank defined party account role.

beneficiaryPercentage
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Percentage value of the ownership that the party has in the account.

beneficiaryAmount
string <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Actual dollar amount of the liability for this account.

accountOwnerRelation
string [ 1 .. 40 ] characters
Example: "PrimaryServicerOfficer"

Identifies how the party is related to the owner of the account.

Array of objects (Restriction)

Party restrictions on the account capabilities

Array of objects (RelatedAccount)
Array
accountRelationType
string (AccountRelationType)
Example: "SubAccount"

Account relation role. Possible values are: Parent, EscrowAccount, SubAccount, ControlAccount, CrossAccount, ChargeAccount, AssociatedAccount, IRAAccount, CombinedStatement, SecondaryCombinedStatement, SummaryAccount, FundingSource, CompensatingAccount. Payment related values: Authorized, Counterpart

accountId
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

accountNumber
string (AccountNumber) <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

accountType
string (RelatedAccountType) [ 1 .. 60 ] characters
Example: "Checking"

Type of the account. Some possible ISO 20022 compliant values are: Checking, CardAccount, CashPayment, Charges, CashIncome, Commission, ClearingParticipantSettlementAccount, LimitedLiquiditySavingsAccount, MarginalLending, MoneyMarket, NonResidentExternal, Overdraft, OverNightDeposit, Settlement, Salary, Savings, Tax, TransactingAccount, CashTrading, VirtualAccount, CreditCard, DebitCard, Universal, Investment, EpurseCard, CertificateOfDeposit, MoneyMarketChecking, RetirementAccount, StockOrBond, PrePaid, FleetCard, Cash, DebitAccount, CreditAccount, Benefit, HealthSavingsAccount, FlexibleSpendingAccount, ForBenefitOf, Estate, ClientTrustAccount, LawyersTrustAccount, KeoghPlanAccount, UniformTransfersToMinorsAct, UniformGiftsToMinorsAct, ReserveFunds, SelfDirectedBrokerage, Loan, Ledger.

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.

productId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
Array of objects (GenericCode)

Account related codes

principalAmount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount of money borrowed (excluding interest).

interestAmount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Interest on the principal amount.

maturityDate
string <date>
Example: "2022-04-17"

Current final repayment date. The maturity date is automatically calculated based upon the first scheduled payment date, the scheduled payment frequency, and the number of payments.

object (MortgageLoan)

Mortgage information of a Loan

fHAStateNumber
string [ 1 .. 2 ] characters
Example: "99"

Federal Housing Administration's (FHA) two-digit state code, which is used to identify the state where a mortgage loan is originated or where the property is located.

fHACountyNumber
string [ 1 .. 2 ] characters
Example: "88"

Federal Housing Administration's (FHA) two-digit county code, which is used to identify the state where a mortgage loan is originated or where the property is located.

censusTract
string (CensusTract) = 5 characters
Example: "12345"

A census tract, census area, census district or meshblock is a geographic region defined for the purpose of taking a census

censusBlock
string (CensusBlock) = 4 characters
Example: "1234"

Census blocks are used to partition counties into smaller areas for the purpose of collecting and presenting census data.

cBSACode
string (CBSACode) = 5 characters
Example: "49780"

Core-based statistical area. Metropolitan statistical area (MSA) is the formal definition of a region that consists of a city and surrounding communities that are linked by social and economic factors. Micropolitan Statistical Areas (MISA) are CBSAs associated with at least one urban cluster that has a population of at least 10,000, but less than 50,000. The micropolitan statistical area comprises the central county or counties or equivalent entities containing the core, plus adjacent outlying counties having a high degree of social and economic integration with the central county as measured through commuting.

cBSAType
string (CBSAType) [ 1 .. 10 ] characters
Example: "MSA"

Type of Core-based statistical area. Possible values: MSA, MISA

hMDAReportingIndicator
boolean

Indicates whether the loan is subject of HMDA reporting. The Home Mortgage Disclosure Act (HMDA) is a federal law in the United States that requires most mortgage lenders to report information about the mortgage loans they originate or purchase.

hMDAOccupationStatus
string <= 36 characters
Example: "Vacant"

Indicates whether the property associated with a mortgage loan is owner-occupied, investor-owned, or vacant. Possible Values: OwnerOccupied, InvestorOwned, Vacant.

hMDAPropertyType
string <= 36 characters
Example: "OneToFourFamily"

Indicates the HMDA type of property associated with a mortgage loan. Possible values: OneToFourFamily, MultiFamily, SingleFamily, ManufacturedHome.

propertyPurpose
string <= 36 characters
Example: "OneToFourFamily"

Indicates the type of property associated with a mortgage loan. Possible values: PrimaryResidence, SecondResidence, Investment.

programs
string <= 36 characters
Example: "FHA"

Mortgage programs are financing options offered by various government agencies, private lenders, and other organizations to help individuals and families purchase or refinance real estate. Possible Values: FHA, FmHA, VA, HomeImprovement, USDA, Jumbo.

rateForecastDays
integer

Adjustable Rate Mortgage (ARM) is a type of mortgage loan in which the interest rate changes periodically throughout the life of the loan. ARM Rate Forecast Days represent the number of days for which the lender provides a forecast of the ARM interest rate.

Array of objects (SpotDate)
Array
name
string (SpotDateName) [ 1 .. 40 ] characters
Example: "Expiration"

Possible values por projected dates: Forecast, Expiration, LastNonFinancial, Escheat. Possible values for past dates: IRALastRollOver. Other possible values: EffectiveDate, ResponseByDate.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (SpotDate)

Loan relevant past dates. Possible values: EarlyInterventionNoticeDate.

Array
name
string (SpotDateName) [ 1 .. 40 ] characters
Example: "Expiration"

Possible values por projected dates: Forecast, Expiration, LastNonFinancial, Escheat. Possible values for past dates: IRALastRollOver. Other possible values: EffectiveDate, ResponseByDate.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (Restriction)
Array
name
required
string [ 1 .. 60 ] characters
Example: "WireTransferIn"

Name of the restriction in PascalCase. Possible values: TransferIn, TransferOut, WireTransferIn, WireTransferOut, ACHTransferIn, ACHTransferOut, ForeignIncomingWires, ForeignOutgoingWires, ACHTransfers, InternetBankingTransfer, InternetView, InternetInquiry, ForeignOutgoingIran, Withdrawals, Renew, Transfers, AdvanceTransfer, OnlineBanking, ElectronicBanking, InvestmentAllowed, InvestmentSetUpAllowed, DebitCardAllowed, CheckOrderAllowed, AutomaticSweep, AccountManagement

restrictionPurpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
enableIndicator
boolean
Example: true

Indicates whether the capability is allowed or not.

disableConditions
Array of strings (ConditionName) [ items [ 1 .. 36 ] characters ]
Example: ["LessThanMinAmount"]

Conditions that disabel the restriction.

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.

status
string (RestrictionStatus) [ 1 .. 36 ] characters
Example: "Pending"

Specifies the status of a restriction enablement request. Possible values: Enable, Pending, InquiryOnly, Disable, Requested.

Array of objects (Limit)
Array
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

name
required
string [ 1 .. 60 ] characters
Example: "CreditLimit"

Name of the limit in PascalCase. Possible values: NSF, UncollectedFunds, Overdraft, CreditLimit, CreditCard, Withdraw, CreditCardWithdraw, ForeignFeesWaived, CreditTransactions, DebitTransactions, ATMSurchargeReimbursement, CashAdvance, ACHInTransfers, ACHOutTransfers, OverdraftProgram, Threshold, MinimumTransfer, MinimumAdvance, DomesticWireTransferIn, DomesticWireTransferOut, ForeignWireTransferIn, ForeignWireTransferOut.

limitType
string (LimitType) <= 35 characters
Example: "DirectDebit"

Specifies the type of risk management limit. Bilateral, NetBilateral, IndirectBilateral, Global, MandatoryBilateral, DiscretionaryBilateral, DirectDebit, SingleCustomerDirectDebit, SingleFinancialInstitutionDirectDebit, TotalDailyCustomerDirectDebit, TotalDailyFinancialInstitutionDirectDebit, AutoCollateralisation, UnsecuredCredit, ExternalGuarantee, Revolving, NotRevolving.

channelType
string [ 1 .. 30 ] characters

Channel type for which this limit applies. Possible values: OnlineATM, OfflineATM, ATM, SaleTerminal, : Check, ACHDebit, DebitCard, BillPayment.

amount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount limit

currency
string = 3 characters ^([A-Z]{3})?$
Example: "USD"

Amount limit currency.

number
integer

Number limit.

enableIndicator
boolean
Example: true

Indicates whether the limit is enabled or not.

feesConsentIndicator
boolean
Example: true

Indicates that the institution received customer consent to assess fees when the limit is exceeded.

percentageIndicator
boolean

Indicates if the limit is calculated as a percentage.

percentage
string (Percentage) <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Value expressed as a positive or negative percentage, rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. total number of digits: 11 number of digits in fractional part: 10 Max Value: 100

temporaryIndicator
boolean
Example: true

Indicates whether the limit is temporary or not.

object (DateTimePeriod)
object (Frequency)

Renewal frequency

usedAmount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount limit used

usedNumber
integer

Number limit used.

usedPercentage
string (Percentage) <= 23 characters [-]{0,1}100|[-]{0,1}(([1-9][0-9]{0,1})([.][0-...
Example: "25"

Value expressed as a positive or negative percentage, rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. total number of digits: 11 number of digits in fractional part: 10 Max Value: 100

status
string (LimitStatus) <= 35 characters
Example: "Requested"

Specifies the current status of a limit. Possible values are: Enabled, Disabled, Deleted, Requested, NotAuthorized (The limit is not authorized by the customer). Other values: CustomerEnrolled, CustomerNotEnrolled, InstitutionEnrolled.

statusDateAndtime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
object (LimitHistory)

Historic values of a Limit

Array of objects (Balance)
Array of objects (GenericCode)

Additional limits codes.

accessConditions
Array of strings (ConditionName) [ items [ 1 .. 36 ] characters ]
Example: ["LessThanMinAmount"]

Limit access condition. Possible values: BeforeTransfers, AfterTransfers: Overdraft Limit is accessed before or after automatic transfers. Other values: POSTransactions, ATMTransactions, when the customer authorize the payment of ATM or POS transactions, if the transaction was to overdraw the account.

notificationOptions
Array of strings
Example: ["Exception"]
Array of objects (AccountPayment)

Payments methods to cover the amount limit overdraft.

Array of objects (GenericCode)

Codes to classify loans.

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

value
string [ 1 .. 35 ] characters
Example: "195"

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
Array of objects (InterestCalculation)
Array
name
string (InterestName) [ 1 .. 40 ] characters
Example: "Deposit"

Name in PascalCase of the interest that applies to the account. For instance, Deposit. Also identifications of the interest or charge.

interestCode
string <= 50 characters

Interest calculation code used by the account servicer.

dayCountBasis
string (InterestDayCountBasis) [ 1 .. 50 ] characters
Example: "Actual360"

An interest day count basis is a method used to calculate interest accrual over a period of time for loans and bonds. The method involves determining the number of days over which interest is being calculated, known as the accrual period. The resulting accrual period is then divided by a certain number to calculate the daily interest rate, which is applied to the principal balance to determine the interest payment. Possible Values: ActualActual, Actual360, Actual365, 365365, 360360, Monthly78ths, 365360, ActualSchedule, ScheduleSchedule.

calculationMethodOption
string (InterestComputationParameter) [ 1 .. 50 ] characters
Example: "LastInterest"

Specifies a parameter that apply at the interest day count basis. Possible Values: LastInterest, EqualPayment, InterestAndPrincipal, InterestSeparatedm, Amortized, AddOn, NegativeAmortization, Simple, FHLMC.

accruedDate
string <date>
Example: "2022-04-17"

An accrued date is a hypothetical point in time when the interest should have been paid.

nextInterestDate
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.

lastInterestDate
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

The period funds are earning interest.

enableIndicator
boolean
Example: true

Indicates whether the interest is enabled for automatic charge.

compoundingMethod
string [ 1 .. 35 ] characters
Example: "Deposit"

Indicates the compounding method used for interest calculations.

object (Frequency)

Frequency of the interest calculation and compounded during the term.

object (Frequency)

Specifies an event frequency

oneDayInterest
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Total interest that has accumulated over a day.

object

Details on the interest payment.

Array of objects (Balance)

Total amounts related to an interest. Possible Values: CurrentEarned, 2021AsOfDate, 2020AsOfDate, 2019AsOfDate, CutOffAvailable, CutOffAverageAvailable, CutOffAverageLedger, CutOffAverageMinimumLedger, CutOffLedger, CutOffMinimumLedger

object (InterestRenewalDetails)

Detailed interest attributes related to rate change at maturity.

object (InterestCycle)

Set of parameters used to calculate an interest cycle.

lastCalculus
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

The amount of automatic interest that was last posted to the account.

reportingIndicator
boolean

Identifies whether interest earned or paid is reportable.

reportingOptions
Array of strings (InterestReportingOption) [ items [ 1 .. 35 ] characters ]
Example: ["Deposit"]
object (TaxForm)

Information of the form requested by the tax payer.

object (Frequency)

The frequency used in calculating the Regulation DD Annual Percentage Yield (APY) when the financial institution requires interest to be withdrawn (i.e. compounding interest is not an option.) The Regulation DD Compound Frequency overrides the interest frequency only in computing the APY. For example, an account with interest paid monthly by check but disclosed as annual compounding.

annualPercentageYield
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Annual Percentage Yield (APY) is a measure used in finance to express the total return on an investment, taking into account both the interest earned and the appreciation in the investment's value, over a specified period. It is expressed as a percentage and is often used for fixed income securities such as bonds, and money market accounts.

daysSinceLastAnniversary
integer

The number of calendar days processed since the last anniversary date

Array of objects (InterestCalculationRate)

Rates involve on interest calculation.

rateType
string (InterestRateType) [ 1 .. 35 ] characters
Example: "Fixed"

Specifies the type of interest rate. Some ISO 20022 compliant values are: Fixed, Forfeit, Variable, StepUp, Scheduled, Unscheduled, Discount, FixedRateUnderlyingExposureForLife, FixedRateUnderlyingExposureWithCompulsoryFutureSwitchToFloating, FixedWithFuturePeriodicResets, FloatingLinkedToIndex, FloatingRateUnderlyingExposureForLife, FloatingRateUnderlyingExposureWithCap, FloatingRateUnderlyingExposureWithFloor, FloatingRateUnderlyingExposureWithFloorAndCap, Modular, ObligorSwapped, SwicthOptionality, Tiered, StepFrequency, RateIndex, IndexFrequency.

rateTieredType
string (InterestTieredRateType) [ 1 .. 35 ] characters
Example: "Whole"

Specifies the type of tiered interest rate. Possible values: Whole, Split, Dynamic.

rateAmountType
string (BalanceName) [ 1 .. 50 ] characters
Example: "Available"

Specifies the nature of the balance. Possible values: Current, Available, Pending, Opening, Blocked, Previous, RelatedBalance, OnHold, PendingLedger, Collected, LastAnniversary, CurrentAccrued, PreviousAccrued, CurrentWithLastCalculus, CarriedAdjustment, PaidWithPenalties, Accrued, Penalty, Fees, Withholding, CollectionLedger, LastLedger, CurrentLedger, Ledger, MinimumAvailable, MinimumLedger, Withheld, CurrentBooked, CurrentBook, LastDeposit, FloatAmount, Average, RegulationDDAvailable. Loan Balances: CashProceeds, the amount that a customer actually received, exclusive of insurance premiums, fees, and unearned discount; FinancedExpenses, indicates the amount of expenses an institution has financed for a borrower; TotalInterest; AdditionalInterest, if the date of the first payment is beyond one month from the note date, the interest for the odd days will be earned during the first interest period; DeferredUnsecuredPrincipal, is the outstanding balance of an unsecured debt. The DUPB includes any accrued interest that is yet to be paid by the borrower. The deferral typically occurs due to bankruptcy or debt relief proceedings, which temporarily halt collection efforts by the original creditor; Charge Balances: Earned, RealTimeDeliveryMaximum, Current, Financed, Prepaid, CurrentEarned, CurrentEarnedOtherEscrow, InterestPaidToDate, InterestPaidThisYear, InterestPaidPreviousYear, InterestPaidLastStatement, InterestPaidThisYear, RevolvingCreditPaid, BasePaidToDate, TotalPastDue, Escrow, AppliedEscrow, UnpaidEscrow, EscrowBucket, Principal, Interest, Fees, BilledFees, OtherEscrow, FinalAmount, FinalInterestAmount, Chapter4PreviousYear, Payments: Delinquent, FixPayment, Transaction, LoanPayOff, PrincipalAndInterest, AvailableCash, AvailableCheck, AvailableCredit, Sweep, Float, MemoLedger, Memo, AvailablePending, LedgerPending.

pastDueOptions
Array of strings[ items [ 1 .. 70 ] characters ]

Indicates how the Past Due Rate is applied to past due loans. After a loan payment is past due after certain days, interest is earned retroactively from the payment due date.

Array of objects (VariableInterestChanges)
object (FinancialStatement)

Specifies financial statement details.

object (Frequency)

The frequency of the regular statement.

fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

cycle
string [ 1 .. 35 ] characters
Example: "Monthly"

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

object (Frequency)

The next frequency of the regular statement.

fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

cycle
string [ 1 .. 35 ] characters
Example: "Monthly"

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

Array of objects (StatementCommunicationChannel)
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

channelIdentification
string (CommunicationChannelIdentification) [ 1 .. 128 ] characters
Example: "011-02010020202"

Communication value such as phone number or email address.

format
string (DocumentFormat) [ 1 .. 35 ] characters
Example: "PDF"

Specifies a choice of format for a document. Possible Values: PDF, HTML.

printOnNextCycleIndicator
boolean

Indicates whether the statement will be produced at the end of the next statement cycle.

Array of objects (GenericCode)

Codes to determine configurarion options for alerts and notifications. Possible code names: NoticeOption.

format
string (DocumentFormat) [ 1 .. 35 ] characters
Example: "PDF"

Specifies a choice of format for a document. Possible Values: PDF, HTML.

Array of objects (GenericCode)

Codes related to statements or internal handling codes associated with the statement. Possible Values: CombinedCode, SpecialStatement, DetailsFormat, StatementGroup, ProfitabilityOption.

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

value
string [ 1 .. 35 ] characters
Example: "195"

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
Array of objects (GenericIdentification)

Identification of statement instances and related. Possible values: schemeName: LastCombinedStatement, CombinedStatementAccountId

Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification.

schemeName
required
string [ 1 .. 35 ] characters

Name of the identification scheme.

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.

templateCode
string (StatementTemplateId) [ 1 .. 36 ] characters
Example: "1"

Template used to create the statement document. This is an external code provided by the account servicer.

object (Period)
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

object (Period)
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

lastStatementDate
string <date>
Example: "2022-04-17"

The date of the last statement.

nextStatementDate
string <date>
Example: "2022-04-17"

The date of the next statement.

serviceChargeDate
string <date>
Example: "2022-04-17"

The date on which service charges will be applied to an account

previousStatementDate
string <date>
Example: "2022-04-17"

The date of the statement previous from the last.

lastRegularStatementDate
string <date>
Example: "2022-04-17"

The date of the last regular statement.

truncationOptions
Array of strings
Example: ["ItemsIncluded"]
accountNameIndicator
boolean

Indicates whether the account name is printed on the statement.

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, Default.

combineType
string [ 1 .. 36 ] characters
Example: "SavingsStatement"

Indicates whether account transactions are printed on a combined statement. Possible combinations: CheckingStatement, SavingsStatement, PrimaryAccount, SecondaryAccount.

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

profitabilityModelId
string (StatementModelId) [ 1 .. 36 ] characters
Example: "1"

Model used to calculate customer profitability. This is an external id provided by the account servicer.

lastIRAStatementDate
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 (AccountProfile)
profileType
string [ 1 .. 40 ] characters
Example: "Personal"

Account profile category. Possible Values: Personal, NonPersonal.

riskLevel
string [ 1 .. 35 ] characters
Example: "High"

Laundering risk level

qualityScore
string (QualityScore) [ 2 .. 10 ] characters

The quality score is based on a borrower's credit history, collateral, and the likelihood of repayment.

Array of objects (RiskMeasure)
Array
name
string (CreditRankingScaleName) [ 1 .. 35 ] characters
Example: "StandardAndPoors"

Most commonly used credit ranking scales. Possible Values: StandardAndPoors, MoodysInvestors. Also other values: Original, 1, 2, 3, Current.

level
string (RiskLevel) [ 1 .. 35 ] characters
Example: "High"

Specifies the customer’s money laundering risk. Possible values: VeryLow, Low, Medium, Medium toHigh, ModerateHigh, High, ExtremelyHigh, NoDetermine.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (GenericCode)

Additional risk measure codes. Possible values: RiskRatingCode

Array of objects (CreditRankingScale)

Borrower credit ranking scores

Array
name
string (CreditRankingScaleName) [ 1 .. 35 ] characters
Example: "StandardAndPoors"

Most commonly used credit ranking scales. Possible Values: StandardAndPoors, MoodysInvestors. Also other values: Original, 1, 2, 3, Current.

score
string [ 2 .. 10 ] characters
Example: "AAA"
date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (GenericCode)

Additional ranking scale codes. Possible values: RiskRatingCode

object (BankruptcyProfile)
chapter
string [ 1 .. 10 ] characters
Example: "11"

The section on the Bankruptcy Code that sets out the rules and procedures for a particular type of bankruptcy. Possible Values: 7, 11, 13, 12, and 9.

status
string [ 1 .. 40 ] characters
Example: "Petition"

Bankruptcy status. Possible values: Petition, Discharged, DebtReaffirmation, DebtReaffirmationRescinded, PlanConfirmed, PlanCompleted, Withdrawn.

statementOption
string [ 1 .. 40 ] characters
Example: "RegularBillingStatement"

Statement option. Possible Values: RegularBillingStatement, BankruptcyBillingStatement

object (Frequency)

Indicates the frequency that the history profile payment status is established. Values are dependent upon credit bureau standards.

fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

cycle
string [ 1 .. 35 ] characters
Example: "Monthly"

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

paymentHistoryOption
string [ 1 .. 40 ] characters
Example: "NotRecalculate"

Indicates whether the Payment History Profile will be recalculated. Possible Values: Default, NotRecalculate, RecalculateAndSetToDefault, RecalculateAndSetToNot.

Array of objects (Balance)

Amount balances related to the credit profile. Possible Values: CreditHighBalance.

Array
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

balanceName
string (BalanceName) [ 1 .. 50 ] characters
Example: "Available"

Specifies the nature of the balance. Possible values: Current, Available, Pending, Opening, Blocked, Previous, RelatedBalance, OnHold, PendingLedger, Collected, LastAnniversary, CurrentAccrued, PreviousAccrued, CurrentWithLastCalculus, CarriedAdjustment, PaidWithPenalties, Accrued, Penalty, Fees, Withholding, CollectionLedger, LastLedger, CurrentLedger, Ledger, MinimumAvailable, MinimumLedger, Withheld, CurrentBooked, CurrentBook, LastDeposit, FloatAmount, Average, RegulationDDAvailable. Loan Balances: CashProceeds, the amount that a customer actually received, exclusive of insurance premiums, fees, and unearned discount; FinancedExpenses, indicates the amount of expenses an institution has financed for a borrower; TotalInterest; AdditionalInterest, if the date of the first payment is beyond one month from the note date, the interest for the odd days will be earned during the first interest period; DeferredUnsecuredPrincipal, is the outstanding balance of an unsecured debt. The DUPB includes any accrued interest that is yet to be paid by the borrower. The deferral typically occurs due to bankruptcy or debt relief proceedings, which temporarily halt collection efforts by the original creditor; Charge Balances: Earned, RealTimeDeliveryMaximum, Current, Financed, Prepaid, CurrentEarned, CurrentEarnedOtherEscrow, InterestPaidToDate, InterestPaidThisYear, InterestPaidPreviousYear, InterestPaidLastStatement, InterestPaidThisYear, RevolvingCreditPaid, BasePaidToDate, TotalPastDue, Escrow, AppliedEscrow, UnpaidEscrow, EscrowBucket, Principal, Interest, Fees, BilledFees, OtherEscrow, FinalAmount, FinalInterestAmount, Chapter4PreviousYear, Payments: Delinquent, FixPayment, Transaction, LoanPayOff, PrincipalAndInterest, AvailableCash, AvailableCheck, AvailableCredit, Sweep, Float, MemoLedger, Memo, AvailablePending, LedgerPending.

amount
string (Amount) <= 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

count
integer

Number of transactions added to the amount.

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 (GenericCode)

Bank defined codes to classify balances. Possible values: BalanceCategory, BalanceType, PartyAgreementNumber.

customerType
string (CustomerType)
Example: "Consumer"

A customer type of a bank account can be classified into different categories based on the account's features, purpose, and benefits. Possible Values: Personal, Business, Consumer, Organization, ThirdParty, Estate, Employee, ForeignConsumer.

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

Array of objects (CreditRankingScale)
creditReportAddressIndicatorCode
string

is a code or marker used by credit reporting agencies to indicate a match or mismatch between the address supplied in an inquiry and the address they have on file for a consumer.

creditReportAddressIndicatorDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
consumerCreditReportInformation
string [ 1 .. 1025 ] characters
Example: "This is a description."

Information provided by the Consumer Credit Report.

consumerCreditReportDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
eCOACode
string

The ECOA code indicates how customer account information is reported to the Credit Bureau in keeping with the Equal Credit Opportunity Act.

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 (Audit)

Resource Audit Information. Captures the creation, modification and maintenance details.

status
string (AuditStatus) [ 1 .. 35 ] characters

Maintenance status of a resource. Possible values: Requested, Created, Changed, Deleted

creationDate
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.

creationBranchId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
object (User)

User information of a person.

personId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
userId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
userName
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

purpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
audit
object (Audit) Recursive

Resource Audit Information. Captures the creation, modification and maintenance details.

lastModificationChannel
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

lastModificationDate
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 (AuditChannel)

Activity audit throught communication channles

Array
lastActivityDate
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 (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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

activityType
string (AuditActivityType) [ 1 .. 35 ] characters

Maintenance activity of a resource. Possible values: Transaction, Modification, Deposit, Withdrawal, Creation, DirectDeposit, CardActivation, CardActivationByCallerId, CardActivationByCodeAndCallerId, Closure, HSACreation

amount
string (PositiveAmount) <= 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

object (LoanDetailedStatus)

Specifies the current state of a loan.

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, WriteDown, WrittenOff, Active, PaymentPastDue, Foreclosure, Bankruptcy.

instructionStatus
string (InstructionStatus) [ 1 .. 35 ] characters
Example: "Queued"

Details about the processing of a request. Possible values are: Rejected, Completed, Queued.

statusDateAndTime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
reason
string (StatusReason) [ 1 .. 36 ] characters
Example: "BlockedAccount"

Reason for the status. Possible Values: AbortedClearingTimeout, AbortedClearingFatalError, AbortedSettlementTimeout, AbortedSettlementFatalError,TimeoutCreditorAgent, TimeoutInstructedAgent, OfflineAgent, OfflineCreditorAgent, ErrorCreditorAgent, ErrorInstructedAgent, TimeoutDebtorAgent,IncorrectAccountNumber, InvalidDebtorAccountNumber,InvalidCreditorAccountNumber, ClosedAccountNumber,ClosedDebtorAccountNumber, BlockedAccount,ClosedCreditorAccountNumber, InvalidBranchCode,InvalidAccountCurrency, InvalidDebtorAccountCurrency,InvalidCreditorAccountCurrency, InvalidAccountType,InvalidDebtorAccountType,InvalidCreditorAccountType,AccountDetailsChanged, CardNumberInvalid, TransactionForbidden, InvalidBankOperationCode, TransactionNotSupported, InvalidAgentCountry, InvalidDebtorAgentCountry, InvalidCreditorAgentCountry, UnsuccesfulDirectDebit, InvalidAccessRights,PaymentNotReceived, AgentSuspended,CreditorAgentSuspended, NotAllowedBookTransfer, ForbiddenReturnPayment, IncorrectAgent, ZeroAmount, NotAllowedAmount, NotAllowedCurrency, InsufficientFunds, Duplication, TooLowAmount, BlockedAmount, WrongAmount, InvalidControlSum, InvalidTransactionCurrency, InvalidAmount, AmountExceedsClearingSystemLimit, AmountExceedsAgreedLimit, AmountBelowClearingSystemMinimum, InvalidGroupControlSum, InvalidPaymentInfoControlSum, InvalidNumberOfTransactions,InvalidGroupNumberOfTransactions, InvalidPaymentInfoNumberOfTransactions, LimitExceeded, ZeroAmountNotApplied, AmountExceedsSettlementLimit, InconsistenWithEndCustomer, MissingCreditorAddress, UnrecognisedInitiatingParty, UnknownEndCustomer, MissingDebtorAddress, MissingDebtorName, InvalidCountry, InvalidDebtorCountry, InvalidCreditorCountry, InvalidCountryOfResidence, InvalidDebtorCountryOfResidence, InvalidCreditorCountryOfResidence, InvalidIdentificationCode, InvalidDebtorIdentificationCode, InvalidCreditorIdentificationCode, InvalidContactDetails, InvalidChargeBearerCode, InvalidNameLength, MissingName, MissingCreditorName, AccountProxyInvalid, CheckERI, RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture, RequestedExecutionDateOrRequestedCollectionDateTooFarInPast, ElementIsNotToBeUsedAtB-andC-Level, MandateChangesNotAllowed, InformationOnMandateChangesMissing, CreditorIdentifierIncorrect, CreditorIdentifierNotUnambiguouslyAtTransaction-Level, OriginalDebtorAccountIsNotToBeUsed, OriginalDebtorAgentIsNotToBeUsed, ElementContentIncludesMoreThan140Characters, ElementContentFormallyIncorrect, ElementNotAdmitted, ValuesWillBeSetToNextTARGETday, DecimalPointsNotCompatibleWithCurrency, RequiredCompulsoryElementMissing, COREandB2BwithinOnemessage, ChequeSettledOnCreditorAccount, CreditorBankIsNotRegistered, IncorrectCurrency, RequestedByCustomer, DebtorBankIsNotRegistered,ElectronicSignaturesCorrect, OrderCancelled, OrderNotCancelled, OrderRejected, OrderForwardedForPostprocessing, TransferOrder, ProcessingOK, DecompressionError, DecryptionError, DataSignRequested, UnknownDataSignFormat, SignerCertificateRevoked, SignerCertificateNotValid, IncorrectSignerCertificate, SignerCertificationAuthoritySignerNotValid, NotAllowedPayment, NotAllowedAccount, NotAllowedNumberOfTransaction, Signer1CertificateRevoked, Signer1CertificateNotValid, IncorrectSigner1Certificate, SignerCertificationAuthoritySigner1NotValid, UserDoesNotExist, IdenticalSignatureFound, PublicKeyVersionIncorrect, DifferentOrderDataInSignatures, RepeatOrder, ElectronicSignatureRightsInsufficient, Signer2CertificateRevoked, Signer2CertificateNotValid, IncorrectSigner2Certificate, SignerCertificationAuthoritySigner2NotValid, WaitingTimeExpired, OrderFileDeleted, UserSignedMultipleTimes, UserNotYetActivated, InvalidDate, InvalidCreationDate, InvalidNonProcessingDate, FutureDateNotSupported, InvalidCutOffDate, ExecutionDateChanged, DuplicateMessageID, DuplicatePaymentInformationID, DuplicateTransaction, DuplicateEndToEndID, DuplicateInstructionID, DuplicatePayment, CorrespondentBankNotPossible, BalanceInfoRequest, SettlementFailed, SettlementSystemNotAvailable, ERIOptionNotSupported, InvalidFileFormat, SyntaxError, InvalidPaymentTypeInformation, InvalidServiceLevelCode, InvalidLocalInstrumentCode, InvalidCategoryPurposeCode, InvalidPurpose, InvalidEndToEndId, InvalidChequeNumber, BankSystemProcessingError, ClearingRequestAborted, PaymentTransferredAndTracked, PaymentTransferredAndNotTracked, CreditDebitNotConfirmed, CreditPendingDocuments, CreditPendingFunds, DeliveredWithServiceLevel, DeliveredWIthoutServiceLevel, CorrespondingOriginalFileStillNotSent, NoMandate, MissingMandatoryInformationInMandate, CollectionNotDue, RefundRequestByEndCustomer, EndCustomerDeceased, NotSpecifiedReasonCustomerGenerated, NotSpecifiedReasonAgentGenerated, Narrative, NoERI, BankIdentifierIncorrect, InvalidBankIdentifier, InvalidDebtorBankIdentifier, InvalidCreditorBankIdentifier, InvalidBICIdentifier, InvalidDebtorBICIdentifier, InvalidCreditorBICIdentifier, InvalidClearingSystemMemberIdentifier, InvalidDebtorClearingSystemMemberIdentifier, InvalidCreditorClearingSystemMemberIdentifier, InvalidIntermediaryAgent, MissingCreditorSchemeId, RMessageConflict, ReceiverCustomerInformation,NotUniqueTransactionReference, MissingDebtorAccountOrIdentification, MissingDebtorNameOrAddress, MissingCreditorNameOrAddress, RegulatoryReason, RegulatoryInformationInvalid, TaxInformationInvalid, RemittanceInformationInvalid, RemittanceInformationTruncated, InvalidStructuredCreditorReference, InvalidCharacterSet, InvalidDebtorAgentServiceID, InvalidPartyID, ValidRequestForCancellationAcknowledged, UETRFlaggedForCancellation, NetworkStopOfUETR, RequestForCancellationForwarded, RequestForCancellationDeliveryAcknowledgement, SpecificServiceOfferedByDebtorAgent, SpecificServiceOfferedByCreditorAgent, ServiceofClearingSystem, CreditorNotOnWhitelistOfDebtor, CreditorOnBlacklistOfDebtor, MaximumNumberOfDirectDebitTransactionsExceeded, MaximumDirectDebitTransactionAmountExceeded, TransmissonAborted, NoDataAvailable, FileNonReadable, IncorrectFileStructure, TokenInvalid, SenderTokenNotFound, ReceiverTokenNotFound, TokenMissing, TokenCounterpartyMismatch, TokenSingleUse, TokenSuspended, TokenValueLimitExceeded, TokenExpired, InvalidCutOffTime, TransmissionSuccessful, TransferToSignByHand, AuthorisationCancelled, FollowingCancellationRequest, Fraud, NotCompliantGeneric, NoAnswerFromCustomer, ReturnUponUnableToApply, UnduePayment, AlreadyAcceptedRTP, AlreadyExpiredRTP, AlreadyRefusedRTP, AlreadyRejectedRTP, AttachementsNotSupported, ExpiryDateTimeReached, ExpiryDateTooLong, FraudulentOrigin, IncorrectExpiryDateTime, InitialRTPNeverReceived, NonAgreedRTP, NoPaymentGuarantee, PayerOrPayerRTPSPNotReachable, RTPNotSupportedForDebtor, RTPReceivedCanBeProcessed, RTPServiceProviderIdentifierIncorrect, TypeOfPaymentInstrumentNotSupported, UnknownCreditor, OriginalTransactionNotEligibleForRequestedReturn, RequestForCancellationNotFound, SettlementNotReceived

reasonDescription
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
Array of objects (GenericStatus)

Detailed account status. Possible Values: RegulationDD, Analysis, NewClassCode

Array
statusType
string [ 1 .. 50 ] characters
Example: "RegulationDD"

Pascal case status type. Possible Values: NSFInstruction, RegulationDD, IRA. Pays, InBox, CashReserve, ChargeOff, RestrictedAccount, AccountVerification, ClassCode, LegalEntity, PrivacyNoticed

statusName
string [ 1 .. 50 ] characters
Example: "Active"

Pascal case status name. Possibles Values for IRA status type: NotEligible, Eligible, DistributionDisability, DistributionDeath, DistributionNormal, AccountLinked, AccountNotLinked. Possible values for Pays: Enable, Disable; InBox: NewMessage, Empty; CashReserve: HasCashReserve, DoNotHave; RestrictedAccount: IsRestricted, NotRestricted; ChargeOff: BankSubmitted, Automatic, IntegratedProcessingAutomatic, IntegratedProcessingClosed. PassbookSavings: NotOnline, Online, Manual. AccountVerification: Valid, NotValid. OverdraftProtection: Enable, Disable. ClassCode: New, NotNew. DefaultStatus: Inminent, NotDefault. LegalEntity: LegalEntityCustomer. PrivacyNoticed: CustomerCanBeDisclosed, CustomerOptOut, CustomerNotOptOut

dateAndTime
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
reasonComment
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
statusReason
string [ 1 .. 50 ] characters
Example: "RegulationDD"

Pascal case status reason. Possible Values: NSFInstruction, RegulationDD, IRA.

Array of objects (ProcessEvent)

Account process event list defined by the account servicer.

Array
name
string [ 1 .. 35 ] characters

Human readable pascal case identifier of the process event. Possible list values: YearEndProcessed, MonthEndProcessed, ManuallyControlled

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
Array of objects (SpotDate)
Array of objects (GenericCode)

Codes related to the external provider account. Possible Values: LookUpReference

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.

accrualStatus
string (LoanNonAccrualStatus) [ 1 .. 17 ] characters
Example: "NonAccrual"

Specifies the current Non Accrual state of a Loan. Possible values names are: NonAccrual, Accrual.

nonAccrualProcess
string (LoanNonAccrualProcess) [ 1 .. 36 ] characters
Example: "PastDueXDays"

Specifies the current Non Accrual process of a Loan. Possible values names are: PastDueXDays, InterestAutomaticAdjustment, ManuallyWithAutomaticReturn, ManuallyWithOutAutomaticReturn, PastDueWillOutAutomatic.

renegotiatedIndicator
boolean

Indicates whether a loan is a product of renegotiation. If a loan has been renegotiated, it has replaced a previous loan that may have been in default.

convertedLoanIndicator
boolean

Indicates whether the loan is coverted. In the context of a mortgage, a converted loan is a type of loan where the mortgage note's face value can be increased, or decreased, at the option of the lender.

object (RepaymentDetails)

Account payment information.

numberOfPayments
integer

Number of payments.

object (RepaymentSchedule)

Generic transaction code definition.

Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

minimumDueAmount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects (PaymentIdentification)
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

object (Repayment)

Generic transaction code definition.

Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

minimumDueAmount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

paymentId
string (PaymentId) [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Identification of the Payment.

reversalIndicator
boolean (ReversalIndicator)

Indicates whether or not the transaction is the result of a reversal. Usage: This element should only be present if the entry is the result of a reversal. If the CreditDebitIndicator is Credit and ReversalIndicator is Yes, the original operation was a debit entry. If the CreditDebitIndicator is Debit and ReversalIndicator is Yes, the original operation was a credit entry.

object (RemittanceInformation)

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system.

valueDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit entry. Usage: If entry status is pending and value date is present, then the value date refers to an expected/requested value date.

bookingDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time when an entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.

Array of objects (TransactionCharge)

All charges and taxes applied to the transaction. Also can include interests if the bank does not discrimate between them.

Array of objects (TransactionInterest)

All interests included in the transaction amount.

paymentDate
string <date>
Example: "2022-04-17"

Original date on which the payment was posted to the account.

paymentAmount
string <date>
Example: "2022-04-17"

Amount payed.

cycleDate
string <date>
Example: "2022-04-17"

Date of the billing cycle for the account.

paymentReason
string (PaymentPurpose) [ 1 .. 60 ] characters
Example: "CashManagementTransfer"

Underlying reason for the payment transaction. Possible Values: Allowance, LoanPrincipal, CashManagementTransfer, LoanStandardPayment, LoanPayment, LoanAdditionalPayment, LoanInterest, OverageInterest, OveragePrincipal, EscrowPayment, FeePayment.

paymentName
string [ 1 .. 35 ] characters

Human readable pascal case identifier of the payment concept. Possible values: CurrentLoanNextPayment.

object (RepaymentSchedule)

Generic transaction code definition.

Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

minimumDueAmount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects (PaymentIdentification)
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

object (RepaymentSchedule)

Generic transaction code definition.

Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

minimumDueAmount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects (PaymentIdentification)
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

Array of objects (Repayment)

All the payments done, scheduled or not.

Array
Array of objects (GenericTransactionCode)

Additional transaction codes.

repaymentScheduleId
string [ 1 .. 300 ] 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

minimumDueAmount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Minimum payment amount due for the account

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, Curtailment, LossMitigation.

Array of objects
delinquentDays
integer

Number of days delinquent.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (Balance)

Other payment amounts

paymentId
string (PaymentId) [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Identification of the Payment.

reversalIndicator
boolean (ReversalIndicator)

Indicates whether or not the transaction is the result of a reversal. Usage: This element should only be present if the entry is the result of a reversal. If the CreditDebitIndicator is Credit and ReversalIndicator is Yes, the original operation was a debit entry. If the CreditDebitIndicator is Debit and ReversalIndicator is Yes, the original operation was a credit entry.

object (RemittanceInformation)

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system.

valueDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit entry. Usage: If entry status is pending and value date is present, then the value date refers to an expected/requested value date.

bookingDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time when an entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.

Array of objects (TransactionCharge)

All charges and taxes applied to the transaction. Also can include interests if the bank does not discrimate between them.

Array of objects (TransactionInterest)

All interests included in the transaction amount.

paymentDate
string <date>
Example: "2022-04-17"

Original date on which the payment was posted to the account.

paymentAmount
string <date>
Example: "2022-04-17"

Amount payed.

cycleDate
string <date>
Example: "2022-04-17"

Date of the billing cycle for the account.

paymentReason
string (PaymentPurpose) [ 1 .. 60 ] characters
Example: "CashManagementTransfer"

Underlying reason for the payment transaction. Possible Values: Allowance, LoanPrincipal, CashManagementTransfer, LoanStandardPayment, LoanPayment, LoanAdditionalPayment, LoanInterest, OverageInterest, OveragePrincipal, EscrowPayment, FeePayment.

paymentName
string [ 1 .. 35 ] characters

Human readable pascal case identifier of the payment concept. Possible values: CurrentLoanNextPayment.

object (Frequency)

How often principal payments are due.

fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

cycle
string [ 1 .. 35 ] characters
Example: "Monthly"

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

object (Frequency)

How often interest payments are due.

fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

cycle
string [ 1 .. 35 ] characters
Example: "Monthly"

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

draftDayAdjuster
integer <= 31
Example: 30

Number of days before or after an automatic payment is debited from an account.

automaticIndicator
boolean

Indicates whether, prior to the loan going past due, a payment is automatic generated.

paymentType
string (PaymentType) [ 1 .. 35 ] characters
Example: "OnUs"

Specifies the type of Payment. Possible values: LiquidityTransfer, OnUs, ACH, Wire, NotOnUs.

firstPaymentDate
string <date>
Example: "2022-04-17"

First payment date

object (RepaymentBillDetails)

Billing information of the payment

billingOption
string <= 60 characters

AutomaticPayment, LumpSumPayment, NegotiatedBillingOptio, AcceleratedBillingOption.

billingDay
integer <= 31
Example: 30

Identifies the day of the month that billing statements are generated.

rebillStatus
string (RepaymentBillStatus) [ 1 .. 40 ] characters
Example: "RebillRequest"

Indicates whether a payment will be recalculated, rebilled and notified to the customer. Possible values: NoRequest, RebillRequest, ReNotifyCustomer.

rebillInterestIndicator
boolean

Indicates whether interest will be rebilled when transactions occur during the forecast period.

leadDays
integer

Identifies the time between creating a receivable and the due date.

interestFromDate
string <date>
Example: "2022-04-17"

The statement date interest was billed.

interestToDate
string <date>
Example: "2022-04-17"

The due date of the next interest payment due that is not past due.

object (Frequency)

How often principal payments are billed.

Array of objects (Balance)

Bill balances

principalVarianceOptions
Array of strings[ items [ 1 .. 70 ] characters ]

Indicates whether, prior to the loan going past due, a payment is generated using previous extra principal payments if any curtailments have been made.

Array of objects (GenericCode)

Additional relationship codes.

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

value
string [ 1 .. 35 ] characters
Example: "195"

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
splitOptions
Array of strings[ items [ 1 .. 70 ] characters ]

Indicates the split payment options.

Array of objects (PastDueTimes)

Indicates the past due times on different periods.

Array
number
integer

Number of times a payment is past due on a period.

fromDay
integer (Day) <= 31
Example: 30

Specifies the date in a month.

toDay
integer (Day) <= 31
Example: 30

Specifies the date in a month.

authorizedAccount
string [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Specifies the account on which the power of attorney applies.

Array of objects (PaymentCardDescriptor)

Payment cards related to the account. Debit cards, for loans or current accounts. Credit cards, for credit card accounts.

Array
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.

object (PersonDescriptor)
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.

Array of objects (PaymentCardIdentification)
productId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
number
string (PrimaryAccountNumber) [ 1 .. 19 ] characters
Example: "1234567890123456789"

Primary Account Number (PAN) of the card.

cardHolderType
string (CardHolderType) [ 1 .. 35 ] characters
Example: "Primary"

Specifies the card holder type of payment card. Possible Values: Primary, Additional, Authorized, Guarantor.

fundingSourceType
string (CardFundingSourceType) [ 1 .. 35 ] characters
Example: "Credit"

Specifies the funding source type of payment card. Possible Values: Credit, Debit, Prepaid, Charge, DeferredDebit, CreditGateway, External.

businessIndicator
boolean

Indicates whether the payment card is business or not.

cardBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: "SEA_1"

Identification of the account servicer institution at branch level or center level. To overlay the codes to produce a unique identifier the following expresion is used: BranchRegionCode-BranchSubdivisionCode.

startDate
string <date>
Example: "2022-04-17"

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.

Array of objects (RelatedAccount)

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.

status
string (CardStatus) [ 1 .. 60 ] characters
Example: "Active"

Specifies the status of payment card. Some possible values are: AssignPIN, Active, Blocked, Closed, Expedite, Expired, HotCarded, Renewed, Inactive, Issued, Lost, Restricted, Stolen, Suspended, Denied, Pending.

statusDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
statusReasons
Array of strings (CardStatusReason) [ items [ 1 .. 60 ] characters ]
Example: ["Active"]
Array of objects (GenericCode)

Codes to classify payment cards. Possible code names: ClassCode

Array of objects (Limit)

Responses

Request samples

Content type
application/json
{
  • "loanBranchId": "SEA_1",
  • "accountNumber": "012345678",
  • "loanType": "Personal",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "recourseType": "FullRecourse",
  • "balanceType": "Asset",
  • "lendingRelationType": "Direct",
  • "securedLoanIndicator": true,
  • "ownershipType": "SingleOwnerAccount",
  • "productId": "PD_CA_0002",
  • "pricingStrategyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "contract": {
    },
  • "parties": [
    ],
  • "relatedAccounts": [
    ],
  • "principalAmount": "100",
  • "interestAmount": "100",
  • "maturityDate": "2022-04-17",
  • "mortgage": {
    },
  • "rateForecastDays": 0,
  • "projectedDates": [
    ],
  • "pastDates": [
    ],
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "codes": [
    ],
  • "interests": [
    ],
  • "statement": {
    },
  • "profile": {
    },
  • "supplementaryData": { },
  • "audit": {
    },
  • "status": {
    },
  • "payment": {
    },
  • "cards": [
    ]
}

Response samples

Content type
application/json
{
  • "loanBranchId": "SEA_1",
  • "accountNumber": "012345678",
  • "loanType": "Personal",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "recourseType": "FullRecourse",
  • "balanceType": "Asset",
  • "lendingRelationType": "Direct",
  • "securedLoanIndicator": true,
  • "ownershipType": "SingleOwnerAccount",
  • "productId": "PD_CA_0002",
  • "pricingStrategyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "contract": {
    },
  • "parties": [
    ],
  • "relatedAccounts": [
    ],
  • "principalAmount": "100",
  • "interestAmount": "100",
  • "maturityDate": "2022-04-17",
  • "mortgage": {
    },
  • "rateForecastDays": 0,
  • "projectedDates": [
    ],
  • "pastDates": [
    ],
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "codes": [
    ],
  • "interests": [
    ],
  • "statement": {
    },
  • "profile": {
    },
  • "supplementaryData": { },
  • "audit": {
    },
  • "status": {
    },
  • "payment": {
    },
  • "cards": [
    ],
  • "amountCalculationDate": "2022-04-17T08:00:00Z",
  • "transactionDates": [
    ],
  • "balances": [
    ],
  • "accountId": "033-DDA-123456",
  • "unscheduledPrincipalReduction": "100",
  • "totalReappliedReduction": "100",
  • "accruedCapitalizationAmount": "100",
  • "reviewDateEvents": [
    ],
  • "payOff": {
    }
}

Retrieves a Loan

Authorizations:
jwtopenIdConnect
path Parameters
loanId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Loan Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "loanBranchId": "SEA_1",
  • "accountNumber": "012345678",
  • "loanType": "Personal",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "recourseType": "FullRecourse",
  • "balanceType": "Asset",
  • "lendingRelationType": "Direct",
  • "securedLoanIndicator": true,
  • "ownershipType": "SingleOwnerAccount",
  • "productId": "PD_CA_0002",
  • "pricingStrategyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "contract": {
    },
  • "parties": [
    ],
  • "relatedAccounts": [
    ],
  • "principalAmount": "100",
  • "interestAmount": "100",
  • "maturityDate": "2022-04-17",
  • "mortgage": {
    },
  • "rateForecastDays": 0,
  • "projectedDates": [
    ],
  • "pastDates": [
    ],
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "codes": [
    ],
  • "interests": [
    ],
  • "statement": {
    },
  • "profile": {
    },
  • "supplementaryData": { },
  • "audit": {
    },
  • "status": {
    },
  • "payment": {
    },
  • "cards": [
    ],
  • "amountCalculationDate": "2022-04-17T08:00:00Z",
  • "transactionDates": [
    ],
  • "balances": [
    ],
  • "accountId": "033-DDA-123456",
  • "unscheduledPrincipalReduction": "100",
  • "totalReappliedReduction": "100",
  • "accruedCapitalizationAmount": "100",
  • "reviewDateEvents": [
    ],
  • "payOff": {
    }
}

Updates a Loan

Use the JSON Merge Patch standard https://tools.ietf.org/html/rfc7396

Authorizations:
jwtopenIdConnect
path Parameters
loanId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Loan Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/merge-patch+json
object

Responses

Request samples

Content type
application/merge-patch+json
{ }

Response samples

Content type
application/json
{
  • "loanBranchId": "SEA_1",
  • "accountNumber": "012345678",
  • "loanType": "Personal",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "recourseType": "FullRecourse",
  • "balanceType": "Asset",
  • "lendingRelationType": "Direct",
  • "securedLoanIndicator": true,
  • "ownershipType": "SingleOwnerAccount",
  • "productId": "PD_CA_0002",
  • "pricingStrategyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "name": "Hermes PD_CA 0002",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "contract": {
    },
  • "parties": [
    ],
  • "relatedAccounts": [
    ],
  • "principalAmount": "100",
  • "interestAmount": "100",
  • "maturityDate": "2022-04-17",
  • "mortgage": {
    },
  • "rateForecastDays": 0,
  • "projectedDates": [
    ],
  • "pastDates": [
    ],
  • "restrictions": [
    ],
  • "limits": [
    ],
  • "codes": [
    ],
  • "interests": [
    ],
  • "statement": {
    },
  • "profile": {
    },
  • "supplementaryData": { },
  • "audit": {
    },
  • "status": {
    },
  • "payment": {
    },
  • "cards": [
    ],
  • "amountCalculationDate": "2022-04-17T08:00:00Z",
  • "transactionDates": [
    ],
  • "balances": [
    ],
  • "accountId": "033-DDA-123456",
  • "unscheduledPrincipalReduction": "100",
  • "totalReappliedReduction": "100",
  • "accruedCapitalizationAmount": "100",
  • "reviewDateEvents": [
    ],
  • "payOff": {
    }
}

Retrieves Loan Balances

Authorizations:
jwtopenIdConnect
path Parameters
loanId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Loan Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "loanId": "033-DDA-123456",
  • "accountNumber": "012345678",
  • "balances": [
    ]
}

Retrieves Loan Transactions

Authorizations:
jwtopenIdConnect
path Parameters
loanId
required
string (Id) [ 1 .. 300 ] 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 (Amount) <= 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 (Amount) <= 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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
{
  • "loanId": "033-DDA-123456",
  • "accountNumber": "012345678",
  • "loanType": "Personal",
  • "currency": "USD",
  • "currentBalance": "100",
  • "availableBalance": "100",
  • "transactions": [
    ]
}

Retrieves Loan Identifiers

Authorizations:
jwtopenIdConnect
path Parameters
loanId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Loan Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "accountBranchId": "SEA_1",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "loanId": "033-DDA-123456",
  • "loanType": "Personal"
}

Retrieves Loan Parties

Authorizations:
jwtopenIdConnect
path Parameters
loanId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Loan Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "loanId": "033-DDA-123456",
  • "accountNumber": "012345678",
  • "parties": [
    ]
}

Retrieves Loan Owners

Authorizations:
jwtopenIdConnect
path Parameters
loanId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Loan Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "accountId": "033-DDA-123456",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "ownershipType": "SingleOwnerAccount",
  • "owners": [
    ]
}

Retrieves Loan Cards

Authorizations:
jwtopenIdConnect
path Parameters
loanId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Loan Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "loanId": "033-DDA-123456",
  • "accountNumber": "012345678",
  • "cards": [
    ],
  • "amountCalculationDate": "2022-04-17T08:00:00Z",
  • "transactionDates": [
    ],
  • "balances": [
    ]
}

Address Book

Postal Address Mangement

Retrieves a list of addresses matching the parameters.

Authorizations:
jwtopenIdConnect
query Parameters
party.name.inc
string

A related party name includes the substring provided.

addressId.eq
string (Id) [ 1 .. 300 ] characters
Example: addressId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002

Returns the document

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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates an Address

Authorizations:
jwtopenIdConnect
header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
Array of objects (AddressBookParty)

Parties related to an address

Array
partyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
partyType
string (PartyType)
Example: "Person"

Possible values are: Person, Organization. Also other types of servicer entities: ServicerOfficer, ExternalOrganization, Referral.

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.

Array of objects (Phone)
Array
number
required
string (PhoneNumber) ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$
Example: "+1-555-1234567"

The collection of information which identifies a specific phone or FAX number as defined by telecom services.

extension
string <= 5 characters

Phone Number Extension.

country
string (CountryCallingCode) <= 3 characters

Country calling codes, country dial-in codes, international subscriber dialing (ISD) codes, or most commonly, telephone country codes. Country codes are defined by the International Telecommunication Union (ITU) in ITU-T standards E.123 and E.164. The prefixes enable international direct dialing (IDD).

phoneType
string [ 1 .. 35 ] characters

Type of phone address. Possible values are:
Mobile, Landline, Fax, Pager, Modem.

phonePurpose
string [ 1 .. 35 ] characters

Purpose of the phone address. Possible values are: Business, Personal, International, Alternative, PersonalInternational, BusinessInternational

foreignIndicator
boolean

Indicates whether is a foreign phone number

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

object (TimeOfTheDay)
comment
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
object

The period of use of the phone information.

Array of objects (GenericCode)
Array of objects (GenericIdentification)

Phone identifiers are used to identify parties that share the same phone or to associate an existing phones with a specific party. Possible scheme name values: PhoneIdentifier.

lastUpdatedDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
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, Business, Administrative, Personal

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

Array of objects (GenericIdentification)

Email identifiers are used to identify parties that share the same email or to associate an existing email with a specific party. Possible scheme name values: EmailIdentifier.

lastUpdatedDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (PostalAddress)
Array
addressCode
string

This code is used to identify parties that share the same address or to associate an existing address with a specific party. Providing this code eliminates the need to separately enter the address details.

addressBookIndicator
string

If true, the address is kept in the system even if the person is no longer a customer.

addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible values are: PhysicalAddress, Postal, POBox, Residential, Permanent, Temporary, Alternative, Previous.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible values are: MailTo, DeliveryTo, Billing, Tax, ForeignTaxRecipient PlaceOfOperation, PlaceOfRegistration, placeOfFormation, Marketing, Statements, Business, Administrative, PreviousPlace, Headquarter, BranchStore, Branch, Property, Military, Secondary, Personal, Annex, Inquiry.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

careOf
string [ 1 .. 100 ] characters
Example: "C/O Company Name"

Identifies an addressee that is accepting the correspondence for the intended recipient. Using care of ensures the correspondence reaches the right recipient rather than getting returned to the sender.

department
string [ 1 .. 70 ] characters
Example: "A"

Identification of a division of a large Organization or building.

subDepartment
string [ 1 .. 70 ] characters
Example: "B"

Identification of a sub-division of a large Organization 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 Organization, where letters are kept until called for.

room
string [ 1 .. 70 ] characters
Example: "22"

Building room number.

postCode
string (PostCode) [ 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. In US may consists of two parts: the five-digit ZIP Code '97062' and the ZIP+4 Code '6884'.

carrierRoute
string (CarrierRoute) [ 1 .. 4 ] characters
Example: "C001"

A Carrier Route is a designated geographic area assigned to individual postal carriers by the United States Postal Service (USPS) to facilitate efficient mail delivery within specific regions.

censusTract
string (CensusTract) = 5 characters
Example: "12345"

A census tract, census area, census district or meshblock is a geographic region defined for the purpose of taking a census

censusBlock
string (CensusBlock) = 4 characters
Example: "1234"

Census blocks are used to partition counties into smaller areas for the purpose of collecting and presenting census data.

cBSACode
string (CBSACode) = 5 characters
Example: "49780"

Core-based statistical area. Metropolitan statistical area (MSA) is the formal definition of a region that consists of a city and surrounding communities that are linked by social and economic factors. Micropolitan Statistical Areas (MISA) are CBSAs associated with at least one urban cluster that has a population of at least 10,000, but less than 50,000. The micropolitan statistical area comprises the central county or counties or equivalent entities containing the core, plus adjacent outlying counties having a high degree of social and economic integration with the central county as measured through commuting.

cBSAType
string (CBSAType) [ 1 .. 10 ] characters
Example: "MSA"

Type of Core-based statistical area. Possible values: MSA, MISA

foreignIndicator
boolean

Indicates whether the postal address is from a foreign country.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

Name of a built-up area, with defined boundaries, and a local government. Also city name.

townLocationName
string [ 1 .. 35 ] characters
Example: "Clackamas"

Specific location name within the town.

districtName
string [ 1 .. 35 ] characters
Example: "Columbia"

Identifies a subdivision within a country sub-division.

countyName
string [ 1 .. 35 ] characters
Example: "Cook"

Identifies a county 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.

temporaryIndicator
boolean
Example: true

Indicates whether the address is temporary or not.

object

The period of use of the address information. Could be also used as a recurring anual period.

Array of objects (GenericCode)

Codes related to postal address or internal handling codes associated with the address. Possible Values: HandlingCode, HandlingCodeOption, AddressFormat.

Array of objects (GenericIdentification)

Postal address identifiers are used to identify parties that share the same address or to associate an existing address with a specific party. Possible scheme name values: AddressIdentifier.

Responses

Request samples

Content type
application/json
{
  • "parties": [
    ],
  • "phones": [
    ],
  • "emails": [
    ],
  • "postalAddresses": [
    ]
}

Response samples

Content type
application/json
{
  • "addressId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "parties": [
    ],
  • "phones": [
    ],
  • "emails": [
    ],
  • "postalAddresses": [
    ]
}

Retrieves an Address

Authorizations:
jwtopenIdConnect
path Parameters
addressId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002
header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "addressId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "parties": [
    ],
  • "phones": [
    ],
  • "emails": [
    ],
  • "postalAddresses": [
    ]
}

Updates an Address

Use the JSON Merge Patch standard https://tools.ietf.org/html/rfc7396

Authorizations:
jwtopenIdConnect
path Parameters
addressId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002
header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/merge-patch+json
object

Responses

Request samples

Content type
application/merge-patch+json
{ }

Response samples

Content type
application/json
{
  • "addressId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "parties": [
    ],
  • "phones": [
    ],
  • "emails": [
    ],
  • "postalAddresses": [
    ]
}

Account Holds

Retrieves Account Holds

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

Account Identification

query Parameters
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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
{
  • "accountId": "033-DDA-123456",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "ownershipType": "SingleOwnerAccount",
  • "numberOfHolds": 0,
  • "holds": [
    ],
  • "identifiers": [
    ]
}

Request an account hold

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

Account Identification

header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
Array of objects (PaymentIdentification)
Array
number
required
string [ 1 .. 40 ] characters

Unique and unambiguous identification of a payment.

schemeName
string [ 1 .. 40 ] characters
Example: "UETR"

Name of other payment identificaction. For instance, ISOInitiationMessageIdentifier, InstructionIdentification (Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period), UETR (Universally unique identifier to provide an end-to-end reference of a payment transaction), ExecutionIdentification, EndToEndIdentification, InstructionIdentification, TransactionIdentification, ClearingSystemReference, CreditorReference, CounterpartyReference, UniqueTradeIdentifier, ClearingBrokerIdentification, UniqueTradeIdentifier, ClearingBrokerIdentification, CommonIdentification, ReferenceNumber, TracerNumber, DraftNumber.

issuer
string
Example: "Baltimore"

Entity that assigns the identification.

holdId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
holdType
string (AccountHoldType) [ 1 .. 35 ] characters

Possible Values: Amount, holds any amount for any purpose; Check, holds the entire amount of a check or a partial amount until the check clears; StopPayment, stop payment on a check; Caution, a hold occurs when there is suspicious activity detected on the account. Values for payments: Payments, PaymentReversal, PaymentAdjustment, PaymentAuthorization.

valueDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date/time that the hold was created or should take effect.

Array of objects (GenericTransactionCode)

Additional transaction codes.

Array
codeType
string [ 1 .. 50 ] characters
Example: "DetailBAI"

Code type in PascalCase form. Possible values are: DetailBAI, SummaryBAI, TransactionCode, BatchNumber, MICRAccountNumber, CustomerTransferCode, WireTransferScope, WireTransferDirection, CoreTransactionCode

name
string

Name of the code in PascalCase. Possible values: ResponseCode, PromotionCode, Domain, Family, Subfamily, MT940, SourceCode, TaxDeferredContributionCode, International, Domestic, Incoming, Outgoing.

value
string [ 1 .. 35 ] characters
Example: "195"

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
Array of objects (RelatedAccount)

Accounts involved in the account hold

Array
accountRelationType
string (AccountRelationType)
Example: "SubAccount"

Account relation role. Possible values are: Parent, EscrowAccount, SubAccount, ControlAccount, CrossAccount, ChargeAccount, AssociatedAccount, IRAAccount, CombinedStatement, SecondaryCombinedStatement, SummaryAccount, FundingSource, CompensatingAccount. Payment related values: Authorized, Counterpart

accountId
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

accountNumber
string (AccountNumber) <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

accountType
string (RelatedAccountType) [ 1 .. 60 ] characters
Example: "Checking"

Type of the account. Some possible ISO 20022 compliant values are: Checking, CardAccount, CashPayment, Charges, CashIncome, Commission, ClearingParticipantSettlementAccount, LimitedLiquiditySavingsAccount, MarginalLending, MoneyMarket, NonResidentExternal, Overdraft, OverNightDeposit, Settlement, Salary, Savings, Tax, TransactingAccount, CashTrading, VirtualAccount, CreditCard, DebitCard, Universal, Investment, EpurseCard, CertificateOfDeposit, MoneyMarketChecking, RetirementAccount, StockOrBond, PrePaid, FleetCard, Cash, DebitAccount, CreditAccount, Benefit, HealthSavingsAccount, FlexibleSpendingAccount, ForBenefitOf, Estate, ClientTrustAccount, LawyersTrustAccount, KeoghPlanAccount, UniformTransfersToMinorsAct, UniformGiftsToMinorsAct, ReserveFunds, SelfDirectedBrokerage, Loan, Ledger.

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.

productId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
Array of objects (GenericCode)

Account related codes

Array of objects (AccountParty)

Parties involve in the account hold

Array
partyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
partyType
string (PartyType)
Example: "Person"

Possible values are: Person, Organization. Also other types of servicer entities: ServicerOfficer, ExternalOrganization, Referral.

partyAccountRole
string (AccountPartyRole) [ 1 .. 35 ] characters
Example: "AccountOwner"

Type of the account party role. Some possibles values are: Comaker, Cosigner, AccountOwner, AccountSigner, ATMDebitCardHolder, CreditCardHolder, LiquidityManager, Endorser, 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, Minor, Nominee, SecondaryOwner, Executor, Beneficiary, PrimaryServicerOfficer, SecondaryServicerOfficer, AccountOpenningOfficer, CustomerServiceOfficer, PowerOfAttorney, ContingentBeneficiary, Fiduciary, ControlPerson, AuthorizedPerson, Dealer, DoingBusinessAs, Grantor, SecondaryTrustee, RepresentativePayee, RestrictedOwner.

partyAccountRoleCode
string
Example: "50"

Bank defined party account role.

employeeIndicator
boolean

Indicates whether is a bank employee.

Array of objects (Balance)

Partial balances after the account hold

Array
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

balanceName
string (BalanceName) [ 1 .. 50 ] characters
Example: "Available"

Specifies the nature of the balance. Possible values: Current, Available, Pending, Opening, Blocked, Previous, RelatedBalance, OnHold, PendingLedger, Collected, LastAnniversary, CurrentAccrued, PreviousAccrued, CurrentWithLastCalculus, CarriedAdjustment, PaidWithPenalties, Accrued, Penalty, Fees, Withholding, CollectionLedger, LastLedger, CurrentLedger, Ledger, MinimumAvailable, MinimumLedger, Withheld, CurrentBooked, CurrentBook, LastDeposit, FloatAmount, Average, RegulationDDAvailable. Loan Balances: CashProceeds, the amount that a customer actually received, exclusive of insurance premiums, fees, and unearned discount; FinancedExpenses, indicates the amount of expenses an institution has financed for a borrower; TotalInterest; AdditionalInterest, if the date of the first payment is beyond one month from the note date, the interest for the odd days will be earned during the first interest period; DeferredUnsecuredPrincipal, is the outstanding balance of an unsecured debt. The DUPB includes any accrued interest that is yet to be paid by the borrower. The deferral typically occurs due to bankruptcy or debt relief proceedings, which temporarily halt collection efforts by the original creditor; Charge Balances: Earned, RealTimeDeliveryMaximum, Current, Financed, Prepaid, CurrentEarned, CurrentEarnedOtherEscrow, InterestPaidToDate, InterestPaidThisYear, InterestPaidPreviousYear, InterestPaidLastStatement, InterestPaidThisYear, RevolvingCreditPaid, BasePaidToDate, TotalPastDue, Escrow, AppliedEscrow, UnpaidEscrow, EscrowBucket, Principal, Interest, Fees, BilledFees, OtherEscrow, FinalAmount, FinalInterestAmount, Chapter4PreviousYear, Payments: Delinquent, FixPayment, Transaction, LoanPayOff, PrincipalAndInterest, AvailableCash, AvailableCheck, AvailableCredit, Sweep, Float, MemoLedger, Memo, AvailablePending, LedgerPending.

amount
string (Amount) <= 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

count
integer

Number of transactions added to the amount.

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 (GenericCode)

Bank defined codes to classify balances. Possible values: BalanceCategory, BalanceType, PartyAgreementNumber.

bookingDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time when an entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.

releaseDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date/time that the hold should be released.

ageOffDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date by when the payment will age off and no longer be searchable.

exclusionDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date by when the account will be excluded from payment float processing.

expirationDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date the payment float process expires.

actualReleaseDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date/time that the hold was actually released.

floatAmount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Payment amount that entered the payment float process

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Payment amount

object (Check)

Characteristics of a check

checkType
string

Specifies the type of the check. Possible values are: CustomerCheque, CertifiedCustomerCheque, BankCheque, Draft, ElectronicDraft.

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Check amount

currency
string = 3 characters ^([A-Z]{3})?$
Example: "USD"

Check currency

checkNumber
string <= 35 characters

The number on the face of the check indicating the id of that check in a series.

issuer
string
Example: "Jhon Smith"

Party that issued the check.

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).

availabilityFloat
string

It refers to the time delay between when a check is deposited and when the funds become available for withdrawal. Possible Values: ImmediateWithdrawal, LocalCheck, NonLocalCheck

Array of objects (GenericIdentification)

Check identifiers. Possible scheme names: Reference.

Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification.

schemeName
required
string [ 1 .. 35 ] characters

Name of the identification scheme.

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.

imageSequence
Array of strings (FileName) [ items <= 255 characters ^[a-zA-Z0-9_\- ]+\.[a-zA-Z0-9]+$ ]
Example: ["image003.png"]

Series of images that are related and sequentially ordered.

Array of objects (GenericCode)

Codes to classify the check. Possible code names: AccountCode

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

value
string [ 1 .. 35 ] characters
Example: "195"

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
printer
string

Check printer used.

object (PaymentCardTransactionDetail)

Payment Card Transaction details.

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.

cardNumber
string (PrimaryAccountNumber) [ 1 .. 19 ] characters
Example: "1234567890123456789"

Primary Account Number (PAN) of the card.

merchantCategoryCode
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.

merchantName
string [ 1 .. 35 ] characters
Example: "Food Store"

Merchant Name

object (PostalAddress)

Information that locates and identifies a specific address, as defined by postal services.

addressCode
string

This code is used to identify parties that share the same address or to associate an existing address with a specific party. Providing this code eliminates the need to separately enter the address details.

addressBookIndicator
string

If true, the address is kept in the system even if the person is no longer a customer.

addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible values are: PhysicalAddress, Postal, POBox, Residential, Permanent, Temporary, Alternative, Previous.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible values are: MailTo, DeliveryTo, Billing, Tax, ForeignTaxRecipient PlaceOfOperation, PlaceOfRegistration, placeOfFormation, Marketing, Statements, Business, Administrative, PreviousPlace, Headquarter, BranchStore, Branch, Property, Military, Secondary, Personal, Annex, Inquiry.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

careOf
string [ 1 .. 100 ] characters
Example: "C/O Company Name"

Identifies an addressee that is accepting the correspondence for the intended recipient. Using care of ensures the correspondence reaches the right recipient rather than getting returned to the sender.

department
string [ 1 .. 70 ] characters
Example: "A"

Identification of a division of a large Organization or building.

subDepartment
string [ 1 .. 70 ] characters
Example: "B"

Identification of a sub-division of a large Organization 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 Organization, where letters are kept until called for.

room
string [ 1 .. 70 ] characters
Example: "22"

Building room number.

postCode
string (PostCode) [ 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. In US may consists of two parts: the five-digit ZIP Code '97062' and the ZIP+4 Code '6884'.

carrierRoute
string (CarrierRoute) [ 1 .. 4 ] characters
Example: "C001"

A Carrier Route is a designated geographic area assigned to individual postal carriers by the United States Postal Service (USPS) to facilitate efficient mail delivery within specific regions.

censusTract
string (CensusTract) = 5 characters
Example: "12345"

A census tract, census area, census district or meshblock is a geographic region defined for the purpose of taking a census

censusBlock
string (CensusBlock) = 4 characters
Example: "1234"

Census blocks are used to partition counties into smaller areas for the purpose of collecting and presenting census data.

cBSACode
string (CBSACode) = 5 characters
Example: "49780"

Core-based statistical area. Metropolitan statistical area (MSA) is the formal definition of a region that consists of a city and surrounding communities that are linked by social and economic factors. Micropolitan Statistical Areas (MISA) are CBSAs associated with at least one urban cluster that has a population of at least 10,000, but less than 50,000. The micropolitan statistical area comprises the central county or counties or equivalent entities containing the core, plus adjacent outlying counties having a high degree of social and economic integration with the central county as measured through commuting.

cBSAType
string (CBSAType) [ 1 .. 10 ] characters
Example: "MSA"

Type of Core-based statistical area. Possible values: MSA, MISA

foreignIndicator
boolean

Indicates whether the postal address is from a foreign country.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

Name of a built-up area, with defined boundaries, and a local government. Also city name.

townLocationName
string [ 1 .. 35 ] characters
Example: "Clackamas"

Specific location name within the town.

districtName
string [ 1 .. 35 ] characters
Example: "Columbia"

Identifies a subdivision within a country sub-division.

countyName
string [ 1 .. 35 ] characters
Example: "Cook"

Identifies a county 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.

temporaryIndicator
boolean
Example: true

Indicates whether the address is temporary or not.

object

The period of use of the address information. Could be also used as a recurring anual period.

Array of objects (GenericCode)

Codes related to postal address or internal handling codes associated with the address. Possible Values: HandlingCode, HandlingCodeOption, AddressFormat.

Array of objects (GenericIdentification)

Postal address identifiers are used to identify parties that share the same address or to associate an existing address with a specific party. Possible scheme name values: AddressIdentifier.

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/json
{
  • "identifiers": [
    ],
  • "holdId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "holdType": "string",
  • "valueDate": "2022-04-17T08:00:00Z",
  • "codes": [
    ],
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "balances": [
    ],
  • "bookingDate": "2022-04-17T08:00:00Z",
  • "releaseDate": "2022-04-17T08:00:00Z",
  • "ageOffDate": "2022-04-17T08:00:00Z",
  • "exclusionDate": "2022-04-17T08:00:00Z",
  • "expirationDate": "2022-04-17T08:00:00Z",
  • "actualReleaseDate": "2022-04-17T08:00:00Z",
  • "floatAmount": "100",
  • "amount": "100",
  • "check": {
    },
  • "card": {
    }
}

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "holdId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "holdType": "string",
  • "valueDate": "2022-04-17T08:00:00Z",
  • "codes": [
    ],
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "balances": [
    ],
  • "bookingDate": "2022-04-17T08:00:00Z",
  • "releaseDate": "2022-04-17T08:00:00Z",
  • "ageOffDate": "2022-04-17T08:00:00Z",
  • "exclusionDate": "2022-04-17T08:00:00Z",
  • "expirationDate": "2022-04-17T08:00:00Z",
  • "actualReleaseDate": "2022-04-17T08:00:00Z",
  • "floatAmount": "100",
  • "amount": "100",
  • "check": {
    },
  • "card": {
    },
  • "accountId": "033-DDA-123456",
  • "status": "string",
  • "statusReason": "BlockedAccount",
  • "statusReasonDescription": "This is a description.",
  • "availableCredit": "100"
}

Retrieves an account hold by id.

Authorizations:
jwtopenIdConnect
path Parameters
holdId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Hold Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "holdId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "holdType": "string",
  • "valueDate": "2022-04-17T08:00:00Z",
  • "codes": [
    ],
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "balances": [
    ],
  • "bookingDate": "2022-04-17T08:00:00Z",
  • "releaseDate": "2022-04-17T08:00:00Z",
  • "ageOffDate": "2022-04-17T08:00:00Z",
  • "exclusionDate": "2022-04-17T08:00:00Z",
  • "expirationDate": "2022-04-17T08:00:00Z",
  • "actualReleaseDate": "2022-04-17T08:00:00Z",
  • "floatAmount": "100",
  • "amount": "100",
  • "check": {
    },
  • "card": {
    },
  • "accountId": "033-DDA-123456",
  • "status": "string",
  • "statusReason": "BlockedAccount",
  • "statusReasonDescription": "This is a description.",
  • "availableCredit": "100"
}

Account Hold Removal

Deletes an account hold

Authorizations:
jwtopenIdConnect
path Parameters
holdId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Hold Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "code": "InvalidRequest",
  • "message": "Invalid Request",
  • "details": [
    ],
  • "innerError": {
    },
  • "debugMessage": { },
  • "documentationUrl": "/errors/invalid-credentials"
}

Updates an account hold

Use the JSON Merge Patch standard https://tools.ietf.org/html/rfc7396

Authorizations:
jwtopenIdConnect
path Parameters
holdId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Hold Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/merge-patch+json
object

Responses

Request samples

Content type
application/merge-patch+json
{ }

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "holdId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "holdType": "string",
  • "valueDate": "2022-04-17T08:00:00Z",
  • "codes": [
    ],
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "balances": [
    ],
  • "bookingDate": "2022-04-17T08:00:00Z",
  • "releaseDate": "2022-04-17T08:00:00Z",
  • "ageOffDate": "2022-04-17T08:00:00Z",
  • "exclusionDate": "2022-04-17T08:00:00Z",
  • "expirationDate": "2022-04-17T08:00:00Z",
  • "actualReleaseDate": "2022-04-17T08:00:00Z",
  • "floatAmount": "100",
  • "amount": "100",
  • "check": {
    },
  • "card": {
    },
  • "accountId": "033-DDA-123456",
  • "status": "string",
  • "statusReason": "BlockedAccount",
  • "statusReasonDescription": "This is a description.",
  • "availableCredit": "100"
}

Relationships

Retrieves Person Relationships

Retrieves all the bank relationships the person may have.

Authorizations:
jwtopenIdConnect
path Parameters
personId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Person Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "personId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "personName": "Jane Birkin",
  • "relationships": [
    ]
}

Retrieves a list of relationships matching the parameters.

Authorizations:
jwtopenIdConnect
query Parameters
customer.name.inc
string

The primary customer name includes the substring provided.

partyId.eq
string (Id) [ 1 .. 300 ] characters
Example: partyId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002

Returns the customer relationships

customer.lastName.eq
string (PartyName) [ 1 .. 350 ] characters
Example: customer.lastName.eq=Jane Birkin

Name by which a party is known and which is usually used to identify that party.

customer.firstName.eq
string (PartyName) [ 1 .. 350 ] characters
Example: customer.firstName.eq=Jane Birkin

Name by which a party is known and which is usually used to identify that party.

customer.birthDate.eq
string <date> (Date)
Example: customer.birthDate.eq=2022-04-17

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

customer.phoneNumber.eq
string (PhoneNumber) ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$
Example: customer.phoneNumber.eq=+1-555-1234567

Any phone number equals to.

customer.accountNumber.eq
string (AccountNumber) <= 30 characters
Example: customer.accountNumber.eq=012345678

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

customer.tin.eq
string
customer.ssn.eq
string

Social Security Number

customer.ssn.last4
string

Social Security Number last four digits.

customer.email.eq
string

Email equals to

customer.addressLine.inc
string

Any address line of any postal address includes substring

customer.postCode.eq
string

Any postal address with post code equals to

customer.country.eq
string

Any postal address with Country code equals to

customer.countrySubDivision.inc
string

Any postal address with country subdivision includes substring

customer.townName.inc
string

Any postal address with town name includes substring

customer.personId.eq
string (Id) [ 1 .. 300 ] characters
Example: customer.personId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002

System id equals to

customer.audit.lastModificationDate.lte
string <date> (Date)
Example: customer.audit.lastModificationDate.lte=2022-04-17

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

customer.audit.lastModificationDate.gte
string <date> (Date)
Example: customer.audit.lastModificationDate.gte=2022-04-17

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a Relationship

Authorizations:
jwtopenIdConnect
header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
object (CustomerRelationshipParty)
partyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
partyType
string (PartyType)
Example: "Person"

Possible values are: Person, Organization. Also other types of servicer entities: ServicerOfficer, ExternalOrganization, Referral.

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: "PrimaryServicerOfficer"

Type of relation between parties. Possible values Between Organizations and persons are: ResponsibleParty, Owner, ControlPerson, ControlPersonOwner, AuthorizedPerson, BeneficialOwner, PrimaryContact, SecondaryContact, VicePresident, President, Treasurer, Secretary, Partner, GeneralPartener, CEO, CFO, COO, Conservator, Dealer, Director, MessageReceiver, Employee, Excecutor, GeneralPartner, HumanResourceRepresentative, IOLTAContact, ManagingMember, PrimaryContact, SecondaryContact, Estate. Between Persons and Organizations: Business, Organization, UnclaimedPropertyContact, UtilityContact. For Trusts: Trustor, Trustee. Between organizations: Subsidiary, ParentOrganization, Branch. Between parties and external entities: AccountOpenningOfficer, CustomerServiceOfficer, PrimaryServicerOfficer, SecondaryServicerOfficer, SalesPerson, ReferralOfficer. Between financial institutions: AffiliateFinancialInstitution, HoldingCompany. Between persons: Spouse, Aunt, Brother, Companion, Daughter, Father, Friend, Granddaughter, Grandmother, Grandfather, Grandson, Husband, Mother, Nephew, Niece, Sister, Son, Uncle, Wife, Child, Grandparent. Grandchild, Sibling, Parent, Partner, Related, InitiatingParty

priorityIndicator
boolean

Indicates whether the related party is a priority.

Array of objects (CustomerRelationshipAccount)
Array
accountRelationType
required
string (AccountRelationType)
Example: "SubAccount"

Account relation role. Possible values are: Parent, EscrowAccount, SubAccount, ControlAccount, CrossAccount, ChargeAccount, AssociatedAccount, IRAAccount, CombinedStatement, SecondaryCombinedStatement, SummaryAccount, FundingSource, CompensatingAccount. Payment related values: Authorized, Counterpart

accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

primaryIndicator
boolean

Indicates whether the account related is primary.

Array of objects (CustomerRelationshipAccount)
Array
accountRelationType
required
string (AccountRelationType)
Example: "SubAccount"

Account relation role. Possible values are: Parent, EscrowAccount, SubAccount, ControlAccount, CrossAccount, ChargeAccount, AssociatedAccount, IRAAccount, CombinedStatement, SecondaryCombinedStatement, SummaryAccount, FundingSource, CompensatingAccount. Payment related values: Authorized, Counterpart

accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

primaryIndicator
boolean

Indicates whether the account related is primary.

Array of objects (CustomerRelationshipLoan)
Array
accountRelationType
required
string (AccountRelationType)
Example: "SubAccount"

Account relation role. Possible values are: Parent, EscrowAccount, SubAccount, ControlAccount, CrossAccount, ChargeAccount, AssociatedAccount, IRAAccount, CombinedStatement, SecondaryCombinedStatement, SummaryAccount, FundingSource, CompensatingAccount. Payment related values: Authorized, Counterpart

accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

primaryIndicator
boolean

Indicates whether the account related is primary.

Array of objects (PaymentCardDescriptor)
Array
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.

object (PersonDescriptor)
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.

Array of objects (PaymentCardIdentification)
productId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
number
string (PrimaryAccountNumber) [ 1 .. 19 ] characters
Example: "1234567890123456789"

Primary Account Number (PAN) of the card.

cardHolderType
string (CardHolderType) [ 1 .. 35 ] characters
Example: "Primary"

Specifies the card holder type of payment card. Possible Values: Primary, Additional, Authorized, Guarantor.

fundingSourceType
string (CardFundingSourceType) [ 1 .. 35 ] characters
Example: "Credit"

Specifies the funding source type of payment card. Possible Values: Credit, Debit, Prepaid, Charge, DeferredDebit, CreditGateway, External.

businessIndicator
boolean

Indicates whether the payment card is business or not.

cardBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: "SEA_1"

Identification of the account servicer institution at branch level or center level. To overlay the codes to produce a unique identifier the following expresion is used: BranchRegionCode-BranchSubdivisionCode.

startDate
string <date>
Example: "2022-04-17"

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.

Array of objects (RelatedAccount)

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.

status
string (CardStatus) [ 1 .. 60 ] characters
Example: "Active"

Specifies the status of payment card. Some possible values are: AssignPIN, Active, Blocked, Closed, Expedite, Expired, HotCarded, Renewed, Inactive, Issued, Lost, Restricted, Stolen, Suspended, Denied, Pending.

statusDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
statusReasons
Array of strings (CardStatusReason) [ items [ 1 .. 60 ] characters ]
Example: ["Active"]
Array of objects (GenericCode)

Codes to classify payment cards. Possible code names: ClassCode

Array of objects (Limit)
object (Audit)

Resource Audit Information. Captures the creation, modification and maintenance details.

status
string (AuditStatus) [ 1 .. 35 ] characters

Maintenance status of a resource. Possible values: Requested, Created, Changed, Deleted

creationDate
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.

creationBranchId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
object (User)

User information of a person.

personId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
userId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
userName
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

purpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
audit
object (Audit) Recursive

Resource Audit Information. Captures the creation, modification and maintenance details.

lastModificationChannel
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

lastModificationDate
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 (AuditChannel)

Activity audit throught communication channles

Array
lastActivityDate
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 (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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

activityType
string (AuditActivityType) [ 1 .. 35 ] characters

Maintenance activity of a resource. Possible values: Transaction, Modification, Deposit, Withdrawal, Creation, DirectDeposit, CardActivation, CardActivationByCallerId, CardActivationByCodeAndCallerId, Closure, HSACreation

amount
string (PositiveAmount) <= 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

Array of objects (GenericCode)

Additional relationship codes.

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

value
string [ 1 .. 35 ] characters
Example: "195"

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."

Responses

Request samples

Content type
application/json
{
  • "parties": {
    },
  • "accounts": [
    ],
  • "deposits": [
    ],
  • "loans": [
    ],
  • "cards": [
    ],
  • "audit": {
    },
  • "codes": [
    ]
}

Response samples

Content type
application/json
{
  • "parties": {
    },
  • "accounts": [
    ],
  • "deposits": [
    ],
  • "loans": [
    ],
  • "cards": [
    ],
  • "audit": {
    },
  • "codes": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "status": "Active"
}

Retrieves a Relationship

Authorizations:
jwtopenIdConnect
path Parameters
relationshipId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Relationship Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "parties": {
    },
  • "accounts": [
    ],
  • "deposits": [
    ],
  • "loans": [
    ],
  • "cards": [
    ],
  • "audit": {
    },
  • "codes": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "status": "Active"
}

Updates a Relationship

Use the JSON Merge Patch standard https://tools.ietf.org/html/rfc7396

Authorizations:
jwtopenIdConnect
path Parameters
relationshipId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Relationship Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/merge-patch+json
object

Responses

Request samples

Content type
application/merge-patch+json
{ }

Response samples

Content type
application/json
{
  • "parties": {
    },
  • "accounts": [
    ],
  • "deposits": [
    ],
  • "loans": [
    ],
  • "cards": [
    ],
  • "audit": {
    },
  • "codes": [
    ],
  • "relationshipId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "status": "Active"
}

Retrieves Relationship Parties

Authorizations:
jwtopenIdConnect
path Parameters
relationshipId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Relationship Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "relationshipId": "033-DDA-123456",
  • "parties": [
    ]
}

Retrieves Customer Relationship Persons

Authorizations:
jwtopenIdConnect
path Parameters
relationshipId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Relationship Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "relationshipId": "033-DDA-123456",
  • "persons": [
    ]
}

Ledger Accounts

Retrieves a list of accounts matching the parameters.

Authorizations:
jwtopenIdConnect
query Parameters
accountId.eq
string (Id) [ 1 .. 300 ] characters
Example: accountId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002
accountType.eq
string
accountBranchCode.eq
string
status.eq
string (AccountStatus) [ 1 .. 35 ] characters
Example: status.eq=Active

Specifies the current primary status of an account. Possible values are: Enabled, Dormant, Disable, Deleted, Pending, Form. Pending, Denied, Review, Approve, ChargeOff, Active, PaymentPastDue, Bankruptcy, AuthorizationProhibited, InterestProhibited, Closed, Restricted, Assumed, New, ZeroBalanceAccount.

accountNumber.eq
string (LedgerAccountNumber) <= 30 characters
Example: accountNumber.eq=1-001

Ledger account number used to identify different accounts. Also used for grouping and categorizing accounts. To make it easy for readers to locate specific accounts or to know what they're looking at instantly, each account typically contains human readable codes.

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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a ledger account or any internal working account of the bank.

Creates a ledger account, detailed or general, of the Chart of Accounts. Also can represent holding accounts, mirror accounts or working accounts that are required for the booking of a part of a transaction in the bank world. This is typically the case when amounts cannot immediately be booked on a final account for duty seggregation or processing reasons or in order to mirror bookings on external accounts, like nostro accounts, mirrow or holding account.

Authorizations:
jwtopenIdConnect
header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
accountType
required
string (LedgerAccountType) [ 1 .. 35 ] characters
Example: "GeneralLedger"

Type of the Ledger Account or Internal Bank Account. Possible values: GeneralLedger, DetailedLedger, Holding, Mirrow, Clearing, CheckDisbursed.

balanceType
string (Balance Type)
Example: "Asset"

Account Balance Type. Possible Values: Asset, positive transaction amount increases balance; Liability, positive transaction amount decreases balance; Equity.

accountCategory
string (LedgerCategoryId) [ 1 .. 40 ] characters
Example: "1"

Unique identifier for the ledger account category. Is a grouping of Ledger Accounts. Its balance is equal to the sum of the balances of all contained accounts.

name
required
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.

number
string (LedgerAccountNumber) <= 30 characters
Example: "1-001"

Ledger account number used to identify different accounts. Also used for grouping and categorizing accounts. To make it easy for readers to locate specific accounts or to know what they're looking at instantly, each account typically contains human readable codes.

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.

Array of objects (RelatedAccount)
Array
accountRelationType
string (AccountRelationType)
Example: "SubAccount"

Account relation role. Possible values are: Parent, EscrowAccount, SubAccount, ControlAccount, CrossAccount, ChargeAccount, AssociatedAccount, IRAAccount, CombinedStatement, SecondaryCombinedStatement, SummaryAccount, FundingSource, CompensatingAccount. Payment related values: Authorized, Counterpart

accountId
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

accountNumber
string (AccountNumber) <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

accountType
string (RelatedAccountType) [ 1 .. 60 ] characters
Example: "Checking"

Type of the account. Some possible ISO 20022 compliant values are: Checking, CardAccount, CashPayment, Charges, CashIncome, Commission, ClearingParticipantSettlementAccount, LimitedLiquiditySavingsAccount, MarginalLending, MoneyMarket, NonResidentExternal, Overdraft, OverNightDeposit, Settlement, Salary, Savings, Tax, TransactingAccount, CashTrading, VirtualAccount, CreditCard, DebitCard, Universal, Investment, EpurseCard, CertificateOfDeposit, MoneyMarketChecking, RetirementAccount, StockOrBond, PrePaid, FleetCard, Cash, DebitAccount, CreditAccount, Benefit, HealthSavingsAccount, FlexibleSpendingAccount, ForBenefitOf, Estate, ClientTrustAccount, LawyersTrustAccount, KeoghPlanAccount, UniformTransfersToMinorsAct, UniformGiftsToMinorsAct, ReserveFunds, SelfDirectedBrokerage, Loan, Ledger.

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.

productId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
Array of objects (GenericCode)

Account related codes

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
{
  • "accountType": "GeneralLedger",
  • "balanceType": "Asset",
  • "accountCategory": "1",
  • "name": "Hermes PD_CA 0002",
  • "number": "1-001",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "relatedAccounts": [
    ],
  • "supplementaryData": { }
}

Response samples

Content type
application/json
{
  • "accountType": "GeneralLedger",
  • "balanceType": "Asset",
  • "accountCategory": "1",
  • "name": "Hermes PD_CA 0002",
  • "number": "1-001",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "relatedAccounts": [
    ],
  • "supplementaryData": { },
  • "accountId": "033-DDA-123456",
  • "accountBranchId": "SEA_1",
  • "balances": [
    ],
  • "status": "Active"
}

Retrieves a Ledger Account

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

Account Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "accountType": "GeneralLedger",
  • "balanceType": "Asset",
  • "accountCategory": "1",
  • "name": "Hermes PD_CA 0002",
  • "number": "1-001",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "relatedAccounts": [
    ],
  • "supplementaryData": { },
  • "accountId": "033-DDA-123456",
  • "accountBranchId": "SEA_1",
  • "balances": [
    ],
  • "status": "Active"
}

Updates an Account

Use the JSON Merge Patch standard https://tools.ietf.org/html/rfc7396

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

Account Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/merge-patch+json
object

Responses

Request samples

Content type
application/merge-patch+json
{ }

Response samples

Content type
application/json
{
  • "accountType": "GeneralLedger",
  • "balanceType": "Asset",
  • "accountCategory": "1",
  • "name": "Hermes PD_CA 0002",
  • "number": "1-001",
  • "accountPurpose": "This is a description.",
  • "currency": "USD",
  • "relatedAccounts": [
    ],
  • "supplementaryData": { },
  • "accountId": "033-DDA-123456",
  • "accountBranchId": "SEA_1",
  • "balances": [
    ],
  • "status": "Active"
}

Retrieves Account Balances

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

Account Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "accountId": "033-DDA-123456",
  • "accountNumber": "1-001",
  • "accountType": "GeneralLedger",
  • "balances": [
    ]
}

Retrieves Ledger Account Transactions

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

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, MemoPosted, HardPosted, Cleared.

amount.lte
string (Amount) <= 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 (Amount) <= 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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
{
  • "accountId": "033-DDA-123456",
  • "accountNumber": "1-001",
  • "accountType": "GeneralLedger",
  • "currentBalance": "100",
  • "transactions": [
    ]
}

Internal Transfers

Retrieves a list of internal transfers matching the parameters.

Authorizations:
jwtopenIdConnect
query Parameters
transferId.eq
string (Id) [ 1 .. 300 ] characters
Example: transferId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002
sourceAccountId.eq
string (Id) [ 1 .. 300 ] characters
Example: sourceAccountId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002
sourceAccountNumber.eq
string (AccountNumber) <= 30 characters
Example: sourceAccountNumber.eq=012345678

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

destinationAccountId.eq
string (Id) [ 1 .. 300 ] characters
Example: destinationAccountId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002
destinationAccountNumber.eq
string (AccountNumber) <= 30 characters
Example: destinationAccountNumber.eq=012345678

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

amount.lte
string (Amount) <= 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 (Amount) <= 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

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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Internal Transfer Request

Instruction to transfer funds between ledger accounts, holding accounts, or final account. To create a balanced internal transfer, there must be at least one credit entry and one debit entry. Additionally, the sum of all credit entry amounts must equal the sum of all debit entry amounts.

Authorizations:
jwtopenIdConnect
header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
Array of objects (PaymentIdentification)
Array
number
required
string [ 1 .. 40 ] characters

Unique and unambiguous identification of a payment.

schemeName
string [ 1 .. 40 ] characters
Example: "UETR"

Name of other payment identificaction. For instance, ISOInitiationMessageIdentifier, InstructionIdentification (Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period), UETR (Universally unique identifier to provide an end-to-end reference of a payment transaction), ExecutionIdentification, EndToEndIdentification, InstructionIdentification, TransactionIdentification, ClearingSystemReference, CreditorReference, CounterpartyReference, UniqueTradeIdentifier, ClearingBrokerIdentification, UniqueTradeIdentifier, ClearingBrokerIdentification, CommonIdentification, ReferenceNumber, TracerNumber, DraftNumber.

issuer
string
Example: "Baltimore"

Entity that assigns the identification.

Array of objects (GenericTransactionCode)

Additional transaction codes.

Array
codeType
string [ 1 .. 50 ] characters
Example: "DetailBAI"

Code type in PascalCase form. Possible values are: DetailBAI, SummaryBAI, TransactionCode, BatchNumber, MICRAccountNumber, CustomerTransferCode, WireTransferScope, WireTransferDirection, CoreTransactionCode

name
string

Name of the code in PascalCase. Possible values: ResponseCode, PromotionCode, Domain, Family, Subfamily, MT940, SourceCode, TaxDeferredContributionCode, International, Domestic, Incoming, Outgoing.

value
string [ 1 .. 35 ] characters
Example: "195"

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
transferId
string [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Trace identification of the transaction entry list. Could be provided by the client and may not be useful to identify a unique transaction.

reversalIndicator
boolean (ReversalIndicator)

Indicates whether or not the transaction is the result of a reversal. Usage: This element should only be present if the entry is the result of a reversal. If the CreditDebitIndicator is Credit and ReversalIndicator is Yes, the original operation was a debit entry. If the CreditDebitIndicator is Debit and ReversalIndicator is Yes, the original operation was a credit entry.

required
Array of objects (InternalTransferEntry)
Array
Array of objects (PaymentIdentification)
Array of objects (GenericTransactionCode)

Additional transaction codes.

amount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

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.

creditDebitIndicator
string (CreditDebitIndicator) [ 1 .. 17 ] characters
Example: "Credit"

Specifies if an operation is an increase or a decrease. Possible values names are: Credit, Debit.

reversalIndicator
boolean (ReversalIndicator)

Indicates whether or not the transaction is the result of a reversal. Usage: This element should only be present if the entry is the result of a reversal. If the CreditDebitIndicator is Credit and ReversalIndicator is Yes, the original operation was a debit entry. If the CreditDebitIndicator is Debit and ReversalIndicator is Yes, the original operation was a credit entry.

object (TransactionAccount)
status
string (InternalTransferStatus) [ 1 .. 60 ] characters
Example: "Accepted"

Indicates the status of an internal transfer. Possible values: Received, Rejected, Pending, Accepted, MemoPosted, HardPosted, Cleared, Expired, Cancelled, Corrected, Reverse, Suspended, Waived. A memo post is a transaction that has not yet been posted but is included in the current day’s available balance until the nightly ledger update. During the ledger update, the transaction is processed and Cleared for the next day. The amount of a transaction is temporarily added to or subtracted from the current available balance until the nightly processing at which time the transaction is scheduled to post the next business day. The reduction in your Current Balance by a Memo Post debit does not remove funds from your account; it only reduces the amount of your then Current Balance.

entryId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
purpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
descriptionLines
Array of strings[ items [ 1 .. 200 ] characters ]
Example: ["This is a description."]
reason
string (PaymentPurpose) [ 1 .. 60 ] characters
Example: "CashManagementTransfer"

Underlying reason for the payment transaction. Possible Values: Allowance, LoanPrincipal, CashManagementTransfer, LoanStandardPayment, LoanPayment, LoanAdditionalPayment, LoanInterest, OverageInterest, OveragePrincipal, EscrowPayment, FeePayment.

object (TransferSettlement)

Transfer settlement information.

postingDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Future transfer posting date. If the posting date is left blank, it will be assumed to be the current date. When creating a MemoPost for an outgoing payment, after this date, the memo record is automatically expired. You can see this change from the status, which is changed from MemoPosted to Expired.

postingType
string (PostingType) [ 1 .. 60 ] characters
Example: "HardPosted"

Indicates the type of posting. Possible values: MemoPosted, HardPosted, ForcePost, PostAuthorizationSucceeds, AuthorizationOnly.

object

Time of the day of the posting date.

hour
string <time-hour>
Example: "12"
timeZone
string (TimeZone) [ 1 .. 30 ] characters
Example: "Pacific"

A time zone is an area which observes a uniform standard time for legal, commercial and social purposes. Some possible values: Pacific, Mountain, Central, Eastern, GreenwichMean

timeOfTheDay
string

Time of the day. Possible Values: AfterMidnight, after midnight and before business day; AfterBusinessDay, after business day and before midnight.

object (Frequency)

Specifies an event frequency

fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

cycle
string [ 1 .. 35 ] characters
Example: "Monthly"

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

memopostedIndicator
boolean

Indicates whether the internal transfer has been memoposted.

Array of objects (Check)
Array
checkType
string

Specifies the type of the check. Possible values are: CustomerCheque, CertifiedCustomerCheque, BankCheque, Draft, ElectronicDraft.

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Check amount

currency
string = 3 characters ^([A-Z]{3})?$
Example: "USD"

Check currency

checkNumber
string <= 35 characters

The number on the face of the check indicating the id of that check in a series.

issuer
string
Example: "Jhon Smith"

Party that issued the check.

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).

availabilityFloat
string

It refers to the time delay between when a check is deposited and when the funds become available for withdrawal. Possible Values: ImmediateWithdrawal, LocalCheck, NonLocalCheck

Array of objects (GenericIdentification)

Check identifiers. Possible scheme names: Reference.

imageSequence
Array of strings (FileName) [ items <= 255 characters ^[a-zA-Z0-9_\- ]+\.[a-zA-Z0-9]+$ ]
Example: ["image003.png"]

Series of images that are related and sequentially ordered.

Array of objects (GenericCode)

Codes to classify the check. Possible code names: AccountCode

printer
string

Check printer used.

object (Cash)

Cashnotes detail

amount
string

Total amount in cash.

uSCurrencyIndicator
boolean
Array of objects (CashNote)
Array
amount
string

Amount in cash

denomination
integer
Example: 100

The face value of each cash note, such as $1, $5, $10, $20, etc.

count
integer
Example: 100

Number of cash notes

currency
string = 3 characters ^([A-Z]{3})?$
Example: "USD"

Amount currency

printer
string

Check printer used.

dispenser
string

Cash or check dispenser used.

Responses

Request samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "codes": [
    ],
  • "transferId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "reversalIndicator": true,
  • "entries": [
    ],
  • "purpose": "This is a description.",
  • "descriptionLines": [
    ],
  • "reason": "CashManagementTransfer",
  • "settlement": {
    },
  • "check": [
    ],
  • "cash": {
    },
  • "printer": "string",
  • "dispenser": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {
    }
}

Internal Transfer Status

Returns the status of an internal transfer.

Authorizations:
jwtopenIdConnect
path Parameters
transferId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Internal Transfer Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "codes": [
    ],
  • "transferId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "reversalIndicator": true,
  • "entries": [
    ],
  • "purpose": "This is a description.",
  • "descriptionLines": [
    ],
  • "reason": "CashManagementTransfer",
  • "settlement": {
    },
  • "check": [
    ],
  • "cash": {
    },
  • "printer": "string",
  • "dispenser": "string",
  • "date": "2022-04-17T08:00:00Z",
  • "status": "Accepted",
  • "charges": [
    ],
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "balances": [
    ]
}

Internal Transfer Cancellation

Request a transfer cancellation.

Authorizations:
jwtopenIdConnect
path Parameters
transferId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Internal Transfer Identification

header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
Array of objects (PaymentIdentification)
Array
number
required
string [ 1 .. 40 ] characters

Unique and unambiguous identification of a payment.

schemeName
string [ 1 .. 40 ] characters
Example: "UETR"

Name of other payment identificaction. For instance, ISOInitiationMessageIdentifier, InstructionIdentification (Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period), UETR (Universally unique identifier to provide an end-to-end reference of a payment transaction), ExecutionIdentification, EndToEndIdentification, InstructionIdentification, TransactionIdentification, ClearingSystemReference, CreditorReference, CounterpartyReference, UniqueTradeIdentifier, ClearingBrokerIdentification, UniqueTradeIdentifier, ClearingBrokerIdentification, CommonIdentification, ReferenceNumber, TracerNumber, DraftNumber.

issuer
string
Example: "Baltimore"

Entity that assigns the identification.

cancellationReason
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."

Responses

Request samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "cancellationReason": "This is a description."
}

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "codes": [
    ],
  • "transferId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "reversalIndicator": true,
  • "entries": [
    ],
  • "purpose": "This is a description.",
  • "descriptionLines": [
    ],
  • "reason": "CashManagementTransfer",
  • "settlement": {
    },
  • "check": [
    ],
  • "cash": {
    },
  • "printer": "string",
  • "dispenser": "string",
  • "date": "2022-04-17T08:00:00Z",
  • "status": "Accepted",
  • "charges": [
    ],
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "balances": [
    ]
}

Internal Transfer Confirmation

Request transfer settlement from memo posted to hard posted.

Authorizations:
jwtopenIdConnect
path Parameters
transferId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Internal Transfer Identification

header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
confirmationReason
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
Array of objects (PaymentIdentification)
Array
number
required
string [ 1 .. 40 ] characters

Unique and unambiguous identification of a payment.

schemeName
string [ 1 .. 40 ] characters
Example: "UETR"

Name of other payment identificaction. For instance, ISOInitiationMessageIdentifier, InstructionIdentification (Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period), UETR (Universally unique identifier to provide an end-to-end reference of a payment transaction), ExecutionIdentification, EndToEndIdentification, InstructionIdentification, TransactionIdentification, ClearingSystemReference, CreditorReference, CounterpartyReference, UniqueTradeIdentifier, ClearingBrokerIdentification, UniqueTradeIdentifier, ClearingBrokerIdentification, CommonIdentification, ReferenceNumber, TracerNumber, DraftNumber.

issuer
string
Example: "Baltimore"

Entity that assigns the identification.

Responses

Request samples

Content type
application/json
{
  • "confirmationReason": "This is a description.",
  • "identifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "codes": [
    ],
  • "transferId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "reversalIndicator": true,
  • "entries": [
    ],
  • "purpose": "This is a description.",
  • "descriptionLines": [
    ],
  • "reason": "CashManagementTransfer",
  • "settlement": {
    },
  • "check": [
    ],
  • "cash": {
    },
  • "printer": "string",
  • "dispenser": "string",
  • "date": "2022-04-17T08:00:00Z",
  • "status": "Accepted",
  • "charges": [
    ],
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "balances": [
    ]
}

Reward Programs

Retrieves a list of reward progrmas matching the parameters.

Authorizations:
jwtopenIdConnect
query Parameters
customer.name.inc
string

The primary customer name includes the substring provided.

partyId.eq
string (Id) [ 1 .. 300 ] characters
Example: partyId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002

Returns the customer relationships

customer.lastName.eq
string (PartyName) [ 1 .. 350 ] characters
Example: customer.lastName.eq=Jane Birkin

Name by which a party is known and which is usually used to identify that party.

customer.firstName.eq
string (PartyName) [ 1 .. 350 ] characters
Example: customer.firstName.eq=Jane Birkin

Name by which a party is known and which is usually used to identify that party.

customer.birthDate.eq
string <date> (Date)
Example: customer.birthDate.eq=2022-04-17

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

customer.phoneNumber.eq
string (PhoneNumber) ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$
Example: customer.phoneNumber.eq=+1-555-1234567

Any phone number equals to.

accountNumber.eq
string (AccountNumber) <= 30 characters
Example: accountNumber.eq=012345678

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

customer.tin.eq
string
customer.ssn.eq
string

Social Security Number

customer.ssn.last4
string

Social Security Number last four digits.

customer.email.eq
string

Email equals to

customer.addressLine.inc
string

Any address line of any postal address includes substring

customer.postCode.eq
string

Any postal address with post code equals to

customer.country.eq
string

Any postal address with Country code equals to

customer.countrySubDivision.inc
string

Any postal address with country subdivision includes substring

customer.townName.inc
string

Any postal address with town name includes substring

customer.personId.eq
string (Id) [ 1 .. 300 ] characters
Example: customer.personId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002

System id equals to

card.number.eq
string (PrimaryAccountNumber) [ 1 .. 19 ] characters
Example: card.number.eq=1234567890123456789

Primary Account Number (PAN) of the card.

card.sourceType.eq
string (CardFundingSourceType) [ 1 .. 35 ] characters
Example: card.sourceType.eq=Credit

Specifies the funding source type of payment card. Possible Values: Credit, Debit, Prepaid, Charge, DeferredDebit, CreditGateway, External.

card.productName.eq
string (CardProductName) [ 1 .. 60 ] characters
Example: card.productName.eq=Visa Classic

Specifies the product name of payment card.

card.brand.inc
string (PartyName) [ 1 .. 350 ] characters
Example: card.brand.inc=Jane Birkin

Name by which a party is known and which is usually used to identify that party.

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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a Reward Program

Authorizations:
jwtopenIdConnect
header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
programTitle
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
name
string (RewardProgramName) [ 1 .. 50 ] characters

Specifies the a Pascal Case name for the reward program.

programType
string (RewardProgramType)

The type of benefits or incentives offered to customers, which can include points, discounts, cash back, merchandise, or special privileges. Possible values: Points, Discounts, CashBack, Merchandise, Privileges.

Array of objects (RelatedAccount)

Accounts related to the reward program

Array
accountRelationType
string (AccountRelationType)
Example: "SubAccount"

Account relation role. Possible values are: Parent, EscrowAccount, SubAccount, ControlAccount, CrossAccount, ChargeAccount, AssociatedAccount, IRAAccount, CombinedStatement, SecondaryCombinedStatement, SummaryAccount, FundingSource, CompensatingAccount. Payment related values: Authorized, Counterpart

accountId
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

accountNumber
string (AccountNumber) <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

accountType
string (RelatedAccountType) [ 1 .. 60 ] characters
Example: "Checking"

Type of the account. Some possible ISO 20022 compliant values are: Checking, CardAccount, CashPayment, Charges, CashIncome, Commission, ClearingParticipantSettlementAccount, LimitedLiquiditySavingsAccount, MarginalLending, MoneyMarket, NonResidentExternal, Overdraft, OverNightDeposit, Settlement, Salary, Savings, Tax, TransactingAccount, CashTrading, VirtualAccount, CreditCard, DebitCard, Universal, Investment, EpurseCard, CertificateOfDeposit, MoneyMarketChecking, RetirementAccount, StockOrBond, PrePaid, FleetCard, Cash, DebitAccount, CreditAccount, Benefit, HealthSavingsAccount, FlexibleSpendingAccount, ForBenefitOf, Estate, ClientTrustAccount, LawyersTrustAccount, KeoghPlanAccount, UniformTransfersToMinorsAct, UniformGiftsToMinorsAct, ReserveFunds, SelfDirectedBrokerage, Loan, Ledger.

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.

productId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
Array of objects (GenericCode)

Account related codes

Array of objects (RewardProgramPaymentCard)

Payment cards related to the reward program.

Array
cardId
required
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.

cardHolderId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
nameOnCard
string [ 1 .. 350 ] characters
Example: "Jane Birkin"

Specifies the card holder name on the card.

brand
string <= 35 characters
Example: "Visa"

Brand name of the card.

Array of objects (PaymentCardIdentification)
productId
string [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
number
string [ 1 .. 19 ] characters
Example: "1234567890123456789"

Primary Account Number (PAN) of the card.

cardHolderType
string [ 1 .. 35 ] characters
Example: "Primary"

Specifies the card holder type of payment card. Possible Values: Primary, Additional, Authorized, Guarantor.

fundingSourceType
string [ 1 .. 35 ] characters
Example: "Credit"

Specifies the funding source type of payment card. Possible Values: Credit, Debit, Prepaid, Charge, DeferredDebit, CreditGateway, External.

businessIndicator
boolean

Indicates whether the payment card is business or not.

cardBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: "SEA_1"

Identification of the account servicer institution at branch level or center level. To overlay the codes to produce a unique identifier the following expresion is used: BranchRegionCode-BranchSubdivisionCode.

startRewardDate
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.

expiryRewardDate
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 (RewardProgramBalance)

Reward balances

status
string (CardStatus) [ 1 .. 60 ] characters
Example: "Active"

Specifies the status of payment card. Some possible values are: AssignPIN, Active, Blocked, Closed, Expedite, Expired, HotCarded, Renewed, Inactive, Issued, Lost, Restricted, Stolen, Suspended, Denied, Pending.

Array of objects (RewardProgramPaymentCard)

Payment cards related to the reward program.

Array
cardId
required
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.

cardHolderId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
nameOnCard
string [ 1 .. 350 ] characters
Example: "Jane Birkin"

Specifies the card holder name on the card.

brand
string <= 35 characters
Example: "Visa"

Brand name of the card.

Array of objects (PaymentCardIdentification)
productId
string [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
number
string [ 1 .. 19 ] characters
Example: "1234567890123456789"

Primary Account Number (PAN) of the card.

cardHolderType
string [ 1 .. 35 ] characters
Example: "Primary"

Specifies the card holder type of payment card. Possible Values: Primary, Additional, Authorized, Guarantor.

fundingSourceType
string [ 1 .. 35 ] characters
Example: "Credit"

Specifies the funding source type of payment card. Possible Values: Credit, Debit, Prepaid, Charge, DeferredDebit, CreditGateway, External.

businessIndicator
boolean

Indicates whether the payment card is business or not.

cardBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: "SEA_1"

Identification of the account servicer institution at branch level or center level. To overlay the codes to produce a unique identifier the following expresion is used: BranchRegionCode-BranchSubdivisionCode.

startRewardDate
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.

expiryRewardDate
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 (RewardProgramBalance)

Reward balances

status
string (CardStatus) [ 1 .. 60 ] characters
Example: "Active"

Specifies the status of payment card. Some possible values are: AssignPIN, Active, Blocked, Closed, Expedite, Expired, HotCarded, Renewed, Inactive, Issued, Lost, Restricted, Stolen, Suspended, Denied, Pending.

Responses

Request samples

Content type
application/json
{
  • "programTitle": "This is a Title.",
  • "name": "string",
  • "programType": "string",
  • "accounts": [
    ],
  • "cards": [
    ],
  • "parties": [
    ]
}

Response samples

Content type
application/json
{
  • "programId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "balances": [
    ],
  • "status": "Available",
  • "programTitle": "This is a Title.",
  • "name": "string",
  • "programType": "string",
  • "accounts": [
    ],
  • "cards": [
    ],
  • "parties": [
    ]
}

Reward Program Status

Returns the status of a Reward Program.

Authorizations:
jwtopenIdConnect
path Parameters
programId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002
header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "programId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "balances": [
    ],
  • "status": "Available",
  • "programTitle": "This is a Title.",
  • "name": "string",
  • "programType": "string",
  • "accounts": [
    ],
  • "cards": [
    ],
  • "parties": [
    ]
}

Updates a Reward Program

Use the JSON Merge Patch standard https://tools.ietf.org/html/rfc7396

Authorizations:
jwtopenIdConnect
path Parameters
programId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002
header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/merge-patch+json
object

Responses

Request samples

Content type
application/merge-patch+json
{ }

Response samples

Content type
application/json
{
  • "programId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "balances": [
    ],
  • "status": "Available",
  • "programTitle": "This is a Title.",
  • "name": "string",
  • "programType": "string",
  • "accounts": [
    ],
  • "cards": [
    ],
  • "parties": [
    ]
}

Retrieves the Reward Programs of a Member

Retrieves all the reward programs the member may have.

Authorizations:
jwtopenIdConnect
path Parameters
personId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Person Identification

query Parameters
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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
{
  • "personId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "personName": "Jane Birkin",
  • "rewardPrograms": [
    ]
}

Documents

Retrieves a list of documents matching the parameters.

Authorizations:
jwtopenIdConnect
query Parameters
party.name.inc
string

A related party name includes the substring provided.

documentId.eq
string (Id) [ 1 .. 300 ] characters
Example: documentId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002

Returns the document

contact.lastName.eq
string (PartyName) [ 1 .. 350 ] characters
Example: contact.lastName.eq=Jane Birkin

Name by which a party is known and which is usually used to identify that party.

contact.firstName.eq
string (PartyName) [ 1 .. 350 ] characters
Example: contact.firstName.eq=Jane Birkin

Name by which a party is known and which is usually used to identify that party.

contact.birthDate.eq
string <date> (Date)
Example: contact.birthDate.eq=2022-04-17

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

contact.phoneNumber.eq
string (PhoneNumber) ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$
Example: contact.phoneNumber.eq=+1-555-1234567

Any phone number equals to.

accountNumber.eq
string (AccountNumber) <= 30 characters
Example: accountNumber.eq=012345678

A related account has equal number

documentType.eq
string
card.number.eq
string (PrimaryAccountNumber) [ 1 .. 19 ] characters
Example: card.number.eq=1234567890123456789

Primary Account Number (PAN) of the card.

card.sourceType.eq
string (CardFundingSourceType) [ 1 .. 35 ] characters
Example: card.sourceType.eq=Credit

Specifies the funding source type of payment card. Possible Values: Credit, Debit, Prepaid, Charge, DeferredDebit, CreditGateway, External.

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 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a Document or Agreement

Authorizations:
jwtopenIdConnect
header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
documentReference
string [ 1 .. 35 ] characters

Document location.

format
string (DocumentFormat) [ 1 .. 35 ] characters
Example: "PDF"

Specifies a choice of format for a document. Possible Values: PDF, HTML.

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

object (Jurisdiction)

Area with a set of laws under the control of a system which are different from neighbouring areas

countrySubdivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

Name of a built-up area, with defined boundaries, and a local government. Also city name.

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

Country name obtained from the United Nations (ISO 3166, Alpha-2 code).

object (ContactDetails)

Specifies the contact details of a person.

object (StructuredName)

The structured name is used to initialize the person name with the format

firstName
required
string [ 1 .. 200 ] characters
Example: "Mary"

Person given first name.

middleName
string [ 1 .. 200 ] characters
Example: "Joe"

Person given middle name.

lastName
required
string [ 1 .. 200 ] characters
Example: "Smith"

Person surname.

middleInitial
string [ 1 .. 10 ] characters
Example: "J."

Person middle initial.

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. Generation order should be expressed with roman numerals: I, II, III, IV, V.

prefix
string [ 1 .. 20 ] characters
Example: "Dr."

Name prefixes are typically Dr., Mr., Mrs., Ms.

name
string [ 1 .. 350 ] characters
Example: "Jane Birkin"

Preferred name to contact the person

firstContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
lastContactDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (Phone)
Array
number
required
string (PhoneNumber) ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$
Example: "+1-555-1234567"

The collection of information which identifies a specific phone or FAX number as defined by telecom services.

extension
string <= 5 characters

Phone Number Extension.

country
string (CountryCallingCode) <= 3 characters

Country calling codes, country dial-in codes, international subscriber dialing (ISD) codes, or most commonly, telephone country codes. Country codes are defined by the International Telecommunication Union (ITU) in ITU-T standards E.123 and E.164. The prefixes enable international direct dialing (IDD).

phoneType
string [ 1 .. 35 ] characters

Type of phone address. Possible values are:
Mobile, Landline, Fax, Pager, Modem.

phonePurpose
string [ 1 .. 35 ] characters

Purpose of the phone address. Possible values are: Business, Personal, International, Alternative, PersonalInternational, BusinessInternational

foreignIndicator
boolean

Indicates whether is a foreign phone number

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

object (TimeOfTheDay)
comment
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
object

The period of use of the phone information.

Array of objects (GenericCode)
Array of objects (GenericIdentification)

Phone identifiers are used to identify parties that share the same phone or to associate an existing phones with a specific party. Possible scheme name values: PhoneIdentifier.

lastUpdatedDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
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, Business, Administrative, Personal

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

Array of objects (GenericIdentification)

Email identifiers are used to identify parties that share the same email or to associate an existing email with a specific party. Possible scheme name values: EmailIdentifier.

lastUpdatedDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
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 Organization or building.

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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

channelIdentification
string (CommunicationChannelIdentification) [ 1 .. 128 ] characters
Example: "011-02010020202"

Communication value such as phone number or email address.

channelPurpose
string (CommunicationChannelPurpose) [ 1 .. 40 ] characters
Example: "PrivacyNotices"

Communication purpose of the channel. Possible values: Alerts, PrivacyNotices, NegativeBalance, OverdraftProtection, ACHNotice, ChargeBack, BalanceOnReceipt, RegulationCCNotice, RateChange, MaturityNotice, InterestNotice, RegularNotice, PastDueNotice, HUDNotice, PaymentChange, AutomaticPayment, PastDueFirstNotice, PastDueSecondNotice, PastDueNoticeGuarantor, CardHolderAuthorization, Delivery, DocumentDistribution.

codeWord
string

A party is asked for a codeword to verify their identity trought a communication channel

alertIndicator
boolean

Indicates whether the channel is used for enterprise alerts to the customer.

personId
string [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

The party authorized to use the communcation channel

Array of objects (GenericCode)

Codes to determine configurarion options for alerts and notifications. Possible code names: NoticeOption.

status
string (AlertStatus) [ 1 .. 35 ] characters
Example: "Warning"

Alert status. Possible values: Sent, SentLastNight, Pending, Enable, Disable, FraudAlert. Possible values for CreditBureauAlert: IdentityTheft.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

object

The lead time between the event and the alert notification.

alertText
string [ 1 .. 1025 ] characters
Example: "This is a description."

Text to appear in alerts and notices.

Array of objects (SpotDate)
contactCount
integer

Number of contacts.

object (Frequency)

Specifies an event frequency

preferredMethod
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, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

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, Default.

object (AccountContractRelatedParty)
partyId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
partyType
string (PartyType)
Example: "Person"

Possible values are: Person, Organization. Also other types of servicer entities: ServicerOfficer, ExternalOrganization, Referral.

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.

agreementType
string (AgreementType)

Document or agreement type. Possible values: CardAgreement, AccountContract.

agreementSubtype
string [ 1 .. 60 ] characters

Agreement detailed category.

documentId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
Array of objects (GenericIdentification)

Unique indentification of the collateral. Possible scheme names: NoteNumber.

Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification.

schemeName
required
string [ 1 .. 35 ] characters

Name of the identification scheme.

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.

status
string (AccountContractStatus) [ 1 .. 35 ] characters
Example: "Active"

Specifies the current status of an account contract. Possible values are: Active, Expired, GracePeriod, Terminated, Waiver.

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 (MasterAgreement)

A master agreement is a document that outlines the terms and conditions of an agreement between two or more parties. It's common to use a master agreement when there are multiple agreements in place with one company.

accountId
string [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

Account at Master Agreement level used as a reference for the Loan opening. Payments are auto-debited from this account.

availableCredit
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Account at Master Agreement level used as a reference for the Loan opening. Payments are auto-debited from this account.

documentReference
string [ 1 .. 35 ] characters

Document location.

format
string (DocumentFormat) [ 1 .. 35 ] characters
Example: "PDF"

Specifies a choice of format for a document. Possible Values: PDF, HTML.

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
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 .. 100 ] characters

Specifies the function of the document.

object

The payment term for the account premium.

object (TemporalDuration)

Describes a temporal duration.

unit
required
string [ 1 .. 36 ] characters
Example: "Months"

Unit that describes the duration.

value
integer <= 999

Value of the duration in number of units.

timesExtended
integer <= 100

The number of times the loan has been extended over its term.

timesRenewed
integer <= 100

The number of times the loan has been renewed over its term.

Array of objects (AlternativeTerm)
Array
object (TemporalDuration)

Describes a temporal duration.

name
string <= 100

Term name in Pascal Case.

effectiveDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
premium
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount of the customer premium.

coverageAmount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Total amount of money the user is insured for.

productId
string (ProductId) [ 1 .. 36 ] characters
Example: "PD_CA_0002"

Identification of the product offered by a financial institution to its customers.

Array of objects (GenericCode)
Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

value
string [ 1 .. 35 ] characters
Example: "195"

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
Array of objects (SpotDate)

Contract dates. Possible values: LossMitigation

Array
name
string (SpotDateName) [ 1 .. 40 ] characters
Example: "Expiration"

Possible values por projected dates: Forecast, Expiration, LastNonFinancial, Escheat. Possible values for past dates: IRALastRollOver. Other possible values: EffectiveDate, ResponseByDate.

date
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
Array of objects (DocumentRelatedAccount)

Accounts involved on the contract document.

Array
accountRelationType
string (AccountRelationType)
Example: "SubAccount"

Account relation role. Possible values are: Parent, EscrowAccount, SubAccount, ControlAccount, CrossAccount, ChargeAccount, AssociatedAccount, IRAAccount, CombinedStatement, SecondaryCombinedStatement, SummaryAccount, FundingSource, CompensatingAccount. Payment related values: Authorized, Counterpart

accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

Array of objects (Balance)

Account balances

Array of objects (LimitDescriptor)
Array of objects (Restriction)

Party restrictions on the account capabilities

object (DatePeriod)
renewalIndicator
boolean

Indicates whether the account renewals at the end of the validity period.

Responses

Request samples

Content type
application/json
{
  • "documentReference": "string",
  • "format": "PDF",
  • "title": "This is a Title.",
  • "version": "string",
  • "signOffDate": "2022-04-17",
  • "issueDate": "2022-04-17",
  • "purpose": "string",
  • "fromDateTime": "2022-04-17T08:00:00Z",
  • "upToDateTime": "2022-04-17T08:00:00Z",
  • "jurisdiction": {
    },
  • "contact": {
    },
  • "parties": {
    },
  • "agreementType": "string",
  • "agreementSubtype": "string",
  • "documentId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "identifiers": [
    ],
  • "status": "Active",
  • "targetClosingDate": "2022-04-17",
  • "targetGoLiveDate": "2022-04-17",
  • "masterAgreement": {
    },
  • "term": {
    },
  • "premium": "100",
  • "coverageAmount": "100",
  • "productId": "PD_CA_0002",
  • "codes": [
    ],
  • "projectedDates": [
    ],
  • "relatedAccounts": [
    ]
}

Response samples

Content type
application/json
{
  • "documentReference": "string",
  • "format": "PDF",
  • "title": "This is a Title.",
  • "version": "string",
  • "signOffDate": "2022-04-17",
  • "issueDate": "2022-04-17",
  • "purpose": "string",
  • "fromDateTime": "2022-04-17T08:00:00Z",
  • "upToDateTime": "2022-04-17T08:00:00Z",
  • "jurisdiction": {
    },
  • "contact": {
    },
  • "parties": {
    },
  • "agreementType": "string",
  • "agreementSubtype": "string",
  • "documentId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "identifiers": [
    ],
  • "status": "Active",
  • "targetClosingDate": "2022-04-17",
  • "targetGoLiveDate": "2022-04-17",
  • "masterAgreement": {
    },
  • "term": {
    },
  • "premium": "100",
  • "coverageAmount": "100",
  • "productId": "PD_CA_0002",
  • "codes": [
    ],
  • "projectedDates": [
    ],
  • "relatedAccounts": [
    ]
}

Retrieves a Document

Authorizations:
jwtopenIdConnect
path Parameters
documentId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002
header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "documentReference": "string",
  • "format": "PDF",
  • "title": "This is a Title.",
  • "version": "string",
  • "signOffDate": "2022-04-17",
  • "issueDate": "2022-04-17",
  • "purpose": "string",
  • "fromDateTime": "2022-04-17T08:00:00Z",
  • "upToDateTime": "2022-04-17T08:00:00Z",
  • "jurisdiction": {
    },
  • "contact": {
    },
  • "parties": {
    },
  • "agreementType": "string",
  • "agreementSubtype": "string",
  • "documentId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "identifiers": [
    ],
  • "status": "Active",
  • "targetClosingDate": "2022-04-17",
  • "targetGoLiveDate": "2022-04-17",
  • "masterAgreement": {
    },
  • "term": {
    },
  • "premium": "100",
  • "coverageAmount": "100",
  • "productId": "PD_CA_0002",
  • "codes": [
    ],
  • "projectedDates": [
    ],
  • "relatedAccounts": [
    ]
}

Updates a Document

Use the JSON Merge Patch standard https://tools.ietf.org/html/rfc7396

Authorizations:
jwtopenIdConnect
path Parameters
documentId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002
header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/merge-patch+json
object

Responses

Request samples

Content type
application/merge-patch+json
{ }

Response samples

Content type
application/json
{
  • "documentReference": "string",
  • "format": "PDF",
  • "title": "This is a Title.",
  • "version": "string",
  • "signOffDate": "2022-04-17",
  • "issueDate": "2022-04-17",
  • "purpose": "string",
  • "fromDateTime": "2022-04-17T08:00:00Z",
  • "upToDateTime": "2022-04-17T08:00:00Z",
  • "jurisdiction": {
    },
  • "contact": {
    },
  • "parties": {
    },
  • "agreementType": "string",
  • "agreementSubtype": "string",
  • "documentId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "identifiers": [
    ],
  • "status": "Active",
  • "targetClosingDate": "2022-04-17",
  • "targetGoLiveDate": "2022-04-17",
  • "masterAgreement": {
    },
  • "term": {
    },
  • "premium": "100",
  • "coverageAmount": "100",
  • "productId": "PD_CA_0002",
  • "codes": [
    ],
  • "projectedDates": [
    ],
  • "relatedAccounts": [
    ]
}