--- title: "Retrieval of the Credit Transfert Transactions that were processed for a given payment request (PISP)" method: GET path: "/payment-requests/{paymentRequestResourceId}/transactions" tags: ["PISP"] --- # Retrieval of the Credit Transfert Transactions that were processed for a given payment request (PISP) `GET /payment-requests/{paymentRequestResourceId}/transactions` ## Request - Base URL: `https://www.18919.live.api.89c3.com/stet/psd2/v1.6.2` - URL: `https://www.18919.live.api.89c3.com/stet/psd2/v1.6.2/payment-requests/{paymentRequestResourceId}/transactions` - Auth: OAuth 2 - Client credentials - Token URL: `/stet/psd2/oauth/token` scopes: `pisp` ### Description The PISP gets the execution history of a payment request. This entry-point is an alternative to the retrieval of the history through the retrieval of the payment request. So, each ASPSP may choose or not to implement this entry-point. ### Prerequisites - The TPP was registered by the Registration Authority for the PISP role - The TPP has previously posted a Standing Order Request which was saved by the ASPSP (cf. § 4.5.3) - The ASPSP has answered with a location link to the saved Payment Request (cf. § 4.5.4) - The TPP has retrieved the saved request in order to get the relevant resource Ids (cf. § 4.6). - The TPP and the ASPSP have successfully processed a mutual check and authentication - The TPP was provided with an OAUTH2 "Client Credential" access token by the ASPSP (cf. § 3.4.2). - The TPP presented its "OAUTH2 Client Credential" access token. ### Business flow The PISP post the history request. The ASPSP answers with the list of relevant transactions. ## Path parameters - `paymentRequestResourceId` string, required ## Headers - `Authorization` string, required - `PSU-IP-Address` string - `PSU-IP-Port` string - `PSU-HTTP-Method` string - `PSU-Date` string - `PSU-GEO-Location` string - `PSU-User-Agent` string - `PSU-Referer` string - `PSU-Accept` string - `PSU-Accept-Charset` string - `PSU-Accept-Encoding` string - `PSU-Accept-Language` string - `PSU-Device-ID` string - `Digest` string - `Signature` string, required - `X-Request-ID` string, required ## Response `200` retrieval of the Payment Request enriched with the status report - HalCreditTransfertTransactions: HYPERMEDIA structure used for returning the transactions of a given payment request to the PISP - `creditTransferTransaction` CreditTransferTransactionResource[], required: ISO20022: Payment processes required to transfer cash from the debtor to the creditor. API: Each ASPSP will specify a maxItems value for this field taking into accounts its specificities about payment request handling - `paymentId` PaymentIdentification, required: ISO20022: Set of elements used to reference a payment instruction. - `instructionId` string, required: ISO20022: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. API: Unique identification shared between the PISP and the ASPSP - `endToEndId` string: ISO20022: 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. - `uetr` string: ISO20022: Universally unique identifier to provide an end-to-end reference of a payment transaction. - `resourceId` string: API: Identifier assigned by the ASPSP for further use of the created resource through API calls. The API client cannot set or modify the value of this field. Since this value can be exchanged between the server and the client as an URL element or for support information, it must not contain sensitive value such as personal or business data. However it is the duty of each ASPSP to perform its own risk analysis on this topic. - `requestedExecutionDate` string, date-time: ISO20022: Date at which the initiating party requests the clearing agent to process the payment. API: When set by the PISP, this field indicates the future date at which the payment instruction should be executed and the debtor account should be debited. if this field is not set by the PISP, the ASPSP is requested to execute the payment instruction as soon as possible. In most of the cases, especially for international payments, the date of the credit on the credit account cannot be set. Only SCTInst can guarantee having the same date for this credit. When the payment cannot be processed at the requested date, the ASPSP is allowed to shift the applied execution date to the next possible execution date for non-standing orders. For standing orders, this field is useless since the [startDate] parameter already provides the needed information for the first payment instruction to be executed. - `cancellableTill` string, date-time: This field may allow the PISP to get information on the limit timestamp for requesting cancelation of the transaction. When this field is not provided by the ASPSP, the PISP must rely on the status of the transaction [transactionStatus] in order to estimate if the transaction is actually cancellable. - `acceptanceDateTime` string, date-time: ISO20022: Date and time at which all processing conditions for execution of the payment are met and adequate financial cover is available at the account servicing agent. - `debtorDecisionDate` string, date-time: ISO20022: Date and time on when the debtor has accepted or rejected the request. - `appliedExecutionDate` string, date-time: ISO20022: Date and time on when the payment was executed. - `standingOrderCharacteristics` StandingOrderCharacteristics: Specifies the characteristics of a standing order. - `startDate` string, date-time, required: The first applicable day of execution for a given period. - `endDate` string, date-time: The last applicable day of execution for a given period. If not given, the period is considered as endless. - `executionRule` 'FWNG' | 'PREC', required: Execution date shifting rule for standing orders This data attribute defines the behaviour when recurring payment dates falls on a weekend or bank holiday. The payment is then executed either the "preceding" or "following" working day. ASPSP might reject the request due to the communicated value, if rules in Online-Banking are not supporting this execution rule. | Code | Description | | ---- | ----------- | | FWNG | following | | PREC | preceding | - `frequency` 'DAIL' | 'WEEK' | 'TOWK' | 'MNTH' | 'TOMN' | 'QUTR' | 'SEMI' | 'YEAR', required: Frequency rule for standing orders. The following codes from the "EventFrequency7Code" of ISO 20022 are supported. | Code | Description | | ---- | ----------- | | DAIL | Daily | | WEEK | Weekly | | TOWK | EveryTwoWeeks | | MNTH | Monthly | | TOMN | EveryTwoMonths | | QUTR | Quarterly | | SEMI | SemiAnnual | | YEAR | Annual | However, each ASPSP might restrict these values into a subset if needed. - `instructedAmount` AmountType: Structure aiming to embed the amount and the currency to be used. - `amount` number, float, required: ISO20022: 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, required: Specifies the currency of the amount or of the account. 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". - `equivalentAmount` EquivalentAmountType: Amount 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. Usage: The first agent will convert the equivalent amount into the amount to be moved. - `amount` number, float, required: ISO20022: 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, required: Specifies the currency of the amount or of the account. 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". - `currencyOfTransfer` string, required: Specifies the currency of the amount or of the account. 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". - `exchangeRateInformation` ExchangeRate: ISO20022: Provides details on the currency exchange rate and contract. The [unitCurrency] property specifies the currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. The [estimatedPayerAmount] gives an estimation of the amount that will be debited on the payer's account, including transaction and change fees. The [estimatedPayeeAmunt] gives an estimation of the amount that will be credited on the payee's account. API: Amounts must always be set as positive values. - `unitCurrency` string: Specifies the currency of the amount or of the account. 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". - `exchangeRate` number, float: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. - `rateType` 'SPOT' | 'SALE' | 'AGRD', required: Specifies the type used to complete the currency exchange. | Code | Name | Description | | ---- | ---- | ---------- | | SPOT | Spot | Exchange rate applied is the spot rate. | | SALE | Sale | Exchange rate applied is the market rate at the time of the sale. | | AGRD | Agreed | Exchange rate applied is the rate agreed between the parties. | - `contractIdentification` string: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. - `estimatedPayerAmount` AmountType: Structure aiming to embed the amount and the currency to be used. - `amount` number, float, required: ISO20022: 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, required: Specifies the currency of the amount or of the account. 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". - `estimatedPayeeAmount` AmountType: Structure aiming to embed the amount and the currency to be used. - `amount` number, float, required: ISO20022: 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, required: Specifies the currency of the amount or of the account. 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". - `ultimateDebtor` PartyIdentification: API : Description of a Party which can be either a person or an organization. - `name` string, required: ISO20022: Name by which a party is known and which is usually used to identify that party. The [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation. The [privateId] property allows the specification of an unique and unambiguous way to identify a person. - `dateAndPlaceOfBirth` DateAndPlaceOfBirth: Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment. - `birthDate` string, date, required: Date on which a person is born. - `cityOfBirth` string, required: City where a person was born. - `countryOfBirth` string, required: Country where a person was born. - `postalAddress` PostalAddress: ISO20022: Information that locates and identifies a specific address, as defined by postal services. - `addressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME': ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed. | Code | Name | Description | | ---- | ---- | ----------- | | BIZZ | Business | Address is the business address | | DLVY | Delivery | Address is the address to which delivery is to take place | | MLTO | Mail To | Address is the address to which mail is sent | | PBOX | PO Box | Address is is a postal office (PO) box | | ADDR | Postal | Address is the complete postal address | | HOME | Business | Address is the home address | - `department` string: ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments. - `subDepartment` string: ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments. - `streetName` string: ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments. - `buildingNumber` string: ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments. - `buildingName` string: ISO20022: Name of the building or house. API: Cannot be used for SEPA payments. - `postCode` string: ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments. - `townName` string: ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments. - `countrySubDivision` string: ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments. - `country` string, required: ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed. - `addressLine` string[]: Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed. - `contactDetails` ContactDetails: Indicates how to contact the party. - `phoneNumber` string: The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters). - `faxNumber` string: The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters). - `emailAddress` string: email address of the contact - `organisationId` GenericIdentification: ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support. - `identification` string, required: API: Identifier - `schemeName` string, required: Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following: | Code | Name | Description | | ---- | ---- | ----------- | | BANK | BankPartyIdentification | Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. | | BBAN | BBANIdentifier | Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. | | COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) | | SREN | SIREN | The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. | | SRET | SIRET | The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. | | NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. | Other values are also permitted, for instance: | Code | Name | Description | | ---- | ---- | ----------- | | OAUT | OAUTH2 | OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU | | CPAN | CardPan | Card PAN | | MPAN | MaskedPan | Card PAN where some digits were replaced for security reason | | TPAN | TokenizedPan | Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field | | TBAN | TokenizedIBAN | Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field | Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used - `issuer` string: ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties - `privateId` GenericIdentification: ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support. - `identification` string, required: API: Identifier - `schemeName` string, required: Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following: | Code | Name | Description | | ---- | ---- | ----------- | | BANK | BankPartyIdentification | Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. | | BBAN | BBANIdentifier | Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. | | COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) | | SREN | SIREN | The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. | | SRET | SIRET | The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. | | NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. | Other values are also permitted, for instance: | Code | Name | Description | | ---- | ---- | ----------- | | OAUT | OAUTH2 | OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU | | CPAN | CardPan | Card PAN | | MPAN | MaskedPan | Card PAN where some digits were replaced for security reason | | TPAN | TokenizedPan | Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field | | TBAN | TokenizedIBAN | Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field | Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used - `issuer` string: ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties - `lei` string: Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". - `intermediaryAgent` IntermediaryAgent: Agent and agent account between the debtor's agent and the creditor's agent. - `agent` PartyIdentification: API : Description of a Party which can be either a person or an organization. - `name` string, required: ISO20022: Name by which a party is known and which is usually used to identify that party. The [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation. The [privateId] property allows the specification of an unique and unambiguous way to identify a person. - `dateAndPlaceOfBirth` DateAndPlaceOfBirth: Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment. - `birthDate` string, date, required: Date on which a person is born. - `cityOfBirth` string, required: City where a person was born. - `countryOfBirth` string, required: Country where a person was born. - `postalAddress` PostalAddress: ISO20022: Information that locates and identifies a specific address, as defined by postal services. - `addressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME': ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed. | Code | Name | Description | | ---- | ---- | ----------- | | BIZZ | Business | Address is the business address | | DLVY | Delivery | Address is the address to which delivery is to take place | | MLTO | Mail To | Address is the address to which mail is sent | | PBOX | PO Box | Address is is a postal office (PO) box | | ADDR | Postal | Address is the complete postal address | | HOME | Business | Address is the home address | - `department` string: ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments. - `subDepartment` string: ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments. - `streetName` string: ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments. - `buildingNumber` string: ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments. - `buildingName` string: ISO20022: Name of the building or house. API: Cannot be used for SEPA payments. - `postCode` string: ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments. - `townName` string: ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments. - `countrySubDivision` string: ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments. - `country` string, required: ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed. - `addressLine` string[]: Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed. - `contactDetails` ContactDetails: Indicates how to contact the party. - `phoneNumber` string: The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters). - `faxNumber` string: The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters). - `emailAddress` string: email address of the contact - `organisationId` GenericIdentification: ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support. - `identification` string, required: API: Identifier - `schemeName` string, required: Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following: | Code | Name | Description | | ---- | ---- | ----------- | | BANK | BankPartyIdentification | Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. | | BBAN | BBANIdentifier | Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. | | COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) | | SREN | SIREN | The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. | | SRET | SIRET | The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. | | NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. | Other values are also permitted, for instance: | Code | Name | Description | | ---- | ---- | ----------- | | OAUT | OAUTH2 | OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU | | CPAN | CardPan | Card PAN | | MPAN | MaskedPan | Card PAN where some digits were replaced for security reason | | TPAN | TokenizedPan | Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field | | TBAN | TokenizedIBAN | Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field | Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used - `issuer` string: ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties - `privateId` GenericIdentification: ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support. - `identification` string, required: API: Identifier - `schemeName` string, required: Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following: | Code | Name | Description | | ---- | ---- | ----------- | | BANK | BankPartyIdentification | Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. | | BBAN | BBANIdentifier | Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. | | COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) | | SREN | SIREN | The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. | | SRET | SIRET | The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. | | NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. | Other values are also permitted, for instance: | Code | Name | Description | | ---- | ---- | ----------- | | OAUT | OAUTH2 | OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU | | CPAN | CardPan | Card PAN | | MPAN | MaskedPan | Card PAN where some digits were replaced for security reason | | TPAN | TokenizedPan | Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field | | TBAN | TokenizedIBAN | Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field | Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used - `issuer` string: ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties - `lei` string: Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". - `agentAccount` AccountIdentification: Unique and unambiguous identification for the account between the account owner and the account servicer. Card accounts must provide the identification of the card through the "other" substructure by giving, for instance, the masked PAN (MPAN). The currency used for the account, when needed, can be specified through the [currency] field. - `workspace` string: Workspace to which the account is linked. This workspace might be specified by the AISP when forwarding the consent on accounts. If not provided, the default workspace is computed from the authentication that was used for getting the OAuth2 Access Token. - `iban` string: ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 "Banking and related financial services - International Bank Account Number (IBAN)" version 1997-10-01, or later revisions. - `other` GenericIdentification: ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support. - `identification` string, required: API: Identifier - `schemeName` string, required: Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following: | Code | Name | Description | | ---- | ---- | ----------- | | BANK | BankPartyIdentification | Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. | | BBAN | BBANIdentifier | Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. | | COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) | | SREN | SIREN | The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. | | SRET | SIRET | The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. | | NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. | Other values are also permitted, for instance: | Code | Name | Description | | ---- | ---- | ----------- | | OAUT | OAUTH2 | OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU | | CPAN | CardPan | Card PAN | | MPAN | MaskedPan | Card PAN where some digits were replaced for security reason | | TPAN | TokenizedPan | Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field | | TBAN | TokenizedIBAN | Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field | Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used - `issuer` string: ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties - `currency` string: Specifies the currency of the amount or of the account. 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". - `beneficiary` Beneficiary, required: Specification of a beneficiary - `workspace` Workspace: Some 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. - `identification` string, required: identification of the workspace to be used as an optional query parameter for some AISP queries - `label` string, required: textual description of the workspace as specified by the ASPSP in relationship wth the PSU - `id` string: Id of the beneficiary - `isTrusted` boolean: The ASPSP having not implemented the trusted beneficiaries list must not set this flag. Otherwise, the ASPSP indicates whether or not the beneficiary was registered by the PSU within the trusted beneficiaries list. - true: the beneficiary is actually a trusted beneficiary - false: the beneficiary is not a trusted beneficiary - `creditorAgent` FinancialInstitutionIdentification: ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme. - `bicFi` string, required: ISO20022: Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)". - `clearingSystemMemberId` ClearingSystemMemberIdentification: ISO20022: Information used to identify a member within a clearing system. API: to be used for some specific international credit transfers in order to identify the beneficiary bank - `clearingSystemId` string, required: ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed. - `memberId` string, required: ISO20022: Identification of a member of a clearing system. - `lei` string: Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". - `name` string: Name of the financial institution - `postalAddress` PostalAddress: ISO20022: Information that locates and identifies a specific address, as defined by postal services. - `addressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME': ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed. | Code | Name | Description | | ---- | ---- | ----------- | | BIZZ | Business | Address is the business address | | DLVY | Delivery | Address is the address to which delivery is to take place | | MLTO | Mail To | Address is the address to which mail is sent | | PBOX | PO Box | Address is is a postal office (PO) box | | ADDR | Postal | Address is the complete postal address | | HOME | Business | Address is the home address | - `department` string: ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments. - `subDepartment` string: ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments. - `streetName` string: ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments. - `buildingNumber` string: ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments. - `buildingName` string: ISO20022: Name of the building or house. API: Cannot be used for SEPA payments. - `postCode` string: ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments. - `townName` string: ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments. - `countrySubDivision` string: ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments. - `country` string, required: ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed. - `addressLine` string[]: Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed. - `creditor` PartyIdentification, required: API : Description of a Party which can be either a person or an organization. - `name` string, required: ISO20022: Name by which a party is known and which is usually used to identify that party. The [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation. The [privateId] property allows the specification of an unique and unambiguous way to identify a person. - `dateAndPlaceOfBirth` DateAndPlaceOfBirth: Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment. - `birthDate` string, date, required: Date on which a person is born. - `cityOfBirth` string, required: City where a person was born. - `countryOfBirth` string, required: Country where a person was born. - `postalAddress` PostalAddress: ISO20022: Information that locates and identifies a specific address, as defined by postal services. - `addressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME': ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed. | Code | Name | Description | | ---- | ---- | ----------- | | BIZZ | Business | Address is the business address | | DLVY | Delivery | Address is the address to which delivery is to take place | | MLTO | Mail To | Address is the address to which mail is sent | | PBOX | PO Box | Address is is a postal office (PO) box | | ADDR | Postal | Address is the complete postal address | | HOME | Business | Address is the home address | - `department` string: ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments. - `subDepartment` string: ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments. - `streetName` string: ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments. - `buildingNumber` string: ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments. - `buildingName` string: ISO20022: Name of the building or house. API: Cannot be used for SEPA payments. - `postCode` string: ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments. - `townName` string: ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments. - `countrySubDivision` string: ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments. - `country` string, required: ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed. - `addressLine` string[]: Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed. - `contactDetails` ContactDetails: Indicates how to contact the party. - `phoneNumber` string: The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters). - `faxNumber` string: The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters). - `emailAddress` string: email address of the contact - `organisationId` GenericIdentification: ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support. - `identification` string, required: API: Identifier - `schemeName` string, required: Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following: | Code | Name | Description | | ---- | ---- | ----------- | | BANK | BankPartyIdentification | Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. | | BBAN | BBANIdentifier | Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. | | COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) | | SREN | SIREN | The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. | | SRET | SIRET | The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. | | NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. | Other values are also permitted, for instance: | Code | Name | Description | | ---- | ---- | ----------- | | OAUT | OAUTH2 | OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU | | CPAN | CardPan | Card PAN | | MPAN | MaskedPan | Card PAN where some digits were replaced for security reason | | TPAN | TokenizedPan | Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field | | TBAN | TokenizedIBAN | Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field | Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used - `issuer` string: ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties - `privateId` GenericIdentification: ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support. - `identification` string, required: API: Identifier - `schemeName` string, required: Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following: | Code | Name | Description | | ---- | ---- | ----------- | | BANK | BankPartyIdentification | Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. | | BBAN | BBANIdentifier | Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. | | COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) | | SREN | SIREN | The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. | | SRET | SIRET | The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. | | NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. | Other values are also permitted, for instance: | Code | Name | Description | | ---- | ---- | ----------- | | OAUT | OAUTH2 | OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU | | CPAN | CardPan | Card PAN | | MPAN | MaskedPan | Card PAN where some digits were replaced for security reason | | TPAN | TokenizedPan | Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field | | TBAN | TokenizedIBAN | Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field | Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used - `issuer` string: ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties - `lei` string: Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". - `creditorAccount` AccountIdentification: Unique and unambiguous identification for the account between the account owner and the account servicer. Card accounts must provide the identification of the card through the "other" substructure by giving, for instance, the masked PAN (MPAN). The currency used for the account, when needed, can be specified through the [currency] field. - `workspace` string: Workspace to which the account is linked. This workspace might be specified by the AISP when forwarding the consent on accounts. If not provided, the default workspace is computed from the authentication that was used for getting the OAuth2 Access Token. - `iban` string: ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 "Banking and related financial services - International Bank Account Number (IBAN)" version 1997-10-01, or later revisions. - `other` GenericIdentification: ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support. - `identification` string, required: API: Identifier - `schemeName` string, required: Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following: | Code | Name | Description | | ---- | ---- | ----------- | | BANK | BankPartyIdentification | Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. | | BBAN | BBANIdentifier | Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. | | COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) | | SREN | SIREN | The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. | | SRET | SIRET | The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. | | NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. | Other values are also permitted, for instance: | Code | Name | Description | | ---- | ---- | ----------- | | OAUT | OAUTH2 | OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU | | CPAN | CardPan | Card PAN | | MPAN | MaskedPan | Card PAN where some digits were replaced for security reason | | TPAN | TokenizedPan | Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field | | TBAN | TokenizedIBAN | Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field | Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used - `issuer` string: ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties - `currency` string: Specifies the currency of the amount or of the account. 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". - `ultimateCreditor` PartyIdentification: API : Description of a Party which can be either a person or an organization. - `name` string, required: ISO20022: Name by which a party is known and which is usually used to identify that party. The [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation. The [privateId] property allows the specification of an unique and unambiguous way to identify a person. - `dateAndPlaceOfBirth` DateAndPlaceOfBirth: Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment. - `birthDate` string, date, required: Date on which a person is born. - `cityOfBirth` string, required: City where a person was born. - `countryOfBirth` string, required: Country where a person was born. - `postalAddress` PostalAddress: ISO20022: Information that locates and identifies a specific address, as defined by postal services. - `addressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME': ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed. | Code | Name | Description | | ---- | ---- | ----------- | | BIZZ | Business | Address is the business address | | DLVY | Delivery | Address is the address to which delivery is to take place | | MLTO | Mail To | Address is the address to which mail is sent | | PBOX | PO Box | Address is is a postal office (PO) box | | ADDR | Postal | Address is the complete postal address | | HOME | Business | Address is the home address | - `department` string: ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments. - `subDepartment` string: ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments. - `streetName` string: ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments. - `buildingNumber` string: ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments. - `buildingName` string: ISO20022: Name of the building or house. API: Cannot be used for SEPA payments. - `postCode` string: ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments. - `townName` string: ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments. - `countrySubDivision` string: ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments. - `country` string, required: ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed. - `addressLine` string[]: Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed. - `contactDetails` ContactDetails: Indicates how to contact the party. - `phoneNumber` string: The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters). - `faxNumber` string: The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters). - `emailAddress` string: email address of the contact - `organisationId` GenericIdentification: ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support. - `identification` string, required: API: Identifier - `schemeName` string, required: Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following: | Code | Name | Description | | ---- | ---- | ----------- | | BANK | BankPartyIdentification | Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. | | BBAN | BBANIdentifier | Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. | | COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) | | SREN | SIREN | The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. | | SRET | SIRET | The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. | | NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. | Other values are also permitted, for instance: | Code | Name | Description | | ---- | ---- | ----------- | | OAUT | OAUTH2 | OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU | | CPAN | CardPan | Card PAN | | MPAN | MaskedPan | Card PAN where some digits were replaced for security reason | | TPAN | TokenizedPan | Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field | | TBAN | TokenizedIBAN | Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field | Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used - `issuer` string: ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties - `privateId` GenericIdentification: ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support. - `identification` string, required: API: Identifier - `schemeName` string, required: Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following: | Code | Name | Description | | ---- | ---- | ----------- | | BANK | BankPartyIdentification | Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. | | BBAN | BBANIdentifier | Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. | | COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) | | SREN | SIREN | The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. | | SRET | SIRET | The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. | | NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. | Other values are also permitted, for instance: | Code | Name | Description | | ---- | ---- | ----------- | | OAUT | OAUTH2 | OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU | | CPAN | CardPan | Card PAN | | MPAN | MaskedPan | Card PAN where some digits were replaced for security reason | | TPAN | TokenizedPan | Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field | | TBAN | TokenizedIBAN | Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field | Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used - `issuer` string: ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties - `lei` string: Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". - `instructionForCreditorAgent` InstructionForCreditorAgent[]: Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent. - `code` 'CHQB' | 'HOLD' | 'PHOB' | 'TELB': Coded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent. | Code | Name | Description | | ---- | ---- | ---------- | | CHQB | PayCreditorByCheque | (Ultimate) creditor must be paid by cheque. | | HOLD | HoldCashForCreditor | Amount of money must be held for the (ultimate) creditor, who will call. Pay on identification. | | PHOB | PhoneBeneficiary | Please advise/contact (ultimate) creditor/claimant by phone. | | TELB | Telecom | Please advise/contact (ultimate) creditor/claimant by the most efficient means of telecommunication. | - `instructionInformation` string: Further information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community. - `purpose` 'ACCT' | 'CASH' | 'COMC' | 'CPKC' | 'TRPT' | 'SALA': ISO20022: Underlying reason for the payment transaction, as published in an external purpose code list. API: The following values are allowed for Payment Request | Code | Name | Description | | ---- | ---- | ---------- | | ACCT | AccountManagement | Funds moved between 2 accounts of same account holder at the same bank) | | CASH | CashManagementTransfer | (general cash management instruction) may be used for Transfer Initiation | | COMC | CommercialPayment | Transaction is related to a payment of commercial credit or debit. | | CPKC | CarparkCharges | General Carpark Charges Transaction is related to carpark charges. | | SALA | SalaryPayment | Transaction is the payment of salaries. | | TRPT | RoadPricing | Transport RoadPricing Transaction is for the payment to top-up pre-paid card and electronic road pricing for the purpose of transportation. | - `regulatoryReportingCodes` RegulatoryReportingCode[]: List of needed regulatory reporting codes for international payments - `remittanceInformation` RemittanceInformation: ISO20022: 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. API: - Only one occurrence of the unstructured information is allowed. - Only one occurrence of the structured information is allowed. - Structured and unstructured information can coexist. - `unstructured` string[]: Unstructured remittance information. Each implementation may add a pattern in order to specify its own character set constraints. - `structured` StructuredRemittanceInformation[]: Structured remittance information - `referredDocumentInformation` ReferredDocumentInformation[]: Provides the identification and the content of the referred documents. - `type` CodeAndIssuer: Specifies a code and the issuer of this code. - `code` string, required: Provides the code. - `issuer` string: Identification of the issuer of the code. - `number` string: Unique and unambiguous identification of the referred document. - `relatedDate` string, date: Date associated with the referred document. - `lineDetails` LineDetail[]: Sets of elements used to provide the content of the referred document line. - `identification` DocumentLineIdentification: Provides identification of the document line. the [type] property must be used for specifying the type of referred document type. - … - `description` string: Description associated with the document line. - `amount` RemittanceAmount: ISO20022: Provides details on the amounts of the document line. API: Amounts must always be set as positive values. | Property | Description | | -------- | ----------- | | duePayableAmount | Amount specified is the exact amount due and payable to the creditor. | | discountAppliedAmount | Amount of discount to be applied to the amount due and payable to the creditor. | | creditNoteAmount | Amount of a credit note. | | taxAmount | Amount of the tax. | | adjustmentAmountAndReason | Specifies detailed information on the amount and reason of the adjustment. | | remittedAmount | Amount of money remitted. | - … - `referredDocumentAmount` RemittanceAmount: ISO20022: Provides details on the amounts of the document line. API: Amounts must always be set as positive values. | Property | Description | | -------- | ----------- | | duePayableAmount | Amount specified is the exact amount due and payable to the creditor. | | discountAppliedAmount | Amount of discount to be applied to the amount due and payable to the creditor. | | creditNoteAmount | Amount of a credit note. | | taxAmount | Amount of the tax. | | adjustmentAmountAndReason | Specifies detailed information on the amount and reason of the adjustment. | | remittedAmount | Amount of money remitted. | - `duePayableAmount` AmountType: Structure aiming to embed the amount and the currency to be used. - `amount` number, float, required: ISO20022: 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, required: Specifies the currency of the amount or of the account. 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". - `discountAppliedAmount` TypedAmount: ISO20022: Typed Amount API: Amounts must always be set as positive values. - `type` string: Type of the amount - `amount` AmountType, required: Structure aiming to embed the amount and the currency to be used. - … - `creditNoteAmount` AmountType: Structure aiming to embed the amount and the currency to be used. - `amount` number, float, required: ISO20022: 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, required: Specifies the currency of the amount or of the account. 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". - `taxAmount` TypedAmount: ISO20022: Typed Amount API: Amounts must always be set as positive values. - `type` string: Type of the amount - `amount` AmountType, required: Structure aiming to embed the amount and the currency to be used. - … - `adjustmentAmountAndReason` DocumentAdjustment: ISO20022: Specifies detailed information on the amount and reason of the adjustment. API: Amounts must always be set as positive values. - `amount` AmountType, required: Structure aiming to embed the amount and the currency to be used. - … - `creditDebitIndicator` 'CRDT' | 'DBIT': Accounting flow of the amount | Code | Description | | ---- | ----------- | | CRDT | Credit type amount | | DBIT | Debit type amount | - `reason` string: Specifies the reason for the adjustment. - `additionalInformation` string: Provides further details on the document adjustment. - `remittedAmount` AmountType: Structure aiming to embed the amount and the currency to be used. - `amount` number, float, required: ISO20022: 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, required: Specifies the currency of the amount or of the account. 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". - `creditorReferenceInformation` CreditorReferenceInformation: Reference information provided by the creditor to allow the identification of the underlying documents. - `type` CodeAndIssuer: Specifies a code and the issuer of this code. - `code` string, required: Provides the code. - `issuer` string: Identification of the issuer of the code. - `reference` string: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. - `invoicer` PartyIdentification: API : Description of a Party which can be either a person or an organization. - `name` string, required: ISO20022: Name by which a party is known and which is usually used to identify that party. The [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation. The [privateId] property allows the specification of an unique and unambiguous way to identify a person. - `dateAndPlaceOfBirth` DateAndPlaceOfBirth: Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment. - `birthDate` string, date, required: Date on which a person is born. - `cityOfBirth` string, required: City where a person was born. - `countryOfBirth` string, required: Country where a person was born. - `postalAddress` PostalAddress: ISO20022: Information that locates and identifies a specific address, as defined by postal services. - `addressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME': ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed. | Code | Name | Description | | ---- | ---- | ----------- | | BIZZ | Business | Address is the business address | | DLVY | Delivery | Address is the address to which delivery is to take place | | MLTO | Mail To | Address is the address to which mail is sent | | PBOX | PO Box | Address is is a postal office (PO) box | | ADDR | Postal | Address is the complete postal address | | HOME | Business | Address is the home address | - `department` string: ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments. - `subDepartment` string: ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments. - `streetName` string: ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments. - `buildingNumber` string: ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments. - `buildingName` string: ISO20022: Name of the building or house. API: Cannot be used for SEPA payments. - `postCode` string: ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments. - `townName` string: ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments. - `countrySubDivision` string: ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments. - `country` string, required: ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed. - `addressLine` string[]: Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed. - `contactDetails` ContactDetails: Indicates how to contact the party. - `phoneNumber` string: The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters). - `faxNumber` string: The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters). - `emailAddress` string: email address of the contact - `organisationId` GenericIdentification: ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support. - `identification` string, required: API: Identifier - `schemeName` string, required: Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following: | Code | Name | Description | | ---- | ---- | ----------- | | BANK | BankPartyIdentification | Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. | | BBAN | BBANIdentifier | Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. | | COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) | | SREN | SIREN | The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. | | SRET | SIRET | The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. | | NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. | Other values are also permitted, for instance: | Code | Name | Description | | ---- | ---- | ----------- | | OAUT | OAUTH2 | OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU | | CPAN | CardPan | Card PAN | | MPAN | MaskedPan | Card PAN where some digits were replaced for security reason | | TPAN | TokenizedPan | Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field | | TBAN | TokenizedIBAN | Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field | Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used - `issuer` string: ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties - `privateId` GenericIdentification: ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support. - `identification` string, required: API: Identifier - `schemeName` string, required: Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following: | Code | Name | Description | | ---- | ---- | ----------- | | BANK | BankPartyIdentification | Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. | | BBAN | BBANIdentifier | Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. | | COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) | | SREN | SIREN | The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. | | SRET | SIRET | The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. | | NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. | Other values are also permitted, for instance: | Code | Name | Description | | ---- | ---- | ----------- | | OAUT | OAUTH2 | OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU | | CPAN | CardPan | Card PAN | | MPAN | MaskedPan | Card PAN where some digits were replaced for security reason | | TPAN | TokenizedPan | Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field | | TBAN | TokenizedIBAN | Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field | Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used - `issuer` string: ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties - `lei` string: Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". - `invoicee` PartyIdentification: API : Description of a Party which can be either a person or an organization. - `name` string, required: ISO20022: Name by which a party is known and which is usually used to identify that party. The [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation. The [privateId] property allows the specification of an unique and unambiguous way to identify a person. - `dateAndPlaceOfBirth` DateAndPlaceOfBirth: Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment. - `birthDate` string, date, required: Date on which a person is born. - `cityOfBirth` string, required: City where a person was born. - `countryOfBirth` string, required: Country where a person was born. - `postalAddress` PostalAddress: ISO20022: Information that locates and identifies a specific address, as defined by postal services. - `addressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME': ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed. | Code | Name | Description | | ---- | ---- | ----------- | | BIZZ | Business | Address is the business address | | DLVY | Delivery | Address is the address to which delivery is to take place | | MLTO | Mail To | Address is the address to which mail is sent | | PBOX | PO Box | Address is is a postal office (PO) box | | ADDR | Postal | Address is the complete postal address | | HOME | Business | Address is the home address | - `department` string: ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments. - `subDepartment` string: ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments. - `streetName` string: ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments. - `buildingNumber` string: ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments. - `buildingName` string: ISO20022: Name of the building or house. API: Cannot be used for SEPA payments. - `postCode` string: ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments. - `townName` string: ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments. - `countrySubDivision` string: ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments. - `country` string, required: ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed. - `addressLine` string[]: Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed. - `contactDetails` ContactDetails: Indicates how to contact the party. - `phoneNumber` string: The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters). - `faxNumber` string: The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters). - `emailAddress` string: email address of the contact - `organisationId` GenericIdentification: ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support. - `identification` string, required: API: Identifier - `schemeName` string, required: Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following: | Code | Name | Description | | ---- | ---- | ----------- | | BANK | BankPartyIdentification | Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. | | BBAN | BBANIdentifier | Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. | | COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) | | SREN | SIREN | The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. | | SRET | SIRET | The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. | | NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. | Other values are also permitted, for instance: | Code | Name | Description | | ---- | ---- | ----------- | | OAUT | OAUTH2 | OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU | | CPAN | CardPan | Card PAN | | MPAN | MaskedPan | Card PAN where some digits were replaced for security reason | | TPAN | TokenizedPan | Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field | | TBAN | TokenizedIBAN | Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field | Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used - `issuer` string: ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties - `privateId` GenericIdentification: ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support. - `identification` string, required: API: Identifier - `schemeName` string, required: Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following: | Code | Name | Description | | ---- | ---- | ----------- | | BANK | BankPartyIdentification | Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. | | BBAN | BBANIdentifier | Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. | | COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) | | SREN | SIREN | The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. | | SRET | SIRET | The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. | | NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. | Other values are also permitted, for instance: | Code | Name | Description | | ---- | ---- | ----------- | | OAUT | OAUTH2 | OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU | | CPAN | CardPan | Card PAN | | MPAN | MaskedPan | Card PAN where some digits were replaced for security reason | | TPAN | TokenizedPan | Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field | | TBAN | TokenizedIBAN | Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field | Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used - `issuer` string: ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties - `lei` string: Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". - `taxRemittance` TaxInformation: ISO20022: 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. API: Amounts must always be set as positive values. The [totalTaxableBaseAmount] property indicates the total amount of money on which the tax is based. The [totalTaxAmount] property indicates the total amount of money as result of the calculation of the tax. - `creditor` TaxParty: Set of elements used to identify a party of the transaction to which the tax applies. The [authorization] property aims to provide the details of the authorised tax paying party. - `taxIdentification` string: Tax identification number of the party. - `registrationIdentification` string: Unique identification, as assigned by an organisation, to unambiguously identify a party. - `taxType` string: Type of tax payer. - `authorisation` TitleAndName: Title and Name of the party or the party's authorised reprensentative. - … - `debtor` TaxParty: Set of elements used to identify a party of the transaction to which the tax applies. The [authorization] property aims to provide the details of the authorised tax paying party. - `taxIdentification` string: Tax identification number of the party. - `registrationIdentification` string: Unique identification, as assigned by an organisation, to unambiguously identify a party. - `taxType` string: Type of tax payer. - `authorisation` TitleAndName: Title and Name of the party or the party's authorised reprensentative. - … - `ultimateDebtor` TaxParty: Set of elements used to identify a party of the transaction to which the tax applies. The [authorization] property aims to provide the details of the authorised tax paying party. - `taxIdentification` string: Tax identification number of the party. - `registrationIdentification` string: Unique identification, as assigned by an organisation, to unambiguously identify a party. - `taxType` string: Type of tax payer. - `authorisation` TitleAndName: Title and Name of the party or the party's authorised reprensentative. - … - `administrationZone` string: Territorial part of a country to which the tax payment is related. - `referenceNumber` string: Tax reference information that is specific to a taxing agency. - `method` string: Method used to indicate the underlying business or how the tax is paid. - `totalTaxableBaseAmount` AmountType: Structure aiming to embed the amount and the currency to be used. - `amount` number, float, required: ISO20022: 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, required: Specifies the currency of the amount or of the account. 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". - `totalTaxAmount` AmountType: Structure aiming to embed the amount and the currency to be used. - `amount` number, float, required: ISO20022: 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, required: Specifies the currency of the amount or of the account. 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". - `date` string, date: Date by which tax is due. - `sequenceNumber` integer: Sequential number of the tax report. - `record` TaxRecord[]: Records of tax details - `type` string: High level code to identify the type of tax details. - `category` string: Specifies the tax code as published by the tax authority. - `categoryDetails` string: Provides further details of the category tax code. - `debtorStatus` string: Code provided by local authority to identify the status of the party that has drawn up the settlement document. - `certificateIdentification` string: Identification number of the tax report as assigned by the taxing authority. - `formsCode` string: Identifies, in a coded form, on which template the tax report is to be provided. - `period` TaxPeriod: Set of elements used to provide details on the period of time related to the tax payment. The [type] property aims to identify the period related to the tax payment. - … - `taxAmount` TaxAmount: ISO20022: Set of elements used to provide information on the amount of the tax record. API: Amounts must always be set as positive values. | Property | Description | | -------- | ----------- | | rate | Rate used to calculate the tax. | | taxableBaseAmount | Amount of money on which the tax is based. | | totalAmount | Total amount that is the result of the calculation of the tax for the record. | | details | Set of elements used to provide details on the tax period and amount. | - … - `additionalInformation` string: Further details of the tax record. - `transactionStatus` 'ACSC' | 'ACSP' | 'ACTC' | 'CANC' | 'PDNG' | 'RJCT': ISO20022: 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 | Code | Name | Description | | ---- | ---- | ---------- | | ACSC | AcceptedSettlementCompleted | Settlement on the debtor's account was completed. In the case of SCTInst, this status must not been set by the debtor's Bank before the reception of the positive confirmation. The transaction cannot be cancelled. | | ACSP | AcceptedSettlementInProcess | All preceding checks such as technical validation and customer profile were successful and therefore the Payment Request was accepted for execution. The transaction cannot be cancelled. | | ACTC | AcceptedTechnicalValidation | Authentication and syntactical and semantical validation are successful. The transaction might be cancelled. | | CANC | Cancelled | Payment initiation was successfully cancelled after having received a request for cancellation. | | PDNG | Pending | Payment request or individual transaction included in the Payment Request is pending. Further checks and status update will be performed. The transaction might be cancelled. | | RJCT | Rejected | Payment request or individual transaction included in the Payment Request was rejected. | ![](https://www.stet.eu//assets/files/documents-api/transaction-status-1-4-2.png) - `statusReasonInformation` 'AC01' | 'AC04' | 'AC06' | 'AG01' | 'AG03' | 'AM18' | 'CH03' | 'CUST' | 'DS02' | 'DUPL' | 'FF01' | 'FRAD' | 'MS03' | 'NOAS' | 'RR01' | 'RR03' | 'RR04' | 'RR12' | 'CNOR' | 'CH04': ISO20022: Provides detailed information on the status reason. API: Can only be used in case the status is equal to "RJCT" or "CANC". Only the following values are allowed: | Code | Name | Description | | ---- | ---- | ---------- | | AC01 | IncorectAccountNumber | the account number is either invalid or does not exist | | AC04 | ClosedAccountNumber | the account is closed and cannot be used | | AC06 | BlockedAccount | the account is blocked and cannot be used | | AG01 | TransactionForbidden | Transaction forbidden on this type of account | | AG03 | TransactionNotSupported | Transaction type not supported/authorized on this account | | AM18 | InvalidNumberOfTransactions | the number of transactions exceeds the ASPSP acceptance limit | | CH03 | RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture | The requested execution date is too far in the future | | CH04 | RequestedExecutionDateOrRequestedCollectionDateTooFarInPast | Value in Requested Execution Date or Requested Collection Date is too far in the past | | CNOR | CreditorBankIsNotRegistered | Creditor bank is not registered under this BIC in the CSM | | CUST | RequestedByCustomer | The reject is due to the debtor: refusal or lack of liquidity | | DS02 | OrderCancelled | An authorized user has cancelled the order | | DUPL | DuplicatePayment | Payment is a duplicate of another payment. Can only be set by a PISP for a payment request cancellation. | | FF01 | InvalidFileFormat | The reject is due to the original Payment Request which is invalid (syntax, structure or values) | | FRAD | FraudulentOriginated | the Payment Request is considered as fraudulent | | MS03 | NotSpecifiedReasonAgentGenerated | No reason specified by the ASPSP | | NOAS | NoAnswerFromCustomer | The PSU has neither accepted nor rejected the Payment Request and a time-out has occurred | | RR01 | MissingDebtorAccountOrIdentification | The Debtor account and/or Identification are missing or inconsistent | | RR03 | MissingCreditorNameOrAddress | Specification of the creditor’s name and/or address needed for regulatory requirements is insufficient or missing. | | RR04 | RegulatoryReason | Reject from regulatory reason | | RR12 | InvalidPartyID | Invalid or missing identification required within a particular country or payment type. | | TECH | TechnicalProblem | Technical problems resulting in an erroneous transaction. Can only be set by a PISP for a payment request cancellation. | - `supplementaryData` SupplementaryData: ISO20022: Additional information that cannot be captured in the structured elements and/or any other specific block. API: This structure is used to embed the relevant URLs for returning the status report to the PISP and to specify which authentication approaches are accepted by the PISP and which was chosen by the ASPSP The [acceptedAuthenticationApproach] property can only be set by the PISP. - Authentication approaches that are supported by the PISP. The PISP can provide several choices separated by commas. - Case of none of the accepted approaches is supported by the ASPSP, the latest will respond with HTTP400 (Bad request) and specify wich approaches are actually supported. The [appliedAuthentication] will be set by the ASPSP. - The 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 was chosen. - It may happen that the ASPSP considers that, in case of payment cancellation request, there is no need for authentication and will then return "NONE". - `acceptedAuthenticationApproach` AuthenticationApproach[]: List of authentication approaches - `appliedAuthenticationApproach` 'REDIRECT' | 'DECOUPLED' | 'EMBEDDED-1-FACTOR' | 'NONE': Authentication approaches that can be applied. REDIRECT: the PSU is redirected by the TPP to the ASPSP which processes identification and authentication DECOUPLED: the TPP identifies the PSU and forwards the identification to the ASPSP which processes the authentication through a decoupled device NONE: there is no need for the PSU to authenticate - `appliedAuthentication` 'noAuthentication' | 'oneFactorAuthentication' | 'strongAuthentication': Can only be set by the ASPSP. This field allows the ASPSP to inform the PISP about the way authentication was processed during the payment request confirmation. - `scaHint` 'noScaExemption' | 'scaExemption': can only be set by the PISP Hint given by the merchant and/or the PISP about an SCA exemption context - `successfulReportUrl` string: URL to be used by the ASPSP in order to notify the PISP of the finalisation of the authentication and consent process in REDIRECT and DECOUPLED approach - `unsuccessfulReportUrl` string: URL to be used by the ASPSP in order to notify the PISP of the failure of the authentication and consent process in REDIRECT and DECOUPLED approach If this URL is not provided by the PISP, the ASPSP will use the "successfulReportUrl" even in case of failure of the Payment Request processing - `nextStatusRequestHint` string, date-time: Date and time at which the PISP is suggested to ask again for the status of the payment request. - `_links` CreditTransferTransactionLinks, required: links that can be used for further navigation when retrieving the transaction of a payment request. | Link | Description | | ---- | ----------- | | self | link to the transactions | | parent | This link shall point to the parent payment request. | | first | link to the first page of the transactions result | | last | link to the last page of the transactions result | | next | link to the next page of the transactions result | | prev | link to the previous page of the transactions result | - `self` GenericLink: hypertext reference - `href` string, required: URI to be used. HREF stands for Hypertext REFerence. - `templated` boolean: This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false - `parent` GenericLink: hypertext reference - `href` string, required: URI to be used. HREF stands for Hypertext REFerence. - `templated` boolean: This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false - `first` GenericLink: hypertext reference - `href` string, required: URI to be used. HREF stands for Hypertext REFerence. - `templated` boolean: This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false - `last` GenericLink: hypertext reference - `href` string, required: URI to be used. HREF stands for Hypertext REFerence. - `templated` boolean: This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false - `next` GenericLink: hypertext reference - `href` string, required: URI to be used. HREF stands for Hypertext REFerence. - `templated` boolean: This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false - `prev` GenericLink: hypertext reference - `href` string, required: URI to be used. HREF stands for Hypertext REFerence. - `templated` boolean: This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false ## Other responses - `400`: Invalid status value - `401`: Unauthorized, authentication failure. - `403`: Forbidden, authentication successful but access to resource is not allowed. - `405`: Method Not Allowed. - `406`: Not Acceptable. - `408`: Request Timeout. - `409`: Conflict. The request could not be completed due to a conflict with the current state of the target resource. - `429`: Too many requests. - `500`: Internal server error. - `503`: Service unavailable. --- [API](https://skmtc.dev/groupebpce/apis/natixis-wealth-management-payments-initiation.md) - [All operations](https://skmtc.dev/groupebpce/apis/natixis-wealth-management-payments-initiation/llms.txt) - [OpenAPI document](https://skmtc.dev/groupebpce/apis/natixis-wealth-management-payments-initiation/revisions/f3770174d7cb?raw)