get/payment-requests/{paymentRequestResourceId}

Schema: PaymentRequestResource

• resourceIdResourceId

  Schema: ResourceId

• paymentInformationIdPaymentInformationIdrequired

  Schema: PaymentInformationId

• batchBookingBatchBookingIndicator

  Schema: BatchBookingIndicator

• creationDateTimeCreationDateTimerequired

  Schema: CreationDateTime

• numberOfTransactionsintegerrequired

  ISO20022: Number of individual transactions contained in the message.

  ISO20022: Number of individual transactions contained in the message. API: Each ASPSP will specify a maximum value for this field taking into accounts its specificities about payment request handling

• initiatingPartyPartyIdentificationrequired

  Schema: PartyIdentification

  • 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

    Schema: DateAndPlaceOfBirth

    • birthDatestring (date)required

      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

    Schema: PostalAddress

    • 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
      BIZZ	Business	Address is the business address
      DLVY	Delivery	Address is the address to which delivery is to take place
      MLTO	Mail To	Address is the address to which mail is sent
      PBOX	PO Box	Address is is a postal office (PO) box
      ADDR	Postal	Address is the complete postal address
      HOME	Home	Address is the home address

      Code	Name	Description
      BIZZ	—	—
      DLVY	—	—
      MLTO	—	—
      PBOX	—	—
      ADDR	—	—
      HOME	—	—

    • 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.

  • contactDetailsContactDetails

    Schema: ContactDetails

    • phoneNumberPhoneNumber

      Schema: PhoneNumber

    • faxNumberPhoneNumber

      Schema: PhoneNumber

    • emailAddressstring

      email address of the contact

      Constraints: maxLength: 2048 · pattern: `^.+@.+$`

  • organisationIdGenericIdentification

    Schema: GenericIdentification

    • 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

    Schema: GenericIdentification

    • 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

    Schema: LeiIdentification

• acceptDebtorAccountChangeboolean

  indicator that the debtor account can be changed in the payment request by the ASPSP if needed

  indicator that the debtor account can be changed in the payment request by the ASPSP if needed

  • true: debtor account can be changed (default value)
  • false: debtor account cannot be changed
• acceptChargeHandlingChangeboolean

  indicator that the charge handling can be changed in the payment request by the ASPSP if needed

  indicator that the charge handling can be changed in the payment request by the ASPSP if needed

  • true: charge handling can be changed (default value)
  • false: charge handling cannot be changed
• acceptInstantPaymentDowngradeboolean

  Indicator that the requested instant SEPA Credit Transfer method can be downgraded by the ASPSP into a plain-vanilla SEPA Credit Transfer, when Instant SCT cannot apply or is refused by the PSU.

  Indicator that the requested instant SEPA Credit Transfer method can be downgraded by the ASPSP into a plain-vanilla SEPA Credit Transfer, when Instant SCT cannot apply or is refused by the PSU. Eventually, it is up to the ASPSP to downgrade or reject the payment. In case of a downgrade, the ASPSP will have to update de relevant field [LocalInstrument] and remove the "INST" value in order to keep the PISP informed.

  • true: payment method can be downgraded
  • false: payment method cannot be downgraded (default value)
• paymentTypeInformationPaymentTypeInformationrequired

  Schema: PaymentTypeInformation

  • instructionPriorityPriorityCode

    Schema: PriorityCode

  • serviceLevelServiceLevelCode

    Schema: ServiceLevelCode

  • localInstrumentLocalInstrumentCode

    Schema: LocalInstrumentCode

  • categoryPurposeCategoryPurposeCode

    Schema: CategoryPurposeCode

    Code	Name	Description
    CASH	CashManagementTransfer	Transaction is a general cash management instruction.
    CORT	TradeSettlementPayment	Transaction is related to settlement of a trade, e.g. a foreign exchange deal or a securities transaction.
    DVPM	DeliverAgainstPayment	Code used to pre-advise the account servicer of a forthcoming deliver against payment instruction.
    INTC	IntraCompanyPayment	Transaction is an intra-company payment, i.e. a payment between two companies belonging to the same group.
    SALA	SalaryPayment	Transaction is the payment of salaries.
    TREA	TreasuryPayment	Transaction is related to treasury operations. E.g. financial contract settlement.

