Resources122 structures
Resources, types & payloads
Every structure declared in the STET OpenAPI — top-level resources, HAL wrappers, ISO 20022 building blocks, technical envelopes — listed once, alphabetically. Each one has its own page detailing its fields, enums and the endpoints that use it.
- AccessRequested access services.
- AccessibleAccountsList of accessible accounts for one given functionality
- AccessibleTrustedBeneficiarieslist of workspaces for which the PSU has given consent to the access by the AISP
- AccountIdentificationUnique and unambiguous identification for the account between the account owner and the account servicer.
- AccountLinkslinks that can be used for further navigation when browsing Account Information at one account level
- AccountListLinksLinks that can be used for further navigation when browsing Account Information at top level
- AccountResourcePSU account that is made available to the TPP.
- AmountAndCurrencyExchangeProvides detailed information on the original amount.
- AmountAndCurrencyExchangeDetailsISO20022: details on amount and currency exchange
- AmountTypeStructure aiming to embed the amount and the currency to be used.
- AuthenticationApproachAuthentication approaches that can be applied.
- AuthenticationApproachesList of authentication approaches
- BalanceResourceStructure of an account balance
- BalancesLinkslinks that can be used for further navigation when browsing balances Information at one account level
- BalanceStatusType of balance
- BankTransactionCodeSet of elements used to fully identify the type of underlying transaction resulting in an entry.
- BatchBookingIndicatorIdentifies whether a single entry per individual transaction or a batch entry for the sum of the amounts of all transactions within the group of a message is requested.
- BeneficiariesLinkslinks that can be used for further navigation when browsing Account Information at one account level
- BeneficiarySpecification of a beneficiary
- BookingInformationIndicator that the payment can be immediately booked or not
- CategoryPurposeCodeISO20022: Specifies the high level purpose of the instruction based on a set of pre-defined categories. This is used by the initiating party to provide information concerning the processing of the payment. It is likely to trigger special processing by any of the agents involved in the payment chain.
- ChargeBearerCodeISO20022: Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
- ChargesISO20022: Provides further details on the charges related to the payment transaction.
- ChargesRecordISO20022: Provides further individual record details on the charges related to the payment transaction.
- ClearingSystemMemberIdentificationISO20022: Information used to identify a member within a clearing system.
- CodeAndIssuerSpecifies a code and the issuer of this code.
- ConfirmationResourceConfirmation request resource
- ContactDetailsIndicates how to contact the party.
- CreationDateTimeISO20022: Date and time at which a (group of) payment instruction(s) was created by the instructing party.
- CreditDebitIndicatorAccounting flow of the amount
- CreditorReferenceInformationReference information provided by the creditor to allow the identification of the underlying documents.
- CreditTransferTransactionLinkslinks that can be used for further navigation when retrieving the transaction of a payment request.
- CreditTransferTransactionResourceISO20022: Payment processes required to transfer cash from the debtor to the creditor.
- CurrencyCodeSpecifies the currency of the amount or of the account.
- DateAndPlaceOfBirthDate and place of birth of a person.
- DocumentAdjustmentISO20022: Specifies detailed information on the amount and reason of the adjustment.
- DocumentLineIdentificationProvides identification of the document line.
- EndDateThe last applicable day of execution for a given period.
- EndToEndIdISO20022: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
- EndUserIdentityLinkslinks that can be used for further navigation after retrieving end-user identity
- EquivalentAmountTypeAmount of money to be moved between debtor and creditor, before deduction of charges, expressed in the currency of the debtor's account, and to be moved in a different currency.
- ErrorDetaildetailed error description
- ErrorModelGeneric error report structure
- ExchangeRateISO20022: Provides details on the currency exchange rate and contract.
- ExecutionRuleExecution date shifting rule for standing orders
- FinancialInstitutionIdentificationISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.
- FrequencyCodeFrequency rule for standing orders.
- FundsAvailabilityInformationIndicator that the payment can be covered or not by the funds available on the relevant account
- GenericIdentificationISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer.
- GenericLinkhypertext reference
- HalAccountsHYPERMEDIA structure used for returning the list of the available accounts to the AISP
- HalAuthenticationRequestData forwarded by the ASPSP top the PISP after creation of the Payment Request resource creation
- HalBalancesHYPERMEDIA structure used for returning the list of the relevant balances for a given account to the AISP
- HalBeneficiariesHYPERMEDIA structure used for returning the list of the whitelisted beneficiaries
- HalCreditTransfertTransactionsHYPERMEDIA structure used for returning the transactions of a given payment request to the PISP
- HalEndUserIdentityHYPERMEDIA structure used for returning the identity of the PSU.
- HalOverdraftsHYPERMEDIA structure used for returning the list of the overdrafts that can apply on a given account to the AISP
- HalOwnersHYPERMEDIA structure used for returning the identities of the account owners.
- HalPaymentCoverageReportHYPERMEDIA structure used for returning the payment coverage report to the CBPII
- HalPaymentRequestHYPERMEDIA structure used for returning the original Payment Request to the PISP
- HalTransactionDetailsHYPERMEDIA structure used for returning the details of a given transaction
- HalTransactionsHYPERMEDIA structure used for returning the list of the transactions for a given account to the AISP
- IdentityHYPERMEDIA structure used for returning the identity of the PSU
- InstructionForCreditorAgentFurther information related to the processing of the payment instruction that may need to be acted upon by the creditor's agent. The instruction may relate to a level of service, or may be an instruction that has to be executed by the creditor's agent, or may be information required by the creditor's agent.
- IntermediaryAgentAgent and agent account between the debtor's agent and the creditor's agent.
- LeiIdentificationLegal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
- LineDetailSet of elements used to provide the content of the referred document line.
- LocalInstrumentCodeISO20022: User community specific instrument.
- NamePrefixCodeSpecifies the terms used to formally address a person.
- NonceChallenge to be sent in order to avoid replay of the authentication process.
- OverdraftISO20022: Overdraft characteristics
- OverdraftsLinkslinks that can be used for further navigation when browsing overdrafts Information at one account level
- OwnersLinkslinks that can be used for further navigation when browsing balances Information at one account level
- PartyIdentificationAPI : Description of a Party which can be either a person or an organization.
- PaymentCoverageReportLinkslinks that can be used for further navigation to post another coverage request.
- PaymentCoverageRequestResourcePayment coverage request structure.
- PaymentIdentificationISO20022: Set of elements used to reference a payment instruction.
- PaymentInformationIdISO20022: Reference assigned by a sending party to unambiguously identify the payment information block within the message.
- PaymentInformationStatusCodeISO20022: Specifies the status of the payment information.
- PaymentRequestLinkslinks that can be used for further navigation when having post a Payment Request in order to get the relevant status report.
- PaymentRequestResourceISO20022: The PaymentRequestResource message is sent by the Creditor sending party to the Debtor receiving party, directly or through agents. It is used by a Creditor to request movement of funds from the debtor account to a creditor.
- PaymentRequestResourceCreationLinkslinks that can be used for further navigation, especially in REDIRECT approach
- PaymentTypeInformationISO20022: Set of elements used to further specify the type of transaction.
- PercentageRateRate expressed as a percentage, ie, in hundredths, eg, 0.7 is 7/10 of a percent, and 7.0 is 7%.
- Perioddefinition of a time period
- PhoneNumberThe collection of information which identifies a specific phone or FAX number as defined by telecom services.
- PostalAddressISO20022: Information that locates and identifies a specific address, as defined by postal services.
- PriorityCodeISO20022: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
- PsuStatusTypeISO20022: Specifies the type of account ownership.
- PurposeCodeISO20022: Underlying reason for the payment transaction, as published in an external purpose code list.
- ReferredDocumentInformationProvides the identification and the content of the referred document.
- ReferredDocumentInformationsProvides the identification and the content of the referred documents.
- RegulatoryReportingCodeInformation needed due to regulatory and statutory requirements.
- RegulatoryReportingCodesList of needed regulatory reporting codes for international payments
- RelatedPartiesinformation about the parties that are related to the transaction
- RemittanceAmountISO20022: Provides details on the amounts of the document line.
- RemittanceInformationISO20022: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
- RequestedExecutionDateISO20022: Date at which the initiating party requests the clearing agent to process the payment.
- ResourceIdAPI: Identifier assigned by the ASPSP for further use of the created resource through API calls.
- ServiceLevelCodeISO20022: Agreement under which or rules under which the transaction should be processed. Specifies a pre-agreed service or level of service between the parties, as published in an external service level code list.
- StandingOrderCharacteristicsSpecifies the characteristics of a standing order.
- StartDateThe first applicable day of execution for a given period.
- StatusReasonInformationISO20022: Provides detailed information on the status reason.
- StructuredRemittanceInformationInformation 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, in a structured form.
- SupplementaryDataISO20022: Additional information that cannot be captured in the structured elements and/or any other specific block.
- TaxAmountISO20022: Set of elements used to provide information on the amount of the tax record.
- TaxChargesISO20022: Provides details on the tax applied to charges.
- TaxInformationISO20022: Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.
- TaxPartySet of elements used to identify a party of the transaction to which the tax applies.
- TaxPeriodSet of elements used to provide details on the period of time related to the tax payment.
- TaxRecordRecord of tax details
- TaxRecordDetailsISO20022: Elements used to provide details on the tax period and amount.
- TaxRecordPeriodCodeIdentification of the period related to the tax payment.
- TitleAndNameTitle and Name of the party or the party's authorised reprensentative.
- TransactionDetailsLinkslinks that can be used after retrieving details on a given transaction
- TransactionIndividualStatusCodeISO20022: Specifies the status of the payment information group.
- TransactionLinkslinks that can be used for further retrieving details on a given transaction
- TransactionResourceISO20022: Structure of a transaction.
- TransactionsLinkslinks that can be used for further navigation when browsing transactions Information at one account level
- TransactionStatusType of Transaction
- TypedAmountISO20022: Typed Amount
- WorkspaceSome ASPSP may provide different user workspaces that can be accessed by the same authenticated PSU. In this case, the AISP is able to retrieve the different pieces of account information by specifying the relevant workspace as a QUERY parameter. Identification of the workspace to be used when processing the request. If not present, the default workspace to be used is the one that is linked to the authentication processed during the OAuth2 access token request.