get/payment-requests/{paymentRequestResourceId}/transactions
Retrieval of the Credit Transfert Transactions that were processed for a given payment request.
OAuth2 scope: 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.
Parameters (17)
- Authorizationheaderstringrequired
Access token to be passed as a header
- paymentRequestResourceIdpathstringrequired
Identification of the Payment Request Resource
Constraints: pattern: ^([a-zA-Z0-9_ /\-?:\()\.,']{1,100})$
- PSU-IP-Addressheaderstring
IP address used by the PSU's terminal when connecting to the TPP
- PSU-IP-Portheaderstring
IP port used by the PSU's terminal when connecting to the TPP
- PSU-HTTP-Methodheaderstring
Http method for the most relevant PSU’s terminal request to the TTP
- PSU-Dateheaderstring
Timestamp of the most relevant PSU’s terminal request to the TTP
- PSU-GEO-Locationheaderstring
Geographical location of the PSU as provided by the PSU mobile terminal if any to the TPP
- PSU-User-Agentheaderstring
"User-Agent" header field sent by the PSU terminal when connecting to the TPP
- PSU-Refererheaderstring
"Referer" header field sent by the PSU terminal when connecting to the TPP. Notice that an initial typo in RFC 1945 specifies that "referer" (incorrect spelling) is to be used. The correct spelling "referrer" can be used but might not be understood.
- PSU-Acceptheaderstring
"Accept" header field sent by the PSU terminal when connecting to the TPP
- PSU-Accept-Charsetheaderstring
"Accept-Charset" header field sent by the PSU terminal when connecting to the TPP
- PSU-Accept-Encodingheaderstring
"Accept-Encoding" header field sent by the PSU terminal when connecting to the TPP
- PSU-Accept-Languageheaderstring
"Accept-Language" header field sent by the PSU terminal when connecting to the TPP
- PSU-Device-IDheaderstring
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of installation identification this ID need to be unaltered until removal from device.
- Digestheaderstring
Digest of the body
- Signatureheaderstringrequired
http-signature of the request The keyId must specify the way to get the relevant qualified certificate. It is requested that this identifier is an URL aiming to provide the relevant Qualified Certificate.
- X-Request-IDheaderstringrequired
Correlation header to be set in a request and retrieved in the relevant response
Constraints: maxLength: 70
Responses
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
Fields (2)
- creditTransferTransactionarray<CreditTransferTransactionResource>required
ISO20022: Payment processes required to transfer cash from the debtor to the creditor.
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
Item: CreditTransferTransactionResource
ISO20022: Payment processes required to transfer cash from the debtor to the creditor. API:
- paymentIdPaymentIdentificationrequired
ISO20022: Set of elements used to reference a payment instruction.
Schema: PaymentIdentification
ISO20022: Set of elements used to reference a payment instruction.
- instructionIdstringrequired
ISO20022: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
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
Constraints: pattern: `^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$`
- endToEndIdEndToEndId
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.
Schema: EndToEndId
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.
Type: string
Constraints: pattern: `^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$`
- uetrstring
ISO20022: Universally unique identifier to provide an end-to-end reference of a payment transaction.
ISO20022: Universally unique identifier to provide an end-to-end reference of a payment transaction.
Constraints: pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$`
- resourceIdResourceId
API: Identifier assigned by the ASPSP for further use of the created resource through API calls.
Schema: ResourceId
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.
Type: string
Constraints: pattern: `^([a-zA-Z0-9_ /\-?:\()\.,']{1,100})$`
- requestedExecutionDateRequestedExecutionDaterequired
ISO20022: Date at which the initiating party requests the clearing agent to process the payment.
Schema: RequestedExecutionDate
ISO20022: Date at which the initiating party requests the clearing agent to process the payment. API: This field indicates the date at which the debtor account should be debited. 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. This date can be used in the following cases:
- the single requested execution date for a payment having several instructions. In this case, this field must be set at the payment level.
- the requested execution date for a given instruction within a payment. In this case, this field must be set at each instruction level.
- The first date of execution for a standing order. When the payment cannot be processed at this date, the ASPSP is allowed to shift the applied execution date to the next possible execution date for non-standing orders. For standing orders, the [executionRule] parameter helps to compute the execution date to be applied.
Type: string (date-time)
This field may allow the PISP to get information on the limit timestamp for requesting cancelation of the transaction.
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.
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.
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.
ISO20022: Date and time on when the debtor has accepted or rejected the request.
ISO20022: Date and time on when the debtor has accepted or rejected the request.
ISO20022: Date and time on when the payment was executed.
ISO20022: Date and time on when the payment was executed.
- standingOrderCharacteristicsStandingOrderCharacteristics
Specifies the characteristics of a standing order.
Schema: StandingOrderCharacteristics
Specifies the characteristics of a standing order.
- startDateStartDaterequired
The first applicable day of execution for a given standing order.
Schema: StartDate
The first applicable day of execution for a given standing order.
Type: string (date-time)
- endDateEndDate
The last applicable day of execution for a given standing order.
Schema: EndDate
The last applicable day of execution for a given standing order. If not given, the standing order is considered as endless.
Type: string (date-time)
- executionRuleExecutionRulerequired
Execution date shifting rule for standing orders
Schema: ExecutionRule
Code Description FWNGfollowing PRECpreceding - frequencyFrequencyCoderequired
Frequency rule for standing orders.
Schema: FrequencyCode
Code Description DAILDaily WEEKWeekly TOWKEveryTwoWeeks MNTHMonthly TOMNEveryTwoMonths QUTRQuarterly SEMISemiAnnual YEARAnnual
- instructedAmountAmountType
Structure aiming to embed the amount and the currency to be used.
Schema: AmountType
Structure aiming to embed the amount and the currency to be used.
- amountnumber (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.
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.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
Specifies the currency of the amount or of the account.
Schema: CurrencyCode
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".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- equivalentAmountEquivalentAmountType
Structure aiming to embed the amount and the currency to be used.
Schema: EquivalentAmountType
Structure aiming to embed the amount and the currency to be used. The currency of transfer should be set.
- amountnumber (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.
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.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
Specifies the currency of the amount or of the account.
Schema: CurrencyCode
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".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- currencyOfTransferCurrencyCoderequired
Specifies the currency of the amount or of the account.
Schema: CurrencyCode
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".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- exchangeRateInformationExchangeRate
Provides details on the currency exchange rate and contract.
Schema: ExchangeRate
Provides details on the currency exchange rate and contract.
- unitCurrencyCurrencyCode
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Schema: CurrencyCode
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".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- exchangeRatenumber (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.
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.
- rateTypestringenum · 3
Specifies the type used to complete the currency exchange.
Code Name Description SPOTSpot Exchange rate applied is the spot rate. SALESale Exchange rate applied is the market rate at the time of the sale. AGRDAgreed Exchange rate applied is the rate agreed between the parties. - contractIdentificationstring
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Constraints: maxLength: 35
- estimatedPayerAmountAmountType
Estimation of the amount that will be debited on the payer's account, including transaction and change fees.
Schema: AmountType
Structure aiming to embed the amount and the currency to be used.
- amountnumber (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.
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.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
Specifies the currency of the amount or of the account.
Schema: CurrencyCode
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".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- estimatedPayeeAmountAmountType
Estimation of the amount that will be credited on the payee's account.
Schema: AmountType
Structure aiming to embed the amount and the currency to be used.
- amountnumber (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.
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.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
Specifies the currency of the amount or of the account.
Schema: CurrencyCode
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".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- ultimateDebtorPartyIdentification
API : Description of a Party which can be either a person or an organization.
Schema: PartyIdentification
API : Description of a Party which can be either a person or an organization.
- namestringrequired
ISO20022: Name by which a party is known and which is usually used to identify that party.
ISO20022: Name by which a party is known and which is usually used to identify that party.
Constraints: maxLength: 140
- dateAndPlaceOfBirthDateAndPlaceOfBirth
Date and place of birth of a person.
Schema: 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.
Date on which a person is born.
- cityOfBirthstringrequired
City where a person was born.
Constraints: maxLength: 35
- countryOfBirthstringrequired
Country where a person was born.
Constraints: pattern: `^[A-Z]{2,2}$`
- postalAddressPostalAddress
ISO20022: Information that locates and identifies a specific address, as defined by postal services.
Schema: PostalAddress
ISO20022: Information that locates and identifies a specific address, as defined by postal services.
- addressTypestringenum · 6
ISO20022: Identifies the nature of the postal address.
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 BIZZBusiness Address is the business address DLVYDelivery Address is the address to which delivery is to take place MLTOMail To Address is the address to which mail is sent PBOXPO Box Address is is a postal office (PO) box ADDRPostal Address is the complete postal address HOMEBusiness Address is the home address - departmentstring
ISO20022: Identification of a division of a large organisation or building.
ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- subDepartmentstring
ISO20022: Identification of a sub-division of a large organisation or building.
ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- streetNamestring
ISO20022: Name of a street or thoroughfare.
ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- buildingNumberstring
ISO20022: Number that identifies the position of a building on a street.
ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- buildingNamestring
ISO20022: Name of the building or house.
ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- postCodestring
ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
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.
Constraints: maxLength: 16
- townNamestring
ISO20022: Name of a built-up area, with defined boundaries, and a local government.
ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
- countrySubDivisionstring
ISO20022: Identifies a subdivision of a country such as state, region, county.
ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
- countrystringrequired
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.
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.
Constraints: pattern: `^([A-Z]{2,2})$`
- addressLinearray<string>required
Unstructured address. The lines must embed zip code and town name.
Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.
Type: array<string>
Item: Address line
Item constraints: maxLength: 70
- contactDetailsContactDetails
Indicates how to contact the party.
Schema: ContactDetails
Indicates how to contact the party.
- phoneNumberPhoneNumber
The collection of information which identifies a specific phone or FAX number as defined by telecom services.
Schema: PhoneNumber
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).
Type: string
Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`
- faxNumberPhoneNumber
The collection of information which identifies a specific phone or FAX number as defined by telecom services.
Schema: PhoneNumber
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).
Type: string
Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`
- emailAddressstring
email address of the contact
Constraints: maxLength: 2048 · pattern: `^.+@.+$`
- organisationIdGenericIdentification
Unique and unambiguous way to identify an organisation.
Schema: 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.
- identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70
- schemeNamestringrequired
Name of the identification scheme.
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. 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 Constraints: maxLength: 70
- issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
Constraints: maxLength: 35
- privateIdGenericIdentification
Unique and unambiguous identification of a person.
Schema: 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.
- identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70
- schemeNamestringrequired
Name of the identification scheme.
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. 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 Constraints: maxLength: 70
- issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
Constraints: maxLength: 35
- leiLeiIdentification
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Schema: LeiIdentification
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Type: string
Constraints: pattern: `^[A-Z0-9]{18,18}[0-9]{2,2}$`
- intermediaryAgentIntermediaryAgent
Agent and agent account between the debtor's agent and the creditor's agent.
Schema: IntermediaryAgent
Agent and agent account between the debtor's agent and the creditor's agent.
- agentPartyIdentification
API : Description of a Party which can be either a person or an organization.
Schema: PartyIdentification
API : Description of a Party which can be either a person or an organization.
- namestringrequired
ISO20022: Name by which a party is known and which is usually used to identify that party.
ISO20022: Name by which a party is known and which is usually used to identify that party.
Constraints: maxLength: 140
- dateAndPlaceOfBirthDateAndPlaceOfBirth
Date and place of birth of a person.
Schema: 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.
Date on which a person is born.
- cityOfBirthstringrequired
City where a person was born.
Constraints: maxLength: 35
- countryOfBirthstringrequired
Country where a person was born.
Constraints: pattern: `^[A-Z]{2,2}$`
- postalAddressPostalAddress
ISO20022: Information that locates and identifies a specific address, as defined by postal services.
Schema: PostalAddress
ISO20022: Information that locates and identifies a specific address, as defined by postal services.
- addressTypestringenum · 6
ISO20022: Identifies the nature of the postal address.
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 BIZZBusiness Address is the business address DLVYDelivery Address is the address to which delivery is to take place MLTOMail To Address is the address to which mail is sent PBOXPO Box Address is is a postal office (PO) box ADDRPostal Address is the complete postal address HOMEBusiness Address is the home address - departmentstring
ISO20022: Identification of a division of a large organisation or building.
ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- subDepartmentstring
ISO20022: Identification of a sub-division of a large organisation or building.
ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- streetNamestring
ISO20022: Name of a street or thoroughfare.
ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- buildingNumberstring
ISO20022: Number that identifies the position of a building on a street.
ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- buildingNamestring
ISO20022: Name of the building or house.
ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- postCodestring
ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
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.
Constraints: maxLength: 16
- townNamestring
ISO20022: Name of a built-up area, with defined boundaries, and a local government.
ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
- countrySubDivisionstring
ISO20022: Identifies a subdivision of a country such as state, region, county.
ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
- countrystringrequired
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.
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.
Constraints: pattern: `^([A-Z]{2,2})$`
- addressLinearray<string>required
Unstructured address. The lines must embed zip code and town name.
Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.
Type: array<string>
Item: Address line
Item constraints: maxLength: 70
- contactDetailsContactDetails
Indicates how to contact the party.
Schema: ContactDetails
Indicates how to contact the party.
- phoneNumberPhoneNumber
The collection of information which identifies a specific phone or FAX number as defined by telecom services.
Schema: PhoneNumber
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).
Type: string
Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`
- faxNumberPhoneNumber
The collection of information which identifies a specific phone or FAX number as defined by telecom services.
Schema: PhoneNumber
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).
Type: string
Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`
- emailAddressstring
email address of the contact
Constraints: maxLength: 2048 · pattern: `^.+@.+$`
- organisationIdGenericIdentification
Unique and unambiguous way to identify an organisation.
Schema: 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.
- identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70
- schemeNamestringrequired
Name of the identification scheme.
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. 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 Constraints: maxLength: 70
- issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
Constraints: maxLength: 35
- privateIdGenericIdentification
Unique and unambiguous identification of a person.
Schema: 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.
- identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70
- schemeNamestringrequired
Name of the identification scheme.
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. 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 Constraints: maxLength: 70
- issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
Constraints: maxLength: 35
- leiLeiIdentification
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Schema: LeiIdentification
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Type: string
Constraints: pattern: `^[A-Z0-9]{18,18}[0-9]{2,2}$`
- agentAccountAccountIdentification
Unique and unambiguous identification for the account between the account owner and the account servicer.
Schema: 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).
- workspacestring
Workspace to which the account is linked.
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.
Constraints: maxLength: 32
- ibanstring
ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer.
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.
Constraints: pattern: `^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$`
- otherGenericIdentification
ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer.
Schema: 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.
- identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70
- schemeNamestringrequired
Name of the identification scheme.
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. 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 Constraints: maxLength: 70
- issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
Constraints: maxLength: 35
Currency used for the account
Schema: CurrencyCode
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".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- beneficiaryBeneficiaryrequired
Specification of a beneficiary
Schema: Beneficiary
Specification of a beneficiary
- workspaceWorkspace
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.
Schema: 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.
- identificationstringrequired
identification of the workspace to be used as an optional query parameter for some AISP queries
Constraints: maxLength: 32
- labelstringrequired
textual description of the workspace as specified by the ASPSP in relationship wth the PSU
Constraints: maxLength: 128
- idstring
Id of the beneficiary
Constraints: pattern: `^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$`
- isTrustedboolean
The ASPSP having not implemented the trusted beneficiaries list must not set this flag.
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
- creditorAgentFinancialInstitutionIdentification
ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.
Schema: FinancialInstitutionIdentification
ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.
- bicFistringrequired
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)".
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)".
Constraints: pattern: `^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$`
- clearingSystemMemberIdClearingSystemMemberIdentification
ISO20022: Information used to identify a member within a clearing system.
Schema: 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
- clearingSystemIdstring
ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.
ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.
Constraints: maxLength: 35
- memberIdstring
ISO20022: Identification of a member of a clearing system.
ISO20022: Identification of a member of a clearing system.
Constraints: maxLength: 35
- namestring
Name of the financial institution
Constraints: maxLength: 140
- postalAddressPostalAddress
ISO20022: Information that locates and identifies a specific address, as defined by postal services.
Schema: PostalAddress
ISO20022: Information that locates and identifies a specific address, as defined by postal services.
- addressTypestringenum · 6
ISO20022: Identifies the nature of the postal address.
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 BIZZBusiness Address is the business address DLVYDelivery Address is the address to which delivery is to take place MLTOMail To Address is the address to which mail is sent PBOXPO Box Address is is a postal office (PO) box ADDRPostal Address is the complete postal address HOMEBusiness Address is the home address - departmentstring
ISO20022: Identification of a division of a large organisation or building.
ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- subDepartmentstring
ISO20022: Identification of a sub-division of a large organisation or building.
ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- streetNamestring
ISO20022: Name of a street or thoroughfare.
ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- buildingNumberstring
ISO20022: Number that identifies the position of a building on a street.
ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- buildingNamestring
ISO20022: Name of the building or house.
ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- postCodestring
ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
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.
Constraints: maxLength: 16
- townNamestring
ISO20022: Name of a built-up area, with defined boundaries, and a local government.
ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
- countrySubDivisionstring
ISO20022: Identifies a subdivision of a country such as state, region, county.
ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
- countrystringrequired
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.
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.
Constraints: pattern: `^([A-Z]{2,2})$`
- addressLinearray<string>required
Unstructured address. The lines must embed zip code and town name.
Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.
Type: array<string>
Item: Address line
Item constraints: maxLength: 70
- creditorPartyIdentificationrequired
API : Description of a Party which can be either a person or an organization.
Schema: PartyIdentification
API : Description of a Party which can be either a person or an organization.
- namestringrequired
ISO20022: Name by which a party is known and which is usually used to identify that party.
ISO20022: Name by which a party is known and which is usually used to identify that party.
Constraints: maxLength: 140
- dateAndPlaceOfBirthDateAndPlaceOfBirth
Date and place of birth of a person.
Schema: 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.
Date on which a person is born.
- cityOfBirthstringrequired
City where a person was born.
Constraints: maxLength: 35
- countryOfBirthstringrequired
Country where a person was born.
Constraints: pattern: `^[A-Z]{2,2}$`
- postalAddressPostalAddress
ISO20022: Information that locates and identifies a specific address, as defined by postal services.
Schema: PostalAddress
ISO20022: Information that locates and identifies a specific address, as defined by postal services.
- addressTypestringenum · 6
ISO20022: Identifies the nature of the postal address.
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 BIZZBusiness Address is the business address DLVYDelivery Address is the address to which delivery is to take place MLTOMail To Address is the address to which mail is sent PBOXPO Box Address is is a postal office (PO) box ADDRPostal Address is the complete postal address HOMEBusiness Address is the home address - departmentstring
ISO20022: Identification of a division of a large organisation or building.
ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- subDepartmentstring
ISO20022: Identification of a sub-division of a large organisation or building.
ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- streetNamestring
ISO20022: Name of a street or thoroughfare.
ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- buildingNumberstring
ISO20022: Number that identifies the position of a building on a street.
ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- buildingNamestring
ISO20022: Name of the building or house.
ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- postCodestring
ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
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.
Constraints: maxLength: 16
- townNamestring
ISO20022: Name of a built-up area, with defined boundaries, and a local government.
ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
- countrySubDivisionstring
ISO20022: Identifies a subdivision of a country such as state, region, county.
ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
- countrystringrequired
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.
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.
Constraints: pattern: `^([A-Z]{2,2})$`
- addressLinearray<string>required
Unstructured address. The lines must embed zip code and town name.
Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.
Type: array<string>
Item: Address line
Item constraints: maxLength: 70
- contactDetailsContactDetails
Indicates how to contact the party.
Schema: ContactDetails
Indicates how to contact the party.
- phoneNumberPhoneNumber
The collection of information which identifies a specific phone or FAX number as defined by telecom services.
Schema: PhoneNumber
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).
Type: string
Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`
- faxNumberPhoneNumber
The collection of information which identifies a specific phone or FAX number as defined by telecom services.
Schema: PhoneNumber
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).
Type: string
Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`
- emailAddressstring
email address of the contact
Constraints: maxLength: 2048 · pattern: `^.+@.+$`
- organisationIdGenericIdentification
Unique and unambiguous way to identify an organisation.
Schema: 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.
- identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70
- schemeNamestringrequired
Name of the identification scheme.
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. 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 Constraints: maxLength: 70
- issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
Constraints: maxLength: 35
- privateIdGenericIdentification
Unique and unambiguous identification of a person.
Schema: 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.
- identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70
- schemeNamestringrequired
Name of the identification scheme.
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. 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 Constraints: maxLength: 70
- issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
Constraints: maxLength: 35
- leiLeiIdentification
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Schema: LeiIdentification
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Type: string
Constraints: pattern: `^[A-Z0-9]{18,18}[0-9]{2,2}$`
- creditorAccountAccountIdentification
Unique and unambiguous identification for the account between the account owner and the account servicer.
Schema: 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).
- workspacestring
Workspace to which the account is linked.
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.
Constraints: maxLength: 32
- ibanstring
ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer.
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.
Constraints: pattern: `^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$`
- otherGenericIdentification
ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer.
Schema: 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.
- identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70
- schemeNamestringrequired
Name of the identification scheme.
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. 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 Constraints: maxLength: 70
- issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
Constraints: maxLength: 35
Currency used for the account
Schema: CurrencyCode
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".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- ultimateCreditorPartyIdentification
API : Description of a Party which can be either a person or an organization.
Schema: PartyIdentification
API : Description of a Party which can be either a person or an organization.
- namestringrequired
ISO20022: Name by which a party is known and which is usually used to identify that party.
ISO20022: Name by which a party is known and which is usually used to identify that party.
Constraints: maxLength: 140
- dateAndPlaceOfBirthDateAndPlaceOfBirth
Date and place of birth of a person.
Schema: 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.
Date on which a person is born.
- cityOfBirthstringrequired
City where a person was born.
Constraints: maxLength: 35
- countryOfBirthstringrequired
Country where a person was born.
Constraints: pattern: `^[A-Z]{2,2}$`
- postalAddressPostalAddress
ISO20022: Information that locates and identifies a specific address, as defined by postal services.
Schema: PostalAddress
ISO20022: Information that locates and identifies a specific address, as defined by postal services.
- addressTypestringenum · 6
ISO20022: Identifies the nature of the postal address.
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 BIZZBusiness Address is the business address DLVYDelivery Address is the address to which delivery is to take place MLTOMail To Address is the address to which mail is sent PBOXPO Box Address is is a postal office (PO) box ADDRPostal Address is the complete postal address HOMEBusiness Address is the home address - departmentstring
ISO20022: Identification of a division of a large organisation or building.
ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- subDepartmentstring
ISO20022: Identification of a sub-division of a large organisation or building.
ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- streetNamestring
ISO20022: Name of a street or thoroughfare.
ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- buildingNumberstring
ISO20022: Number that identifies the position of a building on a street.
ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- buildingNamestring
ISO20022: Name of the building or house.
ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- postCodestring
ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
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.
Constraints: maxLength: 16
- townNamestring
ISO20022: Name of a built-up area, with defined boundaries, and a local government.
ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
- countrySubDivisionstring
ISO20022: Identifies a subdivision of a country such as state, region, county.
ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
- countrystringrequired
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.
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.
Constraints: pattern: `^([A-Z]{2,2})$`
- addressLinearray<string>required
Unstructured address. The lines must embed zip code and town name.
Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.
Type: array<string>
Item: Address line
Item constraints: maxLength: 70
- contactDetailsContactDetails
Indicates how to contact the party.
Schema: ContactDetails
Indicates how to contact the party.
- phoneNumberPhoneNumber
The collection of information which identifies a specific phone or FAX number as defined by telecom services.
Schema: PhoneNumber
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).
Type: string
Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`
- faxNumberPhoneNumber
The collection of information which identifies a specific phone or FAX number as defined by telecom services.
Schema: PhoneNumber
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).
Type: string
Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`
- emailAddressstring
email address of the contact
Constraints: maxLength: 2048 · pattern: `^.+@.+$`
- organisationIdGenericIdentification
Unique and unambiguous way to identify an organisation.
Schema: 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.
- identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70
- schemeNamestringrequired
Name of the identification scheme.
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. 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 Constraints: maxLength: 70
- issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
Constraints: maxLength: 35
- privateIdGenericIdentification
Unique and unambiguous identification of a person.
Schema: 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.
- identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70
- schemeNamestringrequired
Name of the identification scheme.
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. 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 Constraints: maxLength: 70
- issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
Constraints: maxLength: 35
- leiLeiIdentification
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Schema: LeiIdentification
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Type: string
Constraints: pattern: `^[A-Z0-9]{18,18}[0-9]{2,2}$`
- instructionForCreditorAgentarray<InstructionForCreditorAgent>
Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.
Item: InstructionForCreditorAgent
Further information related to the processing of the payment instruction that may need to be acted upon by the creditor's agent. The instruction may relate to a level of service, or may be an instruction that has to be executed by the creditor's agent, or may be information required by the creditor's agent.
- codestringenum · 4
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 CHQBPayCreditorByCheque (Ultimate) creditor must be paid by cheque. HOLDHoldCashForCreditor Amount of money must be held for the (ultimate) creditor, who will call. Pay on identification. PHOBPhoneBeneficiary Please advise/contact (ultimate) creditor/claimant by phone. TELBTelecom Please advise/contact (ultimate) creditor/claimant by the most efficient means of telecommunication. - instructionInformationstring
Further information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.
Constraints: maxLength: 140
- purposePurposeCode
ISO20022: Underlying reason for the payment transaction, as published in an external purpose code list.
Schema: PurposeCode
Code Name Description ACCTAccountManagement Funds moved between 2 accounts of same account holder at the same bank) CASHCashManagementTransfer (general cash management instruction) may be used for Transfer Initiation COMCCommercialPayment Transaction is related to a payment of commercial credit or debit. CPKCCarparkCharges General Carpark Charges Transaction is related to carpark charges. TRPTRoadPricing Transport RoadPricing Transaction is for the payment to top-up pre-paid card and electronic road pricing for the purpose of transportation. - regulatoryReportingCodesRegulatoryReportingCodes
List of needed regulatory reporting codes for international payments
Schema: RegulatoryReportingCodes
Type: array<string>
List of needed regulatory reporting codes for international payments
- remittanceInformationRemittanceInformation
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.
Schema: 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.
- unstructuredarray<string>
Unstructured remittance information
Type: array<string>
Item: Relevant information to the transaction
Item constraints: maxLength: 140
- structuredarray<StructuredRemittanceInformation>
Structured remittance information
Item: StructuredRemittanceInformation
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in a structured form.
- referredDocumentInformationReferredDocumentInformations
Provides the identification and the content of the referred documents.
Item: ReferredDocumentInformation
Provides the identification and the content of the referred document.
- typeCodeAndIssuer
Specifies a code and the issuer of this code.
Schema: CodeAndIssuer
Specifies a code and the issuer of this code.
- codestringrequired
Provides the code.
Constraints: maxLength: 4
- issuerstring
Identification of the issuer of the code.
Constraints: maxLength: 35
- numberstring
Unique and unambiguous identification of the referred document.
Constraints: maxLength: 35
- lineDetailsarray<LineDetail>
Sets of elements used to provide the content of the referred document line.
Item: LineDetail
Set of elements used to provide the content of the referred document line.
- identificationDocumentLineIdentification
Provides identification of the document line.
Schema: DocumentLineIdentification
Provides identification of the document line.
- typeCodeAndIssuer
Specifies the type of referred document type.
Specifies the type of referred document type.
Schema: CodeAndIssuer
- numberstring
Unique and unambiguous identification of the referred document line.
Constraints: maxLength: 35
- descriptionstring
Description associated with the document line.
Constraints: maxLength: 2048
- amountRemittanceAmount
Provides details on the amounts of the document line.
Schema: RemittanceAmount
Provides details on the amounts of the document line.
- duePayableAmountAmountType
Amount specified is the exact amount due and payable to the creditor.
Schema: AmountType
- discountAppliedAmountTypedAmount
Amount of discount to be applied to the amount due and payable to the creditor.
Schema: TypedAmount
- creditNoteAmountAmountType
Amount of a credit note.
Schema: AmountType
- taxAmountTypedAmount
Amount of the tax.
Schema: TypedAmount
- adjustmentAmountAndReasonDocumentAdjustment
Specifies detailed information on the amount and reason of the adjustment.
Schema: DocumentAdjustment
- remittedAmountAmountType
Amount of money remitted.
Schema: AmountType
- referredDocumentAmountRemittanceAmount
Provides details on the amounts of the document line.
Schema: RemittanceAmount
Provides details on the amounts of the document line.
- duePayableAmountAmountType
Amount specified is the exact amount due and payable to the creditor.
Schema: AmountType
Structure aiming to embed the amount and the currency to be used.
- amountnumber (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.
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.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
Specifies the currency of the amount or of the account.
Schema: CurrencyCode
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".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- discountAppliedAmountTypedAmount
Amount of discount to be applied to the amount due and payable to the creditor.
Schema: TypedAmount
Typed Amount
- typestring
Type of the amount
Constraints: maxLength: 35
- amountAmountTyperequired
Structure aiming to embed the amount and the currency to be used.
Schema: AmountType
Structure aiming to embed the amount and the currency to be used.
- amountnumber (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.
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.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
Specifies the currency of the amount or of the account.
Schema: CurrencyCode
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".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- creditNoteAmountAmountType
Amount of a credit note.
Schema: AmountType
Structure aiming to embed the amount and the currency to be used.
- amountnumber (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.
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.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
Specifies the currency of the amount or of the account.
Schema: CurrencyCode
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".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- taxAmountTypedAmount
Amount of the tax.
Schema: TypedAmount
Typed Amount
- typestring
Type of the amount
Constraints: maxLength: 35
- amountAmountTyperequired
Structure aiming to embed the amount and the currency to be used.
Schema: AmountType
Structure aiming to embed the amount and the currency to be used.
- amountnumber (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.
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.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
Specifies the currency of the amount or of the account.
Schema: CurrencyCode
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".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- adjustmentAmountAndReasonDocumentAdjustment
Specifies detailed information on the amount and reason of the adjustment.
Schema: DocumentAdjustment
Specifies detailed information on the amount and reason of the adjustment.
- amountAmountTyperequired
Structure aiming to embed the amount and the currency to be used.
Schema: AmountType
Structure aiming to embed the amount and the currency to be used.
- amountnumber (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.
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.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
Specifies the currency of the amount or of the account.
Schema: CurrencyCode
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".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- creditDebitIndicatorCreditDebitIndicator
Accounting flow of the amount
Schema: CreditDebitIndicator
Code Description CRDTCredit type amount DBITDebit type amount - reasonstring
Specifies the reason for the adjustment.
Constraints: maxLength: 4
- additionalInformationstring
Provides further details on the document adjustment.
Constraints: maxLength: 140
- remittedAmountAmountType
Amount of money remitted.
Schema: AmountType
Structure aiming to embed the amount and the currency to be used.
- amountnumber (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.
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.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
Specifies the currency of the amount or of the account.
Schema: CurrencyCode
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".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- creditorReferenceInformationCreditorReferenceInformation
Reference information provided by the creditor to allow the identification of the underlying documents.
Schema: CreditorReferenceInformation
Reference information provided by the creditor to allow the identification of the underlying documents.
- typeCodeAndIssuer
Specifies a code and the issuer of this code.
Schema: CodeAndIssuer
Specifies a code and the issuer of this code.
- codestringrequired
Provides the code.
Constraints: maxLength: 4
- issuerstring
Identification of the issuer of the code.
Constraints: maxLength: 35
- referencestring
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Constraints: maxLength: 35
- invoicerPartyIdentification
API : Description of a Party which can be either a person or an organization.
Schema: PartyIdentification
API : Description of a Party which can be either a person or an organization.
- namestringrequired
ISO20022: Name by which a party is known and which is usually used to identify that party.
ISO20022: Name by which a party is known and which is usually used to identify that party.
Constraints: maxLength: 140
- dateAndPlaceOfBirthDateAndPlaceOfBirth
Date and place of birth of a person.
Schema: 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.
Date on which a person is born.
- cityOfBirthstringrequired
City where a person was born.
Constraints: maxLength: 35
- countryOfBirthstringrequired
Country where a person was born.
Constraints: pattern: `^[A-Z]{2,2}$`
- postalAddressPostalAddress
ISO20022: Information that locates and identifies a specific address, as defined by postal services.
Schema: PostalAddress
ISO20022: Information that locates and identifies a specific address, as defined by postal services.
- addressTypestringenum · 6
ISO20022: Identifies the nature of the postal address.
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 BIZZBusiness Address is the business address DLVYDelivery Address is the address to which delivery is to take place MLTOMail To Address is the address to which mail is sent PBOXPO Box Address is is a postal office (PO) box ADDRPostal Address is the complete postal address HOMEBusiness Address is the home address - departmentstring
ISO20022: Identification of a division of a large organisation or building.
ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- subDepartmentstring
ISO20022: Identification of a sub-division of a large organisation or building.
ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- streetNamestring
ISO20022: Name of a street or thoroughfare.
ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- buildingNumberstring
ISO20022: Number that identifies the position of a building on a street.
ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- buildingNamestring
ISO20022: Name of the building or house.
ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- postCodestring
ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
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.
Constraints: maxLength: 16
- townNamestring
ISO20022: Name of a built-up area, with defined boundaries, and a local government.
ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
- countrySubDivisionstring
ISO20022: Identifies a subdivision of a country such as state, region, county.
ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
- countrystringrequired
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.
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.
Constraints: pattern: `^([A-Z]{2,2})$`
- addressLinearray<string>required
Unstructured address. The lines must embed zip code and town name.
Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.
Type: array<string>
Item: Address line
Item constraints: maxLength: 70
- contactDetailsContactDetails
Indicates how to contact the party.
Schema: ContactDetails
Indicates how to contact the party.
- phoneNumberPhoneNumber
The collection of information which identifies a specific phone or FAX number as defined by telecom services.
Schema: PhoneNumber
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).
Type: string
Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`
- faxNumberPhoneNumber
The collection of information which identifies a specific phone or FAX number as defined by telecom services.
Schema: PhoneNumber
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).
Type: string
Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`
- emailAddressstring
email address of the contact
Constraints: maxLength: 2048 · pattern: `^.+@.+$`
- organisationIdGenericIdentification
Unique and unambiguous way to identify an organisation.
Schema: 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.
- identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70
- schemeNamestringrequired
Name of the identification scheme.
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. 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 Constraints: maxLength: 70
- issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
Constraints: maxLength: 35
- privateIdGenericIdentification
Unique and unambiguous identification of a person.
Schema: 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.
- identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70
- schemeNamestringrequired
Name of the identification scheme.
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. 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 Constraints: maxLength: 70
- issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
Constraints: maxLength: 35
- leiLeiIdentification
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Schema: LeiIdentification
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Type: string
Constraints: pattern: `^[A-Z0-9]{18,18}[0-9]{2,2}$`
- invoiceePartyIdentification
API : Description of a Party which can be either a person or an organization.
Schema: PartyIdentification
API : Description of a Party which can be either a person or an organization.
- namestringrequired
ISO20022: Name by which a party is known and which is usually used to identify that party.
ISO20022: Name by which a party is known and which is usually used to identify that party.
Constraints: maxLength: 140
- dateAndPlaceOfBirthDateAndPlaceOfBirth
Date and place of birth of a person.
Schema: 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.
Date on which a person is born.
- cityOfBirthstringrequired
City where a person was born.
Constraints: maxLength: 35
- countryOfBirthstringrequired
Country where a person was born.
Constraints: pattern: `^[A-Z]{2,2}$`
- postalAddressPostalAddress
ISO20022: Information that locates and identifies a specific address, as defined by postal services.
Schema: PostalAddress
ISO20022: Information that locates and identifies a specific address, as defined by postal services.
- addressTypestringenum · 6
ISO20022: Identifies the nature of the postal address.
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 BIZZBusiness Address is the business address DLVYDelivery Address is the address to which delivery is to take place MLTOMail To Address is the address to which mail is sent PBOXPO Box Address is is a postal office (PO) box ADDRPostal Address is the complete postal address HOMEBusiness Address is the home address - departmentstring
ISO20022: Identification of a division of a large organisation or building.
ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- subDepartmentstring
ISO20022: Identification of a sub-division of a large organisation or building.
ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- streetNamestring
ISO20022: Name of a street or thoroughfare.
ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- buildingNumberstring
ISO20022: Number that identifies the position of a building on a street.
ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- buildingNamestring
ISO20022: Name of the building or house.
ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- postCodestring
ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
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.
Constraints: maxLength: 16
- townNamestring
ISO20022: Name of a built-up area, with defined boundaries, and a local government.
ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
- countrySubDivisionstring
ISO20022: Identifies a subdivision of a country such as state, region, county.
ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
- countrystringrequired
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.
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.
Constraints: pattern: `^([A-Z]{2,2})$`
- addressLinearray<string>required
Unstructured address. The lines must embed zip code and town name.
Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.
Type: array<string>
Item: Address line
Item constraints: maxLength: 70
- contactDetailsContactDetails
Indicates how to contact the party.
Schema: ContactDetails
Indicates how to contact the party.
- phoneNumberPhoneNumber
The collection of information which identifies a specific phone or FAX number as defined by telecom services.
Schema: PhoneNumber
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).
Type: string
Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`
- faxNumberPhoneNumber
The collection of information which identifies a specific phone or FAX number as defined by telecom services.
Schema: PhoneNumber
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).
Type: string
Constraints: pattern: `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`
- emailAddressstring
email address of the contact
Constraints: maxLength: 2048 · pattern: `^.+@.+$`
- organisationIdGenericIdentification
Unique and unambiguous way to identify an organisation.
Schema: 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.
- identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70
- schemeNamestringrequired
Name of the identification scheme.
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. 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 Constraints: maxLength: 70
- issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
Constraints: maxLength: 35
- privateIdGenericIdentification
Unique and unambiguous identification of a person.
Schema: 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.
- identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70
- schemeNamestringrequired
Name of the identification scheme.
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. 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 Constraints: maxLength: 70
- issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
Constraints: maxLength: 35
- leiLeiIdentification
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Schema: LeiIdentification
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
Type: string
Constraints: pattern: `^[A-Z0-9]{18,18}[0-9]{2,2}$`
- taxRemittanceTaxInformation
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.
Schema: TaxInformation
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.
- creditorTaxParty
Set of elements used to identify a party of the transaction to which the tax applies.
Schema: TaxParty
Set of elements used to identify a party of the transaction to which the tax applies.
- taxIdentificationstring
Tax identification number of the party.
Constraints: maxLength: 35
- registrationIdentificationstring
Unique identification, as assigned by an organisation, to unambiguously identify a party.
Constraints: maxLength: 35
- taxTypestring
Type of tax payer.
Constraints: maxLength: 35
- debtorTaxParty
Set of elements used to identify a party of the transaction to which the tax applies.
Schema: TaxParty
Set of elements used to identify a party of the transaction to which the tax applies.
- taxIdentificationstring
Tax identification number of the party.
Constraints: maxLength: 35
- registrationIdentificationstring
Unique identification, as assigned by an organisation, to unambiguously identify a party.
Constraints: maxLength: 35
- taxTypestring
Type of tax payer.
Constraints: maxLength: 35
- ultimateDebtorTaxParty
Set of elements used to identify a party of the transaction to which the tax applies.
Schema: TaxParty
Set of elements used to identify a party of the transaction to which the tax applies.
- taxIdentificationstring
Tax identification number of the party.
Constraints: maxLength: 35
- registrationIdentificationstring
Unique identification, as assigned by an organisation, to unambiguously identify a party.
Constraints: maxLength: 35
- taxTypestring
Type of tax payer.
Constraints: maxLength: 35
- administrationZonestring
Territorial part of a country to which the tax payment is related.
Constraints: maxLength: 35
- referenceNumberstring
Tax reference information that is specific to a taxing agency.
Constraints: maxLength: 140
- methodstring
Method used to indicate the underlying business or how the tax is paid.
Constraints: maxLength: 35
- totalTaxableBaseAmountAmountType
Total amount of money on which the tax is based.
Schema: AmountType
Structure aiming to embed the amount and the currency to be used.
- amountnumber (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.
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.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
Specifies the currency of the amount or of the account.
Schema: CurrencyCode
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".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
- totalTaxAmountAmountType
Total amount of money as result of the calculation of the tax.
Schema: AmountType
Structure aiming to embed the amount and the currency to be used.
- amountnumber (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.
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.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
Specifies the currency of the amount or of the account.
Schema: CurrencyCode
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".
Type: string
Constraints: pattern: `^[A-Z]{3,3}$`
Date by which tax is due.
- sequenceNumbernumber (int32)
Sequential number of the tax report.
- recordarray<TaxRecord>
Records of tax details
Item: TaxRecord
Record of tax details
- typestring
High level code to identify the type of tax details.
Constraints: maxLength: 35
- categorystring
Specifies the tax code as published by the tax authority.
Constraints: maxLength: 35
- categoryDetailsstring
Provides further details of the category tax code.
Constraints: maxLength: 35
- debtorStatusstring
Code provided by local authority to identify the status of the party that has drawn up the settlement document.
Constraints: maxLength: 35
- certificateIdentificationstring
Identification number of the tax report as assigned by the taxing authority.
Constraints: maxLength: 35
- formsCodestring
Identifies, in a coded form, on which template the tax report is to be provided.
Constraints: maxLength: 35
- periodTaxPeriod
Set of elements used to provide details on the period of time related to the tax payment.
Schema: TaxPeriod
Set of elements used to provide details on the period of time related to the tax payment.
- yearstring (int32)
Year related to the tax payment.
- typeTaxRecordPeriodCode
Identification of the period related to the tax payment.
Schema: TaxRecordPeriodCode
Code Description MM01FirstMonth Tax is related to the second month of the period. MM02SecondMonth Tax is related to the first month of the period. MM03ThirdMonth Tax is related to the third month of the period. MM04FourthMonth Tax is related to the fourth month of the period. MM05FifthMonth Tax is related to the fifth month of the period. MM06SixthMonth Tax is related to the sixth month of the period. MM07SeventhMonth Tax is related to the seventh month of the period. MM08EighthMonth Tax is related to the eighth month of the period. MM09NinthMonth Tax is related to the ninth month of the period. MM10TenthMonth Tax is related to the tenth month of the period. MM11EleventhMonth Tax is related to the eleventh month of the period. MM12TwelfthMonth Tax is related to the twelfth month of the period. QTR1FirstQuarter Tax is related to the first quarter of the period. QTR2SecondQuarter Tax is related to the second quarter of the period. QTR3ThirdQuarter Tax is related to the third quarter of the period. QTR4FourthQuarter Tax is related to the fourth quarter of the period. HLF1FirstHalf Tax is related to the first half of the period. HLF2SecondHalf Tax is related to the second half of the period. Start date of the range.
End date of the range.
- taxAmountTaxAmount
Set of elements used to provide information on the amount of the tax record.
Schema: TaxAmount
Set of elements used to provide information on the amount of the tax record.
- ratePercentageRate
Rate used to calculate the tax.
Schema: PercentageRate
Rate expressed as a percentage, ie, in hundredths, eg, 0.7 is 7/10 of a percent, and 7.0 is 7%.
Type: number (float)
- taxableBaseAmountAmountType
Amount of money on which the tax is based.
Schema: AmountType
- totalAmountAmountType
Total amount that is the result of the calculation of the tax for the record.
Schema: AmountType
- detailsarray<TaxRecordDetails>
Set of elements used to provide details on the tax period and amount.
Item: TaxRecordDetails
- additionalInformationstring
Further details of the tax record.
Constraints: maxLength: 140
- transactionStatusTransactionIndividualStatusCode
ISO20022: Specifies the status of the payment information group.
Schema: TransactionIndividualStatusCode
Code Name Description ACSCAcceptedSettlementCompleted 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. ACSPAcceptedSettlementInProcess 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. ACTCAcceptedTechnicalValidation Authentication and syntactical and semantical validation are successful. The transaction might be cancelled. CANCCancelled Payment initiation was successfully cancelled after having received a request for cancellation. PDNGPending 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. RJCTRejected Payment request or individual transaction included in the Payment Request was rejected. - statusReasonInformationStatusReasonInformation
ISO20022: Provides detailed information on the status reason.
Schema: StatusReasonInformation
Code Name Description AC01IncorectAccountNumber the account number is either invalid or does not exist AC04ClosedAccountNumber the account is closed and cannot be used AC06BlockedAccount the account is blocked and cannot be used AG01Transaction forbidden Transaction forbidden on this type of account AM18InvalidNumberOfTransactions the number of transactions exceeds the ASPSP acceptance limit CH03RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture The requested execution date is too far in the future CUSTRequestedByCustomer The reject is due to the debtor: refusal or lack of liquidity DS02OrderCancelled An authorized user has cancelled the order DUPLDuplicatePayment Payment is a duplicate of another payment. Can only be set by a PISP for a payment request cancellation. FF01InvalidFileFormat The reject is due to the original Payment Request which is invalid (syntax, structure or values) FRADFraudulentOriginated the Payment Request is considered as fraudulent MS03NotSpecifiedReasonAgentGenerated No reason specified by the ASPSP NOASNoAnswerFromCustomer The PSU has neither accepted nor rejected the Payment Request and a time-out has occurred RR01MissingDebtorAccountOrIdentification The Debtor account and/or Identification are missing or inconsistent RR03MissingCreditorNameOrAddress Specification of the creditor’s name and/or address needed for regulatory requirements is insufficient or missing. RR04RegulatoryReason Reject from regulatory reason RR12InvalidPartyID Invalid or missing identification required within a particular country or payment type. TECHTechnicalProblem Technical problems resulting in an erroneous transaction. Can only be set by a PISP for a payment request cancellation. - supplementaryDataSupplementaryData
ISO20022: Additional information that cannot be captured in the structured elements and/or any other specific block.
Schema: 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
- acceptedAuthenticationApproachAuthenticationApproaches
Can only be set by the PISP.
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.
Schema: AuthenticationApproach
Code REDIRECTDECOUPLEDEMBEDDED-1-FACTORNONE - appliedAuthenticationApproachAppliedAuthenticationApproach
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.
Schema: AppliedAuthenticationApproach
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".
Type: object
- appliedAuthenticationstringenum · 3
Can only be set by the ASPSP.
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.
Code noAuthenticationoneFactorAuthenticationstrongAuthentication - scaHintstringenum · 2
can only be set by the PISP
can only be set by the PISP Hint given by the merchant and/or the PISP about an SCA exemption context
Code noScaExemptionscaExemption - successfulReportUrlstring
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
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
- unsuccessfulReportUrlstring
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
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
- _linksCreditTransferTransactionLinksrequired
links that can be used for further navigation when retrieving the transaction of a payment request.
Schema: CreditTransferTransactionLinks
links that can be used for further navigation when retrieving the transaction of a payment request.
- selfGenericLink
hypertext reference
Schema: GenericLink
hypertext reference
- hrefstringrequired
URI to be used. HREF stands for Hypertext REFerence.
Constraints: maxLength: 2000
- templatedboolean
specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false
- parentGenericLink
This link shall point to the parent payment request.
This link shall point to the parent payment request.
Schema: GenericLink
hypertext reference
- hrefstringrequired
URI to be used. HREF stands for Hypertext REFerence.
Constraints: maxLength: 2000
- templatedboolean
specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false
- firstGenericLink
hypertext reference
Schema: GenericLink
hypertext reference
- hrefstringrequired
URI to be used. HREF stands for Hypertext REFerence.
Constraints: maxLength: 2000
- templatedboolean
specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false
- lastGenericLink
hypertext reference
Schema: GenericLink
hypertext reference
- hrefstringrequired
URI to be used. HREF stands for Hypertext REFerence.
Constraints: maxLength: 2000
- templatedboolean
specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false
- nextGenericLink
hypertext reference
Schema: GenericLink
hypertext reference
- hrefstringrequired
URI to be used. HREF stands for Hypertext REFerence.
Constraints: maxLength: 2000
- templatedboolean
specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false
- prevGenericLink
hypertext reference
Schema: GenericLink
hypertext reference
- hrefstringrequired
URI to be used. HREF stands for Hypertext REFerence.
Constraints: maxLength: 2000
- templatedboolean
specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false
400
Invalid status value
Error400Model
Specific 400 error report structure
Fields (6)
current timestamp
- statusinteger (int32)required
HTTP error code
- errorstring
HTTP error text
Constraints: maxLength: 140
- messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
- pathstring
Relevant path that was used
Constraints: maxLength: 140
- acceptedAuthenticationApproachAuthenticationApproaches
Can only be set by the ASPSP
Can only be set by the ASPSP Authentication approaches that are supported by the ASPSP. The PISP can provide several choices separated by commas.
Schema: AuthenticationApproach
Code REDIRECTDECOUPLEDEMBEDDED-1-FACTORNONE
401
Unauthorized, authentication failure.
ErrorModel
Generic error report structure
Fields (5)
current timestamp
- statusinteger (int32)required
HTTP error code
- errorstring
HTTP error text
Constraints: maxLength: 140
- messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
- pathstring
Relevant path that was used
Constraints: maxLength: 140
403
Forbidden, authentication successful but access to resource is not allowed.
ErrorModel
Generic error report structure
Fields (5)
current timestamp
- statusinteger (int32)required
HTTP error code
- errorstring
HTTP error text
Constraints: maxLength: 140
- messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
- pathstring
Relevant path that was used
Constraints: maxLength: 140
405
Method Not Allowed.
ErrorModel
Generic error report structure
Fields (5)
current timestamp
- statusinteger (int32)required
HTTP error code
- errorstring
HTTP error text
Constraints: maxLength: 140
- messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
- pathstring
Relevant path that was used
Constraints: maxLength: 140
406
Not Acceptable.
ErrorModel
Generic error report structure
Fields (5)
current timestamp
- statusinteger (int32)required
HTTP error code
- errorstring
HTTP error text
Constraints: maxLength: 140
- messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
- pathstring
Relevant path that was used
Constraints: maxLength: 140
408
Request Timeout.
ErrorModel
Generic error report structure
Fields (5)
current timestamp
- statusinteger (int32)required
HTTP error code
- errorstring
HTTP error text
Constraints: maxLength: 140
- messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
- pathstring
Relevant path that was used
Constraints: maxLength: 140
409
Conflict. The request could not be completed due to a conflict with the current state of the target resource.
ErrorModel
Generic error report structure
Fields (5)
current timestamp
- statusinteger (int32)required
HTTP error code
- errorstring
HTTP error text
Constraints: maxLength: 140
- messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
- pathstring
Relevant path that was used
Constraints: maxLength: 140
429
Too many requests.
ErrorModel
Generic error report structure
Fields (5)
current timestamp
- statusinteger (int32)required
HTTP error code
- errorstring
HTTP error text
Constraints: maxLength: 140
- messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
- pathstring
Relevant path that was used
Constraints: maxLength: 140
500
Internal server error.
ErrorModel
Generic error report structure
Fields (5)
current timestamp
- statusinteger (int32)required
HTTP error code
- errorstring
HTTP error text
Constraints: maxLength: 140
- messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
- pathstring
Relevant path that was used
Constraints: maxLength: 140
503
Service unavailable.
ErrorModel
Generic error report structure
Fields (5)
current timestamp
- statusinteger (int32)required
HTTP error code
- errorstring
HTTP error text
Constraints: maxLength: 140
- messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
- pathstring
Relevant path that was used
Constraints: maxLength: 140
Schemas used by this endpoint
Every structure referenced by this operation, listed once. Cross-references resolve to anchors on this page.
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).
Fields (4)
- workspacestring
Workspace to which the account is linked.
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.
Constraints: maxLength: 32
- ibanstring
ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer.
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.
Constraints: pattern: `^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$`
- otherGenericIdentification
Schema: GenericIdentification
Currency used for the account
Schema: CurrencyCode
AmountType
Structure aiming to embed the amount and the currency to be used.
Fields (2)
- amountnumber (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.
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.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
Schema: CurrencyCode
AppliedAuthenticationApproach
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".
AuthenticationApproach
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 EMBEDDED-1-FACTOR: the TPP identifies the PSU and forwards the identification to the ASPSP which starts the authentication. The TPP forwards one authentication factor of the PSU (e.g. OTP or response to a challenge) NONE: there is no need for the PSU to authenticate
| Code |
|---|
REDIRECT |
DECOUPLED |
EMBEDDED-1-FACTOR |
NONE |
AuthenticationApproaches
List of authentication approaches
Items: AuthenticationApproach
Beneficiary
Specification of a beneficiary
Fields (6)
- workspaceWorkspace
Schema: Workspace
- idstring
Id of the beneficiary
Constraints: pattern: `^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$`
- isTrustedboolean
The ASPSP having not implemented the trusted beneficiaries list must not set this flag.
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
- creditorAgentFinancialInstitutionIdentification
- creditorPartyIdentificationrequired
Schema: PartyIdentification
- creditorAccountAccountIdentification
Schema: AccountIdentification
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
Fields (2)
- clearingSystemIdstring
ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.
ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.
Constraints: maxLength: 35
- memberIdstring
ISO20022: Identification of a member of a clearing system.
ISO20022: Identification of a member of a clearing system.
Constraints: maxLength: 35
CodeAndIssuer
Specifies a code and the issuer of this code.
Fields (2)
- codestringrequired
Provides the code.
Constraints: maxLength: 4
- issuerstring
Identification of the issuer of the code.
Constraints: maxLength: 35
ContactDetails
Indicates how to contact the party.
Fields (3)
- phoneNumberPhoneNumber
Schema: PhoneNumber
- faxNumberPhoneNumber
Schema: PhoneNumber
- emailAddressstring
email address of the contact
Constraints: maxLength: 2048 · pattern: `^.+@.+$`
CreditDebitIndicator
Accounting flow of the amount
| Code | Description |
|---|---|
CRDT | Credit type amount |
DBIT | Debit type amount |
CreditorReferenceInformation
Reference information provided by the creditor to allow the identification of the underlying documents.
Fields (2)
- typeCodeAndIssuer
Schema: CodeAndIssuer
- referencestring
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Constraints: maxLength: 35
CreditTransferTransactionLinks
links that can be used for further navigation when retrieving the transaction of a payment request.
Fields (6)
- selfGenericLink
Schema: GenericLink
- parentGenericLink
This link shall point to the parent payment request.
This link shall point to the parent payment request.
Schema: GenericLink
- firstGenericLink
Schema: GenericLink
- lastGenericLink
Schema: GenericLink
- nextGenericLink
Schema: GenericLink
- prevGenericLink
Schema: GenericLink
CreditTransferTransactionResource
ISO20022: Payment processes required to transfer cash from the debtor to the creditor. API:
Fields (22)
- paymentIdPaymentIdentificationrequired
Schema: PaymentIdentification
- resourceIdResourceId
Schema: ResourceId
- requestedExecutionDateRequestedExecutionDaterequired
Schema: RequestedExecutionDate
This field may allow the PISP to get information on the limit timestamp for requesting cancelation of the transaction.
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.
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.
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.
ISO20022: Date and time on when the debtor has accepted or rejected the request.
ISO20022: Date and time on when the debtor has accepted or rejected the request.
ISO20022: Date and time on when the payment was executed.
ISO20022: Date and time on when the payment was executed.
- standingOrderCharacteristicsStandingOrderCharacteristics
Schema: StandingOrderCharacteristics
- instructedAmountAmountType
Schema: AmountType
- equivalentAmountEquivalentAmountType
Schema: EquivalentAmountType
- exchangeRateInformationExchangeRate
Schema: ExchangeRate
- ultimateDebtorPartyIdentification
Schema: PartyIdentification
- intermediaryAgentIntermediaryAgent
Schema: IntermediaryAgent
- beneficiaryBeneficiaryrequired
Schema: Beneficiary
- ultimateCreditorPartyIdentification
Schema: PartyIdentification
- instructionForCreditorAgentarray<InstructionForCreditorAgent>
Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.
- purposePurposeCode
Schema: PurposeCode
- regulatoryReportingCodesRegulatoryReportingCodes
Schema: RegulatoryReportingCodes
- remittanceInformationRemittanceInformation
Schema: RemittanceInformation
- transactionStatusTransactionIndividualStatusCode
Schema: TransactionIndividualStatusCode
- statusReasonInformationStatusReasonInformation
Schema: StatusReasonInformation
- supplementaryDataSupplementaryData
Schema: SupplementaryData
CurrencyCode
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".
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.
Fields (3)
Date on which a person is born.
- cityOfBirthstringrequired
City where a person was born.
Constraints: maxLength: 35
- countryOfBirthstringrequired
Country where a person was born.
Constraints: pattern: `^[A-Z]{2,2}$`
DocumentAdjustment
Specifies detailed information on the amount and reason of the adjustment.
Fields (4)
- amountAmountTyperequired
Schema: AmountType
- creditDebitIndicatorCreditDebitIndicator
Schema: CreditDebitIndicator
- reasonstring
Specifies the reason for the adjustment.
Constraints: maxLength: 4
- additionalInformationstring
Provides further details on the document adjustment.
Constraints: maxLength: 140
DocumentLineIdentification
Provides identification of the document line.
Fields (3)
- typeCodeAndIssuer
Specifies the type of referred document type.
Specifies the type of referred document type.
Schema: CodeAndIssuer
- numberstring
Unique and unambiguous identification of the referred document line.
Constraints: maxLength: 35
EndDate
The last applicable day of execution for a given standing order. If not given, the standing order is considered as endless.
EndToEndId
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.
EquivalentAmountType
Structure aiming to embed the amount and the currency to be used. The currency of transfer should be set.
Fields (3)
- amountnumber (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.
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.
Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`
Schema: CurrencyCode
- currencyOfTransferCurrencyCoderequired
Schema: CurrencyCode
Error400Model
Specific 400 error report structure
Fields (6)
current timestamp
- statusinteger (int32)required
HTTP error code
- errorstring
HTTP error text
Constraints: maxLength: 140
- messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
- pathstring
Relevant path that was used
Constraints: maxLength: 140
- acceptedAuthenticationApproachAuthenticationApproaches
Can only be set by the ASPSP
Can only be set by the ASPSP Authentication approaches that are supported by the ASPSP. The PISP can provide several choices separated by commas.
Schema: AuthenticationApproaches
ErrorModel
Generic error report structure
Fields (5)
current timestamp
- statusinteger (int32)required
HTTP error code
- errorstring
HTTP error text
Constraints: maxLength: 140
- messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
- pathstring
Relevant path that was used
Constraints: maxLength: 140
ExchangeRate
Provides details on the currency exchange rate and contract.
Fields (6)
- unitCurrencyCurrencyCode
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
Schema: CurrencyCode
- exchangeRatenumber (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.
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.
- rateTypestringenum · 3
Specifies the type used to complete the currency exchange.
Code Name Description SPOTSpot Exchange rate applied is the spot rate. SALESale Exchange rate applied is the market rate at the time of the sale. AGRDAgreed Exchange rate applied is the rate agreed between the parties. - contractIdentificationstring
Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
Constraints: maxLength: 35
- estimatedPayerAmountAmountType
Estimation of the amount that will be debited on the payer's account, including transaction and change fees.
Schema: AmountType
- estimatedPayeeAmountAmountType
Estimation of the amount that will be credited on the payee's account.
Schema: AmountType
ExecutionRule
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 |
FinancialInstitutionIdentification
ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.
Fields (4)
- bicFistringrequired
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)".
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)".
Constraints: pattern: `^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$`
- clearingSystemMemberIdClearingSystemMemberIdentification
- namestring
Name of the financial institution
Constraints: maxLength: 140
- postalAddressPostalAddress
Schema: PostalAddress
FrequencyCode
Frequency rule for standing orders. The following codes from the "EventFrequency7Code" of ISO 20022 are supported. However, each ASPSP might restrict these values into a subset if needed.
| Code | Description |
|---|---|
DAIL | Daily |
WEEK | Weekly |
TOWK | EveryTwoWeeks |
MNTH | Monthly |
TOMN | EveryTwoMonths |
QUTR | Quarterly |
SEMI | SemiAnnual |
YEAR | Annual |
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.
Fields (3)
- identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70
- schemeNamestringrequired
Name of the identification scheme.
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. 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 Constraints: maxLength: 70
- issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
Constraints: maxLength: 35
GenericLink
hypertext reference
Fields (2)
- hrefstringrequired
URI to be used. HREF stands for Hypertext REFerence.
Constraints: maxLength: 2000
- templatedboolean
specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false
HalCreditTransfertTransactions
HYPERMEDIA structure used for returning the transactions of a given payment request to the PISP
Fields (2)
- creditTransferTransactionarray<CreditTransferTransactionResource>required
ISO20022: Payment processes required to transfer cash from the debtor to the creditor.
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
- _linksCreditTransferTransactionLinksrequired
Schema: CreditTransferTransactionLinks
InstructionForCreditorAgent
Further information related to the processing of the payment instruction that may need to be acted upon by the creditor's agent. The instruction may relate to a level of service, or may be an instruction that has to be executed by the creditor's agent, or may be information required by the creditor's agent.
Fields (2)
- codestringenum · 4
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 CHQBPayCreditorByCheque (Ultimate) creditor must be paid by cheque. HOLDHoldCashForCreditor Amount of money must be held for the (ultimate) creditor, who will call. Pay on identification. PHOBPhoneBeneficiary Please advise/contact (ultimate) creditor/claimant by phone. TELBTelecom Please advise/contact (ultimate) creditor/claimant by the most efficient means of telecommunication. - instructionInformationstring
Further information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.
Constraints: maxLength: 140
IntermediaryAgent
Agent and agent account between the debtor's agent and the creditor's agent.
Fields (2)
- agentPartyIdentification
Schema: PartyIdentification
- agentAccountAccountIdentification
Schema: AccountIdentification
LeiIdentification
Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
LineDetail
Set of elements used to provide the content of the referred document line.
Fields (3)
- identificationDocumentLineIdentification
Schema: DocumentLineIdentification
- descriptionstring
Description associated with the document line.
Constraints: maxLength: 2048
- amountRemittanceAmount
Schema: RemittanceAmount
PartyIdentification
API : Description of a Party which can be either a person or an organization.
Fields (7)
- namestringrequired
ISO20022: Name by which a party is known and which is usually used to identify that party.
ISO20022: Name by which a party is known and which is usually used to identify that party.
Constraints: maxLength: 140
- dateAndPlaceOfBirthDateAndPlaceOfBirth
Schema: DateAndPlaceOfBirth
- postalAddressPostalAddress
Schema: PostalAddress
- contactDetailsContactDetails
Schema: ContactDetails
- organisationIdGenericIdentification
Unique and unambiguous way to identify an organisation.
Schema: GenericIdentification
- privateIdGenericIdentification
Unique and unambiguous identification of a person.
Schema: GenericIdentification
- leiLeiIdentification
Schema: LeiIdentification
PaymentIdentification
ISO20022: Set of elements used to reference a payment instruction.
Fields (3)
- instructionIdstringrequired
ISO20022: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
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
Constraints: pattern: `^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$`
- endToEndIdEndToEndId
Schema: EndToEndId
- uetrstring
ISO20022: Universally unique identifier to provide an end-to-end reference of a payment transaction.
ISO20022: Universally unique identifier to provide an end-to-end reference of a payment transaction.
Constraints: pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$`
PercentageRate
Rate expressed as a percentage, ie, in hundredths, eg, 0.7 is 7/10 of a percent, and 7.0 is 7%.
PhoneNumber
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).
PostalAddress
ISO20022: Information that locates and identifies a specific address, as defined by postal services.
Fields (11)
- addressTypestringenum · 6
ISO20022: Identifies the nature of the postal address.
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 BIZZBusiness Address is the business address DLVYDelivery Address is the address to which delivery is to take place MLTOMail To Address is the address to which mail is sent PBOXPO Box Address is is a postal office (PO) box ADDRPostal Address is the complete postal address HOMEBusiness Address is the home address - departmentstring
ISO20022: Identification of a division of a large organisation or building.
ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- subDepartmentstring
ISO20022: Identification of a sub-division of a large organisation or building.
ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- streetNamestring
ISO20022: Name of a street or thoroughfare.
ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
- buildingNumberstring
ISO20022: Number that identifies the position of a building on a street.
ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- buildingNamestring
ISO20022: Name of the building or house.
ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
- postCodestring
ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
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.
Constraints: maxLength: 16
- townNamestring
ISO20022: Name of a built-up area, with defined boundaries, and a local government.
ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
- countrySubDivisionstring
ISO20022: Identifies a subdivision of a country such as state, region, county.
ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
- countrystringrequired
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.
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.
Constraints: pattern: `^([A-Z]{2,2})$`
- addressLinearray<string>required
Unstructured address. The lines must embed zip code and town name.
Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.
Type: array<string>
Item: Address line
Item constraints: maxLength: 70
PurposeCode
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. |
TRPT | RoadPricing | Transport RoadPricing Transaction is for the payment to top-up pre-paid card and electronic road pricing for the purpose of transportation. |
ReferredDocumentInformation
Provides the identification and the content of the referred document.
Fields (4)
- typeCodeAndIssuer
Schema: CodeAndIssuer
- numberstring
Unique and unambiguous identification of the referred document.
Constraints: maxLength: 35
- lineDetailsarray<LineDetail>
Sets of elements used to provide the content of the referred document line.
Item: LineDetail
ReferredDocumentInformations
Provides the identification and the content of the referred documents.
Items: ReferredDocumentInformation
RegulatoryReportingCode
Information needed due to regulatory and statutory requirements. Economical codes to be used are provided by the National Competent Authority
RegulatoryReportingCodes
List of needed regulatory reporting codes for international payments
Items: RegulatoryReportingCode
RemittanceAmount
Provides details on the amounts of the document line.
Fields (6)
- duePayableAmountAmountType
Amount specified is the exact amount due and payable to the creditor.
Schema: AmountType
- discountAppliedAmountTypedAmount
Amount of discount to be applied to the amount due and payable to the creditor.
Schema: TypedAmount
- creditNoteAmountAmountType
Amount of a credit note.
Schema: AmountType
- taxAmountTypedAmount
Amount of the tax.
Schema: TypedAmount
- adjustmentAmountAndReasonDocumentAdjustment
Specifies detailed information on the amount and reason of the adjustment.
Schema: DocumentAdjustment
- remittedAmountAmountType
Amount of money remitted.
Schema: AmountType
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.
Fields (2)
- unstructuredarray<string>
Unstructured remittance information
Type: array<string>
Item: Relevant information to the transaction
Item constraints: maxLength: 140
- structuredarray<StructuredRemittanceInformation>
Structured remittance information
RequestedExecutionDate
ISO20022: Date at which the initiating party requests the clearing agent to process the payment. API: This field indicates the date at which the debtor account should be debited. 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. This date can be used in the following cases:
- the single requested execution date for a payment having several instructions. In this case, this field must be set at the payment level.
- the requested execution date for a given instruction within a payment. In this case, this field must be set at each instruction level.
- The first date of execution for a standing order. When the payment cannot be processed at this date, the ASPSP is allowed to shift the applied execution date to the next possible execution date for non-standing orders. For standing orders, the [executionRule] parameter helps to compute the execution date to be applied.
ResourceId
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.
StandingOrderCharacteristics
Specifies the characteristics of a standing order.
Fields (4)
- startDateStartDaterequired
Schema: StartDate
- endDateEndDate
Schema: EndDate
- executionRuleExecutionRulerequired
Schema: ExecutionRule
- frequencyFrequencyCoderequired
Schema: FrequencyCode
StartDate
The first applicable day of execution for a given standing order.
StatusReasonInformation
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 | Transaction forbidden | Transaction forbidden on this type of account |
AM18 | InvalidNumberOfTransactions | the number of transactions exceeds the ASPSP acceptance limit |
CH03 | RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture | The requested execution date is too far in the future |
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. |
StructuredRemittanceInformation
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in a structured form.
Fields (6)
- referredDocumentInformationReferredDocumentInformations
Schema: ReferredDocumentInformations
- referredDocumentAmountRemittanceAmount
Schema: RemittanceAmount
- creditorReferenceInformationCreditorReferenceInformation
Schema: CreditorReferenceInformation
- invoicerPartyIdentification
Schema: PartyIdentification
- invoiceePartyIdentification
Schema: PartyIdentification
- taxRemittanceTaxInformation
Schema: TaxInformation
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
Fields (6)
- acceptedAuthenticationApproachAuthenticationApproaches
Can only be set by the PISP.
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.
Schema: AuthenticationApproaches
- appliedAuthenticationApproachAppliedAuthenticationApproach
Schema: AppliedAuthenticationApproach
- appliedAuthenticationstringenum · 3
Can only be set by the ASPSP.
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.
Code noAuthenticationoneFactorAuthenticationstrongAuthentication - scaHintstringenum · 2
can only be set by the PISP
can only be set by the PISP Hint given by the merchant and/or the PISP about an SCA exemption context
Code noScaExemptionscaExemption - successfulReportUrlstring
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
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
- unsuccessfulReportUrlstring
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
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
TaxAmount
Set of elements used to provide information on the amount of the tax record.
Fields (4)
- ratePercentageRate
Rate used to calculate the tax.
Schema: PercentageRate
- taxableBaseAmountAmountType
Amount of money on which the tax is based.
Schema: AmountType
- totalAmountAmountType
Total amount that is the result of the calculation of the tax for the record.
Schema: AmountType
- detailsarray<TaxRecordDetails>
Set of elements used to provide details on the tax period and amount.
Item: TaxRecordDetails
TaxInformation
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.
Fields (11)
- creditorTaxParty
Schema: TaxParty
- debtorTaxParty
Schema: TaxParty
- ultimateDebtorTaxParty
Schema: TaxParty
- administrationZonestring
Territorial part of a country to which the tax payment is related.
Constraints: maxLength: 35
- referenceNumberstring
Tax reference information that is specific to a taxing agency.
Constraints: maxLength: 140
- methodstring
Method used to indicate the underlying business or how the tax is paid.
Constraints: maxLength: 35
- totalTaxableBaseAmountAmountType
Total amount of money on which the tax is based.
Schema: AmountType
- totalTaxAmountAmountType
Total amount of money as result of the calculation of the tax.
Schema: AmountType
Date by which tax is due.
- sequenceNumbernumber (int32)
Sequential number of the tax report.
- recordarray<TaxRecord>
Records of tax details
Item: TaxRecord
TaxParty
Set of elements used to identify a party of the transaction to which the tax applies.
Fields (4)
- taxIdentificationstring
Tax identification number of the party.
Constraints: maxLength: 35
- registrationIdentificationstring
Unique identification, as assigned by an organisation, to unambiguously identify a party.
Constraints: maxLength: 35
- taxTypestring
Type of tax payer.
Constraints: maxLength: 35
TaxPeriod
Set of elements used to provide details on the period of time related to the tax payment.
Fields (4)
- yearstring (int32)
Year related to the tax payment.
- typeTaxRecordPeriodCode
Identification of the period related to the tax payment.
Schema: TaxRecordPeriodCode
Start date of the range.
End date of the range.
TaxRecord
Record of tax details
Fields (9)
- typestring
High level code to identify the type of tax details.
Constraints: maxLength: 35
- categorystring
Specifies the tax code as published by the tax authority.
Constraints: maxLength: 35
- categoryDetailsstring
Provides further details of the category tax code.
Constraints: maxLength: 35
- debtorStatusstring
Code provided by local authority to identify the status of the party that has drawn up the settlement document.
Constraints: maxLength: 35
- certificateIdentificationstring
Identification number of the tax report as assigned by the taxing authority.
Constraints: maxLength: 35
- formsCodestring
Identifies, in a coded form, on which template the tax report is to be provided.
Constraints: maxLength: 35
- periodTaxPeriod
Set of elements used to provide details on the period of time related to the tax payment.
Schema: TaxPeriod
- taxAmountTaxAmount
Set of elements used to provide information on the amount of the tax record.
Schema: TaxAmount
- additionalInformationstring
Further details of the tax record.
Constraints: maxLength: 140
TaxRecordDetails
Elements used to provide details on the tax period and amount.
Fields (2)
- periodTaxPeriod
Set of elements used to provide details on the period of time related to the tax payment.
Schema: TaxPeriod
- amountAmountTyperequired
Underlying tax amount related to the specified period.
Schema: AmountType
TaxRecordPeriodCode
Identification of the period related to the tax payment.
| Code | Description |
|---|---|
MM01 | FirstMonth Tax is related to the second month of the period. |
MM02 | SecondMonth Tax is related to the first month of the period. |
MM03 | ThirdMonth Tax is related to the third month of the period. |
MM04 | FourthMonth Tax is related to the fourth month of the period. |
MM05 | FifthMonth Tax is related to the fifth month of the period. |
MM06 | SixthMonth Tax is related to the sixth month of the period. |
MM07 | SeventhMonth Tax is related to the seventh month of the period. |
MM08 | EighthMonth Tax is related to the eighth month of the period. |
MM09 | NinthMonth Tax is related to the ninth month of the period. |
MM10 | TenthMonth Tax is related to the tenth month of the period. |
MM11 | EleventhMonth Tax is related to the eleventh month of the period. |
MM12 | TwelfthMonth Tax is related to the twelfth month of the period. |
QTR1 | FirstQuarter Tax is related to the first quarter of the period. |
QTR2 | SecondQuarter Tax is related to the second quarter of the period. |
QTR3 | ThirdQuarter Tax is related to the third quarter of the period. |
QTR4 | FourthQuarter Tax is related to the fourth quarter of the period. |
HLF1 | FirstHalf Tax is related to the first half of the period. |
HLF2 | SecondHalf Tax is related to the second half of the period. |
TitleAndName
Title and Name of the party or the party's authorised reprensentative.
Fields (2)
- titlestring
Title or position of the party or the party's authorised reprensentative.
Constraints: maxLength: 35
- namestring
Name of the party or the party's authorised reprensentative.
Constraints: maxLength: 140
TransactionIndividualStatusCode
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. |
TypedAmount
Typed Amount
Fields (2)
- typestring
Type of the amount
Constraints: maxLength: 35
- amountAmountTyperequired
Schema: AmountType
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.
Fields (2)
- identificationstringrequired
identification of the workspace to be used as an optional query parameter for some AISP queries
Constraints: maxLength: 32
- labelstringrequired
textual description of the workspace as specified by the ASPSP in relationship wth the PSU
Constraints: maxLength: 128