• debtorPartyIdentification

  Schema: PartyIdentification

  • 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

    Schema: DateAndPlaceOfBirth

    • birthDatestring (date)required

      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

    Schema: PostalAddress

    • 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
      BIZZ	Business	Address is the business address
      DLVY	Delivery	Address is the address to which delivery is to take place
      MLTO	Mail To	Address is the address to which mail is sent
      PBOX	PO Box	Address is is a postal office (PO) box
      ADDR	Postal	Address is the complete postal address
      HOME	Home	Address is the home address

      Code	Name	Description
      BIZZ	—	—
      DLVY	—	—
      MLTO	—	—
      PBOX	—	—
      ADDR	—	—
      HOME	—	—

    • 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.

  • contactDetailsContactDetails

    Schema: ContactDetails

    • phoneNumberPhoneNumber

      Schema: PhoneNumber

    • faxNumberPhoneNumber

      Schema: PhoneNumber

    • emailAddressstring

      email address of the contact

      Constraints: maxLength: 2048 · pattern: `^.+@.+$`

  • organisationIdGenericIdentification

    Schema: GenericIdentification

    • 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

    Schema: GenericIdentification

    • 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

    Schema: LeiIdentification

• debtorAccountAccountIdentification

  Schema: AccountIdentification

  • 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

    • 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

  • currencyCurrencyCode

    Schema: CurrencyCode

• debtorAgentFinancialInstitutionIdentification

  Schema: FinancialInstitutionIdentification

  • 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

    Schema: ClearingSystemMemberIdentification

    • 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

    Schema: LeiIdentification

  • namestring

    Name of the financial institution

    Constraints: maxLength: 140

  • postalAddressPostalAddress

    Schema: PostalAddress

    • 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
      BIZZ	Business	Address is the business address
      DLVY	Delivery	Address is the address to which delivery is to take place
      MLTO	Mail To	Address is the address to which mail is sent
      PBOX	PO Box	Address is is a postal office (PO) box
      ADDR	Postal	Address is the complete postal address
      HOME	Home	Address is the home address

      Code	Name	Description
      BIZZ	—	—
      DLVY	—	—
      MLTO	—	—
      PBOX	—	—
      ADDR	—	—
      HOME	—	—

    • 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.

• chargeBearerChargeBearerCode

  Schema: ChargeBearerCode

  Code	Name	Description
  DEBT	BorneByDebtor	All transaction charges are to be borne by the debtor.
  CRED	BorneByCreditor	All transaction charges are to be borne by the creditor.
  SHAR	Shared	In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor.
  SLEV	FollowingServiceLevel	Charges are to be applied following the rules agreed in the service level and/or scheme.

• paymentInformationStatusPaymentInformationStatusCode

  Schema: PaymentInformationStatusCode

  Code	Name	Description
  ACCO	AcceptedCustomerCOnfirmed	The customer, during his/her authentication, has confirmed the payment request.
  ACCP	AcceptedCustomerProfile	Preceding check of technical validation was successful. Customer profile check was also successful.
  ACSC	AcceptedSettlementCompleted	Settlement on the debtor's account 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.
  ACSP	AcceptedSettlementInProcess	All preceding checks such as technical validation and customer profile were successful. Dynamic risk assessment is now also successful and therefore the Payment Request was accepted for execution.
  ACTC	AcceptedTechnicalValidation	Authentication and syntactical and semantical validation are successful.
  ACWC	AcceptedWithChange	Instruction is accepted but a change will be made, such as date or remittance not sent.
  ACWP	AcceptedWithoutPosting	Payment instruction included in the credit transfer is accepted without being posted to the creditor customer's account.
  CANC	Cancelled	Payment initiation was successfully cancelled after having received a request for cancellation.
  PART	PartiallyAccepted	A number of transactions were accepted, whereas another number of transactions have not yet achieved 'accepted' status.
  PATC	PartiallyAcceptedTechnicalCorrect	Payment initiation needs multiple authentications, where some but not yet all were performed. Syntactical and semantical validations are successful.
  RCVD	Received	Payment initiation was received by the receiving agent.
  PDNG	Pending	Payment request or individual transaction included in the Payment Request is pending. Further checks and status update will be performed.
  RJCT	Rejected	Payment request was rejected.

