--- title: "PaymentRequestResource" canonical: "https://openfinanceguide.com/en/stet/1.6.3/resources/payment-request-resource" edition: "STET PSD2 API 1.6.3.1" source: "https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.2-openapi.yaml" pdf: "https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf" section: "4.1.10" pdf_pages: "18" language: "en" normative: "The normative text is the English PDF and OpenAPI file published by STET. This Markdown reproduces it for reading; where they differ, the PDF prevails." license: "CC BY 3.0 FR (https://creativecommons.org/licenses/by/3.0/fr/), STET. Converted to Markdown by Open Finance Guide." --- # PaymentRequestResource Type: `object` · Kind: Resources · Source: [§ 4.1.10, PDF p. 18](https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf#page=18) ISO20022: The PaymentRequestResource message is sent by the Creditor sending party to the Debtor receiving party, directly or through agents. It is used by a Creditor to request movement of funds from the debtor account to a creditor. API: Information about the creditor (Id, account and agent) must be placed at instruction level. Thus multi-beneficiary payments can be handled. The requested execution date must be placed at payment level even when all instructions are requested to be executed at the same date. The latest case includes: - multiple instructions having different requested execution dates - standing orders settings Fields: - `resourceId`, [`ResourceId`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/resource-id.md) - `paymentInformationId`, [`PaymentInformationId`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/payment-information-id.md), required - `batchBooking`, [`BatchBookingIndicator`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/batch-booking-indicator.md) - `creationDateTime`, [`CreationDateTime`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/creation-date-time.md), required - `numberOfTransactions`, `integer`, required — 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 - `initiatingParty`, [`PartyIdentification`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/party-identification.md), required - `acceptDebtorAccountChange`, `boolean` — 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 - `acceptChargeHandlingChange`, `boolean` — 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 - `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. 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) - `paymentTypeInformation`, [`PaymentTypeInformation`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/payment-type-information.md), required - `debtor`, [`PartyIdentification`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/party-identification.md) - `debtorAccount`, [`AccountIdentification`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/account-identification.md) - `debtorAgent`, [`FinancialInstitutionIdentification`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/financial-institution-identification.md) - `chargeBearer`, [`ChargeBearerCode`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/charge-bearer-code.md) - `paymentInformationStatus`, [`PaymentInformationStatusCode`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/payment-information-status-code.md) - `statusReasonInformation`, [`StatusReasonInformation`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/status-reason-information.md) - `fundsAvailability`, [`FundsAvailabilityInformation`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/funds-availability-information.md) - `booking`, [`BookingInformation`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/booking-information.md) - `creditTransferTransaction`, array of [`CreditTransferTransactionResource`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/credit-transfer-transaction-resource.md), required — ISO20022: Payment processes required to transfer cash from the debtor to the creditor. API: Each ASPSP will specify a maxItems value for this field taking into accounts its specificities about payment request handling - `supplementaryData`, [`SupplementaryData`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/supplementary-data.md), required ## Example ```json { "paymentInformationId": "MyPmtInfId", "creationDateTime": "2020-02-19T13:56:54.877+01:00", "numberOfTransactions": 2, "initiatingParty": { "name": "MyPreferredPisp", "postalAddress": { "country": "FR", "addressLine": [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId": { "identification": "12FR5", "schemeName": "COID", "issuer": "ACPR" } }, "paymentTypeInformation": { "serviceLevel": "SEPA", "localInstrument": "INST", "categoryPurpose": "CASH" }, "debtor": { "name": "MyCustomer", "postalAddress": { "country": "FR", "addressLine": [ "18 rue de la DSP2", "75008 PARIS" ] }, "privateId": { "identification": "FD37G", "schemeName": "BANK", "issuer": "BICXYYTTZZZ" } }, "chargeBearer": "SLEV", "creditTransferTransaction": [ { "paymentId": { "instructionId": "MyInstrId3", "endToEndId": "MyEndToEndId3" }, "requestedExecutionDate": "2020-02-19T13:56:54.878+01:00", "instructedAmount": { "amount": 124.35, "currency": "EUR" }, "beneficiary": { "creditor": { "name": "June Doe", "postalAddress": { "country": "FR", "addressLine": [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId": { "identification": "12FR5", "schemeName": "COID", "issuer": "ACPR" }, "privateId": { "identification": "852126789", "schemeName": "SIREN", "issuer": "FR" } }, "creditorAccount": { "iban": "YY49QEZO90424459988701367845944910", "currency": "EUR" } }, "ultimateCreditor": { "name": "myPreferredUltimateMerchant", "postalAddress": { "country": "FR", "addressLine": [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId": { "identification": "85212678900025", "schemeName": "SIRET", "issuer": "FR" } }, "purpose": "CASH", "remittanceInformation": { "unstructured": [ "MyRemittanceInformation" ] } }, { "paymentId": { "instructionId": "MyInstrId4", "endToEndId": "MyEndToEndId4" }, "requestedExecutionDate": "2020-02-19T13:56:54.878+01:00", "instructedAmount": { "amount": 124.35, "currency": "EUR" }, "beneficiary": { "creditor": { "name": "John Doe", "postalAddress": { "country": "FR", "addressLine": [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId": { "identification": "12FR5", "schemeName": "COID", "issuer": "ACPR" }, "privateId": { "identification": "852126789", "schemeName": "SIREN", "issuer": "FR" } }, "creditorAccount": { "iban": "YY27KYHO61109079868328944728829436", "currency": "EUR" } }, "ultimateCreditor": { "name": "myPreferredUltimateMerchant", "postalAddress": { "country": "FR", "addressLine": [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId": { "identification": "85212678900025", "schemeName": "SIRET", "issuer": "FR" } }, "purpose": "CASH", "remittanceInformation": { "unstructured": [ "MyRemittanceInformation" ] } } ], "supplementaryData": { "acceptedAuthenticationApproach": [ "REDIRECT", "DECOUPLED" ], "successfulReportUrl": "http://myPisp/PaymentSuccess", "unsuccessfulReportUrl": "http://myPisp/PaymentFailure" } } ``` ## Used by - `POST /payment-requests/{paymentRequestResourceId}/confirmation` (paymentRequestConfirmationPost) - `PUT /payment-requests/{paymentRequestResourceId}` (paymentRequestPut) - `GET /payment-requests/{paymentRequestResourceId}` (paymentRequestsGet) - `POST /payment-requests` (paymentRequestsPost)