paymentRequest (required) | PaymentRequestResource body {
"resourceId (string)": "API: Identifier assigned by the ASPSP for further use of the created resource through API calls.\nThe API client cannot set or modify the value of this field.\nSince this value can be exchanged between the server and the client as an URL element or for support information, it must not contain sensitive value such as personal or business data.\nHowever it is the duty of each ASPSP to perform its own risk analysis on this topic.\n",
"paymentInformationId (string)": "ISO20022: Reference assigned by a sending party to unambiguously identify the payment information block within the message.\nAPI: This field is a clue for idempotency check by the ASPSP in order to avoid duplicate SCA or payment execution. However the ASPSP may use other mechanisms.\n",
"batchBooking (boolean)": "Identifies whether a single entry per individual transaction or a batch entry for the sum of the amounts of all transactions within the group of a message is requested.\nMeaning When True: Identifies that a batch entry for the sum of the amounts of all transactions in the batch or message is requested.\nMeaning When False: Identifies that a single entry for each of the transactions in the batch or message is requested.\nDefault value: each ASPSP must be able to specify its own default value.\n",
"creationDateTime (string)": "ISO20022: Date and time at which a (group of) payment instruction(s) was created by the instructing party.\n",
"numberOfTransactions (integer)": "ISO20022: Number of individual transactions contained in the message.\nAPI: Each ASPSP will specify a maximum value for this field taking into accounts its specificities about payment request handling\n",
"initiatingParty": {
"name (string)": "ISO20022: Name by which a party is known and which is usually used to identify that party.\nThe [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation.\nThe [privateId] property allows the specification of an unique and unambiguous way to identify a person.\n",
"dateAndPlaceOfBirth": {
"birthDate (string)": "Date on which a person is born.",
"cityOfBirth (string)": "City where a person was born.",
"countryOfBirth (string)": "Country where a person was born."
},
"postalAddress": {
"addressType (string)": "ISO20022: Identifies the nature of the postal address.\nAPI: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed.\n| Code | Name | Description |\n| ---- | ---- | ----------- |\n| BIZZ | Business | Address is the business address |\n| DLVY | Delivery | Address is the address to which delivery is to take place |\n| MLTO | Mail To | Address is the address to which mail is sent |\n| PBOX | PO Box | Address is is a postal office (PO) box |\n| ADDR | Postal | Address is the complete postal address |\n| HOME | Business | Address is the home address |\n",
"department (string)": "ISO20022: Identification of a division of a large organisation or building.\nAPI: Cannot be used for SEPA payments.\n",
"subDepartment (string)": "ISO20022: Identification of a sub-division of a large organisation or building.\nAPI: Cannot be used for SEPA payments.\n",
"streetName (string)": "ISO20022: Name of a street or thoroughfare.\nAPI: Cannot be used for SEPA payments.\n",
"buildingNumber (string)": "ISO20022: Number that identifies the position of a building on a street.\nAPI: Cannot be used for SEPA payments.\n",
"buildingName (string)": "ISO20022: Name of the building or house.\nAPI: Cannot be used for SEPA payments.\n",
"postCode (string)": "ISO20022: Identifier consisting of a group of letters and\/or numbers that is added to a postal address to assist the sorting of mail.\nAPI: Cannot be used for SEPA payments.\n",
"townName (string)": "ISO20022: Name of a built-up area, with defined boundaries, and a local government.\nAPI: Cannot be used for SEPA payments.\n",
"countrySubDivision (string)": "ISO20022: Identifies a subdivision of a country such as state, region, county.\nAPI: Cannot be used for SEPA payments.\n",
"country (string)": "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.\n",
"addressLine (array)": "Unstructured address. The lines must embed zip code and town name.\nFor SEPA payments, only two address lines are allowed.\n"
},
"contactDetails": {
"phoneNumber (string)": "The collection of information which identifies a specific phone or FAX number as defined by telecom services.\nIt 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).\n",
"faxNumber (string)": "The collection of information which identifies a specific phone or FAX number as defined by telecom services.\nIt 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).\n",
"emailAddress (string)": "email address of the contact"
},
"organisationId": {
"identification (string)": "API: Identifier\n",
"schemeName (string)": "Name of the identification scheme.\nPossible values for the scheme name, partially based on ISO20022 external code list, are the following:\n| Code | Name | Description |\n| ---- | ---- | ----------- |\n| 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. |\n| 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. |\n| COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) |\n| 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. |\n| 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. |\n| NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. |\nOther values are also permitted, for instance:\n| Code | Name | Description |\n| ---- | ---- | ----------- |\n| 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 |\n| CPAN | CardPan | Card PAN |\n| MPAN | MaskedPan | Card PAN where some digits were replaced for security reason |\n| 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 |\n| 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 |\nEach implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used\n",
"issuer (string)": "ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties\n"
},
"privateId": {
"identification (string)": "API: Identifier\n",
"schemeName (string)": "Name of the identification scheme.\nPossible values for the scheme name, partially based on ISO20022 external code list, are the following:\n| Code | Name | Description |\n| ---- | ---- | ----------- |\n| 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. |\n| 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. |\n| COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) |\n| 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. |\n| 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. |\n| NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. |\nOther values are also permitted, for instance:\n| Code | Name | Description |\n| ---- | ---- | ----------- |\n| 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 |\n| CPAN | CardPan | Card PAN |\n| MPAN | MaskedPan | Card PAN where some digits were replaced for security reason |\n| 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 |\n| 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 |\nEach implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used\n",
"issuer (string)": "ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties\n"
},
"lei (string)": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\".\n"
},
"acceptDebtorAccountChange (boolean)": "indicator that the debtor account can be changed in the payment request by the ASPSP if needed\n- true: debtor account can be changed (default value)\n- false: debtor account cannot be changed\n",
"acceptChargeHandlingChange (boolean)": "indicator that the charge handling can be changed in the payment request by the ASPSP if needed\n- true: charge handling can be changed (default value)\n- false: charge handling cannot be changed\n",
"acceptInstantPaymentDowngrade (boolean)": "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.\nEventually, 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 \u201cINST\u201d value in order to keep the PISP informed.\n- true: payment method can be downgraded\n- false: payment method cannot be downgraded (default value)\n",
"paymentTypeInformation": {
"instructionPriority (string)": "ISO20022: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\nAPI: This field is useless for SCTInst and thus should be ignored.\n",
"serviceLevel (string)": "ISO20022: Agreement under which or rules under which the transaction should be processed. Specifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\nAPI: Only \"SEPA\" (SEPA Credit Transfer) value is allowed\n",
"localInstrument (string)": "ISO20022: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and\/or further qualify the service or service level.\nAPI: \"INST\" value is to be used in order to ask for an SEPA instant Payment (SCTInst).\nFor International payments, this field may be valued with one of the ISO20022 external code to specify with payment instrument should be used by the creditor's bank.\n",
"categoryPurpose (string)": "ISO20022: Specifies the high level purpose of the instruction based on a set of pre-defined categories. This is used by the initiating party to provide information concerning the processing of the payment. It is likely to trigger special processing by any of the agents involved in the payment chain.\nAPI: The following values are allowed:\n| Code | Name | Description |\n| ---- | ---- | ---------- |\n| CASH | CashManagementTransfer | Transaction is a general cash management instruction. |\n| CORT | TradeSettlementPayment | Transaction is related to settlement of a trade, e.g. a foreign exchange deal or a securities transaction. |\n| DVPM | DeliverAgainstPayment | Code used to pre-advise the account servicer of a forthcoming deliver against payment instruction. |\n| INTC | IntraCompanyPayment | Transaction is an intra-company payment, i.e. a payment between two companies belonging to the same group. |\n| SALA | SalaryPayment | Transaction is the payment of salaries. |\n| TREA | TreasuryPayment | Transaction is related to treasury operations. E.g. financial contract settlement. |\n"
},
"debtor": {
"name (string)": "ISO20022: Name by which a party is known and which is usually used to identify that party.\nThe [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation.\nThe [privateId] property allows the specification of an unique and unambiguous way to identify a person.\n",
"dateAndPlaceOfBirth": {
"birthDate (string)": "Date on which a person is born.",
"cityOfBirth (string)": "City where a person was born.",
"countryOfBirth (string)": "Country where a person was born."
},
"postalAddress": {
"addressType (string)": "ISO20022: Identifies the nature of the postal address.\nAPI: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed.\n| Code | Name | Description |\n| ---- | ---- | ----------- |\n| BIZZ | Business | Address is the business address |\n| DLVY | Delivery | Address is the address to which delivery is to take place |\n| MLTO | Mail To | Address is the address to which mail is sent |\n| PBOX | PO Box | Address is is a postal office (PO) box |\n| ADDR | Postal | Address is the complete postal address |\n| HOME | Business | Address is the home address |\n",
"department (string)": "ISO20022: Identification of a division of a large organisation or building.\nAPI: Cannot be used for SEPA payments.\n",
"subDepartment (string)": "ISO20022: Identification of a sub-division of a large organisation or building.\nAPI: Cannot be used for SEPA payments.\n",
"streetName (string)": "ISO20022: Name of a street or thoroughfare.\nAPI: Cannot be used for SEPA payments.\n",
"buildingNumber (string)": "ISO20022: Number that identifies the position of a building on a street.\nAPI: Cannot be used for SEPA payments.\n",
"buildingName (string)": "ISO20022: Name of the building or house.\nAPI: Cannot be used for SEPA payments.\n",
"postCode (string)": "ISO20022: Identifier consisting of a group of letters and\/or numbers that is added to a postal address to assist the sorting of mail.\nAPI: Cannot be used for SEPA payments.\n",
"townName (string)": "ISO20022: Name of a built-up area, with defined boundaries, and a local government.\nAPI: Cannot be used for SEPA payments.\n",
"countrySubDivision (string)": "ISO20022: Identifies a subdivision of a country such as state, region, county.\nAPI: Cannot be used for SEPA payments.\n",
"country (string)": "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.\n",
"addressLine (array)": "Unstructured address. The lines must embed zip code and town name.\nFor SEPA payments, only two address lines are allowed.\n"
},
"contactDetails": {
"phoneNumber (string)": "The collection of information which identifies a specific phone or FAX number as defined by telecom services.\nIt 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).\n",
"faxNumber (string)": "The collection of information which identifies a specific phone or FAX number as defined by telecom services.\nIt 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).\n",
"emailAddress (string)": "email address of the contact"
},
"organisationId": {
"identification (string)": "API: Identifier\n",
"schemeName (string)": "Name of the identification scheme.\nPossible values for the scheme name, partially based on ISO20022 external code list, are the following:\n| Code | Name | Description |\n| ---- | ---- | ----------- |\n| 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. |\n| 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. |\n| COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) |\n| 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. |\n| 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. |\n| NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. |\nOther values are also permitted, for instance:\n| Code | Name | Description |\n| ---- | ---- | ----------- |\n| 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 |\n| CPAN | CardPan | Card PAN |\n| MPAN | MaskedPan | Card PAN where some digits were replaced for security reason |\n| 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 |\n| 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 |\nEach implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used\n",
"issuer (string)": "ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties\n"
},
"privateId": {
"identification (string)": "API: Identifier\n",
"schemeName (string)": "Name of the identification scheme.\nPossible values for the scheme name, partially based on ISO20022 external code list, are the following:\n| Code | Name | Description |\n| ---- | ---- | ----------- |\n| 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. |\n| 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. |\n| COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) |\n| 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. |\n| 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. |\n| NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. |\nOther values are also permitted, for instance:\n| Code | Name | Description |\n| ---- | ---- | ----------- |\n| 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 |\n| CPAN | CardPan | Card PAN |\n| MPAN | MaskedPan | Card PAN where some digits were replaced for security reason |\n| 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 |\n| 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 |\nEach implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used\n",
"issuer (string)": "ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties\n"
},
"lei (string)": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\".\n"
},
"debtorAccount": {
"workspace (string)": "Workspace to which the account is linked.\nThis workspace might be specified by the AISP when forwarding the consent on accounts.\nIf not provided, the default workspace is computed from the authentication that was used for getting the OAuth2 Access Token.\n",
"iban (string)": "ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer.\n\nFurther 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.\n",
"other": {
"identification (string)": "API: Identifier\n",
"schemeName (string)": "Name of the identification scheme.\nPossible values for the scheme name, partially based on ISO20022 external code list, are the following:\n| Code | Name | Description |\n| ---- | ---- | ----------- |\n| 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. |\n| 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. |\n| COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) |\n| 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. |\n| 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. |\n| NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. |\nOther values are also permitted, for instance:\n| Code | Name | Description |\n| ---- | ---- | ----------- |\n| 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 |\n| CPAN | CardPan | Card PAN |\n| MPAN | MaskedPan | Card PAN where some digits were replaced for security reason |\n| 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 |\n| 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 |\nEach implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used\n",
"issuer (string)": "ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties\n"
},
"currency (string)": "Specifies the currency of the amount or of the account.\nA 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\".\n"
},
"debtorAgent": {
"bicFi (string)": "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)\".\n",
"clearingSystemMemberId": {
"clearingSystemId (string)": "ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
"memberId (string)": "ISO20022: Identification of a member of a clearing system.\n"
},
"lei (string)": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\".\n",
"name (string)": "Name of the financial institution",
"postalAddress": {
"addressType (string)": "ISO20022: Identifies the nature of the postal address.\nAPI: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed.\n| Code | Name | Description |\n| ---- | ---- | ----------- |\n| BIZZ | Business | Address is the business address |\n| DLVY | Delivery | Address is the address to which delivery is to take place |\n| MLTO | Mail To | Address is the address to which mail is sent |\n| PBOX | PO Box | Address is is a postal office (PO) box |\n| ADDR | Postal | Address is the complete postal address |\n| HOME | Business | Address is the home address |\n",
"department (string)": "ISO20022: Identification of a division of a large organisation or building.\nAPI: Cannot be used for SEPA payments.\n",
"subDepartment (string)": "ISO20022: Identification of a sub-division of a large organisation or building.\nAPI: Cannot be used for SEPA payments.\n",
"streetName (string)": "ISO20022: Name of a street or thoroughfare.\nAPI: Cannot be used for SEPA payments.\n",
"buildingNumber (string)": "ISO20022: Number that identifies the position of a building on a street.\nAPI: Cannot be used for SEPA payments.\n",
"buildingName (string)": "ISO20022: Name of the building or house.\nAPI: Cannot be used for SEPA payments.\n",
"postCode (string)": "ISO20022: Identifier consisting of a group of letters and\/or numbers that is added to a postal address to assist the sorting of mail.\nAPI: Cannot be used for SEPA payments.\n",
"townName (string)": "ISO20022: Name of a built-up area, with defined boundaries, and a local government.\nAPI: Cannot be used for SEPA payments.\n",
"countrySubDivision (string)": "ISO20022: Identifies a subdivision of a country such as state, region, county.\nAPI: Cannot be used for SEPA payments.\n",
"country (string)": "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.\n",
"addressLine (array)": "Unstructured address. The lines must embed zip code and town name.\nFor SEPA payments, only two address lines are allowed.\n"
}
},
"chargeBearer (string)": "ISO20022: Specifies which party\/parties will bear the charges associated with the processing of the payment transaction.\nThe following values are allowed:\n| Code | Name | Description |\n| ---- | ---- | ---------- |\n| DEBT | BorneByDebtor | All transaction charges are to be borne by the debtor. |\n| CRED | BorneByCreditor | All transaction charges are to be borne by the creditor. |\n| 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. |\n| SLEV | FollowingServiceLevel | Charges are to be applied following the rules agreed in the service level and\/or scheme. |\n",
"paymentInformationStatus (string)": "ISO20022: Specifies the status of the payment information.\nAPI: Mandatory. The following values are allowed to provide the status of the Payment Request\n| Code | Name | Description |\n| ---- | ---- | ---------- |\n| ACCO | AcceptedCustomerCOnfirmed | The customer, during his\/her authentication, has confirmed the payment request. |\n| ACCP | AcceptedCustomerProfile | Preceding check of technical validation was successful. Customer profile check was also successful. |\n| 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. |\n| 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. |\n| ACTC | AcceptedTechnicalValidation | Authentication and syntactical and semantical validation are successful. |\n| ACWC | AcceptedWithChange | Instruction is accepted but a change will be made, such as date or remittance not sent. |\n| ACWP | AcceptedWithoutPosting | Payment instruction included in the credit transfer is accepted without being posted to the creditor customer\u2019s account. |\n| CANC | Cancelled | Payment initiation was successfully cancelled after having received a request for cancellation. |\n| PART | PartiallyAccepted | A number of transactions were accepted, whereas another number of transactions have not yet achieved 'accepted' status. |\n| PATC | PartiallyAcceptedTechnicalCorrect | Payment initiation needs multiple authentications, where some but not yet all were performed. Syntactical and semantical validations are successful. |\n| RCVD | Received | Payment initiation was received by the receiving agent. |\n| PDNG | Pending | Payment request or individual transaction included in the Payment Request is pending. Further checks and status update will be performed. |\n| RJCT | Rejected | Payment request was rejected. |\n![](https:\/\/www.stet.eu\/\/assets\/files\/documents-api\/payment-request-status-1-4-2.png)\n",
"statusReasonInformation (string)": "ISO20022: Provides detailed information on the status reason.\n\nAPI: Can only be used in case the status is equal to \"RJCT\" or \"CANC\". Only the following values are allowed:\n| Code | Name | Description |\n| ---- | ---- | ---------- |\n| AC01 | IncorectAccountNumber | the account number is either invalid or does not exist |\n| AC04 | ClosedAccountNumber | the account is closed and cannot be used |\n| AC06 | BlockedAccount | the account is blocked and cannot be used |\n| AG01 | TransactionForbidden | Transaction forbidden on this type of account |\n| AG03 | TransactionNotSupported | Transaction type not supported\/authorized on this account |\n| AM18 | InvalidNumberOfTransactions | the number of transactions exceeds the ASPSP acceptance limit |\n| CH03 | RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture | The requested execution date is too far in the future |\n| CH04 | RequestedExecutionDateOrRequestedCollectionDateTooFarInPast | Value in Requested Execution Date or Requested Collection Date is too far in the past |\n| CNOR | CreditorBankIsNotRegistered | Creditor bank is not registered under this BIC in the CSM |\n| CUST | RequestedByCustomer | The reject is due to the debtor: refusal or lack of liquidity |\n| DS02 | OrderCancelled | An authorized user has cancelled the order |\n| DUPL | DuplicatePayment | Payment is a duplicate of another payment. Can only be set by a PISP for a payment request cancellation. |\n| FF01 | InvalidFileFormat | The reject is due to the original Payment Request which is invalid (syntax, structure or values) |\n| FRAD | FraudulentOriginated | the Payment Request is considered as fraudulent |\n| MS03 | NotSpecifiedReasonAgentGenerated | No reason specified by the ASPSP |\n| NOAS | NoAnswerFromCustomer | The PSU has neither accepted nor rejected the Payment Request and a time-out has occurred |\n| RR01 | MissingDebtorAccountOrIdentification | The Debtor account and\/or Identification are missing or inconsistent |\n| RR03 | MissingCreditorNameOrAddress | Specification of the creditor\u2019s name and\/or address needed for regulatory requirements is insufficient or missing. |\n| RR04 | RegulatoryReason | Reject from regulatory reason |\n| RR12 | InvalidPartyID | Invalid or missing identification required within a particular country or payment type. |\n| TECH | TechnicalProblem | Technical problems resulting in an erroneous transaction. Can only be set by a PISP for a payment request cancellation. |\n",
"fundsAvailability (boolean)": "Indicator that the payment can be covered or not by the funds available on the relevant account\n- true: payment is covered\n- false: payment is not covered\nThis indicator must be provided by the ASPSP when the Booking Information is present and set to \"False\".\nThis indicator will not be provided if the Booking Information is absent or set to \"True\".\n",
"booking (boolean)": "Indicator that the payment can be immediately booked or not\n- true: payment is booked\n- false: payment is not booked\nBooking a transaction means that the funds required by this transaction are immediatly reserved and that a subsequent transaction will not interfere with the proper execution of the payment.\nHowever, usual fraud detection mechanisms might still be triggered and result as a rejection of the payment.\nThis indicator must be provided when the relevant Credit Transfer will be executed as soon as possible but not as an instant payment.\nThis indicator is irrelevant and will not be provided for delayed payments.\nThis indicator is only relevant for the first occurrence of a standing order when this occurrence is not delayed and will be executed as soon as possible.\n\nCase the Information System cannot handle this immediate booking, the ASPSP will have to provide the funds availability information.\n",
"creditTransferTransaction (array)": "ISO20022: Payment processes required to transfer cash from the debtor to the creditor.\nAPI: Each ASPSP will specify a maxItems value for this field taking into accounts its specificities about payment request handling\n",
"supplementaryData": {
"acceptedAuthenticationApproach (array)": "List of authentication approaches",
"appliedAuthenticationApproach (string)": "Authentication approaches that can be applied.\nREDIRECT: the PSU is redirected by the TPP to the ASPSP which processes identification and authentication\nDECOUPLED: the TPP identifies the PSU and forwards the identification to the ASPSP which processes the authentication through a decoupled device\nNONE: there is no need for the PSU to authenticate\n",
"appliedAuthentication (string)": "Can only be set by the ASPSP.\nThis field allows the ASPSP to inform the PISP about the way authentication was processed during the payment request confirmation.\n",
"scaHint (string)": "can only be set by the PISP\nHint given by the merchant and\/or the PISP about an SCA exemption context\n",
"successfulReportUrl (string)": "URL to be used by the ASPSP in order to notify the PISP of the finalisation of the authentication and consent process in REDIRECT and DECOUPLED approach\n",
"unsuccessfulReportUrl (string)": "URL to be used by the ASPSP in order to notify the PISP of the failure of the authentication and consent process in REDIRECT and DECOUPLED approach\nIf this URL is not provided by the PISP, the ASPSP will use the \"successfulReportUrl\" even in case of failure of the Payment Request processing\n",
"nextStatusRequestHint (string)": "Date and time at which the PISP is suggested to ask again for the status of the payment request.\n"
}
} "{\n \"paymentInformationId\" : \"MyPmtInfId\",\n \"creationDateTime\" : \"2020-02-19T13:56:54.877+01:00\",\n \"numberOfTransactions\" : 2,\n \"initiatingParty\" : {\n \"name\" : \"MyPreferredPisp\",\n \"postalAddress\" : {\n \"country\" : \"FR\",\n \"addressLine\" : [ \"18 rue de la DSP2\", \"75008 PARIS\" ]\n },\n \"organisationId\" : {\n \"identification\" : \"12FR5\",\n \"schemeName\" : \"COID\",\n \"issuer\" : \"ACPR\"\n }\n },\n \"paymentTypeInformation\" : {\n \"serviceLevel\" : \"SEPA\",\n \"localInstrument\" : \"INST\",\n \"categoryPurpose\" : \"CASH\"\n },\n \"debtor\" : {\n \"name\" : \"MyCustomer\",\n \"postalAddress\" : {\n \"country\" : \"FR\",\n \"addressLine\" : [ \"18 rue de la DSP2\", \"75008 PARIS\" ]\n },\n \"privateId\" : {\n \"identification\" : \"FD37G\",\n \"schemeName\" : \"BANK\",\n \"issuer\" : \"BICXYYTTZZZ\"\n }\n },\n \"chargeBearer\" : \"SLEV\",\n \"creditTransferTransaction\" : [ {\n \"paymentId\" : {\n \"instructionId\" : \"MyInstrId3\",\n \"endToEndId\" : \"MyEndToEndId3\"\n },\n \"requestedExecutionDate\" : \"2020-02-19T13:56:54.878+01:00\",\n \"instructedAmount\" : {\n \"amount\" : 124.35,\n \"currency\" : \"EUR\"\n },\n \"beneficiary\" : {\n \"creditor\" : {\n \"name\" : \"June Doe\",\n \"postalAddress\" : {\n \"country\" : \"FR\",\n \"addressLine\" : [ \"18 rue de la DSP2\", \"75008 PARIS\" ]\n },\n \"organisationId\" : {\n \"identification\" : \"12FR5\",\n \"schemeName\" : \"COID\",\n \"issuer\" : \"ACPR\"\n },\n \"privateId\" : {\n \"identification\" : \"852126789\",\n \"schemeName\" : \"SIREN\",\n \"issuer\" : \"FR\"\n }\n },\n \"creditorAccount\" : {\n \"iban\" : \"YY49QEZO90424459988701367845944910\",\n \"currency\" : \"EUR\"\n }\n },\n \"ultimateCreditor\" : {\n \"name\" : \"myPreferredUltimateMerchant\",\n \"postalAddress\" : {\n \"country\" : \"FR\",\n \"addressLine\" : [ \"18 rue de la DSP2\", \"75008 PARIS\" ]\n },\n \"organisationId\" : {\n \"identification\" : \"85212678900025\",\n \"schemeName\" : \"SIRET\",\n \"issuer\" : \"FR\"\n }\n },\n \"purpose\" : \"CASH\",\n \"remittanceInformation\" : {\n \"unstructured\" : [ \"MyRemittanceInformation\" ]\n }\n }, {\n \"paymentId\" : {\n \"instructionId\" : \"MyInstrId4\",\n \"endToEndId\" : \"MyEndToEndId4\"\n },\n \"requestedExecutionDate\" : \"2020-02-19T13:56:54.878+01:00\",\n \"instructedAmount\" : {\n \"amount\" : 124.35,\n \"currency\" : \"EUR\"\n },\n \"beneficiary\" : {\n \"creditor\" : {\n \"name\" : \"John Doe\",\n \"postalAddress\" : {\n \"country\" : \"FR\",\n \"addressLine\" : [ \"18 rue de la DSP2\", \"75008 PARIS\" ]\n },\n \"organisationId\" : {\n \"identification\" : \"12FR5\",\n \"schemeName\" : \"COID\",\n \"issuer\" : \"ACPR\"\n },\n \"privateId\" : {\n \"identification\" : \"852126789\",\n \"schemeName\" : \"SIREN\",\n \"issuer\" : \"FR\"\n }\n },\n \"creditorAccount\" : {\n \"iban\" : \"YY27KYHO61109079868328944728829436\",\n \"currency\" : \"EUR\"\n }\n },\n \"ultimateCreditor\" : {\n \"name\" : \"myPreferredUltimateMerchant\",\n \"postalAddress\" : {\n \"country\" : \"FR\",\n \"addressLine\" : [ \"18 rue de la DSP2\", \"75008 PARIS\" ]\n },\n \"organisationId\" : {\n \"identification\" : \"85212678900025\",\n \"schemeName\" : \"SIRET\",\n \"issuer\" : \"FR\"\n }\n },\n \"purpose\" : \"CASH\",\n \"remittanceInformation\" : {\n \"unstructured\" : [ \"MyRemittanceInformation\" ]\n }\n } ],\n \"supplementaryData\" : {\n \"acceptedAuthenticationApproach\" : [ \"REDIRECT\", \"DECOUPLED\" ],\n \"successfulReportUrl\" : \"http:\/\/myPisp\/PaymentSuccess\",\n \"unsuccessfulReportUrl\" : \"http:\/\/myPisp\/PaymentFailure\"\n }\n}" Cliquez pour définir comme valeur de paramètre ISO20022 based payment Initiation Request |