• statusReasonInformationStatusReasonInformation

  Schema: StatusReasonInformation

  Code	Name	Description
  AC01	IncorectAccountNumber	the account number is either invalid or does not exist
  AC04	ClosedAccountNumber	the account is closed and cannot be used
  AC06	BlockedAccount	the account is blocked and cannot be used
  AG01	TransactionForbidden	Transaction forbidden on this type of account
  AG03	TransactionNotSupported	Transaction type not supported/authorized on this account
  AM02	NotAllowedAccount	SPecific transaction/message amount is greater than allowed maximum
  AM04	InsufficientFunds	Amount of funds available to cover specified message amount is insufficient
  AM18	InvalidNumberOfTransactions	the number of transactions exceeds the ASPSP acceptance limit
  CH03	RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture	The requested execution date is too far in the future
  CH04	RequestedExecutionDateOrRequestedCollectionDateTooFarInPast	Value in Requested Execution Date or Requested Collection Date is too far in the past
  CNOR	CreditorBankIsNotRegistered	Creditor bank is not registered under this BIC in the CSM
  CUST	RequestedByCustomer	The reject is due to the debtor: refusal or lack of liquidity
  DS02	OrderCancelled	An authorized user has cancelled the order
  DUPL	DuplicatePayment	Payment is a duplicate of another payment. Can only be set by a PISP for a payment request cancellation.
  FF01	InvalidFileFormat	The reject is due to the original Payment Request which is invalid (syntax, structure or values)
  FRAD	FraudulentOriginated	the Payment Request is considered as fraudulent
  MS03	NotSpecifiedReasonAgentGenerated	No reason specified by the ASPSP
  NOAS	NoAnswerFromCustomer	The PSU has neither accepted nor rejected the Payment Request and a time-out has occurred
  RR01	MissingDebtorAccountOrIdentification	The Debtor account and/or Identification are missing or inconsistent
  RR03	MissingCreditorNameOrAddress	Specification of the creditor's name and/or address needed for regulatory requirements is insufficient or missing.
  RR04	RegulatoryReason	Reject from regulatory reason
  RR12	InvalidPartyID	Invalid or missing identification required within a particular country or payment type.
  TECH	TechnicalProblem	Technical problems resulting in an erroneous transaction. Can only be set by a PISP for a payment request cancellation.

• fundsAvailabilityFundsAvailabilityInformation

  Schema: FundsAvailabilityInformation

• bookingBookingInformation

  Schema: BookingInformation

