bfsi_account_and_transaction_api.model
Modules
Module bfsi_account_and_transaction_api.model
API
Definitions
wso2bfsi/bfsi_account_and_transaction_api.model
Records
bfsi_account_and_transaction_api.model: Account
Set of elements used to define the account details.
Fields
- AccountIdreadonly string - A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
- Status string? - Specifies the status of account resource in code form.
- StatusUpdateDateTime string(default util:getPastDateTime()) - Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- Currency string(default "USD") - Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
- AccountType string? - Specifies the type of account (personal or business).
- AccountSubType string? - Specifies the sub type of account (product family group).
- Description string? - Specifies the description of the account type.
- Nickname string? - The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
- OpeningDate string(default util:getPastDateTime()) - Date on which the account and related basic services are effectively operational for the account owner. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- MaturityDate string(default util:getFutureDateTime()) - Maturity date of the account.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- SwitchStatus string? - Specifies the switch status for the account, in a coded form.
- Account CreditorAccount[]? - Provides the details to identify an account.
bfsi_account_and_transaction_api.model: AccountsResponse
Represent an accounts response record with hateoas data.
Fields
- Links Links? - Links relevant to the payload
- Meta Meta? - Meta Data relevant to the payload
bfsi_account_and_transaction_api.model: Address
Postal address of a party.
Fields
- AddressType string? - Identifies the nature of the postal address.
- AddressLine string[]? - Name of the address line
- StreetName string? - Name of a street or thoroughfare.
- BuildingNumber string? - Number that identifies the position of a building on a street.
- PostCode string? - Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
- TownName string? - Name of a built-up area, with defined boundaries, and a local government.
- CountrySubDivision string? - Identifies a subdivision of a country eg, state, region, county.
- Country string - Nation with its own government, occupying a particular territory.
bfsi_account_and_transaction_api.model: Amount
Amount of money of the cash balance.
Fields
- Amount string(default util:getRandomAmount()) - A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
- Currency string(default "USD") - A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217(Codes for the representation of currencies and funds)
bfsi_account_and_transaction_api.model: BadRequest
Represents the subtype of http:BadRequest status code record.
Fields
- Fields Included from *BadRequest
bfsi_account_and_transaction_api.model: Balance
Set of elements used to define the balance details.
Fields
- AccountIdreadonly string - A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
- BalanceIdreadonly string - A unique and immutable identifier used to identify the balance resource. This identifier has no meaning to the account owner.
- CreditDebitIndicator string - Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance.
- Type string - Balance type, in a coded form.
- DateTime string(default util:getDateTime()) - Indicates the date (and time) of the balance.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- Amount Amount? - Amount of money of the cash balance.
- CreditLine Creditline[]? - Set of elements used to provide details on the credit line.
bfsi_account_and_transaction_api.model: BalanceAmount
Set of elements used to provide details of a generic amount for the statement resource.
Fields
- CreditDebitIndicator string - Indicates whether the amount is a credit or a debit. Usage: A zero amount is considered to be a credit amount.
- Type string - Amount type, in a coded form.
- Amount Amount - Amount of money associated with the amount type.
bfsi_account_and_transaction_api.model: BalanceResponse
Represent a balance response record with hateoas data.
Fields
- Links Links? - Links relevant to the payload
- Meta Meta? - Meta Data relevant to the payload
bfsi_account_and_transaction_api.model: BankTransactionCode
Set of elements used to fully identify the type of underlying transaction resulting in an entry.
Fields
- Code string - Specifies the family within a domain.
- SubCode string - Specifies the sub-product family within a specific family.
bfsi_account_and_transaction_api.model: BeneficiariesResponse
Represent an beneficiaries response record with hateoas data.
Fields
- Data Beneficiary|Beneficiary[] - Response data
- Links Links? - Links relevant to the payload
- Meta Meta? - Meta Data relevant to the payload
bfsi_account_and_transaction_api.model: Beneficiary
Set of elements used to define the beneficiary details.
Fields
- AccountIdreadonly string - A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
- BeneficiaryIdreadonly string - A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.
- BeneficiaryType string? - Specifies the Beneficiary Type.
- Reference string? - Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
- CreditorAccount CreditorAccount? - Provides the details to identify the beneficiary account.
bfsi_account_and_transaction_api.model: CardInstrument
Set of elements to describe the card instrument used in the transaction.
Fields
- CardSchemeName string - Name of the card scheme.
- AuthorisationType string? - The card authorisation type.
- Name string? - Name of the cardholder using the card instrument.
- Identification string? - Identification assigned by an institution to identify the card instrument used in the transaction. This identification is known by the account owner, and may be masked.
bfsi_account_and_transaction_api.model: CreditInterest
Details about the interest that may be payable to the Account holders.
Fields
- TierBandSet TierBandSet[] - The group of tiers or bands for which credit interest can be applied.
bfsi_account_and_transaction_api.model: Creditline
Set of elements used to provide details on the credit line.
Fields
- Included boolean - Indicates whether or not the credit line is included in the balance of the account. Usage: If not present, credit line is not included in the balance amount of the account.
- Type string? - Limit type, in a coded form.
- Amount Amount? - Amount of money of the credit line.
bfsi_account_and_transaction_api.model: CreditorAccount
Provides the details to identify the beneficiary account.
Fields
- SchemeName string - Name of the identification scheme, in a coded form as published in an external list.
- Identification string(default util:getRandomId()) - Beneficiary account identification.
- Name string? - The account name is the name or names of the account owner(s) represented at an account level, as displayed by
the bank's online channels.
Note
, the account name is not the product name or the nickname of the account.
- SecondaryIdentification string? - This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
bfsi_account_and_transaction_api.model: CreditorAgent
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
Fields
- SchemeName string - Name of the identification scheme, in a coded form as published in an external list.
- Identification string - Unique and unambiguous identification of the servicing institution.
bfsi_account_and_transaction_api.model: CurrencyExchange
Set of elements used to provide details on the currency exchange.
Fields
- SourceCurrency string - Currency from which an amount is to be converted in a currency conversion.
- TargetCurrency string? - Currency into which an amount is to be converted in a currency conversion.
- UnitCurrency string? - Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
- ExchangeRate decimal - Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency).
- ContractIdentification string? - Unique identification to unambiguously identify the foreign exchange contract.
- QuotationDate string? - Date and time at which an exchange rate is quoted.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- InstructedAmount Amount? - 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.
bfsi_account_and_transaction_api.model: DirectDebit
Account to or from which a cash entry is made.
Fields
- AccountIdreadonly string - A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
- DirectDebitIdreadonly string - A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner.
- MandateIdentification string(default util:getRandomId()) - Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference.
- DirectDebitStatusCode string? - Specifies the status of the direct debit in code form.
- Name string - Name of Service User.
- PreviousPaymentDateTime string(default util:getPastDateTime()) - Date of most recent direct debit collection.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- Frequency string? - Regularity with which direct debit instructions are to be created and processed.
- PreviousPaymentAmount Amount? - The amount of the most recent direct debit collection.
bfsi_account_and_transaction_api.model: DirectDebitsResponse
Represent an directDebits response record with hateoas data.
Fields
- Data DirectDebit|DirectDebit[] - Response data
- Links Links? - Links relevant to the payload
- Meta Meta? - Meta Data relevant to the payload
bfsi_account_and_transaction_api.model: ErrorDetail
An object of detail error codes, and messages, and URLs to documentation to help remediation.
Fields
- ErrorCode string - Low level textual error code, e.g., OB.Field.Missing
- Path string? - Recommended but optional reference to the JSON Path of the field with error,
e.g., Data.Initiation.InstructedAmount.Currency
- Url string? - URL to help remediate the problem, or provide more information, or to API Reference, or help etc
bfsi_account_and_transaction_api.model: Links
Links relevant to the payload.
Fields
- Self string - Self Link relevant to the payload
- First string? - First Link relevant to the payload
- Prev string? - Prev Link relevant to the payload
- Next string? - Next Link relevant to the payload
- Last string? - Last Link relevant to the payload
bfsi_account_and_transaction_api.model: MerchantDetails
Details of the merchant involved in the transaction.
Fields
- MerchantName string? - Name by which the merchant is known.
- MerchantCategoryCode string? - Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
bfsi_account_and_transaction_api.model: Meta
Meta Data relevant to the payload.
Fields
- TotalPages int? - Count of Metadata
- FirstAvailableDateTime string? - All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- LastAvailableDateTime string? - All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
bfsi_account_and_transaction_api.model: Object
Represent an empty object.
bfsi_account_and_transaction_api.model: Offer
Set of elements used to define the offer details.
Fields
- AccountIdreadonly string - A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
- OfferIdreadonly string - A unique and immutable identifier used to identify the offer resource. This identifier has no meaning to the account owner.
- OfferType string? - Offer type, in a coded form.
- Description string? - Further details of the offer.
- StartDateTime string(default util:getPastDateTime()) - Date and time at which the offer starts.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- EndDateTime string(default util:getFutureDateTime()) - Date and time at which the offer ends.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- Rate string(default util:getRandomAmount()) - Rate associated with the offer type.
- Value int? - Value associated with the offer type.
- Term string? - Further details of the term of the offer.
- URL string? - URL (Uniform Resource Locator) where documentation on the offer can be found
- Amount Amount? - Amount of money associated with the offer type.
- Fee Amount? - Fee associated with the offer type.
bfsi_account_and_transaction_api.model: OffersResponse
Represent an offers response record with hateoas data.
Fields
- Links Links? - Links relevant to the payload
- Meta Meta? - Meta Data relevant to the payload
bfsi_account_and_transaction_api.model: OtherCodeType
Describes destinations or calculation methods.
Fields
- Code string? - The four letter Mnemonic used within an XML file to identify a code
- Name string - Long name associated with the code
- Description string - Description to describe the purpose of the code
bfsi_account_and_transaction_api.model: OtherproductType
Other product type details associated with the account.
Fields
- Name string - Long name associated with the product
- Description string - Description of the Product associated with the account
- ProductDetails ProductDetails? - Description of the product details
- CreditInterest CreditInterest? - Details about the interest that may be payable to the Account holders
bfsi_account_and_transaction_api.model: OtherSegment
Holds other segment details.
Fields
- Code string? - The four letter Mnemonic used within an XML file to identify a code
- Name string - Long name associated with the code
- Description string - Description to describe the purpose of the code
bfsi_account_and_transaction_api.model: PartiesResponse
Represent an parties response record with hateoas data.
Fields
- Links Links? - Links relevant to the payload
- Meta Meta? - Meta Data relevant to the payload
bfsi_account_and_transaction_api.model: Party
Set of elements used to define the party details.
Fields
- PartyIdreadonly string - A unique and immutable identifier used to identify the party resource. This identifier has no meaning to the account owner.
- PartyNumber string(default util:getRandomId()) - Number assigned by an agent to identify its customer.
- PartyType string? - Party type, in a coded form.
- Name string? - Name by which a party is known and which is usually used to identify that party.
- FullLegalName string? - Specifies a character string with a maximum length of 350 characters.
- LegalStructure string? - Legal standing of the party.
- BeneficialOwnership boolean? - Beneficial ownership of the party
- AccountRole string? - A party’s role with respect to the related account.
- EmailAddress string? - Address for electronic mail (e-mail).
- Phone string? - Collection of information that identifies a phone number, as defined by telecom services.
- Mobile string? - Collection of information that identifies a mobile phone number, as defined by telecom services.
- Relationships PartyRelationship? - The Party's relationships with other resources.
- Address Address[]? - Postal address of a party.
bfsi_account_and_transaction_api.model: PartyRelationship
The Party's relationships with other resources.
Fields
- Account PartyRelationshipAccount? - Relationship to the Account resource.
bfsi_account_and_transaction_api.model: PartyRelationshipAccount
The Party's relationships with other resources.
Fields
- Related string - Absolute URI to the related resource.
- Id string - Unique identification as assigned by the bank to uniquely identify the related resource.
bfsi_account_and_transaction_api.model: PostalAddress
Information that locates and identifies a specific address, as defined by postal services.
Fields
- AddressType string? - Identifies the nature of the postal address.
- Department string? - Identification of a division of a large organisation or building.
- SubDepartment string? - Identification of a sub-division of a large organisation or building.
- StreetName string? - Name of a street or thoroughfare.
- BuildingNumber string? - Number that identifies the position of a building on a street.
- PostCode string? - Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
- TownName string? - Name of a built-up area, with defined boundaries, and a local government.
- CountrySubDivision string? - Identifies a subdivision of a country such as state, region, county.
- Country string? - Nation with its own government.
- AddressLine string[]? - Describes address line list
bfsi_account_and_transaction_api.model: Product
Product details associated with the Account.
Fields
- ProductName string? - The name of the Product used for marketing purposes from a customer perspective. I.e. what the customer would recognise.
- ProductIdreadonly string - The unique ID that has been internally assigned by the financial institution to each of the current account banking products they market to their retail and/or small to medium enterprise (SME) customers.
- AccountIdreadonly string - A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
- SecondaryProductId string? - Any secondary Identification which supports Product Identifier to uniquely identify the current account banking products.
- ProductType string - Product type : Personal Current Account, Business Current Account
- MarketingStateId string? - Unique and unambiguous identification of a Product Marketing State.
- OtherProductType OtherproductType? - Other product type details associated with the account.
bfsi_account_and_transaction_api.model: ProductDetails
Description of the product details.
Fields
- Segment string[]? - Holds product segments
- FeeFreeLength int? - The length/duration of the fee free period
- FeeFreeLengthPeriod string? - The unit of period (days, weeks, months etc.) of the promotional length
- MonthlyMaximumCharge string? - The maximum relevant charges that could accrue as defined fully in Part 7 of the CMA order
- Notes string[]? - Holds product notes
- OtherSegment OtherSegment? - Holds other segment details
bfsi_account_and_transaction_api.model: ProductsResponse
Represent an products response record with hateoas data.
Fields
- Links Links? - Links relevant to the payload
- Meta Meta? - Meta Data relevant to the payload
bfsi_account_and_transaction_api.model: ProprietaryBankTransactionCode
Set of elements to fully identify a proprietary bank transaction code.
Fields
- Code string - Proprietary bank transaction code to identify the underlying transaction.
- Issuer string? - Identification of the issuer of the proprietary bank transaction code.
bfsi_account_and_transaction_api.model: ScheduledPayment
Set of elements used to define the scheduled payment details.
Fields
- AccountIdreadonly string - A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
- ScheduledPaymentIdreadonly string - A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.
- ScheduledPaymentDateTime string(default util:getFutureDateTime()) - The date on which the scheduled payment will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- ScheduledType string - Specifies the scheduled payment date type requested
- Reference string? - Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
- DebtorReference string? - A reference value provided by the user to the TPP while setting up the scheduled payment.
- InstructedAmount Amount - 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. Usage: This amount has to be transported unchanged through the transaction chain.
- CreditorAgent CreditorAgent? - Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
- CreditorAccount CreditorAccount? - Provides the details to identify the beneficiary account.
bfsi_account_and_transaction_api.model: ScheduledPaymentsResponse
Represent an scheduled payments response record with hateoas data.
Fields
- Data ScheduledPayment|ScheduledPayment[] - Response data
- Links Links? - Links relevant to the payload
- Meta Meta? - Meta Data relevant to the payload
bfsi_account_and_transaction_api.model: StandingOrder
Set of elements used to define the standing order details.
Fields
- AccountIdreadonly string - A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
- StandingOrderIdreadonly string - A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.
- Frequency string - Individual Definitions:
- NotKnown - Not Known
- EvryDay - Every day
- EvryWorkgDay - Every working day
- IntrvlDay - An interval specified in number of calendar days (02 to 31)
- IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)
- WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)
- IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the
- month (-05 to -01, 01 to 31)
- QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED)
- ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December.
- SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.
- RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December.
- Individual Patterns:
- NotKnown (ScheduleCode)
- EvryDay (ScheduleCode)
- EvryWorkgDay (ScheduleCode)
- IntrvlDay:NoOfDay (ScheduleCode + NoOfDay)
- IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)
- WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)
- IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)
- QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay
- NotKnown
- EvryDay
- EvryWorkgDay
- IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1])
- IntrvlWkDay:0[1-9]:0[1-7]
- WkInMnthDay:0[1-5]:0[1-7]
- IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])
- QtrDay:(ENGLISH|SCOTTISH|RECEIVED)
- Reference string? - Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
- FirstPaymentDateTime string(default util:getPastDateTime()) - The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- NextPaymentDateTime string(default util:getFutureDateTime()) - The date on which the next payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- LastPaymentDateTime string(default util:getPastDateTime()) - The date on which the last (most recent) payment for a Standing Order schedule was made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- FinalPaymentDateTime string(default util:getFutureDateTime()) - The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- NumberOfPayments string? - Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
- StandingOrderStatusCode string? - Specifies the status of the standing order in code form.
- FirstPaymentAmount Amount? - The amount of the first Standing Order
- NextPaymentAmount Amount? - The amount of the next Standing Order.
- LastPaymentAmount Amount? - The amount of the last (most recent) Standing Order instruction.
- FinalPaymentAmount Amount? - The amount of the final Standing Order
- CreditorAgent CreditorAgent? - Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
- CreditorAccount CreditorAccount? - Provides the details to identify the beneficiary account.
- SupplementaryData Object? - Additional information that can not be captured in the structured fields and/or any other specific block.
bfsi_account_and_transaction_api.model: StandingOrdersResponse
Represent an standing orders response record with hateoas data.
Fields
- Data StandingOrder|StandingOrder[] - Response data
- Links Links? - Links relevant to the payload
- Meta Meta? - Meta Data relevant to the payload
bfsi_account_and_transaction_api.model: Statement
Provides further details on a statement resource.
Fields
- AccountIdreadonly string - A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
- StatementIdreadonly string - Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.
- StatementReference string? - Unique reference for the statement. This reference may be optionally populated if available.
- Type string - Statement type, in a coded form.
- StartDateTime string(default util:getDateTime()) - Date and time at which the statement period starts.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- EndDateTime string(default util:getFutureDateTime()) - Date and time at which the statement period ends.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- CreationDateTime string(default util:getPastDateTime()) - Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- StatementDescription string[]? - Describes statement descriptions list
- StatementBenefit StatementBenefit[]? - Describes statement benefits list
- StatementFee StatementDetails[]? - Describes statement fees list
- StatementInterest StatementDetails[]? - Describes statement intrests list
- StatementAmount BalanceAmount[]? - Describes statement amount list
- StatementDateTime StatementDateTime[]? - Describes statement date time list
- StatementRate StatementRate[]? - Describes statement rate list
- StatementValue StatementValue[]? - Describes statement value list
bfsi_account_and_transaction_api.model: StatementBenefit
Set of elements used to provide details of a benefit or reward amount for the statement resource.
Fields
- Type string - Benefit type, in a coded form.
- Amount Amount - Amount of money associated with the statement benefit type.
bfsi_account_and_transaction_api.model: StatementDateTime
Set of elements used to provide details of a generic date time for the statement resource.
Fields
- DateTime string(default util:getDateTime()) - Date and time associated with the date time type.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- Type string - Date time type, in a coded form.
bfsi_account_and_transaction_api.model: StatementDetails
Set of elements used to provide details of a fee for the statement resource.
Fields
- Description string? - Description that may be available for the statement fee.
- CreditDebitIndicator string - Indicates whether the amount is a credit or a debit. Usage: A zero amount is considered to be a credit amount.
- Type string - Fee type, in a coded form.
- Rate int? - Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)
- RateType string? - Description that may be available for the statement fee rate type.
- Frequency string? - How frequently the fee is applied to the Account.
- Amount Amount - Amount of money associated with the statement fee type.
bfsi_account_and_transaction_api.model: StatementRate
Set of elements used to provide details of a generic rate related to the statement resource.
Fields
- Rate string - Rate associated with the statement rate type.
- Type string - Statement rate type, in a coded form.
bfsi_account_and_transaction_api.model: StatementsResponse
Represent an statement response record with hateoas data.
Fields
- Links Links? - Links relevant to the payload
- Meta Meta? - Meta Data relevant to the payload
bfsi_account_and_transaction_api.model: StatementValue
Set of elements used to provide details of a generic number value related to the statement resource.
Fields
- Value string - Value associated with the statement value type.
- Type string - Statement value type, in a coded form.
bfsi_account_and_transaction_api.model: Tierband
Tier Band Details.
Fields
- Identification string? - Unique and unambiguous identification of a Tier Band for the Product.
- TierValueMinimum string - Minimum deposit value for which the credit interest tier applies.
- TierValueMaximum string? - Maximum deposit value for which the credit interest tier applies.
- CalculationFrequency string? - How often is credit interest calculated for the account.
- ApplicationFrequency string - How often is interest applied to the Product for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's account.
- DepositInterestAppliedCoverage string? - Amount on which Interest applied.
- FixedVariableInterestRateType string - Type of interest rate, Fixed or Variable
- AER string - The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A
- BankInterestRateType string? - Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the account holder's account.
- BankInterestRate string? - Bank Interest for the product
- Notes string[]? - Describes tierband notes list
- OtherBankInterestType OtherCodeType? - Other interest rate types which are not available in the standard code list
- OtherApplicationFrequency OtherCodeType? - Other application frequencies that are not available in the standard code list
- OtherCalculationFrequency OtherCodeType? - Other calculation frequency which is not available in the standard code set.
bfsi_account_and_transaction_api.model: TierBandSet
The group of tiers or bands for which credit interest can be applied.
Fields
- TierBandMethod string - The methodology of how credit interest is paid/applied. It can be:-
- Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases.
- Tiered Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance.
- Whole The same interest rate is applied irrespective of the product holder's account balance
- CalculationMethod string? - Methods of calculating interest
- Destination string - Describes whether accrued interest is payable only to the BCA or to another bank account
- Notes string[]? - Describes tierband notes
- OtherCalculationMethod OtherCodeType? - Describes calculation method
- OtherDestination OtherCodeType? - Describes destination
- TierBand Tierband[] - Describes optional tier bands list
bfsi_account_and_transaction_api.model: Transaction
Provides further details on an entry in the report.
Fields
- AccountIdreadonly string - A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
- TransactionIdreadonly string - Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
- TransactionReference string? - Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.
- StatementReference string[]? - Describes transaction statement reference
- CreditDebitIndicator string - Indicates whether the transaction is a credit or a debit entry.
- Status string - Status of a transaction entry on the books of the account servicer.
- TransactionMutability string? - Specifies the Mutability of the Transaction record.
- BookingDateTime string(default util:getPastDateTime()) - Date and time when a transaction 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.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- ValueDateTime string? - 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 transaction entry. Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- TransactionInformation string? - Further details of the transaction. This is the transaction narrative, which is unstructured text.
- AddressLine string? - Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
- Amount Amount - Amount of money in the cash transaction entry.
- ChargeAmount Amount? - Transaction charges to be paid by the charge bearer.
- CurrencyExchange CurrencyExchange? - Set of elements used to provide details on the currency exchange.
- BankTransactionCode BankTransactionCode? - Set of elements used to fully identify the type of underlying transaction resulting in an entry.
- ProprietaryBankTransactionCode ProprietaryBankTransactionCode? - Set of elements to fully identify a proprietary bank transaction code.
- Balance BalanceAmount? - Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.
- MerchantDetails MerchantDetails? - Details of the merchant involved in the transaction.
- CreditorAgent TransactionCreditorAgent? - Financial institution servicing an account for the creditor.
- CreditorAccount CreditorAccount? - Unambiguous identification of the account of the creditor, in the case of a debit transaction.
- DebtorAgent TransactionCreditorAgent? - Financial institution servicing an account for the debtor.
- DebtorAccount CreditorAccount? - Unambiguous identification of the account of the debtor, in the case of a crebit transaction.
- CardInstrument CardInstrument? - Set of elements to describe the card instrument used in the transaction.
- SupplementaryData Object? - Additional information that can not be captured in the structured fields and/or any other specific block.
bfsi_account_and_transaction_api.model: TransactionCreditorAgent
Financial institution servicing an account for the creditor.
Fields
- SchemeName string? - Name of the identification scheme, in a coded form as published in an external list.
- Identification string? - Unique and unambiguous identification of a financial institution or a branch of a financial institution.
- Name string? - Name by which an agent is known and which is usually used to identify that agent.
- PostalAddress PostalAddress? - Information that locates and identifies a specific address, as defined by postal services.
bfsi_account_and_transaction_api.model: TransactionsResponse
Represent an transactions response record with hateoas data.
Fields
- Data Transaction|Transaction[] - Response data
- Links Links? - Links relevant to the payload
- Meta Meta? - Meta Data relevant to the payload
Import
import wso2bfsi/bfsi_account_and_transaction_api.model;
Metadata
Released date: over 1 year ago
Version: 1.0.0
Compatibility
Platform: any
Ballerina version: 2201.3.1
GraalVM compatible: Yes
Pull count
Total: 59
Current verison: 59
Weekly downloads
Keywords
Type/RestApi
Category/Service
Internal/http
Cost/Free
Vertical/bfsi
Contributors
Other versions
1.0.0