Beneficiary
Specification of a beneficiary
Fields (6)
- 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
- clearingSystemIdstringrequired
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
- memberIdstringrequired
ISO20022: Identification of a member of a clearing system.
ISO20022: Identification of a member of a clearing system.
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}$`
- 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 HOMEHome 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>
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. The [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation. The [privateId] property allows the specification of an unique and unambiguous way to identify a person.
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 HOMEHome 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>
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
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. BBAN BBANIdentifier Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. COID CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) SREN SIREN The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. SRET SIRET The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. NIDN NationalIdentityNumber Number assigned by an authority to identify the national identity number of a person. Other values are also permitted, for instance: Code Name Description ---- ---- ----------- OAUT OAUTH2 OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU CPAN CardPan Card PAN MPAN MaskedPan Card PAN where some digits were replaced for security reason TPAN TokenizedPan Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field TBAN TokenizedIBAN Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used 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
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. BBAN BBANIdentifier Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. COID CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) SREN SIREN The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. SRET SIRET The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. NIDN NationalIdentityNumber Number assigned by an authority to identify the national identity number of a person. Other values are also permitted, for instance: Code Name Description ---- ---- ----------- OAUT OAUTH2 OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU CPAN CardPan Card PAN MPAN MaskedPan Card PAN where some digits were replaced for security reason TPAN TokenizedPan Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field TBAN TokenizedIBAN Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used 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). The currency used for the account, when needed, can be specified through the [currency] field.
- 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. BBAN BBANIdentifier Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. COID CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) SREN SIREN The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. SRET SIRET The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. NIDN NationalIdentityNumber Number assigned by an authority to identify the national identity number of a person. Other values are also permitted, for instance: Code Name Description ---- ---- ----------- OAUT OAUTH2 OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU CPAN CardPan Card PAN MPAN MaskedPan Card PAN where some digits were replaced for security reason TPAN TokenizedPan Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field TBAN TokenizedIBAN Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used 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
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}$`