• 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

  • paymentIdPaymentIdentificationrequired

    Schema: PaymentIdentification

    • 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}$`

  • resourceIdResourceId

    Schema: ResourceId

  • requestedExecutionDateRequestedExecutionDate

    Schema: RequestedExecutionDate

  • cancellableTillstring (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.

  • acceptanceDateTimestring (date-time)

    ISO20022: Date and time at which all processing conditions for execution of the payment are met and adequate financial cover is available at the account servicing agent.

    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.

  • debtorDecisionDatestring (date-time)

    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.

  • appliedExecutionDatestring (date-time)

    ISO20022: Date and time on when the payment was executed.

    ISO20022: Date and time on when the payment was executed.

  • standingOrderCharacteristicsStandingOrderCharacteristics

    Schema: StandingOrderCharacteristics

    • startDateStartDaterequired

      Schema: StartDate

    • endDateEndDate

      Schema: EndDate

    • executionRuleExecutionRulerequired

      Schema: ExecutionRule

    • frequencyFrequencyCoderequired

      Schema: FrequencyCode

  • instructedAmountAmountType

    Schema: AmountType

    • 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}$`

    • currencyCurrencyCoderequired

      Schema: CurrencyCode

  • equivalentAmountEquivalentAmountType

    Schema: EquivalentAmountType

    • 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}$`

    • currencyCurrencyCoderequired

      Schema: CurrencyCode

    • currencyOfTransferCurrencyCoderequired

      Schema: CurrencyCode

  • exchangeRateInformationExchangeRate

    Schema: ExchangeRate

    • unitCurrencyCurrencyCode

      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.

    • rateTypestringrequiredenum · 3

      Specifies the type used to complete the currency exchange.

      Specifies the type used to complete the currency exchange.

      Code	Name	Description
      SPOT	Spot	Exchange rate applied is the spot rate.
      SALE	Sale	Exchange rate applied is the market rate at the time of the sale.
      AGRD	Agreed	Exchange rate applied is the rate agreed between the parties.

      Code	Name	Description
      SPOT	—	—
      SALE	—	—
      AGRD	—	—

    • contractIdentificationstring

      Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

      Constraints: maxLength: 35

    • estimatedPayerAmountAmountType

      Schema: AmountType

    • estimatedPayeeAmountAmountType

      Schema: AmountType

  • ultimateDebtorPartyIdentification

    Schema: PartyIdentification

    • 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

      Schema: DateAndPlaceOfBirth

    • postalAddressPostalAddress

      Schema: PostalAddress

    • contactDetailsContactDetails

      Schema: ContactDetails

    • organisationIdGenericIdentification

      Schema: GenericIdentification

    • privateIdGenericIdentification

      Schema: GenericIdentification

    • leiLeiIdentification

      Schema: LeiIdentification

  • intermediaryAgentIntermediaryAgent

    Schema: IntermediaryAgent

    • agentPartyIdentification

      Schema: PartyIdentification

    • agentAccountAccountIdentification

      Schema: AccountIdentification

  • beneficiaryBeneficiaryrequired

    Schema: Beneficiary

    • 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

      Schema: FinancialInstitutionIdentification

    • creditorPartyIdentificationrequired

      Schema: PartyIdentification

    • creditorAccountAccountIdentification

      Schema: AccountIdentification

  • ultimateCreditorPartyIdentification

    Schema: PartyIdentification

    • 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

      Schema: DateAndPlaceOfBirth

    • postalAddressPostalAddress

      Schema: PostalAddress

    • contactDetailsContactDetails

      Schema: ContactDetails

    • organisationIdGenericIdentification

      Schema: GenericIdentification

    • privateIdGenericIdentification

      Schema: GenericIdentification

    • leiLeiIdentification

      Schema: LeiIdentification

  • 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

    • codestringenum · 4

      Coded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.

      Coded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.

      Code	Name	Description
      CHQB	PayCreditorByCheque	(Ultimate) creditor must be paid by cheque.
      HOLD	HoldCashForCreditor	Amount of money must be held for the (ultimate) creditor, who will call. Pay on identification.
      PHOB	PhoneBeneficiary	Please advise/contact (ultimate) creditor/claimant by phone.
      TELB	Telecom	Please advise/contact (ultimate) creditor/claimant by the most efficient means of telecommunication.

      Code	Name	Description
      CHQB	—	—
      HOLD	—	—
      PHOB	—	—
      TELB	—	—

    • 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

    Schema: PurposeCode

    Code	Name	Description
    ACCT	AccountManagement	Funds moved between 2 accounts of same account holder at the same bank)
    CASH	CashManagementTransfer	(general cash management instruction) may be used for Transfer Initiation
    COMC	CommercialPayment	Transaction is related to a payment of commercial credit or debit.
    CPKC	CarparkCharges	General Carpark Charges Transaction is related to carpark charges.
    SALA	SalaryPayment	Transaction is the payment of salaries.
    TRPT	RoadPricing	Transport RoadPricing Transaction is for the payment to top-up pre-paid card and electronic road pricing for the purpose of transportation.

  • regulatoryReportingCodesRegulatoryReportingCodes

    Schema: RegulatoryReportingCodes

  • remittanceInformationRemittanceInformation

    Schema: RemittanceInformation

    • unstructuredarray<string>

      Unstructured remittance information.

      Unstructured remittance information. Each implementation may add a pattern in order to specify its own character set constraints.

    • structuredarray<StructuredRemittanceInformation>

      Structured remittance information

      Item schema: StructuredRemittanceInformation

  • transactionStatusTransactionIndividualStatusCode

    Schema: TransactionIndividualStatusCode

    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.

  • statusReasonInformationStatusReasonInformation

    Schema: StatusReasonInformation

    Code	Name	Description
    AC01	IncorectAccountNumber	the account number is either invalid or does not exist
    AC04	ClosedAccountNumber	the account is closed and cannot be used
    AC06	BlockedAccount	the account is blocked and cannot be used
    AG01	TransactionForbidden	Transaction forbidden on this type of account
    AG03	TransactionNotSupported	Transaction type not supported/authorized on this account
    AM02	NotAllowedAccount	SPecific transaction/message amount is greater than allowed maximum
    AM04	InsufficientFunds	Amount of funds available to cover specified message amount is insufficient
    AM18	InvalidNumberOfTransactions	the number of transactions exceeds the ASPSP acceptance limit
    CH03	RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture	The requested execution date is too far in the future
    CH04	RequestedExecutionDateOrRequestedCollectionDateTooFarInPast	Value in Requested Execution Date or Requested Collection Date is too far in the past
    CNOR	CreditorBankIsNotRegistered	Creditor bank is not registered under this BIC in the CSM
    CUST	RequestedByCustomer	The reject is due to the debtor: refusal or lack of liquidity
    DS02	OrderCancelled	An authorized user has cancelled the order
    DUPL	DuplicatePayment	Payment is a duplicate of another payment. Can only be set by a PISP for a payment request cancellation.
    FF01	InvalidFileFormat	The reject is due to the original Payment Request which is invalid (syntax, structure or values)
    FRAD	FraudulentOriginated	the Payment Request is considered as fraudulent
    MS03	NotSpecifiedReasonAgentGenerated	No reason specified by the ASPSP
    NOAS	NoAnswerFromCustomer	The PSU has neither accepted nor rejected the Payment Request and a time-out has occurred
    RR01	MissingDebtorAccountOrIdentification	The Debtor account and/or Identification are missing or inconsistent
    RR03	MissingCreditorNameOrAddress	Specification of the creditor's name and/or address needed for regulatory requirements is insufficient or missing.
    RR04	RegulatoryReason	Reject from regulatory reason
    RR12	InvalidPartyID	Invalid or missing identification required within a particular country or payment type.
    TECH	TechnicalProblem	Technical problems resulting in an erroneous transaction. Can only be set by a PISP for a payment request cancellation.

  • supplementaryDataSupplementaryData

    Schema: SupplementaryData

    • acceptedAuthenticationApproachAuthenticationApproaches

      Schema: AuthenticationApproaches

    • appliedAuthenticationApproachAuthenticationApproach

      Schema: AuthenticationApproach

    • 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	Name	Description
      noAuthentication	—	—
      oneFactorAuthentication	—	—
      strongAuthentication	—	—

    • 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	Name	Description
      noScaExemption	—	—
      scaExemption	—	—

    • 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

    • nextStatusRequestHintstring (date-time)

      Date and time at which the PISP is suggested to ask again for the status of the payment request.

      Date and time at which the PISP is suggested to ask again for the status of the payment request.

    • loginHintTokenstring

      The LOGIN_HINT_TOKEN is a piece of data that may be provided to the API client by the API server, once a PSU has been identified and authenticated.

      The LOGIN_HINT_TOKEN is a piece of data that may be provided to the API client by the API server, once a PSU has been identified and authenticated.

      • through a response to a token introspection request (RFC7662)
      • through a status response to a Payment Request This LOGIN_HINT_TOKEN can then be sent back by the API client to the API server through the posting of a new Payment request. This will help the API server to identify the relevant PSU and ease the authentication process.
  • investigationStatusboolean

    Boolean indicator aiming to clarify that the relevant transaction is under dispute investigation.

    Boolean indicator aiming to clarify that the relevant transaction is under dispute investigation.

• supplementaryDataSupplementaryDatarequired

  Schema: SupplementaryData

  • acceptedAuthenticationApproachAuthenticationApproaches

    Schema: AuthenticationApproaches

  • appliedAuthenticationApproachAuthenticationApproach

    Schema: AuthenticationApproach

  • 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	Name	Description
    noAuthentication	—	—
    oneFactorAuthentication	—	—
    strongAuthentication	—	—

  • 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	Name	Description
    noScaExemption	—	—
    scaExemption	—	—

  • 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

  • nextStatusRequestHintstring (date-time)

    Date and time at which the PISP is suggested to ask again for the status of the payment request.

    Date and time at which the PISP is suggested to ask again for the status of the payment request.

  • loginHintTokenstring

    The LOGIN_HINT_TOKEN is a piece of data that may be provided to the API client by the API server, once a PSU has been identified and authenticated.

    The LOGIN_HINT_TOKEN is a piece of data that may be provided to the API client by the API server, once a PSU has been identified and authenticated.

    • through a response to a token introspection request (RFC7662)
    • through a status response to a Payment Request This LOGIN_HINT_TOKEN can then be sent back by the API client to the API server through the posting of a new Payment request. This will help the API server to identify the relevant PSU and ease the authentication process.

Schema: PaymentRequestLinks

• requestGenericLink

  Schema: GenericLink

  • hrefstringrequired

    URI to be used. HREF stands for Hypertext REFerence.

    Constraints: maxLength: 2000

  • templatedboolean

    This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570.

    This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false

• confirmationGenericLink

  Schema: GenericLink

  • hrefstringrequired

    URI to be used. HREF stands for Hypertext REFerence.

    Constraints: maxLength: 2000

  • templatedboolean

    This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570.

    This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false

• transactionsGenericLink

  Schema: GenericLink

  • hrefstringrequired

    URI to be used. HREF stands for Hypertext REFerence.

    Constraints: maxLength: 2000

  • templatedboolean

    This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570.

    This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false

Item: ErrorDetail

• locationstringenum · 2

  Location of the erroneous parameter when not in request body

  Code	Name	Description
  header	—	—
  query	—	—

• namestring

  Name of the erroneous parameter when not in request body

• pathstring

  JsonPath of the erroneous request body property

• erroneousValuestring

  Erroneous parameter value

• messagestring

  Relevant message for the erroneous parameter

• expectedPatternstring

  Expected pattern, if any, that the erroneous parameter does not match with

• expectedValueRangeobject

  Expected value range, if any, that the erroneous parameter does not match with

• expectedValueCountobject

  Expected value count, in the case of an array item, that the erroneous parameter does not match with

• expectedEnumerationarray<string>

  Expected enumeration, if any, that the erroneous parameter do not match with

Item: ErrorDetail

• locationstringenum · 2

  Location of the erroneous parameter when not in request body

  Code	Name	Description
  header	—	—
  query	—	—

• namestring

  Name of the erroneous parameter when not in request body

• pathstring

  JsonPath of the erroneous request body property

• erroneousValuestring

  Erroneous parameter value

• messagestring

  Relevant message for the erroneous parameter

• expectedPatternstring

  Expected pattern, if any, that the erroneous parameter does not match with

• expectedValueRangeobject

  Expected value range, if any, that the erroneous parameter does not match with

• expectedValueCountobject

  Expected value count, in the case of an array item, that the erroneous parameter does not match with

• expectedEnumerationarray<string>

  Expected enumeration, if any, that the erroneous parameter do not match with

Item: ErrorDetail

• locationstringenum · 2

  Location of the erroneous parameter when not in request body

  Code	Name	Description
  header	—	—
  query	—	—

• namestring

  Name of the erroneous parameter when not in request body

• pathstring

  JsonPath of the erroneous request body property

• erroneousValuestring

  Erroneous parameter value

• messagestring

  Relevant message for the erroneous parameter

• expectedPatternstring

  Expected pattern, if any, that the erroneous parameter does not match with

• expectedValueRangeobject

  Expected value range, if any, that the erroneous parameter does not match with

• expectedValueCountobject

  Expected value count, in the case of an array item, that the erroneous parameter does not match with

• expectedEnumerationarray<string>

  Expected enumeration, if any, that the erroneous parameter do not match with

Item: ErrorDetail

• locationstringenum · 2

  Location of the erroneous parameter when not in request body

  Code	Name	Description
  header	—	—
  query	—	—

• namestring

  Name of the erroneous parameter when not in request body

• pathstring

  JsonPath of the erroneous request body property

• erroneousValuestring

  Erroneous parameter value

• messagestring

  Relevant message for the erroneous parameter

• expectedPatternstring

  Expected pattern, if any, that the erroneous parameter does not match with

• expectedValueRangeobject

  Expected value range, if any, that the erroneous parameter does not match with

• expectedValueCountobject

  Expected value count, in the case of an array item, that the erroneous parameter does not match with

• expectedEnumerationarray<string>

  Expected enumeration, if any, that the erroneous parameter do not match with

Item: ErrorDetail

• locationstringenum · 2

  Location of the erroneous parameter when not in request body

  Code	Name	Description
  header	—	—
  query	—	—

• namestring

  Name of the erroneous parameter when not in request body

• pathstring

  JsonPath of the erroneous request body property

• erroneousValuestring

  Erroneous parameter value

• messagestring

  Relevant message for the erroneous parameter

• expectedPatternstring

  Expected pattern, if any, that the erroneous parameter does not match with

• expectedValueRangeobject

  Expected value range, if any, that the erroneous parameter does not match with

• expectedValueCountobject

  Expected value count, in the case of an array item, that the erroneous parameter does not match with

• expectedEnumerationarray<string>

  Expected enumeration, if any, that the erroneous parameter do not match with

Item: ErrorDetail

• locationstringenum · 2

  Location of the erroneous parameter when not in request body

  Code	Name	Description
  header	—	—
  query	—	—

• namestring

  Name of the erroneous parameter when not in request body

• pathstring

  JsonPath of the erroneous request body property

• erroneousValuestring

  Erroneous parameter value

• messagestring

  Relevant message for the erroneous parameter

• expectedPatternstring

  Expected pattern, if any, that the erroneous parameter does not match with

• expectedValueRangeobject

  Expected value range, if any, that the erroneous parameter does not match with

• expectedValueCountobject

  Expected value count, in the case of an array item, that the erroneous parameter does not match with

• expectedEnumerationarray<string>

  Expected enumeration, if any, that the erroneous parameter do not match with

Item: ErrorDetail

• locationstringenum · 2

  Location of the erroneous parameter when not in request body

  Code	Name	Description
  header	—	—
  query	—	—

• namestring

  Name of the erroneous parameter when not in request body

• pathstring

  JsonPath of the erroneous request body property

• erroneousValuestring

  Erroneous parameter value

• messagestring

  Relevant message for the erroneous parameter

• expectedPatternstring

  Expected pattern, if any, that the erroneous parameter does not match with

• expectedValueRangeobject

  Expected value range, if any, that the erroneous parameter does not match with

• expectedValueCountobject

  Expected value count, in the case of an array item, that the erroneous parameter does not match with

• expectedEnumerationarray<string>

  Expected enumeration, if any, that the erroneous parameter do not match with

Item: ErrorDetail

• locationstringenum · 2

  Location of the erroneous parameter when not in request body

  Code	Name	Description
  header	—	—
  query	—	—

• namestring

  Name of the erroneous parameter when not in request body

• pathstring

  JsonPath of the erroneous request body property

• erroneousValuestring

  Erroneous parameter value

• messagestring

  Relevant message for the erroneous parameter

• expectedPatternstring

  Expected pattern, if any, that the erroneous parameter does not match with

• expectedValueRangeobject

  Expected value range, if any, that the erroneous parameter does not match with

• expectedValueCountobject

  Expected value count, in the case of an array item, that the erroneous parameter does not match with

• expectedEnumerationarray<string>

  Expected enumeration, if any, that the erroneous parameter do not match with