Resources65 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
- 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
- AccountResourcePSU account that is made available to the TPP
- AmountTypeStructure aiming to embed the amount and the currency to be used.
- AppliedAuthenticationApproachThe ASPSP, based on the authentication approaches proposed by the PISP, choose the one that it can processed, in respect with the preferences and constraints of the PSU and indicates in this field which approach has been chosen
- BalanceResourceStructure of an account balance
- BalancesLinkslinks that can be used for further navigation when browsing Account Information at one account level
- BalanceStatusType of balance
- 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. API: The following values are allowed:
- ChargeBearerCodeISO20022: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. The following values are allowed:
- ClearingSystemMemberIdentificationISO20022: Information used to identify a member within a clearing system.
- ConfirmationResourceConfirmation request resource
- CreationDateTimeISO20022: Date and time at which a (group of) payment instruction(s) was created by the instructing party.
- CreditDebitIndicatorAccounting flow of the amount
- CreditTransferTransactionISO20022: Payment processes required to transfer cash from the debtor to the creditor.
- CurrencyCodeSpecifies the currency of the amount or of the account.
- EndDateThe last applicable day of execution for a given standing order.
- EndUserIdentityLinkslinks that can be used for further navigation when browsing Account Information at one account level
- ErrorModelGeneric error report structure
- 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
- 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
- HalEndUserIdentityHYPERMEDIA structure used for returning the identity of the PSU
- HalPaymentCoverageReportHYPERMEDIA structure used for returning the payment coverage report to the CBPII
- HalPaymentRequestHYPERMEDIA structure used for returning the original Payment Request to the PISP
- HalPaymentRequestCreationdata forwarded by the ASPSP top the PISP after creation of the Payment Request resource creation
- HalTransactionsHYPERMEDIA structure used for returning the list of the transactions for a given account to the AISP
- LocalInstrumentCodeISO20022: User community specific instrument.
- 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. The request must rely either on a cash account or a payment card.
- 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. API: Mandatory. The following values are allowed to provide the status of the Payment Request - ACCP (AcceptedCustomerProfile): Preceding check of technical validation was successful. Customer profile check was also successful. - ACSC (AcceptedSettlementCompleted): Settlement on the debtor's account has been completed. In the case of SCTInst, this status must not been set by the debtor's Bank before the reception of the positive confirmation. - ACSP (AcceptedSettlementInProcess): All preceding checks such as technical validation and customer profile were successful. Dynamic risk assessment is now also successful and therefore the Payment Request has been accepted for execution. - ACTC (AcceptedTechnicalValidation): Authentication and syntactical and semantical validation are successful. - ACWC (AcceptedWithChange): Instruction is accepted but a change will be made, such as date or remittance not sent. - ACWP (AcceptedWithoutPosting): Payment instruction included in the credit transfer is accepted without being posted to the creditor customer’s account. - PART (PartiallyAccepted): A number of transactions have been accepted, whereas another number of transactions have not yet achieved 'accepted' status. - RCVD (Received): Payment initiation has been received by the receiving agent. - PDNG (Pending): Payment request or individual transaction included in the Payment Request is pending. Further checks and status update will be performed. - RJCT (Rejected): Payment request has been rejected. 
- 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.
- 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.
- PsuContextLinksLinks that can be used for further navigation when browsing Account Information at top level
- PurposeCodeISO20022: Underlying reason for the payment transaction, as published in an external purpose code list.
- RegulatoryReportingCodeInformation needed due to regulatory and statutory requirements.
- RegulatoryReportingCodesList of needed regulatory reporting codes for international payments
- 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.
- StatusReasonInformationISO20022: Provides detailed information on the status reason.
- SupplementaryDataISO20022: Additional information that cannot be captured in the structured elements and/or any other specific block.
- Transactionstructure of a transaction
- TransactionIndividualStatusCodeISO20022: Specifies the status of the payment information group. API: Only the following values are allowed to provide the status of the subsequent CREDIT TRANSFER to the Payment Request - RJCT: Payment request or individual transaction included in the Payment Request has been rejected. - PDNG: (Pending): Payment request or individual transaction included in the Payment Request is pending. Further checks and status update will be performed. - ACSP: All preceding checks such as technical validation and customer profile were successful and therefore the Payment Request has been accepted for execution. - ACSC: Settlement on the debtor's account has been completed. In the case of SCTInst, this status must not been set by the debtor's Bank before the reception of the positive confirmation. 
- TransactionsLinkslinks that can be used for further navigation when browsing Account Information at one account level
- TransactionStatusType of Transaction
- UnstructuredRemittanceInformationISO20022: 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.