openapi: 3.2.0 info: title: Groupe Bpce PISP API contact: name: BPCE url: https://apistore.groupebpce.com/support-technique license: name: Copyright BPCE url: https://apistore.groupebpce.com/regulatory-information termsOfService: https://apistore.groupebpce.com/terms-of-use x-business-exposure: true x-internal-id: BDSP2BC1 version: '1.0' description: 'Operations tagged PISP across 3 of this provider''s published API definitions: payments-oas3-public-v1.4.2.20-b_0.json, payments-oas3-public-v1.6.2.0-b_0.json, groupe-bpce-psd2-payments-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - description: Production - Banque Populaire url: https://www.{etab}.oba-bad-me-live-api.banquepopulaire.fr/stet/psd2/v1.4.2 variables: etab: default: '10207' enum: - '10207' - '10807' - '10907' - '13507' - '13807' - '14607' - '14707' - '16607' - '16807' - '17807' - '18707' - description: Production - Caisse d'Epargne url: https://www.{etab}.oba-bad-me-live-api.caisse-epargne.fr/stet/psd2/v1.4.2 variables: etab: default: '11315' enum: - '11315' - '11425' - '12135' - '13135' - '13335' - '13485' - '13825' - '14265' - '14445' - '14505' - '15135' - '16275' - '17515' - '18315' - '18715' - description: Production - Banque BCP url: https://www.12579.oba-bad-me-live-api.banquebcp.fr/stet/psd2/v1.4.2 - description: Production - BTP Banque url: https://www.30258.oba-bad-me-live-api.btp-banque.fr/stet/psd2/v1.4.2 - description: Production - Crédit Coopératif url: https://www.42559.oba-bad-me-live-api.credit-cooperatif.coop/stet/psd2/v1.4.2 - description: Production - Banque Palatine url: https://www.40978.oba-bad-me-live-api.palatine.fr/stet/psd2/v1.4.2 - description: Production - Banque de Savoie url: https://www.10548.oba-bad-me-live-api.banque-de-savoie.fr/stet/psd2/v1.6.2 - description: Sandbox url: https://www.{etab}.sandbox.api.89c3.com/stet/psd2/v1.4.2 variables: etab: default: '13807' enum: - '17515' - '13807' - description: Production - Banque Populaire url: https://www.{etab}.oba-bad-me-live-api.banquepopulaire.fr/stet/psd2/v1.6.2 variables: etab: default: '10207' enum: - '10207' - '10807' - '10907' - '13507' - '13807' - '14607' - '14707' - '16607' - '16807' - '17807' - '18707' - description: Production - Caisse d'Epargne url: https://www.{etab}.oba-bad-me-live-api.caisse-epargne.fr/stet/psd2/v1.6.2 variables: etab: default: '11315' enum: - '11315' - '11425' - '12135' - '13135' - '13335' - '13485' - '13825' - '14265' - '14445' - '14505' - '15135' - '16275' - '17515' - '18315' - '18715' - description: Production - Banque BCP url: https://www.12579.oba-bad-me-live-api.banquebcp.fr/stet/psd2/v1.6.2 - description: Production - BTP Banque url: https://www.30258.oba-bad-me-live-api.btp-banque.fr/stet/psd2/v1.6.2 - description: Production - Crédit Coopératif url: https://www.42559.oba-bad-me-live-api.credit-cooperatif.coop/stet/psd2/v1.6.2 - description: Production - Banque Palatine url: https://www.40978.oba-bad-me-live-api.palatine.fr/stet/psd2/v1.6.2 - description: Sandbox url: https://www.{etab}.sandbox.api.89c3.com/stet/psd2/v1.6.2 variables: etab: default: '13807' enum: - '17515' - '13807' tags: - name: PISP paths: /payment-requests: post: operationId: paymentRequestsPost summary: Payment request initiation (PISP) description: '### Description The following use cases can be applied: - payment request on behalf of a merchant - transfer request on behalf of the account''s owner - standing-order request on behalf of the account''s owner #### Data content A payment request or a transfer request might embed several payment instructions having - one single execution date or multiple execution dates - case of one single execution date, this date must be set at the payment level - case of multiple execution dates, those dates must be set at each payment instruction level - one single beneficiary or multiple beneficiaries - case of one single beneficiary, this beneficiary must be set at the payment level - case of multiple beneficiaries, those beneficiaries must be set at each payment instruction level Having at the same time multiple beneficiaries and multiple execution date might not be a relevant business case, although it is technically allowed.' parameters: - $ref: '#/components/parameters/AuthorizationParameter' - $ref: '#/components/parameters/PsuIpAddressHeader' - $ref: '#/components/parameters/PsuIpPortHeader' - $ref: '#/components/parameters/PsuHttpMethodHeader' - $ref: '#/components/parameters/PsuDateHeader' - $ref: '#/components/parameters/PsuGeoLocation' - $ref: '#/components/parameters/PsuUserAgentHeader' - $ref: '#/components/parameters/PsuRefererHeader' - $ref: '#/components/parameters/PsuAcceptHeader' - $ref: '#/components/parameters/PsuAcceptCharsetHeader' - $ref: '#/components/parameters/PsuAcceptEncodingHeader' - $ref: '#/components/parameters/PsuAcceptLanguageHeader' - $ref: '#/components/parameters/PsuDeviceId' - $ref: '#/components/parameters/DigestHeader' - $ref: '#/components/parameters/SignatureHeader' - $ref: '#/components/parameters/Correlation' - $ref: '#/components/parameters/UiLocales' requestBody: $ref: '#/components/requestBodies/PaymentRequestResource' responses: '201': description: The request has been created as a resource. The ASPSP must authenticate the PSU. headers: location: description: "URI of the created (and updated if needed) Payment Request. \nActually, this link is the URI to be used (cf. § 4.6) for retrieving the Payment Request ant its status:\n- GET /payment-requests/{paymentRequestResourceId}\nThe parameter {paymentRequestResourceId} is the identifier of the Payment Request, as the resource that was created on the ASPSP server side. \n" schema: type: string X-Request-ID: description: 'Correlation header to be set in a request and retrieved in the relevant response ' schema: type: string Digest: description: Digest of the body schema: type: string Signature: description: '[http-signature of the response ](https://datatracker.ietf.org/doc/draft-cavage-http-signatures/) The keyId must specify the way to get the relevant qualified certificate. It is requested that this identifier is an URL aiming to provide the relevant Qualified Certificate. ' schema: type: string Warning: description: 'Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ' schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/HalPaymentRequestCreation' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '408': $ref: '#/components/responses/408' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '503': $ref: '#/components/responses/503' security: - clientCredentials: - pisp tags: - PISP servers: - description: Production - Banque Populaire url: https://www.{etab}.oba-bad-me-live-api.banquepopulaire.fr/stet/psd2/v1.4.2 variables: etab: default: '10207' enum: - '10207' - '10807' - '10907' - '13507' - '13807' - '14607' - '14707' - '16607' - '16807' - '17807' - '18707' - description: Production - Caisse d'Epargne url: https://www.{etab}.oba-bad-me-live-api.caisse-epargne.fr/stet/psd2/v1.4.2 variables: etab: default: '11315' enum: - '11315' - '11425' - '12135' - '13135' - '13335' - '13485' - '13825' - '14265' - '14445' - '14505' - '15135' - '16275' - '17515' - '18315' - '18715' - description: Production - Banque BCP url: https://www.12579.oba-bad-me-live-api.banquebcp.fr/stet/psd2/v1.4.2 - description: Production - BTP Banque url: https://www.30258.oba-bad-me-live-api.btp-banque.fr/stet/psd2/v1.4.2 - description: Production - Crédit Coopératif url: https://www.42559.oba-bad-me-live-api.credit-cooperatif.coop/stet/psd2/v1.4.2 - description: Production - Banque Palatine url: https://www.40978.oba-bad-me-live-api.palatine.fr/stet/psd2/v1.4.2 - description: Production - Banque de Savoie url: https://www.10548.oba-bad-me-live-api.banque-de-savoie.fr/stet/psd2/v1.6.2 - description: Sandbox url: https://www.{etab}.sandbox.api.89c3.com/stet/psd2/v1.4.2 variables: etab: default: '13807' enum: - '17515' - '13807' /payment-requests/{paymentRequestResourceId}: get: operationId: paymentRequestsGet summary: Retrieval of a payment request (PISP) description: '### Description The following use cases can be applied: - retrieval of a payment request on behalf of a merchant - retrieval of a transfer request on behalf of the account''s owner - retrieval of a standing-order request on behalf of the account''s owner The PISP has previously sent a Request through a POST command. - The ASPSP has registered the Request, updated if necessary the relevant identifiers in order to avoid duplicates and returned the location of the updated Request. - The PISP gets the Request that has been updated with the resource identifiers, and eventually the status of the Payment/Transfer Request and the status of the subsequent credit transfer. ### Prerequisites - The TPP has been registered by the Registration Authority for the PISP role - The TPP was provided with an OAUTH2 "Client Credential" access token by the ASPSP (cf. § 3.4.2). - The TPP has previously posted a Request which has been saved by the ASPSP (cf. § 4.5.3) - The ASPSP has answered with a location link to the saved Payment/Transfer Request (cf. § 4.5.4) - The TPP and the ASPSP have successfully processed a mutual check and authentication - The TPP has presented its "OAUTH2 Client Credential" access token ### Business flow The PISP asks to retrieve the Payment/Transfer Request that has been saved by the ASPSP. The PISP uses the location link provided by the ASPSP in response of the posting of this request. The ASPSP returns the previously posted Payment/Transfer Request which is enriched with: - The resource identifiers given by the ASPSP - The status information of the Payment Request and of the subsequent credit transfer The status information must be available during at least 30 calendar days after the posting of the Payment Request. However, the ASPSP may increase this availability duration, based on its own rules.' parameters: - $ref: '#/components/parameters/AuthorizationParameter' - $ref: '#/components/parameters/PaymentRequestResourceIdentification' - $ref: '#/components/parameters/PsuIpAddressHeader' - $ref: '#/components/parameters/PsuIpPortHeader' - $ref: '#/components/parameters/PsuHttpMethodHeader' - $ref: '#/components/parameters/PsuDateHeader' - $ref: '#/components/parameters/PsuGeoLocation' - $ref: '#/components/parameters/PsuUserAgentHeader' - $ref: '#/components/parameters/PsuRefererHeader' - $ref: '#/components/parameters/PsuAcceptHeader' - $ref: '#/components/parameters/PsuAcceptCharsetHeader' - $ref: '#/components/parameters/PsuAcceptEncodingHeader' - $ref: '#/components/parameters/PsuAcceptLanguageHeader' - $ref: '#/components/parameters/PsuDeviceId' - $ref: '#/components/parameters/DigestHeader' - $ref: '#/components/parameters/SignatureHeader' - $ref: '#/components/parameters/Correlation' responses: '200': description: Retrieval of the previously posted Payment Request headers: X-Request-ID: description: 'Correlation header to be set in a request and retrieved in the relevant response ' schema: type: string Digest: description: Digest of the body schema: type: string Signature: description: '[http-signature of the response ](https://datatracker.ietf.org/doc/draft-cavage-http-signatures/) The keyId must specify the way to get the relevant qualified certificate. It is requested that this identifier is an URL aiming to provide the relevant Qualified Certificate. ' schema: type: string Warning: description: 'Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ' schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/HalPaymentRequest' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '408': $ref: '#/components/responses/408' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '503': $ref: '#/components/responses/503' security: - clientCredentials: - pisp tags: - PISP put: operationId: paymentRequestPut summary: Modification of a Payment/Transfer Request (PISP) description: '### Description The PISP sent a Payment/Transfer Request through a POST command.' parameters: - $ref: '#/components/parameters/AuthorizationParameter' - $ref: '#/components/parameters/PaymentRequestResourceIdentification' - $ref: '#/components/parameters/PsuIpAddressHeader' - $ref: '#/components/parameters/PsuIpPortHeader' - $ref: '#/components/parameters/PsuHttpMethodHeader' - $ref: '#/components/parameters/PsuDateHeader' - $ref: '#/components/parameters/PsuGeoLocation' - $ref: '#/components/parameters/PsuUserAgentHeader' - $ref: '#/components/parameters/PsuRefererHeader' - $ref: '#/components/parameters/PsuAcceptHeader' - $ref: '#/components/parameters/PsuAcceptCharsetHeader' - $ref: '#/components/parameters/PsuAcceptEncodingHeader' - $ref: '#/components/parameters/PsuAcceptLanguageHeader' - $ref: '#/components/parameters/PsuDeviceId' - $ref: '#/components/parameters/DigestHeader' - $ref: '#/components/parameters/SignatureHeader' - $ref: '#/components/parameters/Correlation' requestBody: $ref: '#/components/requestBodies/PaymentRequestResource' responses: '200': description: The modification request has been saved. The ASPSP must authenticate the PSU before committing the update. headers: X-Request-ID: description: 'Correlation header to be set in a request and retrieved in the relevant response ' schema: type: string Digest: description: Digest of the body schema: type: string Signature: description: '[http-signature of the response ](https://datatracker.ietf.org/doc/draft-cavage-http-signatures/) The keyId must specify the way to get the relevant qualified certificate. It is requested that this identifier is an URL aiming to provide the relevant Qualified Certificate. ' schema: type: string Warning: description: 'Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ' schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/HalPaymentRequestCreation' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '408': $ref: '#/components/responses/408' '409': $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '503': $ref: '#/components/responses/503' security: - clientCredentials: - pisp tags: - PISP servers: - description: Production - Banque Populaire url: https://www.{etab}.oba-bad-me-live-api.banquepopulaire.fr/stet/psd2/v1.4.2 variables: etab: default: '10207' enum: - '10207' - '10807' - '10907' - '13507' - '13807' - '14607' - '14707' - '16607' - '16807' - '17807' - '18707' - description: Production - Caisse d'Epargne url: https://www.{etab}.oba-bad-me-live-api.caisse-epargne.fr/stet/psd2/v1.4.2 variables: etab: default: '11315' enum: - '11315' - '11425' - '12135' - '13135' - '13335' - '13485' - '13825' - '14265' - '14445' - '14505' - '15135' - '16275' - '17515' - '18315' - '18715' - description: Production - Banque BCP url: https://www.12579.oba-bad-me-live-api.banquebcp.fr/stet/psd2/v1.4.2 - description: Production - BTP Banque url: https://www.30258.oba-bad-me-live-api.btp-banque.fr/stet/psd2/v1.4.2 - description: Production - Crédit Coopératif url: https://www.42559.oba-bad-me-live-api.credit-cooperatif.coop/stet/psd2/v1.4.2 - description: Production - Banque Palatine url: https://www.40978.oba-bad-me-live-api.palatine.fr/stet/psd2/v1.4.2 - description: Production - Banque de Savoie url: https://www.10548.oba-bad-me-live-api.banque-de-savoie.fr/stet/psd2/v1.6.2 - description: Sandbox url: https://www.{etab}.sandbox.api.89c3.com/stet/psd2/v1.4.2 variables: etab: default: '13807' enum: - '17515' - '13807' /payment-requests/{paymentRequestResourceId}/confirmation: post: operationId: paymentRequestConfirmationPost summary: Confirmation of a payment request or a modification request using a standard… description: '### Description The PISP confirms one of the following requests or modifications - payment request on behalf of a merchant - transfer request on behalf of the account''s owner - standing-order request on behalf of the account''s owner The ASPSP answers with a status of the relevant request and the subsequent Credit Transfer. ### Prerequisites - The TPP has been registered by the Registration Authority for the PISP role - The TPP was provided with an OAUTH2 "Client Credential" access token by the ASPSP (cf. § 3.4.2). - The TPP has previously posted a Request which has been saved by the ASPSP (cf. § 4.5.3) - The ASPSP has answered with a location link to the saved Payment Request (cf. § 4.5.4) - The TPP has retrieved the saved request in order to get the relevant resource Ids (cf. § 4.6). - The TPP and the ASPSP have successfully processed a mutual check and authentication - The TPP has presented its "OAUTH2 Client Credential" access token ### Business flow Once the PSU has been authenticated using a standard procedure (non OAUTH2), it is the due to the PISP to confirm the Request to the ASPSP in order to complete the process flow. The ASPSP must wait for confirmation before executing the subsequent Credit Tranfer.' parameters: - $ref: '#/components/parameters/AuthorizationParameter' - $ref: '#/components/parameters/PaymentRequestResourceIdentification' - $ref: '#/components/parameters/PsuIpAddressHeader' - $ref: '#/components/parameters/PsuIpPortHeader' - $ref: '#/components/parameters/PsuHttpMethodHeader' - $ref: '#/components/parameters/PsuDateHeader' - $ref: '#/components/parameters/PsuGeoLocation' - $ref: '#/components/parameters/PsuUserAgentHeader' - $ref: '#/components/parameters/PsuRefererHeader' - $ref: '#/components/parameters/PsuAcceptHeader' - $ref: '#/components/parameters/PsuAcceptCharsetHeader' - $ref: '#/components/parameters/PsuAcceptEncodingHeader' - $ref: '#/components/parameters/PsuAcceptLanguageHeader' - $ref: '#/components/parameters/PsuDeviceId' - $ref: '#/components/parameters/DigestHeader' - $ref: '#/components/parameters/SignatureHeader' - $ref: '#/components/parameters/Correlation' requestBody: $ref: '#/components/requestBodies/ConfirmationResource' responses: '200': description: retrieval of the Payment Request enriched with the status report headers: X-Request-ID: description: 'Correlation header to be set in a request and retrieved in the relevant response ' schema: type: string Digest: description: Digest of the body schema: type: string Signature: description: '[http-signature of the response ](https://datatracker.ietf.org/doc/draft-cavage-http-signatures/) The keyId must specify the way to get the relevant qualified certificate. It is requested that this identifier is an URL aiming to provide the relevant Qualified Certificate. ' schema: type: string Warning: description: 'Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ' schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/HalPaymentRequest' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '408': $ref: '#/components/responses/408' '409': $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '503': $ref: '#/components/responses/503' security: - clientCredentials: - pisp tags: - PISP servers: - description: Production - Banque Populaire url: https://www.{etab}.oba-bad-me-live-api.banquepopulaire.fr/stet/psd2/v1.4.2 variables: etab: default: '10207' enum: - '10207' - '10807' - '10907' - '13507' - '13807' - '14607' - '14707' - '16607' - '16807' - '17807' - '18707' - description: Production - Caisse d'Epargne url: https://www.{etab}.oba-bad-me-live-api.caisse-epargne.fr/stet/psd2/v1.4.2 variables: etab: default: '11315' enum: - '11315' - '11425' - '12135' - '13135' - '13335' - '13485' - '13825' - '14265' - '14445' - '14505' - '15135' - '16275' - '17515' - '18315' - '18715' - description: Production - Banque BCP url: https://www.12579.oba-bad-me-live-api.banquebcp.fr/stet/psd2/v1.4.2 - description: Production - BTP Banque url: https://www.30258.oba-bad-me-live-api.btp-banque.fr/stet/psd2/v1.4.2 - description: Production - Crédit Coopératif url: https://www.42559.oba-bad-me-live-api.credit-cooperatif.coop/stet/psd2/v1.4.2 - description: Production - Banque Palatine url: https://www.40978.oba-bad-me-live-api.palatine.fr/stet/psd2/v1.4.2 - description: Production - Banque de Savoie url: https://www.10548.oba-bad-me-live-api.banque-de-savoie.fr/stet/psd2/v1.6.2 - description: Sandbox url: https://www.{etab}.sandbox.api.89c3.com/stet/psd2/v1.4.2 variables: etab: default: '13807' enum: - '17515' - '13807' /payment-requests/{paymentRequestResourceId}/o-confirmation: post: operationId: paymentRequestOConfirmationPost summary: Confirmation of a payment request or a modification request using an OAUTH2… description: '### Description The PISP confirms one of the following requests or modifications: - payment request on behalf of a merchant - transfer request on behalf of the account''s owner - standing-order request on behalf of the account''s owner The ASPSP answers with a status of the relevant request and the subsequent Credit Transfer. ### Prerequisites - The TPP has been registered by the Registration Authority for the PISP role - The TPP was provided with an OAUTH2 "Client Credential" access token by the ASPSP (cf. § 3.4.2). - The TPP has previously posted a Request which has been saved by the ASPSP (cf. § 4.5.3) - The ASPSP has answered with a location link to the saved Payment Request (cf. § 4.5.4) - The TPP has retrieved the saved request in order to get the relevant resource Ids (cf. § 4.6). - The PSU has been authenticated by the ASPSP through an OAUTH2 authorization code grant flow (REDIRECT approach) and the PISP got the relevant token - The TPP and the ASPSP have successfully processed a mutual check and authentication - The TPP has presented its "OAUTH2 Authorization Code" access token ### Business flow Once the PSU has been authenticated through an OAUTH2 authorization code grant flow (REDIRECT approach), it is the due to the PISP to confirm the Request to the ASPSP in order to complete the process flow. The ASPSP must wait for confirmation before executing the subsequent Credit Tranfer.' parameters: - $ref: '#/components/parameters/AuthorizationParameter' - $ref: '#/components/parameters/PaymentRequestResourceIdentification' - $ref: '#/components/parameters/PsuIpAddressHeader' - $ref: '#/components/parameters/PsuIpPortHeader' - $ref: '#/components/parameters/PsuHttpMethodHeader' - $ref: '#/components/parameters/PsuDateHeader' - $ref: '#/components/parameters/PsuGeoLocation' - $ref: '#/components/parameters/PsuUserAgentHeader' - $ref: '#/components/parameters/PsuRefererHeader' - $ref: '#/components/parameters/PsuAcceptHeader' - $ref: '#/components/parameters/PsuAcceptCharsetHeader' - $ref: '#/components/parameters/PsuAcceptEncodingHeader' - $ref: '#/components/parameters/PsuAcceptLanguageHeader' - $ref: '#/components/parameters/PsuDeviceId' - $ref: '#/components/parameters/DigestHeader' - $ref: '#/components/parameters/SignatureHeader' - $ref: '#/components/parameters/Correlation' requestBody: $ref: '#/components/requestBodies/ConfirmationResource' responses: '200': description: retrieval of the Payment Request enriched with the status report headers: X-Request-ID: description: 'Correlation header to be set in a request and retrieved in the relevant response ' schema: type: string Digest: description: Digest of the body schema: type: string Signature: description: '[http-signature of the response ](https://datatracker.ietf.org/doc/draft-cavage-http-signatures/) The keyId must specify the way to get the relevant qualified certificate. It is requested that this identifier is an URL aiming to provide the relevant Qualified Certificate. ' schema: type: string Warning: description: 'Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ' schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/HalPaymentRequest' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '408': $ref: '#/components/responses/408' '409': $ref: '#/components/responses/409' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '503': $ref: '#/components/responses/503' security: - accessCode: - pisp tags: - PISP servers: - description: Production - Banque Populaire url: https://www.{etab}.oba-bad-me-live-api.banquepopulaire.fr/stet/psd2/v1.4.2 variables: etab: default: '10207' enum: - '10207' - '10807' - '10907' - '13507' - '13807' - '14607' - '14707' - '16607' - '16807' - '17807' - '18707' - description: Production - Caisse d'Epargne url: https://www.{etab}.oba-bad-me-live-api.caisse-epargne.fr/stet/psd2/v1.4.2 variables: etab: default: '11315' enum: - '11315' - '11425' - '12135' - '13135' - '13335' - '13485' - '13825' - '14265' - '14445' - '14505' - '15135' - '16275' - '17515' - '18315' - '18715' - description: Production - Banque BCP url: https://www.12579.oba-bad-me-live-api.banquebcp.fr/stet/psd2/v1.4.2 - description: Production - BTP Banque url: https://www.30258.oba-bad-me-live-api.btp-banque.fr/stet/psd2/v1.4.2 - description: Production - Crédit Coopératif url: https://www.42559.oba-bad-me-live-api.credit-cooperatif.coop/stet/psd2/v1.4.2 - description: Production - Banque Palatine url: https://www.40978.oba-bad-me-live-api.palatine.fr/stet/psd2/v1.4.2 - description: Production - Banque de Savoie url: https://www.10548.oba-bad-me-live-api.banque-de-savoie.fr/stet/psd2/v1.6.2 - description: Sandbox url: https://www.{etab}.sandbox.api.89c3.com/stet/psd2/v1.4.2 variables: etab: default: '13807' enum: - '17515' - '13807' /payment-requests/{paymentRequestResourceId}/transactions: get: operationId: paymentRequestTransactionsGet summary: Retrieval of the Credit Transfert Transactions that were processed for a given… description: '### Description The PISP gets the execution history of a payment request. This entry-point is an alternative to the retrieval of the history through the retrieval of the payment request. So, each ASPSP may choose or not to implement this entry-point. ### Prerequisites - The TPP was registered by the Registration Authority for the PISP role - The TPP has previously posted a Standing Order Request which was saved by the ASPSP (cf. § 4.5.3) - The ASPSP has answered with a location link to the saved Payment Request (cf. § 4.5.4) - The TPP has retrieved the saved request in order to get the relevant resource Ids (cf. § 4.6). - The TPP and the ASPSP have successfully processed a mutual check and authentication - The TPP was provided with an OAUTH2 "Client Credential" access token by the ASPSP (cf. § 3.4.2). - The TPP presented its "OAUTH2 Client Credential" access token. ### Business flow The PISP post the history request. The ASPSP answers with the list of relevant transactions.' parameters: - $ref: '#/components/parameters/AuthorizationParameter' - $ref: '#/components/parameters/PaymentRequestResourceIdentification_2' - $ref: '#/components/parameters/PsuIpAddressHeader' - $ref: '#/components/parameters/PsuIpPortHeader' - $ref: '#/components/parameters/PsuHttpMethodHeader' - $ref: '#/components/parameters/PsuDateHeader' - $ref: '#/components/parameters/PsuGeoLocation' - $ref: '#/components/parameters/PsuUserAgentHeader' - $ref: '#/components/parameters/PsuRefererHeader' - $ref: '#/components/parameters/PsuAcceptHeader' - $ref: '#/components/parameters/PsuAcceptCharsetHeader' - $ref: '#/components/parameters/PsuAcceptEncodingHeader' - $ref: '#/components/parameters/PsuAcceptLanguageHeader' - $ref: '#/components/parameters/PsuDeviceId' - $ref: '#/components/parameters/DigestHeader' - $ref: '#/components/parameters/SignatureHeader' - $ref: '#/components/parameters/Correlation' responses: '200': description: retrieval of the Payment Request enriched with the status report headers: X-Request-ID: description: 'Correlation header to be set in a request and retrieved in the relevant response ' schema: type: string Digest: description: Digest of the body schema: type: string Signature: description: '[http-signature of the response ](https://datatracker.ietf.org/doc/draft-cavage-http-signatures/) The keyId must specify the way to get the relevant qualified certificate. It is requested that this identifier is an URL aiming to provide the relevant Qualified Certificate. ' schema: type: string Warning: description: 'Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ' schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/HalCreditTransfertTransactions' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '408': $ref: '#/components/responses/408' '409': $ref: '#/components/responses/409_2' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '503': $ref: '#/components/responses/503' security: - clientCredentials: - pisp tags: - PISP servers: - description: Production - Banque Populaire url: https://www.{etab}.oba-bad-me-live-api.banquepopulaire.fr/stet/psd2/v1.6.2 variables: etab: default: '10207' enum: - '10207' - '10807' - '10907' - '13507' - '13807' - '14607' - '14707' - '16607' - '16807' - '17807' - '18707' - description: Production - Caisse d'Epargne url: https://www.{etab}.oba-bad-me-live-api.caisse-epargne.fr/stet/psd2/v1.6.2 variables: etab: default: '11315' enum: - '11315' - '11425' - '12135' - '13135' - '13335' - '13485' - '13825' - '14265' - '14445' - '14505' - '15135' - '16275' - '17515' - '18315' - '18715' - description: Production - Banque BCP url: https://www.12579.oba-bad-me-live-api.banquebcp.fr/stet/psd2/v1.6.2 - description: Production - BTP Banque url: https://www.30258.oba-bad-me-live-api.btp-banque.fr/stet/psd2/v1.6.2 - description: Production - Crédit Coopératif url: https://www.42559.oba-bad-me-live-api.credit-cooperatif.coop/stet/psd2/v1.6.2 - description: Production - Banque Palatine url: https://www.40978.oba-bad-me-live-api.palatine.fr/stet/psd2/v1.6.2 - description: Production - Banque de Savoie url: https://www.10548.oba-bad-me-live-api.banque-de-savoie.fr/stet/psd2/v1.6.2 - description: Sandbox url: https://www.{etab}.sandbox.api.89c3.com/stet/psd2/v1.6.2 variables: etab: default: '13807' enum: - '17515' - '13807' components: schemas: StatusReasonInformation: description: "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 | Transaction forbidden | Transaction forbidden on this type of 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| 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’s 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" type: string enum: - AC01 - AC04 - AC06 - AG01 - AM18 - CH03 - CUST - DS02 - FF01 - FRAD - MS03 - NOAS - RR01 - RR03 - RR04 - RR12 example: FRAD TaxAmount: description: Set of elements used to provide information on the amount of the tax record. type: object properties: rate: $ref: '#/components/schemas/PercentageRate' taxableBaseAmount: $ref: '#/components/schemas/AmountType' totalAmount: $ref: '#/components/schemas/AmountType' details: description: Set of elements used to provide details on the tax period and amount. type: array items: $ref: '#/components/schemas/TaxRecordDetails' PurposeCode: description: "ISO20022: Underlying reason for the payment transaction, as published in an external purpose code list. \nAPI: The following values are allowed for Payment Request\n| Code | Name | Description |\n| ---- | ---- | ---------- |\n| ACCT | AccountManagement | Funds moved between 2 accounts of same account holder at the same bank) |\n| CASH | CashManagementTransfer | (general cash management instruction) may be used for Transfer Initiation |\n| COMC | CommercialPayment | Transaction is related to a payment of commercial credit or debit. |\n| CPKC | CarparkCharges | General Carpark Charges Transaction is related to carpark charges. |\n| TRPT | RoadPricing | Transport RoadPricing Transaction is for the payment to top-up pre-paid card and electronic road pricing for the purpose of transportation. |\n" type: string enum: - ACCT - CASH - COMC - CPKC - TRPT example: CPKC PaymentInformationId: description: 'ISO20022: Reference assigned by a sending party to unambiguously identify the payment information block within the message. ' type: string pattern: ^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$ example: MyPmtInfId ConfirmationResource: description: Confirmation request resource type: object properties: nonce: $ref: '#/components/schemas/Nonce' psuAuthenticationFactor: description: authentication factor forwarded by the TPP to the ASPSP in order to fulfil the strong customer authentication process type: string example: psuAuthenticationFactor: JJKJKJ788GKJKJBK ExchangeRate: description: Provides details on the currency exchange rate and contract. type: object properties: unitCurrency: $ref: '#/components/schemas/CurrencyCode' exchangeRate: description: '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. ' type: number format: float rateType: description: '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. | ' type: string enum: - SPOT - SALE - AGRD contractIdentification: description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. type: string maxLength: 35 PriorityCode: description: '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. API: This field is useless for SCTInst and thus should be ignored. ' type: string enum: - HIGH - NORM example: NORM ExecutionRule: description: "Execution date shifting rule for standing orders\nThis data attribute defines the behaviour when recurring payment dates falls on a weekend or bank holiday. \nThe payment is then executed either the \"preceding\" or \"following\" working day.\nASPSP might reject the request due to the communicated value, if rules in Online-Banking are not supporting \nthis execution rule.\n| Code | Description |\n| ---- | ----------- |\n| FWNG | following |\n| PREC | preceding |\n" type: string enum: - FWNG - PREC example: FWNG RegulatoryReportingCodes: description: 'List of needed regulatory reporting codes for international payments ' type: array items: $ref: '#/components/schemas/RegulatoryReportingCode' minItems: 1 maxItems: 10 example: - ECO456 - ECO457 CreationDateTime: description: 'ISO20022: Date and time at which a (group of) payment instruction(s) was created by the instructing party. ' type: string format: date-time example: '2018-03-31T13:25:22.527+02:00' TitleAndName: description: Title and Name of the party or the party's authorised reprensentative. type: object properties: title: description: Title or position of the party or the party's authorised reprensentative. type: string maxLength: 35 name: description: Name of the party or the party's authorised reprensentative. type: string maxLength: 140 RemittanceInformation: description: "ISO20022: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.\nAPI: \n- Only one occurrence of the unstructured information is allowed.\n- Only one occurrence of the structured information is allowed.\n- Structured and unstructured information can coexist.\n" type: object properties: unstructured: description: Unstructured remittance information type: array items: type: string description: Relevant information to the transaction title: remittanceLine maxLength: 140 structured: description: Structured remittance information type: array items: $ref: '#/components/schemas/StructuredRemittanceInformation' ServiceLevelCode: description: '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. API: Only "SEPA" (SEPA Credit Transfer) value is allowed ' type: string enum: - SEPA example: SEPA CreditDebitIndicator: description: 'Accounting flow of the amount | Code | Description | | ---- | ----------- | | CRDT | Credit type amount | | DBIT | Debit type amount | ' type: string enum: - CRDT - DBIT example: CRDT ClearingSystemMemberIdentification: description: 'ISO20022: Information used to identify a member within a clearing system. API: to be used for some specific international credit transfers in order to identify the beneficiary bank ' type: object properties: clearingSystemId: description: 'ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed. ' type: string maxLength: 35 memberId: description: 'ISO20022: Identification of a member of a clearing system. ' type: string maxLength: 35 example: "{\n \"clearingSystemId\" : \"NZNCC\",\n \"memberId\" : \"020368\"\n} \n" TypedAmount: description: Typed Amount type: object properties: type: description: Type of the amount type: string maxLength: 35 amount: $ref: '#/components/schemas/AmountType' required: - amount LineDetail: description: Set of elements used to provide the content of the referred document line. type: object properties: identification: $ref: '#/components/schemas/DocumentLineIdentification' description: description: Description associated with the document line. type: string maxLength: 2048 amount: $ref: '#/components/schemas/RemittanceAmount' CategoryPurposeCode: description: "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| TREA | TreasuryPayment | Transaction is related to treasury operations. E.g. financial contract settlement. | \n" type: string enum: - CASH - CORT - DVPM - INTC - TREA example: CASH PaymentInformationStatusCode: description: "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| 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 has been 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’s account. |\n| CANC | Cancelled | Payment initiation has been successfully cancelled after having received a request for cancellation. |\n| PART | PartiallyAccepted | A number of transactions have been 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 have been performed. Syntactical and semantical validations are successful. |\n| RCVD | Received | Payment initiation has been 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 has been rejected. |\n![](https://www.stet.eu//assets/files/documents-api/payment-request-status-1-4-2.png)\n" type: string enum: - ACCP - ACSC - ACSP - ACTC - ACWC - ACWP - CANC - PART - RCVD - PDNG - RJCT example: ACSC EndDate: description: 'The last applicable day of execution for a given standing order. If not given, the standing order is considered as endless. ' type: string format: date-time example: '2019-02-01T00:00:00.000+01:00' RegulatoryReportingCode: description: "Information needed due to regulatory and statutory requirements. \nEconomical codes to be used are provided by the National Competent Authority\n" type: string maxLength: 10 example: ECO456 GenericIdentification: description: 'ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support. ' type: object properties: identification: description: 'API: Identifier ' type: string maxLength: 70 schemeName: description: 'Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following: | Code | Name | Description | | ---- | ---- | ----------- | | BANK | BankPartyIdentification | Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. | | COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) | | SREN | SIREN | The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. | | SRET | SIRET | The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. | | NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. | Other values are also permitted, for instance: | Code | Name | Description | | ---- | ---- | ----------- | | OAUT | OAUTH2 | OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU | | CPAN | CardPan | Card PAN | Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used ' type: string maxLength: 70 issuer: description: 'ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties ' type: string maxLength: 35 required: - identification - schemeName example: identification: 12FR5 schemeName: COID issuer: FR IntermediaryAgent: description: Agent and agent account between the debtor's agent and the creditor's agent. type: object properties: agent: $ref: '#/components/schemas/PartyIdentification' agentAccount: $ref: '#/components/schemas/AccountIdentification' PaymentRequestResourceCreationLinks: description: "links that can be used for further navigation, especially in REDIRECT approach \n" type: object properties: consentApproval: $ref: '#/components/schemas/GenericLink' readOnly: true example: consentApproval: href: https://psd2.aspsp/consent-approval TaxParty: description: Set of elements used to identify a party of the transaction to which the tax applies. type: object properties: taxIdentification: description: Tax identification number of the party. type: string maxLength: 35 registrationIdentification: description: Unique identification, as assigned by an organisation, to unambiguously identify a party. type: string maxLength: 35 taxType: description: Type of tax payer. type: string maxLength: 35 authorisation: $ref: '#/components/schemas/TitleAndName' SupplementaryData: description: 'ISO20022: Additional information that cannot be captured in the structured elements and/or any other specific block. API: This structure is used to embed the relevant URLs for returning the status report to the PISP and to specify which authentication approaches are accepted by the PISP and which has been chosen by the ASPSP ' type: object properties: acceptedAuthenticationApproach: description: "can only be set by the PISP\nauthentication approaches that are supported by the PISP. The PISP can provide several choices separated by commas. \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\nEMBEDDED-1-FACTOR: the TPP identifies the PSU and forwards the identification to the ASPSP which starts the authentication. The TPP forwards one authentication factor of the PSU (e.g. OTP or response to a challenge)\n" type: array items: type: string description: combination of possible values for authentication approaches minItems: 1 enum: - REDIRECT - DECOUPLED - EMBEDDED-1-FACTOR appliedAuthenticationApproach: $ref: '#/components/schemas/AppliedAuthenticationApproach' scaHint: description: 'can only be set by the PISP Hint given by the merchant and/or the PISP about an SCA exemption context ' type: string enum: - noScaExemption - scaExemption successfulReportUrl: description: '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 ' type: string unsuccessfulReportUrl: description: "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" type: string example: successfulReportUrl: http://myPisp/PaymentSuccess unsuccessfulReportUrl: http://myPisp/PaymentFailure TaxRecordPeriodCode: description: 'Identification of the period related to the tax payment. | Code | Description | | ---- | ---------- | | MM01 | FirstMonth Tax is related to the second month of the period. | | MM02 | SecondMonth Tax is related to the first month of the period. | | MM03 | ThirdMonth Tax is related to the third month of the period. | | MM04 | FourthMonth Tax is related to the fourth month of the period. | | MM05 | FifthMonth Tax is related to the fifth month of the period. | | MM06 | SixthMonth Tax is related to the sixth month of the period. | | MM07 | SeventhMonth Tax is related to the seventh month of the period. | | MM08 | EighthMonth Tax is related to the eighth month of the period. | | MM09 | NinthMonth Tax is related to the ninth month of the period. | | MM10 | TenthMonth Tax is related to the tenth month of the period. | | MM11 | EleventhMonth Tax is related to the eleventh month of the period. | | MM12 | TwelfthMonth Tax is related to the twelfth month of the period. | | QTR1 | FirstQuarter Tax is related to the first quarter of the period. | | QTR2 | SecondQuarter Tax is related to the second quarter of the period. | | QTR3 | ThirdQuarter Tax is related to the third quarter of the period. | | QTR4 | FourthQuarter Tax is related to the fourth quarter of the period. | | HLF1 | FirstHalf Tax is related to the first half of the period. | | HLF2 | SecondHalf Tax is related to the second half of the period. | ' type: string enum: - MM01 - MM02 - MM03 - MM04 - MM05 - MM06 - MM07 - MM08 - MM09 - MM10 - MM11 - MM12 - QTR1 - QTR2 - QTR3 - QTR4 - HLF1 - HLF2 CodeAndIssuer: description: 'Specifies a code and the issuer of this code. ' type: object properties: code: description: Provides the code. type: string maxLength: 4 issuer: description: Identification of the issuer of the code. type: string maxLength: 35 required: - code StructuredRemittanceInformation: description: 'Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts'' receivable system, in a structured form. ' type: object properties: referredDocumentInformation: $ref: '#/components/schemas/ReferredDocumentInformations' referredDocumentAmount: $ref: '#/components/schemas/RemittanceAmount' creditorReferenceInformation: $ref: '#/components/schemas/CreditorReferenceInformation' invoicer: $ref: '#/components/schemas/PartyIdentification' invoicee: $ref: '#/components/schemas/PartyIdentification' taxRemittance: $ref: '#/components/schemas/TaxInformation' ReferredDocumentInformation: description: Provides the identification and the content of the referred document. type: object properties: type: $ref: '#/components/schemas/CodeAndIssuer' number: description: Unique and unambiguous identification of the referred document. type: string maxLength: 35 relatedDate: description: Date associated with the referred document. type: string format: date lineDetails: description: Sets of elements used to provide the content of the referred document line. type: array items: $ref: '#/components/schemas/LineDetail' TaxPeriod: description: Set of elements used to provide details on the period of time related to the tax payment. type: object properties: year: description: Year related to the tax payment. type: string format: int32 type: $ref: '#/components/schemas/TaxRecordPeriodCode' fromDate: description: Start date of the range. type: string format: date toDate: description: End date of the range. type: string format: date TaxInformation: description: Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account. type: object properties: creditor: $ref: '#/components/schemas/TaxParty' debtor: $ref: '#/components/schemas/TaxParty' ultimateDebtor: $ref: '#/components/schemas/TaxParty' administrationZone: description: Territorial part of a country to which the tax payment is related. type: string maxLength: 35 referenceNumber: description: Tax reference information that is specific to a taxing agency. type: string maxLength: 140 method: description: Method used to indicate the underlying business or how the tax is paid. type: string maxLength: 35 totalTaxableBaseAmount: $ref: '#/components/schemas/AmountType' totalTaxAmount: $ref: '#/components/schemas/AmountType' date: description: Date by which tax is due. type: string format: date sequenceNumber: description: Sequential number of the tax report. type: number format: int32 record: description: Records of tax details type: array items: $ref: '#/components/schemas/TaxRecord' PaymentIdentification: description: 'ISO20022: Set of elements used to reference a payment instruction. ' type: object properties: resourceId: $ref: '#/components/schemas/ResourceId' instructionId: description: "ISO20022: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\n\nAPI: Unique identification shared between the PISP and the ASPSP \n" type: string pattern: ^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$ endToEndId: description: 'ISO20022: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. ' type: string pattern: ^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$ required: - instructionId example: resourceId: MyInstrRscId instructionId: MyInstrId endToEndId: MyEndToEndId AmountType: description: 'Structure aiming to embed the amount and the currency to be used. ' type: object properties: amount: description: '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. ' type: number format: float pattern: ^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$ currency: $ref: '#/components/schemas/CurrencyCode' required: - amount - currency example: currency: EUR amount: 12.25 DateAndPlaceOfBirth: description: "Date and place of birth of a person.\nThis information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment. \n" type: object properties: birthDate: description: Date on which a person is born. type: string format: date cityOfBirth: description: City where a person was born. type: string maxLength: 35 countryOfBirth: description: Country where a person was born. type: string pattern: ^[A-Z]{2,2}$ required: - birthDate - cityOfBirth - countryOfBirth BatchBookingIndicator: description: "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. \n" type: boolean FundsAvailabilityInformation: description: 'indicator that the payment can be covered or not by the funds available on the relevant account - true: payment is covered - false: payment is not covered ' type: boolean readOnly: true example: 'true' DocumentLineIdentification: description: Provides identification of the document line. type: object properties: type: $ref: '#/components/schemas/CodeAndIssuer' number: description: Unique and unambiguous identification of the referred document line. type: string maxLength: 35 relatedDate: description: Date associated with the referred document line. type: string format: date PaymentRequestLinks: description: 'links that can be used for further navigation when having post a Payment Request in order to get the relevant status report. ' type: object properties: request: $ref: '#/components/schemas/GenericLink' confirmation: $ref: '#/components/schemas/GenericLink' readOnly: true example: self: href: v1/payment-requests/MyPmtInfRscId confirmation: href: v1/payment-requests/MyPmtInfRscId/confirmation GenericLink: description: hypertext reference type: object properties: href: description: URI to be used. HREF stands for Hypertext REFerence. type: string maxLength: 2000 templated: description: specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false type: boolean required: - href example: href: v1/accounts/Alias1/balances TaxRecordDetails: description: Elements used to provide details on the tax period and amount. type: object properties: period: $ref: '#/components/schemas/TaxPeriod' amount: $ref: '#/components/schemas/AmountType' required: - amount FrequencyCode: description: "Frequency rule for standing orders.\nThe following codes from the \"EventFrequency7Code\" of ISO 20022 are supported.\n| Code | Description |\n| ---- | ----------- |\n| DAIL | Daily |\n| WEEK | Weekly |\n| TOWK | EveryTwoWeeks |\n| MNTH | Monthly |\n| TOMN | EveryTwoMonths |\n| QUTR | Quarterly |\n| SEMI | SemiAnnual |\n| YEAR | Annual |\nHowever, each ASPSP might restrict these values into a subset if needed. \n" type: string enum: - DAIL - WEEK - TOWK - MNTH - TOMN - QUTR - SEMI - YEAR example: MNTH PaymentTypeInformation: description: 'ISO20022: Set of elements used to further specify the type of transaction. ' type: object properties: instructionPriority: $ref: '#/components/schemas/PriorityCode' serviceLevel: $ref: '#/components/schemas/ServiceLevelCode' localInstrument: $ref: '#/components/schemas/LocalInstrumentCode' categoryPurpose: $ref: '#/components/schemas/CategoryPurposeCode' example: serviceLevel: SEPA localInstrument: INST categoryPurpose: DVPM TaxRecord: description: Record of tax details type: object properties: type: description: High level code to identify the type of tax details. type: string maxLength: 35 category: description: Specifies the tax code as published by the tax authority. type: string maxLength: 35 categoryDetails: description: Provides further details of the category tax code. type: string maxLength: 35 debtorStatus: description: Code provided by local authority to identify the status of the party that has drawn up the settlement document. type: string maxLength: 35 certificateIdentification: description: Identification number of the tax report as assigned by the taxing authority. type: string maxLength: 35 formsCode: description: Identifies, in a coded form, on which template the tax report is to be provided. type: string maxLength: 35 period: $ref: '#/components/schemas/TaxPeriod' taxAmount: $ref: '#/components/schemas/TaxAmount' additionalInformation: description: Further details of the tax record. type: string maxLength: 140 RemittanceAmount: description: Provides details on the amounts of the document line. type: object properties: duePayableAmount: $ref: '#/components/schemas/AmountType' discountAppliedAmount: $ref: '#/components/schemas/TypedAmount' creditNoteAmount: $ref: '#/components/schemas/AmountType' taxAmount: $ref: '#/components/schemas/TypedAmount' adjustmentAmountAndReason: $ref: '#/components/schemas/DocumentAdjustment' remittedAmount: $ref: '#/components/schemas/AmountType' RequestedExecutionDate: description: "ISO20022: Date at which the initiating party requests the clearing agent to process the payment.\nAPI: \nThis field indicates the date at which the debtor account should be debited. \nIn most of the cases, especially for international payments, the date of the credit on the credit account cannot be set. Only SCTInst can guarantee having the same date for this credit. \nThis date can be used in the following cases:\n- the single requested execution date for a payment having several instructions. In this case, this field must be set at the payment level. \n- the requested execution date for a given instruction within a payment. In this case, this field must be set at each instruction level. \n- The first date of execution for a standing order.\nWhen the payment cannot be processed at this date, the ASPSP is allowed to shift the applied execution date to the next possible execution date for non-standing orders.\nFor standing orders, the [executionRule] parameter helps to compute the execution date to be applied.\n" type: string format: date-time example: '2019-02-01T00:00:00.000+01:00' ErrorModel: description: Generic error report structure type: object properties: timestamp: description: current timestamp type: string format: date-time status: description: HTTP error code type: integer format: int32 error: description: HTTP error text type: string maxLength: 140 message: description: HTTP textual reason phrase type: string maxLength: 140 path: description: Relevant path that was used type: string maxLength: 140 required: - status - message example: timestamp: 2018-03-30T16:06:27.499+0000 status: 400 error: Bad Request message: Missing request header 'Digest' for method parameter of type String path: /v1/accounts DocumentAdjustment: description: Specifies detailed information on the amount and reason of the adjustment. type: object properties: amount: $ref: '#/components/schemas/AmountType' creditDebitIndicator: $ref: '#/components/schemas/CreditDebitIndicator' reason: description: Specifies the reason for the adjustment. type: string maxLength: 4 additionalInformation: description: Provides further details on the document adjustment. type: string maxLength: 140 required: - amount ChargeBearerCode: description: "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" type: string enum: - DEBT - CRED - SHAR - SLEV example: SLEV PercentageRate: description: Rate expressed as a percentage, ie, in hundredths, eg, 0.7 is 7/10 of a percent, and 7.0 is 7%. type: number format: float CurrencyCode: description: "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" type: string pattern: ^[A-Z]{3,3}$ example: EUR LocalInstrumentCode: description: "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" type: string example: INST PostalAddress: description: 'ISO20022: Information that locates and identifies a specific address, as defined by postal services. ' type: object properties: addressType: description: "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" type: string enum: - BIZZ - DLVY - MLTO - PBOX - ADDR - HOME department: description: 'ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments. ' type: string maxLength: 70 subDepartment: description: 'ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments. ' type: string maxLength: 70 streetName: description: 'ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments. ' type: string maxLength: 70 buildingNumber: description: 'ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments. ' type: string maxLength: 16 buildingName: description: 'ISO20022: Name of the building or house. API: Cannot be used for SEPA payments. ' type: string maxLength: 16 postCode: description: '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. ' type: string maxLength: 16 townName: description: 'ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments. ' type: string maxLength: 35 countrySubDivision: description: 'ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments. ' type: string maxLength: 35 country: description: '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. ' type: string pattern: ^([A-Z]{2,2})$ addressLine: description: 'Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed. ' type: array items: description: Address line type: string maxLength: 70 maxItems: 7 required: - country - addressLine example: country: FR addressLine: - 18 rue de la DSP2 - 75008 PARIS ResourceId: description: 'API: Identifier assigned by the ASPSP for further use of the created resource through API calls. The API client cannot set or modify the value of this field. Since this value can be exchanged between the server and the client as an URL element or for support information, it must not contain sensitive value such as personal or business data. ' type: string pattern: ^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$ readOnly: true example: MyInstrRscId CreditorReferenceInformation: description: Reference information provided by the creditor to allow the identification of the underlying documents. type: object properties: type: $ref: '#/components/schemas/CodeAndIssuer' reference: description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. type: string maxLength: 35 PaymentRequestResource: description: "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.\nAPI: \nInformation about the creditor (Id, account and agent) might be placed either at payment level or at instruction level. Thus multi-beneficiary payments can be handled.\nThe requested execution date can be placed either at payment level when all instructions are requested to be executed at the same date or at instruction level.\nThe latest case includes:\n- multiple instructions having different requested execution dates\n- standing orders settings \n" type: object properties: resourceId: $ref: '#/components/schemas/ResourceId' paymentInformationId: $ref: '#/components/schemas/PaymentInformationId' batchBooking: $ref: '#/components/schemas/BatchBookingIndicator' creationDateTime: $ref: '#/components/schemas/CreationDateTime' numberOfTransactions: description: '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 ' type: integer minimum: 1 initiatingParty: $ref: '#/components/schemas/PartyIdentification' acceptDebtorAccountChange: description: '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 ' type: boolean acceptChargeHandlingChange: description: '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 ' type: boolean paymentTypeInformation: $ref: '#/components/schemas/PaymentTypeInformation' debtor: $ref: '#/components/schemas/PartyIdentification' debtorAccount: $ref: '#/components/schemas/AccountIdentification' debtorAgent: $ref: '#/components/schemas/FinancialInstitutionIdentification' beneficiary: $ref: '#/components/schemas/Beneficiary' chargeBearer: $ref: '#/components/schemas/ChargeBearerCode' paymentInformationStatus: $ref: '#/components/schemas/PaymentInformationStatusCode' statusReasonInformation: $ref: '#/components/schemas/StatusReasonInformation' fundsAvailability: $ref: '#/components/schemas/FundsAvailabilityInformation' booking: $ref: '#/components/schemas/BookingInformation' requestedExecutionDate: description: "ISO20022: Date at which the initiating party requests the clearing agent to process the payment. \n" type: string format: date-time creditTransferTransaction: description: '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 ' type: array items: $ref: '#/components/schemas/CreditTransferTransaction' minItems: 1 supplementaryData: $ref: '#/components/schemas/SupplementaryData' required: - paymentInformationId - creationDateTime - numberOfTransactions - initiatingParty - paymentTypeInformation - creditTransferTransaction - supplementaryData example: paymentInformationId: MyPmtInfId creationDateTime: '2018-03-31T13:25:22.527+02:00' numberOfTransactions: 1 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: DVPM debtor: name: MyCustomer postalAddress: country: FR addressLine: - 18 rue de la DSP2 - 75008 PARIS privateId: identification: FD37G schemeName: BANK issuer: BICXYYTTZZZ beneficiary: creditor: name: myMerchant postalAddress: country: FR addressLine: - 18 rue de la DSP2 - 75008 PARIS organisationId: identification: '852126789' schemeName: SIREN issuer: FR creditorAccount: iban: YY64COJH41059545330222956960771321 ultimateCreditor: name: myPreferredUltimateMerchant postalAddress: country: FR addressLine: - 18 rue de la DSP2 - 75008 PARIS organisationId: identification: '85212678900025' schemeName: SIRET issuer: FR purpose: COMC chargeBearer: SLEV creditTransferTransaction: - paymentId: instructionId: MyInstrId endToEndId: MyEndToEndId requestedExecutionDate: '2016-12-31T00:00:00.000+01:00' instructedAmount: currency: EUR amount: 124.35 remittanceInformation: - MyRemittanceInformation supplementaryData: acceptedAuthenticationApproach: - REDIRECT - DECOUPLED successfulReportUrl: http://myPisp/PaymentSuccess unsuccessfulReportUrl: http://myPisp/PaymentFailure InstructionForCreditorAgent: description: 'Further information related to the processing of the payment instruction that may need to be acted upon by the creditor''s agent. The instruction may relate to a level of service, or may be an instruction that has to be executed by the creditor''s agent, or may be information required by the creditor''s agent. ' type: object properties: code: description: 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. | type: string enum: - CHQB - HOLD - PHOB - TELB instructionInformation: description: Further information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community. type: string maxLength: 140 TransactionIndividualStatusCode: description: 'ISO20022: Specifies the status of the payment information group. API: Only the following values are allowed to provide the status of the subsequent CREDIT TRANSFER to the Payment Request | Code | Name | Description | | ---- | ---- | ---------- | | ACSC | AcceptedSettlementCompleted | Settlement on the debtor''s account was completed. In the case of SCTInst, this status must not been set by the debtor''s Bank before the reception of the positive confirmation. | | ACSP | AcceptedSettlementInProcess | All preceding checks such as technical validation and customer profile were successful and therefore the Payment Request has been accepted for execution. | | ACTC | AcceptedTechnicalValidation | Authentication and syntactical and semantical validation are successful. | | CANC | Cancelled | Payment initiation has been 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. | | RJCT | Rejected | Payment request or individual transaction included in the Payment Request has been rejected. | ![](https://www.stet.eu//assets/files/documents-api/transaction-status-1-4-2.png) ' type: string enum: - ACSC - ACSP - ACTC - CANC - PDNG - RJCT example: ACSP AccountIdentification: description: Unique and unambiguous identification for the account between the account owner and the account servicer. type: object properties: iban: description: "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" type: string pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ other: $ref: '#/components/schemas/GenericIdentification' currency: $ref: '#/components/schemas/CurrencyCode' example: iban: YY64COJH41059545330222956960771321 Nonce: description: 'Challenge to be sent in order to avoid replay of the authentication process. ' type: string maxLength: 70 PartyIdentification: description: 'API : Description of a Party which can be either a person or an organization. ' type: object properties: name: description: 'ISO20022: Name by which a party is known and which is usually used to identify that party. ' type: string maxLength: 140 dateAndPlaceOfBirth: $ref: '#/components/schemas/DateAndPlaceOfBirth' postalAddress: $ref: '#/components/schemas/PostalAddress' organisationId: $ref: '#/components/schemas/GenericIdentification' privateId: $ref: '#/components/schemas/GenericIdentification' required: - name example: name: MyPreferredPisp postalAddress: country: FR addressLine: - 18 rue de la DSP2 - 75008 PARIS AppliedAuthenticationApproach: description: 'The ASPSP, based on the authentication approaches proposed by the PISP, choose the one that it can processed, in respect with the preferences and constraints of the PSU and indicates in this field which approach has been chosen. It may happen that the ASPSP considers that, in case of payment cancellation request, there is no need for authentication and will then return "NONE". ' type: string enum: - REDIRECT - DECOUPLED - EMBEDDED-1-FACTOR - NONE readOnly: true example: REDIRECT Beneficiary: description: Specification of a beneficiary type: object properties: id: description: Id of the beneficiary type: string pattern: ^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$ isTrusted: description: "The ASPSP having not implemented the trusted beneficiaries list must not set this flag.\nOtherwise, the ASPSP indicates whether or not the beneficiary has been registered by the PSU within the trusted beneficiaries list.\n- true: the beneficiary is actually a trusted beneficiary\n- false: the beneficiary is not a trusted beneficiary \n" type: boolean readOnly: true creditorAgent: $ref: '#/components/schemas/FinancialInstitutionIdentification' creditor: $ref: '#/components/schemas/PartyIdentification' creditorAccount: $ref: '#/components/schemas/AccountIdentification' required: - creditor example: id: MyBeneficiaryId isTrusted: true creditorAgent: bicFi: BNKAFRPPXXX creditor: name: MyPreferredPisp postalAddress: country: FR addressLine: - 18 rue de la DSP2 - 75008 PARIS creditorAccount: iban: YY64COJH41059545330222956960771321 HalPaymentRequestCreation: description: 'data forwarded by the ASPSP top the PISP after creation of the Payment Request resource creation ' type: object properties: appliedAuthenticationApproach: $ref: '#/components/schemas/AppliedAuthenticationApproach' nonce: $ref: '#/components/schemas/Nonce' _links: $ref: '#/components/schemas/PaymentRequestResourceCreationLinks' example: appliedAuthenticationApproach: appliedAuthenticationApproach: REDIRECT _links: consentApproval: href: https://psd2.aspsp/consent-approval HalPaymentRequest: description: HYPERMEDIA structure used for returning the original Payment Request to the PISP type: object properties: paymentRequest: $ref: '#/components/schemas/PaymentRequestResource' _links: $ref: '#/components/schemas/PaymentRequestLinks' required: - paymentRequest - _links example: paymentRequest: paymentInformationId: MyPmtInfId creationDateTime: '2018-03-31T13:25:22.527+02:00' numberOfTransactions: 1 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: DVPM debtor: name: MyCustomer postalAddress: country: FR addressLine: - 18 rue de la DSP2 - 75008 PARIS privateId: identification: FD37G schemeName: BANK issuer: BICXYYTTZZZ beneficiary: isTrusted: true creditor: name: myMerchant postalAddress: country: FR addressLine: - 18 rue de la DSP2 - 75008 PARIS organisationId: identification: '852126789' schemeName: SIREN issuer: FR creditorAccount: iban: YY64COJH41059545330222956960771321 ultimateCreditor: name: myPreferredUltimateMerchant postalAddress: country: FR addressLine: - 18 rue de la DSP2 - 75008 PARIS organisationId: identification: '85212678900025' schemeName: SIRET issuer: FR purpose: COMC chargeBearer: SLEV creditTransferTransaction: - paymentId: instructionId: MyInstrId endToEndId: MyEndToEndId requestedExecutionDate: '2016-12-31T00:00:00.000+01:00' instructedAmount: currency: EUR amount: 124.35 remittanceInformation: - MyRemittanceInformation supplementaryData: acceptedAuthenticationApproach: - REDIRECT - DECOUPLED successfulReportUrl: http://myPisp/PaymentSuccess unsuccessfulReportUrl: http://myPisp/PaymentFailure _links: self: href: v1/payment-requests/MyPmtInfRscId confirmation: href: v1/payment-requests/MyPmtInfRscId/confirmation BookingInformation: description: 'indicator that the payment can be immediately booked or not - true: payment is booked - false: payment is not booked ' type: boolean readOnly: true example: 'true' ReferredDocumentInformations: description: 'Provides the identification and the content of the referred documents. ' type: array items: $ref: '#/components/schemas/ReferredDocumentInformation' CreditTransferTransaction: description: "ISO20022: Payment processes required to transfer cash from the debtor to the creditor.\nAPI: \n" type: object properties: paymentId: $ref: '#/components/schemas/PaymentIdentification' requestedExecutionDate: $ref: '#/components/schemas/RequestedExecutionDate' endDate: $ref: '#/components/schemas/EndDate' executionRule: $ref: '#/components/schemas/ExecutionRule' frequency: $ref: '#/components/schemas/FrequencyCode' instructedAmount: $ref: '#/components/schemas/AmountType' equivalentAmount: $ref: '#/components/schemas/EquivalentAmountType' exchangeRateInformation: $ref: '#/components/schemas/ExchangeRate' ultimateDebtor: $ref: '#/components/schemas/PartyIdentification' intermediaryAgent: $ref: '#/components/schemas/IntermediaryAgent' beneficiary: $ref: '#/components/schemas/Beneficiary' ultimateCreditor: $ref: '#/components/schemas/PartyIdentification' instructionForCreditorAgent: description: Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent. type: array items: $ref: '#/components/schemas/InstructionForCreditorAgent' purpose: $ref: '#/components/schemas/PurposeCode' regulatoryReportingCodes: $ref: '#/components/schemas/RegulatoryReportingCodes' remittanceInformation: $ref: '#/components/schemas/RemittanceInformation' transactionStatus: $ref: '#/components/schemas/TransactionIndividualStatusCode' statusReasonInformation: $ref: '#/components/schemas/StatusReasonInformation' required: - paymentId example: paymentIdentification: resourceId: MyInstrRscId instructionIdentification: MyInstrId endToEndIdentification: MyEndToEndId requestedExecutionDate: '2016-12-31T00:00:00.000+01:00' instructedAmount: currency: EUR amount: 124.35 remittanceInformation: - MyRemittanceInformation FinancialInstitutionIdentification: description: 'ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme. ' type: object properties: bicFi: description: '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)". ' type: string pattern: ^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$ clearingSystemMemberId: $ref: '#/components/schemas/ClearingSystemMemberIdentification' name: description: Name of the financial institution type: string maxLength: 140 postalAddress: $ref: '#/components/schemas/PostalAddress' required: - bicFi example: bicFi: BNKAFRPPXXX EquivalentAmountType: description: "Structure aiming to embed the amount and the currency to be used.\nThe currency of transfer should be set. \n" type: object properties: amount: description: '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. ' type: number format: float pattern: ^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$ currency: $ref: '#/components/schemas/CurrencyCode' currencyOfTransfer: $ref: '#/components/schemas/CurrencyCode' required: - amount - currency - currencyOfTransfer example: currency: EUR currencyOfTransfer: USD amount: 12.25 StatusReasonInformation_2: description: 'ISO20022: Provides detailed information on the status reason. API: Can only be used in case the status is equal to "RJCT" or "CANC". Only the following values are allowed: | Code | Name | Description | | ---- | ---- | ---------- | | AC01 | IncorectAccountNumber | the account number is either invalid or does not exist | | AC04 | ClosedAccountNumber | the account is closed and cannot be used | | AC06 | BlockedAccount | the account is blocked and cannot be used | | AG01 | TransactionForbidden | Transaction forbidden on this type of account | | AG03 | TransactionNotSupported | Transaction type not supported/authorized on this account | | 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. | ' type: string enum: - AC01 - AC04 - AC06 - AG01 - AG03 - AM18 - CH03 - CUST - DS02 - DUPL - FF01 - FRAD - MS03 - NOAS - RR01 - RR03 - RR04 - RR12 - CNOR - CH04 TaxAmount_2: description: 'ISO20022: Set of elements used to provide information on the amount of the tax record. API: Amounts must always be set as positive values. | Property | Description | | -------- | ----------- | | rate | Rate used to calculate the tax. | | taxableBaseAmount | Amount of money on which the tax is based. | | totalAmount | Total amount that is the result of the calculation of the tax for the record. | | details | Set of elements used to provide details on the tax period and amount. | ' type: object properties: rate: $ref: '#/components/schemas/PercentageRate' taxableBaseAmount: $ref: '#/components/schemas/AmountType_2' totalAmount: $ref: '#/components/schemas/AmountType_2' details: description: Set of elements used to provide details on the tax period and amount. type: array items: $ref: '#/components/schemas/TaxRecordDetails_2' minItems: 1 example: "{\n \"details\" : [ {\n \"period\" : {\n \"year\" : \"2020\",\n \"type\" : \"QTR4\",\n \"fromDate\" : \"2019-10-01\",\n \"toDate\" : \"2020-01-01\"\n },\n \"amount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n } ]\n}" AuthenticationApproaches: description: List of authentication approaches type: array items: $ref: '#/components/schemas/AuthenticationApproach' PurposeCode_2: description: 'ISO20022: Underlying reason for the payment transaction, as published in an external purpose code list. API: The following values are allowed for Payment Request | Code | Name | Description | | ---- | ---- | ---------- | | ACCT | AccountManagement | Funds moved between 2 accounts of same account holder at the same bank) | | CASH | CashManagementTransfer | (general cash management instruction) may be used for Transfer Initiation | | COMC | CommercialPayment | Transaction is related to a payment of commercial credit or debit. | | CPKC | CarparkCharges | General Carpark Charges Transaction is related to carpark charges. | | 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. | ' type: string enum: - ACCT - CASH - COMC - CPKC - TRPT - SALA PaymentInformationId_2: description: 'ISO20022: Reference assigned by a sending party to unambiguously identify the payment information block within the message. API: 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. ' type: string pattern: ^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$ ConfirmationResource_2: description: Confirmation request resource type: object properties: nonce: $ref: '#/components/schemas/Nonce' psuAuthenticationFactor: description: authentication factor forwarded by the TPP to the ASPSP in order to fulfil the strong customer authentication process type: string example: "{\n \"nonce\" : \"Nonce56fdd\",\n \"psuAuthenticationFactor\" : \"U1RF51mITWWmTQ72M1xWiw\"\n}" ExchangeRate_2: description: 'ISO20022: Provides details on the currency exchange rate and contract. The [unitCurrency] property specifies the currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. The [estimatedPayerAmount] gives an estimation of the amount that will be debited on the payer''s account, including transaction and change fees. The [estimatedPayeeAmunt] gives an estimation of the amount that will be credited on the payee''s account. API: Amounts must always be set as positive values. ' type: object properties: unitCurrency: $ref: '#/components/schemas/CurrencyCode_2' exchangeRate: description: '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. ' type: number format: float rateType: description: '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. | ' type: string enum: - SPOT - SALE - AGRD contractIdentification: description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. type: string maxLength: 35 estimatedPayerAmount: $ref: '#/components/schemas/AmountType_2' estimatedPayeeAmount: $ref: '#/components/schemas/AmountType_2' required: - rateType example: "{\n \"unitCurrency\" : \"USD\",\n \"exchangeRate\" : 1.1,\n \"rateType\" : \"AGRD\",\n \"contractIdentification\" : \"CTRCT37H8\"\n}" PriorityCode_2: description: '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. API: This field is useless for SCTInst and thus should be ignored. ' type: string enum: - HIGH - NORM ExecutionRule_2: description: 'Execution date shifting rule for standing orders This data attribute defines the behaviour when recurring payment dates falls on a weekend or bank holiday. The payment is then executed either the "preceding" or "following" working day. ASPSP might reject the request due to the communicated value, if rules in Online-Banking are not supporting this execution rule. | Code | Description | | ---- | ----------- | | FWNG | following | | PREC | preceding | ' type: string enum: - FWNG - PREC RegulatoryReportingCodes_2: description: 'List of needed regulatory reporting codes for international payments ' type: array items: $ref: '#/components/schemas/RegulatoryReportingCode_2' minItems: 1 maxItems: 10 TitleAndName_2: description: Title and Name of the party or the party's authorised reprensentative. type: object properties: title: description: Title or position of the party or the party's authorised reprensentative. type: string maxLength: 35 name: description: Name of the party or the party's authorised reprensentative. type: string maxLength: 140 example: "{\n \"title\" : \"M.\",\n \"name\" : \"John Doe\"\n}" CreationDateTime_2: description: 'ISO20022: Date and time at which a (group of) payment instruction(s) was created by the instructing party. ' type: string format: date-time ContactDetails: description: 'Indicates how to contact the party. ' type: object properties: phoneNumber: $ref: '#/components/schemas/PhoneNumber' faxNumber: $ref: '#/components/schemas/PhoneNumber' emailAddress: description: email address of the contact type: string pattern: ^.+@.+$ maxLength: 2048 example: "{\n \"emailAddress\" : \"John.doe@john-doe.com\"\n}" StartDate: description: 'The first applicable day of execution for a given period. ' type: string format: date-time RemittanceInformation_2: description: 'ISO20022: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts'' receivable system. API: - Only one occurrence of the unstructured information is allowed. - Only one occurrence of the structured information is allowed. - Structured and unstructured information can coexist. ' type: object properties: unstructured: description: "Unstructured remittance information.\nEach implementation may add a pattern in order to specify its own character set constraints. \n" type: array items: title: remittanceLine description: Relevant information to the transaction type: string maxLength: 140 minItems: 1 structured: description: Structured remittance information type: array items: $ref: '#/components/schemas/StructuredRemittanceInformation_2' minItems: 1 example: "{\n \"unstructured\" : [ \"MyRemittanceInformation\" ]\n}" ServiceLevelCode_2: description: '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. API: Only "SEPA" (SEPA Credit Transfer) value is allowed ' type: string enum: - SEPA ErrorDetail: description: detailed error description type: object properties: location: description: Location of the erroneous parameter when not in request body type: string enum: - header - query name: description: Name of the erroneous parameter when not in request body type: string path: description: JsonPath of the erroneous request body property type: string erroneousValue: description: Erroneous parameter value type: string message: description: Relevant message for the erroneous parameter type: string expectedPattern: description: Expected pattern, if any, that the erroneous parameter does not match with type: string expectedValueRange: description: Expected value range, if any, that the erroneous parameter does not match with type: object example: "{\n \"minValue\": 1,\n \"maxValue\": 100\n} " properties: minValue: type: integer maxValue: type: integer expectedValueCount: description: Expected value count, in the case of an array item, that the erroneous parameter does not match with type: object example: "{\n \"minValue\": \"1\"\n} " properties: minValue: type: integer maxValue: type: integer expectedEnumeration: description: Expected enumeration, if any, that the erroneous parameter do not match with type: array items: type: string CreditDebitIndicator_2: description: 'Accounting flow of the amount | Code | Description | | ---- | ----------- | | CRDT | Credit type amount | | DBIT | Debit type amount | ' type: string enum: - CRDT - DBIT ClearingSystemMemberIdentification_2: description: 'ISO20022: Information used to identify a member within a clearing system. API: to be used for some specific international credit transfers in order to identify the beneficiary bank ' type: object properties: clearingSystemId: description: 'ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed. ' type: string maxLength: 35 memberId: description: 'ISO20022: Identification of a member of a clearing system. ' type: string maxLength: 35 required: - clearingSystemId - memberId example: "{\n \"clearingSystemId\" : \"NZNCC\",\n \"memberId\" : \"020368\"\n}" TypedAmount_2: description: 'ISO20022: Typed Amount API: Amounts must always be set as positive values. ' type: object properties: type: description: Type of the amount type: string maxLength: 35 amount: $ref: '#/components/schemas/AmountType_2' required: - amount example: "{\n \"type\" : \"CHRG\",\n \"amount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n}" LineDetail_2: description: Set of elements used to provide the content of the referred document line. type: object properties: identification: $ref: '#/components/schemas/DocumentLineIdentification_2' description: description: Description associated with the document line. type: string maxLength: 2048 amount: $ref: '#/components/schemas/RemittanceAmount_2' example: "{\n \"identification\" : {\n \"type\" : {\n \"code\" : \"CD01\",\n \"issuer\" : \"MyIssuer\"\n },\n \"number\" : \"1\",\n \"relatedDate\" : \"2020-02-09\"\n },\n \"description\" : \"Some comments\",\n \"amount\" : {\n \"remittedAmount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n }\n}" CategoryPurposeCode_2: description: '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. API: The following values are allowed: | 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. | ' type: string enum: - CASH - CORT - DVPM - INTC - TREA - SALA PaymentInformationStatusCode_2: description: 'ISO20022: Specifies the status of the payment information. API: Mandatory. The following values are allowed to provide the status of the Payment Request | 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. | ![](https://www.stet.eu//assets/files/documents-api/payment-request-status-1-4-2.png) ' type: string enum: - ACCP - ACSC - ACSP - ACTC - ACWC - ACWP - CANC - PART - RCVD - PDNG - RJCT - ACCO EndDate_2: description: 'The last applicable day of execution for a given period. If not given, the period is considered as endless. ' type: string format: date-time CreditTransferTransactionResource: description: "ISO20022: Payment processes required to transfer cash from the debtor to the creditor.\nThe [instructedAmount] property indicates 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.\n Usage: This amount has to be transported unchanged through the transaction chain.\nAPI: Amounts must always be set as positive values.\n" type: object properties: paymentId: $ref: '#/components/schemas/PaymentIdentification_2' resourceId: $ref: '#/components/schemas/ResourceId_2' requestedExecutionDate: $ref: '#/components/schemas/RequestedExecutionDate_2' cancellableTill: description: '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. ' type: string format: date-time acceptanceDateTime: description: '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. ' type: string format: date-time debtorDecisionDate: description: 'ISO20022: Date and time on when the debtor has accepted or rejected the request. ' type: string format: date-time appliedExecutionDate: description: 'ISO20022: Date and time on when the payment was executed. ' type: string format: date-time standingOrderCharacteristics: $ref: '#/components/schemas/StandingOrderCharacteristics' instructedAmount: $ref: '#/components/schemas/AmountType_2' equivalentAmount: $ref: '#/components/schemas/EquivalentAmountType_2' exchangeRateInformation: $ref: '#/components/schemas/ExchangeRate_2' ultimateDebtor: $ref: '#/components/schemas/PartyIdentification_2' intermediaryAgent: $ref: '#/components/schemas/IntermediaryAgent_2' beneficiary: $ref: '#/components/schemas/Beneficiary_2' ultimateCreditor: $ref: '#/components/schemas/PartyIdentification_2' instructionForCreditorAgent: description: Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent. type: array items: $ref: '#/components/schemas/InstructionForCreditorAgent_2' purpose: $ref: '#/components/schemas/PurposeCode_2' regulatoryReportingCodes: $ref: '#/components/schemas/RegulatoryReportingCodes_2' remittanceInformation: $ref: '#/components/schemas/RemittanceInformation_2' transactionStatus: $ref: '#/components/schemas/TransactionIndividualStatusCode_2' statusReasonInformation: $ref: '#/components/schemas/StatusReasonInformation_2' supplementaryData: $ref: '#/components/schemas/SupplementaryData_2' required: - paymentId - beneficiary example: "{\n \"paymentId\" : {\n \"instructionId\" : \"MyInstrId3\",\n \"endToEndId\" : \"MyEndToEndId3\"\n },\n \"requestedExecutionDate\" : \"2020-02-19T12:56:54.639Z\",\n \"instructedAmount\" : {\n \"amount\" : 124.35,\n \"currency\" : \"EUR\"\n },\n \"beneficiary\" : {\n \"creditor\" : {\n \"name\" : \"myMerchant\",\n \"postalAddress\" : {\n \"country\" : \"FR\",\n \"addressLine\" : [ \"18 rue de la DSP2\", \"75008 PARIS\" ]\n },\n \"organisationId\" : {\n \"identification\" : \"852126789\",\n \"schemeName\" : \"SIREN\",\n \"issuer\" : \"FR\"\n }\n },\n \"creditorAccount\" : {\n \"iban\" : \"YY64COJH41059545330222956960771321\",\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}" RegulatoryReportingCode_2: description: 'Information needed due to regulatory and statutory requirements. Economical codes to be used are provided by the National Competent Authority ' type: string maxLength: 10 LeiIdentification: description: 'Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". ' type: string pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$ GenericIdentification_2: description: 'ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support. ' type: object properties: identification: description: 'API: Identifier ' type: string maxLength: 70 schemeName: description: '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 ' type: string maxLength: 70 issuer: description: 'ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties ' type: string maxLength: 35 required: - identification - schemeName example: "{\n \"identification\" : \"12FR5\",\n \"schemeName\" : \"COID\",\n \"issuer\" : \"ACPR\"\n}" PaymentRequestResourceCreationLinks_2: description: 'links that can be used for further navigation, especially in REDIRECT approach | Link | Description | | ---- | ----------- | | consentApproval | URL to be used by the PISP in order to start the ASPSP authentication and consent management process | ' type: object properties: consentApproval: $ref: '#/components/schemas/GenericLink_2' readOnly: true example: "{\n \"consentApproval\" : {\n \"href\" : \"https://psd2.aspsp/consent-approval\"\n }\n}" IntermediaryAgent_2: description: Agent and agent account between the debtor's agent and the creditor's agent. type: object properties: agent: $ref: '#/components/schemas/PartyIdentification_2' agentAccount: $ref: '#/components/schemas/AccountIdentification_2' example: "{\n \"agent\" : {\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 \"agentAccount\" : {\n \"iban\" : \"YY64COJH41059545330222956960771321\",\n \"currency\" : \"EUR\"\n }\n}" TaxParty_2: description: 'Set of elements used to identify a party of the transaction to which the tax applies. The [authorization] property aims to provide the details of the authorised tax paying party. ' type: object properties: taxIdentification: description: Tax identification number of the party. type: string maxLength: 35 registrationIdentification: description: Unique identification, as assigned by an organisation, to unambiguously identify a party. type: string maxLength: 35 taxType: description: Type of tax payer. type: string maxLength: 35 authorisation: $ref: '#/components/schemas/TitleAndName_2' example: "{\n \"taxIdentification\" : \"TaxIdHGH5445\",\n \"registrationIdentification\" : \"REGId387H\",\n \"taxType\" : \"VAT\",\n \"authorisation\" : {\n \"title\" : \"M.\",\n \"name\" : \"John Doe\"\n }\n}" SupplementaryData_2: description: 'ISO20022: Additional information that cannot be captured in the structured elements and/or any other specific block. API: This structure is used to embed the relevant URLs for returning the status report to the PISP and to specify which authentication approaches are accepted by the PISP and which was chosen by the ASPSP The [acceptedAuthenticationApproach] property can only be set by the PISP. - Authentication approaches that are supported by the PISP. The PISP can provide several choices separated by commas. - Case of none of the accepted approaches is supported by the ASPSP, the latest will respond with HTTP400 (Bad request) and specify wich approaches are actually supported. The [appliedAuthentication] will be set by the ASPSP. - The ASPSP, based on the authentication approaches proposed by the PISP, choose the one that it can processed, in respect with the preferences and constraints of the PSU and indicates in this field which approach was chosen. - It may happen that the ASPSP considers that, in case of payment cancellation request, there is no need for authentication and will then return "NONE". ' type: object properties: acceptedAuthenticationApproach: $ref: '#/components/schemas/AuthenticationApproaches' appliedAuthenticationApproach: $ref: '#/components/schemas/AuthenticationApproach' appliedAuthentication: description: '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. ' type: string enum: - noAuthentication - oneFactorAuthentication - strongAuthentication scaHint: description: 'can only be set by the PISP Hint given by the merchant and/or the PISP about an SCA exemption context ' type: string enum: - noScaExemption - scaExemption successfulReportUrl: description: '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 ' type: string unsuccessfulReportUrl: description: '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 ' type: string nextStatusRequestHint: description: 'Date and time at which the PISP is suggested to ask again for the status of the payment request. ' type: string format: date-time example: "{\n \"successfulReportUrl\" : \"http://myPisp/PaymentSuccess\",\n \"unsuccessfulReportUrl\" : \"http://myPisp/PaymentFailure\"\n}" CreditTransferTransactionLinks: description: 'links that can be used for further navigation when retrieving the transaction of a payment request. | Link | Description | | ---- | ----------- | | self | link to the transactions | | parent | This link shall point to the parent payment request. | | first | link to the first page of the transactions result | | last | link to the last page of the transactions result | | next | link to the next page of the transactions result | | prev | link to the previous page of the transactions result | ' type: object properties: self: $ref: '#/components/schemas/GenericLink_2' parent: $ref: '#/components/schemas/GenericLink_2' first: $ref: '#/components/schemas/GenericLink_2' last: $ref: '#/components/schemas/GenericLink_2' next: $ref: '#/components/schemas/GenericLink_2' prev: $ref: '#/components/schemas/GenericLink_2' readOnly: true example: "{\n \"self\": {\n \"href\": \"/v1/payment-requests/MyPmtInfRscId/creditTransfertTransactions\"\n },\n \"parent\": {\n \"href\": \"/v1/payment-requests/MyPmtInfRscId\"\n }\n}" CodeAndIssuer_2: description: 'Specifies a code and the issuer of this code. ' type: object properties: code: description: Provides the code. type: string maxLength: 4 issuer: description: Identification of the issuer of the code. type: string maxLength: 35 required: - code example: "{\n \"code\" : \"CD01\",\n \"issuer\" : \"MyIssuer\"\n}" StructuredRemittanceInformation_2: description: 'Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts'' receivable system, in a structured form. ' type: object properties: referredDocumentInformation: $ref: '#/components/schemas/ReferredDocumentInformations_2' referredDocumentAmount: $ref: '#/components/schemas/RemittanceAmount_2' creditorReferenceInformation: $ref: '#/components/schemas/CreditorReferenceInformation_2' invoicer: $ref: '#/components/schemas/PartyIdentification_2' invoicee: $ref: '#/components/schemas/PartyIdentification_2' taxRemittance: $ref: '#/components/schemas/TaxInformation_2' example: "{\n \"referredDocumentInformation\" : [ {\n \"type\" : {\n \"code\" : \"CD01\",\n \"issuer\" : \"MyIssuer\"\n },\n \"number\" : \"1\",\n \"relatedDate\" : \"2020-02-19\",\n \"lineDetails\" : [ {\n \"amount\" : {\n \"remittedAmount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n }\n } ]\n } ],\n \"referredDocumentAmount\" : {\n \"remittedAmount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n },\n \"creditorReferenceInformation\" : {\n \"type\" : {\n \"code\" : \"CD01\",\n \"issuer\" : \"MyIssuer\"\n },\n \"reference\" : \"CredRef56FH6\"\n },\n \"invoicee\" : {\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 \"taxRemittance\" : {\n \"creditor\" : {\n \"taxIdentification\" : \"TaxIdHGH5445\",\n \"registrationIdentification\" : \"REGId387H\",\n \"taxType\" : \"VAT\",\n \"authorisation\" : {\n \"title\" : \"M.\",\n \"name\" : \"John Doe\"\n }\n },\n \"debtor\" : {\n \"taxIdentification\" : \"TaxIdHGH5445\",\n \"registrationIdentification\" : \"REGId387H\",\n \"taxType\" : \"VAT\",\n \"authorisation\" : {\n \"title\" : \"M.\",\n \"name\" : \"John Doe\"\n }\n },\n \"administrationZone\" : \"FR\",\n \"method\" : \"CT\",\n \"date\" : \"2020-02-19\",\n \"record\" : [ {\n \"type\" : \"NationalTax\",\n \"category\" : \"VAT\",\n \"categoryDetails\" : \"VAT02\",\n \"debtorStatus\" : \"Valid\",\n \"certificateIdentification\" : \"CertId56RD\",\n \"formsCode\" : \"FormHJH7\",\n \"period\" : {\n \"year\" : \"2020\",\n \"type\" : \"QTR4\",\n \"fromDate\" : \"2019-10-01\",\n \"toDate\" : \"2020-01-01\"\n },\n \"taxAmount\" : {\n \"details\" : [ {\n \"period\" : {\n \"year\" : \"2020\",\n \"type\" : \"QTR4\",\n \"fromDate\" : \"2019-10-01\",\n \"toDate\" : \"2020-01-01\"\n },\n \"amount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n } ]\n },\n \"additionalInformation\" : \"Some comment\"\n } ]\n }\n}" ReferredDocumentInformation_2: description: Provides the identification and the content of the referred document. type: object properties: type: $ref: '#/components/schemas/CodeAndIssuer_2' number: description: Unique and unambiguous identification of the referred document. type: string maxLength: 35 relatedDate: description: Date associated with the referred document. type: string format: date lineDetails: description: Sets of elements used to provide the content of the referred document line. type: array items: $ref: '#/components/schemas/LineDetail_2' minItems: 1 example: "{\n \"type\" : {\n \"code\" : \"CD01\",\n \"issuer\" : \"MyIssuer\"\n },\n \"number\" : \"1\",\n \"relatedDate\" : \"2020-02-19\",\n \"lineDetails\" : [ {\n \"amount\" : {\n \"remittedAmount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n }\n } ]\n}" TaxPeriod_2: description: 'Set of elements used to provide details on the period of time related to the tax payment. The [type] property aims to identify the period related to the tax payment. ' type: object properties: year: description: Year related to the tax payment. type: string pattern: ^[0-9]{4,4}$ type: $ref: '#/components/schemas/TaxRecordPeriodCode' fromDate: description: Start date of the range. type: string format: date toDate: description: End date of the range. type: string format: date example: "{\n \"year\" : \"2020\",\n \"type\" : \"QTR4\",\n \"fromDate\" : \"2019-10-01\",\n \"toDate\" : \"2020-01-01\"\n}" TaxInformation_2: description: 'ISO20022: Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account. API: Amounts must always be set as positive values. The [totalTaxableBaseAmount] property indicates the total amount of money on which the tax is based. The [totalTaxAmount] property indicates the total amount of money as result of the calculation of the tax. ' type: object properties: creditor: $ref: '#/components/schemas/TaxParty_2' debtor: $ref: '#/components/schemas/TaxParty_2' ultimateDebtor: $ref: '#/components/schemas/TaxParty_2' administrationZone: description: Territorial part of a country to which the tax payment is related. type: string maxLength: 35 referenceNumber: description: Tax reference information that is specific to a taxing agency. type: string maxLength: 140 method: description: Method used to indicate the underlying business or how the tax is paid. type: string maxLength: 35 totalTaxableBaseAmount: $ref: '#/components/schemas/AmountType_2' totalTaxAmount: $ref: '#/components/schemas/AmountType_2' date: description: Date by which tax is due. type: string format: date sequenceNumber: description: Sequential number of the tax report. type: integer format: int32 record: description: Records of tax details type: array items: $ref: '#/components/schemas/TaxRecord_2' minItems: 1 example: "{\n \"creditor\" : {\n \"taxIdentification\" : \"TaxIdHGH5445\",\n \"registrationIdentification\" : \"REGId387H\",\n \"taxType\" : \"VAT\",\n \"authorisation\" : {\n \"title\" : \"M.\",\n \"name\" : \"John Doe\"\n }\n },\n \"debtor\" : {\n \"taxIdentification\" : \"TaxIdHGH5445\",\n \"registrationIdentification\" : \"REGId387H\",\n \"taxType\" : \"VAT\",\n \"authorisation\" : {\n \"title\" : \"M.\",\n \"name\" : \"John Doe\"\n }\n },\n \"administrationZone\" : \"FR\",\n \"method\" : \"CT\",\n \"date\" : \"2020-02-19\",\n \"record\" : [ {\n \"type\" : \"NationalTax\",\n \"category\" : \"VAT\",\n \"categoryDetails\" : \"VAT02\",\n \"debtorStatus\" : \"Valid\",\n \"certificateIdentification\" : \"CertId56RD\",\n \"formsCode\" : \"FormHJH7\",\n \"period\" : {\n \"year\" : \"2020\",\n \"type\" : \"QTR4\",\n \"fromDate\" : \"2019-10-01\",\n \"toDate\" : \"2020-01-01\"\n },\n \"taxAmount\" : {\n \"details\" : [ {\n \"period\" : {\n \"year\" : \"2020\",\n \"type\" : \"QTR4\",\n \"fromDate\" : \"2019-10-01\",\n \"toDate\" : \"2020-01-01\"\n },\n \"amount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n } ]\n },\n \"additionalInformation\" : \"Some comment\"\n } ]\n}" PaymentIdentification_2: description: 'ISO20022: Set of elements used to reference a payment instruction. ' type: object properties: instructionId: description: '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 ' type: string pattern: ^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$ endToEndId: $ref: '#/components/schemas/EndToEndId' uetr: description: 'ISO20022: Universally unique identifier to provide an end-to-end reference of a payment transaction. ' type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$ required: - instructionId example: "{\n \"resourceId\" : \"MyInstrRscId1\",\n \"instructionId\" : \"MyInstrId1\",\n \"endToEndId\" : \"MyEndToEndId1\"\n}" AmountType_2: description: 'Structure aiming to embed the amount and the currency to be used. ' type: object properties: amount: description: '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. ' type: number format: float pattern: ^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$ currency: $ref: '#/components/schemas/CurrencyCode_2' required: - amount - currency example: "{\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n}" DateAndPlaceOfBirth_2: description: 'Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment. ' type: object properties: birthDate: description: Date on which a person is born. type: string format: date cityOfBirth: description: City where a person was born. type: string maxLength: 35 countryOfBirth: description: Country where a person was born. type: string pattern: ^[A-Z]{2,2}$ required: - birthDate - cityOfBirth - countryOfBirth example: "{\n \"birthDate\" : \"1985-02-19\",\n \"cityOfBirth\" : \"Paris\",\n \"countryOfBirth\" : \"FR\"\n}" BatchBookingIndicator_2: description: '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. Meaning When True: Identifies that a batch entry for the sum of the amounts of all transactions in the batch or message is requested. Meaning When False: Identifies that a single entry for each of the transactions in the batch or message is requested. Default value: each ASPSP must be able to specify its own default value. ' type: boolean FundsAvailabilityInformation_2: description: 'Indicator that the payment can be covered or not by the funds available on the relevant account - true: payment is covered - false: payment is not covered This indicator must be provided by the ASPSP when the Booking Information is present and set to "False". This indicator will not be provided if the Booking Information is absent or set to "True". ' type: boolean readOnly: true DocumentLineIdentification_2: description: 'Provides identification of the document line. the [type] property must be used for specifying the type of referred document type. ' type: object properties: type: $ref: '#/components/schemas/CodeAndIssuer_2' number: description: Unique and unambiguous identification of the referred document line. type: string maxLength: 35 relatedDate: description: Date associated with the referred document line. type: string format: date example: "{\n \"type\" : {\n \"code\" : \"CD01\",\n \"issuer\" : \"MyIssuer\"\n },\n \"number\" : \"1\",\n \"relatedDate\" : \"2020-02-09\"\n}" PaymentRequestLinks_2: description: 'links that can be used for further navigation when having post a Payment Request in order to get the relevant status report. | Link | Description | | ---- | ----------- | | request | This link provides the payment-request URL for retrieving or modifying | | confirmation | This link shall not be provided when the confirmation was already posted. | | transactions | The ASPSP might choose to provide the relevant transactions of a Payment Request through a specific link | ' type: object properties: request: $ref: '#/components/schemas/GenericLink_2' confirmation: $ref: '#/components/schemas/GenericLink_2' transactions: $ref: '#/components/schemas/GenericLink_2' readOnly: true example: "{\n \"request\" : {\n \"href\" : \"/v1/payment-requests/MyPmtInfRscId\"\n },\n \"confirmation\" : {\n \"href\" : \"/v1/payment-requests/MyPmtInfRscId/confirmation\"\n }\n}" GenericLink_2: description: hypertext reference type: object properties: href: description: URI to be used. HREF stands for Hypertext REFerence. type: string maxLength: 2000 templated: description: '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 ' type: boolean required: - href example: "{\n \"href\" : \"/v1/accounts\"\n}" TaxRecordDetails_2: description: 'ISO20022: Elements used to provide details on the tax period and amount. API: Amounts must always be set as positive values. | Property | Description | | -------- | ----------- | | period | Set of elements used to provide details on the period of time related to the tax payment. | | amount | Underlying tax amount related to the specified period. | ' type: object properties: period: $ref: '#/components/schemas/TaxPeriod_2' amount: $ref: '#/components/schemas/AmountType_2' required: - amount example: "{\n \"period\" : {\n \"year\" : \"2020\",\n \"type\" : \"QTR4\",\n \"fromDate\" : \"2019-10-01\",\n \"toDate\" : \"2020-01-01\"\n },\n \"amount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n}" FrequencyCode_2: description: 'Frequency rule for standing orders. The following codes from the "EventFrequency7Code" of ISO 20022 are supported. | Code | Description | | ---- | ----------- | | DAIL | Daily | | WEEK | Weekly | | TOWK | EveryTwoWeeks | | MNTH | Monthly | | TOMN | EveryTwoMonths | | QUTR | Quarterly | | SEMI | SemiAnnual | | YEAR | Annual | However, each ASPSP might restrict these values into a subset if needed. ' type: string enum: - DAIL - WEEK - TOWK - MNTH - TOMN - QUTR - SEMI - YEAR PaymentTypeInformation_2: description: 'ISO20022: Set of elements used to further specify the type of transaction. ' type: object properties: instructionPriority: $ref: '#/components/schemas/PriorityCode_2' serviceLevel: $ref: '#/components/schemas/ServiceLevelCode_2' localInstrument: $ref: '#/components/schemas/LocalInstrumentCode_2' categoryPurpose: $ref: '#/components/schemas/CategoryPurposeCode_2' example: "{\n \"serviceLevel\" : \"SEPA\",\n \"localInstrument\" : \"INST\",\n \"categoryPurpose\" : \"CASH\"\n}" TaxRecord_2: description: 'Record of tax details the [period] property embbeds the set of elements used to provide details on the period of time related to the tax payment. the [amount] property embbeds the set of elements used to provide information on the amount of the tax record. ' type: object properties: type: description: High level code to identify the type of tax details. type: string maxLength: 35 category: description: Specifies the tax code as published by the tax authority. type: string maxLength: 35 categoryDetails: description: Provides further details of the category tax code. type: string maxLength: 35 debtorStatus: description: Code provided by local authority to identify the status of the party that has drawn up the settlement document. type: string maxLength: 35 certificateIdentification: description: Identification number of the tax report as assigned by the taxing authority. type: string maxLength: 35 formsCode: description: Identifies, in a coded form, on which template the tax report is to be provided. type: string maxLength: 35 period: $ref: '#/components/schemas/TaxPeriod_2' taxAmount: $ref: '#/components/schemas/TaxAmount_2' additionalInformation: description: Further details of the tax record. type: string maxLength: 140 example: "{\n \"type\" : \"NationalTax\",\n \"category\" : \"VAT\",\n \"categoryDetails\" : \"VAT02\",\n \"debtorStatus\" : \"Valid\",\n \"certificateIdentification\" : \"CertId56RD\",\n \"formsCode\" : \"FormHJH7\",\n \"period\" : {\n \"year\" : \"2020\",\n \"type\" : \"QTR4\",\n \"fromDate\" : \"2019-10-01\",\n \"toDate\" : \"2020-01-01\"\n },\n \"taxAmount\" : {\n \"details\" : [ {\n \"period\" : {\n \"year\" : \"2020\",\n \"type\" : \"QTR4\",\n \"fromDate\" : \"2019-10-01\",\n \"toDate\" : \"2020-01-01\"\n },\n \"amount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n } ]\n },\n \"additionalInformation\" : \"Some comment\"\n}" RemittanceAmount_2: description: 'ISO20022: Provides details on the amounts of the document line. API: Amounts must always be set as positive values. | Property | Description | | -------- | ----------- | | duePayableAmount | Amount specified is the exact amount due and payable to the creditor. | | discountAppliedAmount | Amount of discount to be applied to the amount due and payable to the creditor. | | creditNoteAmount | Amount of a credit note. | | taxAmount | Amount of the tax. | | adjustmentAmountAndReason | Specifies detailed information on the amount and reason of the adjustment. | | remittedAmount | Amount of money remitted. | ' type: object properties: duePayableAmount: $ref: '#/components/schemas/AmountType_2' discountAppliedAmount: $ref: '#/components/schemas/TypedAmount_2' creditNoteAmount: $ref: '#/components/schemas/AmountType_2' taxAmount: $ref: '#/components/schemas/TypedAmount_2' adjustmentAmountAndReason: $ref: '#/components/schemas/DocumentAdjustment_2' remittedAmount: $ref: '#/components/schemas/AmountType_2' example: "{\n \"remittedAmount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n}" RequestedExecutionDate_2: description: 'ISO20022: Date at which the initiating party requests the clearing agent to process the payment. API: When set by the PISP, this field indicates the future date at which the payment instruction should be executed and the debtor account should be debited. if this field is not set by the PISP, the ASPSP is requested to execute the payment instruction as soon as possible. In most of the cases, especially for international payments, the date of the credit on the credit account cannot be set. Only SCTInst can guarantee having the same date for this credit. When the payment cannot be processed at the requested date, the ASPSP is allowed to shift the applied execution date to the next possible execution date for non-standing orders. For standing orders, this field is useless since the [startDate] parameter already provides the needed information for the first payment instruction to be executed. ' type: string format: date-time ErrorModel_2: description: Generic error report structure type: object properties: timestamp: description: current timestamp type: string format: date-time status: description: HTTP error code type: integer format: int32 error: description: HTTP error text type: string maxLength: 140 message: description: HTTP textual reason phrase type: string maxLength: 140 path: description: Relevant path that was used type: string maxLength: 140 details: description: list of detailed errors that were encountered type: array items: $ref: '#/components/schemas/ErrorDetail' minItems: 1 required: - status - message example: "{\n \"timestamp\" : \"2021-03-17T16:47:00.187248+01:00\",\n \"status\" : 400,\n \"error\" : \"Bad Request\",\n \"message\" : \"This Authentication Approach is not available\",\n \"details\" : [ {\n \"path\" : \"$.supplementaryData.acceptedAuthenticationApproach\",\n \"erroneousValue\" : \"EMBEDDED\",\n \"expectedEnumeration\" : [ \"REDIRECT\", \"DECOUPLED\" ]\n } ]\n}" AuthenticationApproach: description: 'Authentication approaches that can be applied. REDIRECT: the PSU is redirected by the TPP to the ASPSP which processes identification and authentication DECOUPLED: the TPP identifies the PSU and forwards the identification to the ASPSP which processes the authentication through a decoupled device NONE: there is no need for the PSU to authenticate ' type: string enum: - REDIRECT - DECOUPLED - EMBEDDED-1-FACTOR - NONE Workspace: description: Some ASPSP may provide different user workspaces that can be accessed by the same authenticated PSU. In this case, the AISP is able to retrieve the different pieces of account information by specifying the relevant workspace as a QUERY parameter. Identification of the workspace to be used when processing the request. If not present, the default workspace to be used is the one that is linked to the authentication processed during the OAuth2 access token request. type: object properties: identification: description: identification of the workspace to be used as an optional query parameter for some AISP queries type: string maxLength: 32 label: description: textual description of the workspace as specified by the ASPSP in relationship wth the PSU type: string maxLength: 128 required: - identification - label example: "{\n \"identification\" : \"PRO_1\",\n \"label\" : \"comptes de la SARL PRO1\"\n}" DocumentAdjustment_2: description: 'ISO20022: Specifies detailed information on the amount and reason of the adjustment. API: Amounts must always be set as positive values. ' type: object properties: amount: $ref: '#/components/schemas/AmountType_2' creditDebitIndicator: $ref: '#/components/schemas/CreditDebitIndicator_2' reason: description: Specifies the reason for the adjustment. type: string maxLength: 4 additionalInformation: description: Provides further details on the document adjustment. type: string maxLength: 140 required: - amount example: "{\n \"amount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n },\n \"creditDebitIndicator\" : \"CRDT\",\n \"reason\" : \"RFND\",\n \"additionalInformation\" : \"Some comment\"\n}" ChargeBearerCode_2: description: 'ISO20022: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. The following values are allowed: | 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. | ' type: string enum: - DEBT - CRED - SHAR - SLEV CurrencyCode_2: description: 'Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". ' type: string pattern: ^[A-Z]{3,3}$ LocalInstrumentCode_2: description: 'ISO20022: User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. API: "INST" value is to be used in order to ask for an SEPA instant Payment (SCTInst). For 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. ' type: string PostalAddress_2: description: 'ISO20022: Information that locates and identifies a specific address, as defined by postal services. ' type: object properties: addressType: description: '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 | Business | Address is the home address | ' type: string enum: - BIZZ - DLVY - MLTO - PBOX - ADDR - HOME department: description: 'ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments. ' type: string maxLength: 70 subDepartment: description: 'ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments. ' type: string maxLength: 70 streetName: description: 'ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments. ' type: string maxLength: 70 buildingNumber: description: 'ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments. ' type: string maxLength: 16 buildingName: description: 'ISO20022: Name of the building or house. API: Cannot be used for SEPA payments. ' type: string maxLength: 16 postCode: description: '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. ' type: string maxLength: 16 townName: description: 'ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments. ' type: string maxLength: 35 countrySubDivision: description: 'ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments. ' type: string maxLength: 35 country: description: '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. ' type: string pattern: ^([A-Z]{2,2})$ addressLine: description: 'Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed. ' type: array items: description: Address line type: string maxLength: 70 minItems: 1 maxItems: 7 required: - country example: "{\n \"country\" : \"FR\",\n \"addressLine\" : [ \"18 rue de la DSP2\", \"75008 PARIS\" ]\n}" ResourceId_2: description: 'API: Identifier assigned by the ASPSP for further use of the created resource through API calls. The API client cannot set or modify the value of this field. Since this value can be exchanged between the server and the client as an URL element or for support information, it must not contain sensitive value such as personal or business data. However it is the duty of each ASPSP to perform its own risk analysis on this topic. ' type: string pattern: ^([a-zA-Z0-9_ /\-?:\()\.,']{1,100})$ readOnly: true CreditorReferenceInformation_2: description: Reference information provided by the creditor to allow the identification of the underlying documents. type: object properties: type: $ref: '#/components/schemas/CodeAndIssuer_2' reference: description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. type: string maxLength: 35 example: "{\n \"type\" : {\n \"code\" : \"CD01\",\n \"issuer\" : \"MyIssuer\"\n },\n \"reference\" : \"CredRef56FH6\"\n}" PaymentRequestResource_2: description: '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 ' type: object properties: resourceId: $ref: '#/components/schemas/ResourceId_2' paymentInformationId: $ref: '#/components/schemas/PaymentInformationId_2' batchBooking: $ref: '#/components/schemas/BatchBookingIndicator_2' creationDateTime: $ref: '#/components/schemas/CreationDateTime_2' numberOfTransactions: description: '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 ' type: integer minimum: 1 initiatingParty: $ref: '#/components/schemas/PartyIdentification_2' acceptDebtorAccountChange: description: '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 ' type: boolean acceptChargeHandlingChange: description: '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 ' type: boolean acceptInstantPaymentDowngrade: description: '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) ' type: boolean paymentTypeInformation: $ref: '#/components/schemas/PaymentTypeInformation_2' debtor: $ref: '#/components/schemas/PartyIdentification_2' debtorAccount: $ref: '#/components/schemas/AccountIdentification_2' debtorAgent: $ref: '#/components/schemas/FinancialInstitutionIdentification_2' chargeBearer: $ref: '#/components/schemas/ChargeBearerCode_2' paymentInformationStatus: $ref: '#/components/schemas/PaymentInformationStatusCode_2' statusReasonInformation: $ref: '#/components/schemas/StatusReasonInformation_2' fundsAvailability: $ref: '#/components/schemas/FundsAvailabilityInformation_2' booking: $ref: '#/components/schemas/BookingInformation_2' creditTransferTransaction: description: '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 ' type: array items: $ref: '#/components/schemas/CreditTransferTransactionResource' minItems: 1 supplementaryData: $ref: '#/components/schemas/SupplementaryData_2' required: - paymentInformationId - creationDateTime - numberOfTransactions - initiatingParty - paymentTypeInformation - creditTransferTransaction - supplementaryData example: "{\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}" InstructionForCreditorAgent_2: description: 'Further information related to the processing of the payment instruction that may need to be acted upon by the creditor''s agent. The instruction may relate to a level of service, or may be an instruction that has to be executed by the creditor''s agent, or may be information required by the creditor''s agent. ' type: object properties: code: description: '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. |' type: string enum: - CHQB - HOLD - PHOB - TELB instructionInformation: description: Further information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community. type: string maxLength: 140 example: "{\n \"code\" : \"TELB\",\n \"instructionInformation\" : \"Please contact M. John Doe\"\n}" HalCreditTransfertTransactions: description: HYPERMEDIA structure used for returning the transactions of a given payment request to the PISP type: object properties: creditTransferTransaction: description: '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 ' type: array items: $ref: '#/components/schemas/CreditTransferTransactionResource' minItems: 0 _links: $ref: '#/components/schemas/CreditTransferTransactionLinks' required: - creditTransferTransaction - _links example: "{\n \"creditTransferTransaction\": [\n {\n \"paymentId\": {\n \"instructionId\": \"MyInstrId3\",\n \"endToEndId\": \"MyEndToEndId3\"\n },\n \"requestedExecutionDate\": \"2021-08-23T14:27:04.601852Z\",\n \"instructedAmount\": {\n \"amount\": 124.35,\n \"currency\": \"EUR\"\n },\n \"beneficiary\": {\n \"creditor\": {\n \"name\": \"myMerchant\",\n \"postalAddress\": {\n \"country\": \"FR\",\n \"addressLine\": [\n \"18 rue de la DSP2\",\n \"75008 PARIS\"\n ]\n },\n \"organisationId\": {\n \"identification\": \"852126789\",\n \"schemeName\": \"SIREN\",\n \"issuer\": \"FR\"\n }\n },\n \"creditorAccount\": {\n \"iban\": \"YY64COJH41059545330222956960771321\"\n }\n },\n \"ultimateCreditor\": {\n \"name\": \"MyPreferredPisp\",\n \"postalAddress\": {\n \"country\": \"FR\",\n \"addressLine\": [\n \"18 rue de la DSP2\",\n \"75008 PARIS\"\n ]\n },\n \"organisationId\": {\n \"identification\": \"12FR5\",\n \"schemeName\": \"COID\",\n \"issuer\": \"ACPR\"\n }\n },\n \"purpose\": \"CASH\",\n \"remittanceInformation\": {\n \"unstructured\": [\n \"MyRemittanceInformation\"\n ]\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/v1/payment-requests/MyPmtInfRscId/creditTransfertTransactions\"\n },\n \"parent\": {\n \"href\": \"/v1/payment-requests/MyPmtInfRscId\"\n }\n }\n}" TransactionIndividualStatusCode_2: description: 'ISO20022: Specifies the status of the payment information group. API: Only the following values are allowed to provide the status of the subsequent CREDIT TRANSFER to the Payment Request | Code | Name | Description | | ---- | ---- | ---------- | | ACSC | AcceptedSettlementCompleted | Settlement on the debtor''s account was completed. In the case of SCTInst, this status must not been set by the debtor''s Bank before the reception of the positive confirmation. The transaction cannot be cancelled. | | ACSP | AcceptedSettlementInProcess | All preceding checks such as technical validation and customer profile were successful and therefore the Payment Request was accepted for execution. The transaction cannot be cancelled. | | ACTC | AcceptedTechnicalValidation | Authentication and syntactical and semantical validation are successful. The transaction might be cancelled. | | CANC | Cancelled | Payment initiation was successfully cancelled after having received a request for cancellation. | | PDNG | Pending | Payment request or individual transaction included in the Payment Request is pending. Further checks and status update will be performed. The transaction might be cancelled. | | RJCT | Rejected | Payment request or individual transaction included in the Payment Request was rejected. | ![](https://www.stet.eu//assets/files/documents-api/transaction-status-1-4-2.png) ' type: string enum: - ACSC - ACSP - ACTC - CANC - PDNG - RJCT AccountIdentification_2: description: 'Unique and unambiguous identification for the account between the account owner and the account servicer. Card accounts must provide the identification of the card through the "other" substructure by giving, for instance, the masked PAN (MPAN). The currency used for the account, when needed, can be specified through the [currency] field. ' type: object properties: workspace: description: '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. ' type: string maxLength: 32 iban: description: '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. ' type: string pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ other: $ref: '#/components/schemas/GenericIdentification_2' currency: $ref: '#/components/schemas/CurrencyCode_2' example: "{\n \"workspace\": \"PRO_1\",\n \"iban\" : \"YY64COJH41059545330222956960771321\",\n \"currency\" : \"EUR\"\n}" StandingOrderCharacteristics: description: 'Specifies the characteristics of a standing order. ' type: object properties: startDate: $ref: '#/components/schemas/StartDate' endDate: $ref: '#/components/schemas/EndDate_2' executionRule: $ref: '#/components/schemas/ExecutionRule_2' frequency: $ref: '#/components/schemas/FrequencyCode_2' required: - startDate - executionRule - frequency example: "{\n \"startDate\" : \"2020-02-24T00:00Z\",\n \"executionRule\" : \"FWNG\",\n \"frequency\" : \"MNTH\"\n}" PartyIdentification_2: description: 'API : Description of a Party which can be either a person or an organization. ' type: object properties: name: description: '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. ' type: string maxLength: 140 dateAndPlaceOfBirth: $ref: '#/components/schemas/DateAndPlaceOfBirth_2' postalAddress: $ref: '#/components/schemas/PostalAddress_2' contactDetails: $ref: '#/components/schemas/ContactDetails' organisationId: $ref: '#/components/schemas/GenericIdentification_2' privateId: $ref: '#/components/schemas/GenericIdentification_2' lei: $ref: '#/components/schemas/LeiIdentification' required: - name example: "{\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}" Beneficiary_2: description: Specification of a beneficiary type: object properties: workspace: $ref: '#/components/schemas/Workspace' id: description: Id of the beneficiary type: string pattern: ^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$ isTrusted: description: '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 ' type: boolean readOnly: true creditorAgent: $ref: '#/components/schemas/FinancialInstitutionIdentification_2' creditor: $ref: '#/components/schemas/PartyIdentification_2' creditorAccount: $ref: '#/components/schemas/AccountIdentification_2' required: - creditor example: "{\n \"creditor\" : {\n \"name\" : \"myMerchant\",\n \"postalAddress\" : {\n \"country\" : \"FR\",\n \"addressLine\" : [ \"18 rue de la DSP2\", \"75008 PARIS\" ]\n },\n \"organisationId\" : {\n \"identification\" : \"852126789\",\n \"schemeName\" : \"SIREN\",\n \"issuer\" : \"FR\"\n }\n },\n \"creditorAccount\" : {\n \"iban\" : \"YY64COJH41059545330222956960771321\",\n \"currency\" : \"EUR\"\n }\n}" EndToEndId: description: 'ISO20022: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. ' type: string pattern: ^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$ HalPaymentRequest_2: description: HYPERMEDIA structure used for returning the original Payment Request to the PISP type: object properties: paymentRequest: $ref: '#/components/schemas/PaymentRequestResource_2' _links: $ref: '#/components/schemas/PaymentRequestLinks_2' required: - paymentRequest - _links example: "{\n \"paymentRequest\" : {\n \"resourceId\" : \"MyPmtInfRscId\",\n \"paymentInformationId\" : \"MyPmtInfId\",\n \"creationDateTime\" : \"2020-02-19T13:56:54.758+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 \"debtorAgent\" : {\n \"bicFi\" : \"BNKAFRPPXXX\"\n },\n \"chargeBearer\" : \"SLEV\",\n \"paymentInformationStatus\" : \"PDNG\",\n \"creditTransferTransaction\" : [ {\n \"paymentId\" : {\n \"instructionId\" : \"MyInstrId3\",\n \"endToEndId\" : \"MyEndToEndId3\"\n\n },\n \"requestedExecutionDate\" : \"2020-02-19T13:56:54.759+01:00\",\n \"instructedAmount\" : {\n \"amount\" : 124.35,\n \"currency\" : \"EUR\"\n\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 \"transactionStatus\" : \"PDNG\"\n }, {\n \"paymentId\" : {\n \"instructionId\" : \"MyInstrId4\",\n \"endToEndId\" : \"MyEndToEndId4\"\n },\n \"requestedExecutionDate\" : \"2020-02-19T13:56:54.759+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 \"transactionStatus\" : \"PDNG\"\n } ],\n \"supplementaryData\" : {\n \"acceptedAuthenticationApproach\" : [ \"REDIRECT\", \"DECOUPLED\" ],\n \"appliedAuthenticationApproach\" : \"REDIRECT\",\n \"successfulReportUrl\" : \"http://myPisp/PaymentSuccess\",\n \"unsuccessfulReportUrl\" : \"http://myPisp/PaymentFailure\"\n }\n },\n \"_links\" : {\n \"request\" : {\n \"href\" : \"/v1/payment-requests/MyPmtInfRscId\"\n },\n \"confirmation\" : {\n \"href\" : \"/v1/payment-requests/MyPmtInfRscId/confirmation\"\n }\n }\n}" BookingInformation_2: description: 'Indicator that the payment can be immediately booked or not - true: payment is booked - false: payment is not booked Booking 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. However, usual fraud detection mechanisms might still be triggered and result as a rejection of the payment. This indicator must be provided when the relevant Credit Transfer will be executed as soon as possible but not as an instant payment. This indicator is irrelevant and will not be provided for delayed payments. This 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. Case the Information System cannot handle this immediate booking, the ASPSP will have to provide the funds availability information. ' type: boolean readOnly: true ReferredDocumentInformations_2: description: 'Provides the identification and the content of the referred documents. ' type: array items: $ref: '#/components/schemas/ReferredDocumentInformation_2' minItems: 1 PhoneNumber: description: 'The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters). ' type: string pattern: ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$ EquivalentAmountType_2: description: 'Amount of money to be moved between debtor and creditor, before deduction of charges, expressed in the currency of the debtor''s account, and to be moved in a different currency. Usage: The first agent will convert the equivalent amount into the amount to be moved. ' type: object properties: amount: description: '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. ' type: number format: float pattern: ^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$ currency: $ref: '#/components/schemas/CurrencyCode_2' currencyOfTransfer: $ref: '#/components/schemas/CurrencyCode_2' required: - amount - currency - currencyOfTransfer example: "{\n \"amount\" : 140.45,\n \"currency\" : \"EUR\",\n \"currencyOfTransfer\" : \"USD\"\n}" FinancialInstitutionIdentification_2: description: 'ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme. ' type: object properties: bicFi: description: '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)". ' type: string pattern: ^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$ clearingSystemMemberId: $ref: '#/components/schemas/ClearingSystemMemberIdentification_2' lei: $ref: '#/components/schemas/LeiIdentification' name: description: Name of the financial institution type: string maxLength: 140 postalAddress: $ref: '#/components/schemas/PostalAddress_2' required: - bicFi example: "{\n \"bicFi\" : \"BNKAFRPPXXX\"\n}" HalAuthenticationRequest: description: 'Data forwarded by the ASPSP top the PISP after creation of the Payment Request resource creation The ASPSP, based on the authentication approaches proposed by the PISP, choose the one that it can processed, in respect with the preferences and constraints of the PSU and indicates in this field which approach was chosen. It may happen that the ASPSP considers that, in case of payment cancellation request, there is no need for authentication and will then return "NONE". ' type: object properties: appliedAuthenticationApproach: $ref: '#/components/schemas/AuthenticationApproach' nonce: $ref: '#/components/schemas/Nonce' _links: $ref: '#/components/schemas/PaymentRequestResourceCreationLinks_2' example: "{\n \"appliedAuthenticationApproach\" : \"REDIRECT\",\n \"nonce\" : \"GH6HGH5CGH763\",\n \"_links\" : {\n \"consentApproval\" : {\n \"href\" : \"https://psd2.aspsp/consent-approval\"\n }\n }\n}" StatusReasonInformation_3: description: 'ISO20022: Provides detailed information on the status reason. API: Can only be used in case the status is equal to "RJCT" or "CANC". Only the following values are allowed: | Code | Name | Description | | ---- | ---- | ---------- | | AC01 | IncorectAccountNumber | the account number is either invalid or does not exist | | AC04 | ClosedAccountNumber | the account is closed and cannot be used | | AC06 | BlockedAccount | the account is blocked and cannot be used | | AG01 | TransactionForbidden | Transaction forbidden on this type of account | | AG03 | TransactionNotSupported | Transaction type not supported/authorized on this account | | 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. | ' type: string enum: - AC01 - AC04 - AC06 - AG01 - AG03 - AM18 - CH03 - CUST - DS02 - DUPL - FF01 - FRAD - MS03 - NOAS - RR01 - RR03 - RR04 - RR12 - CNOR - CH04 TaxAmount_3: description: 'ISO20022: Set of elements used to provide information on the amount of the tax record. API: Amounts must always be set as positive values. | Property | Description | | -------- | ----------- | | rate | Rate used to calculate the tax. | | taxableBaseAmount | Amount of money on which the tax is based. | | totalAmount | Total amount that is the result of the calculation of the tax for the record. | | details | Set of elements used to provide details on the tax period and amount. | ' type: object properties: rate: $ref: '#/components/schemas/PercentageRate' taxableBaseAmount: $ref: '#/components/schemas/AmountType_3' totalAmount: $ref: '#/components/schemas/AmountType_3' details: description: Set of elements used to provide details on the tax period and amount. type: array items: $ref: '#/components/schemas/TaxRecordDetails_3' minItems: 1 example: "{\n \"details\" : [ {\n \"period\" : {\n \"year\" : \"2020\",\n \"type\" : \"QTR4\",\n \"fromDate\" : \"2019-10-01\",\n \"toDate\" : \"2020-01-01\"\n },\n \"amount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n } ]\n}" PurposeCode_3: description: 'ISO20022: Underlying reason for the payment transaction, as published in an external purpose code list. API: The following values are allowed for Payment Request | Code | Name | Description | | ---- | ---- | ---------- | | ACCT | AccountManagement | Funds moved between 2 accounts of same account holder at the same bank) | | CASH | CashManagementTransfer | (general cash management instruction) may be used for Transfer Initiation | | COMC | CommercialPayment | Transaction is related to a payment of commercial credit or debit. | | CPKC | CarparkCharges | General Carpark Charges Transaction is related to carpark charges. | | 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. | ' type: string enum: - ACCT - CASH - COMC - CPKC - TRPT - SALA PaymentInformationId_3: description: 'ISO20022: Reference assigned by a sending party to unambiguously identify the payment information block within the message. API: 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. ' type: string pattern: ^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$ ConfirmationResource_3: description: Confirmation request resource type: object properties: nonce: $ref: '#/components/schemas/Nonce' psuAuthenticationFactor: description: authentication factor forwarded by the TPP to the ASPSP in order to fulfil the strong customer authentication process type: string example: "{\n \"nonce\" : \"Nonce56fdd\",\n \"psuAuthenticationFactor\" : \"U1RF51mITWWmTQ72M1xWiw\"\n}" ExchangeRate_3: description: 'ISO20022: Provides details on the currency exchange rate and contract. The [unitCurrency] property specifies the currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. The [estimatedPayerAmount] gives an estimation of the amount that will be debited on the payer''s account, including transaction and change fees. The [estimatedPayeeAmunt] gives an estimation of the amount that will be credited on the payee''s account. API: Amounts must always be set as positive values. ' type: object properties: unitCurrency: $ref: '#/components/schemas/CurrencyCode_3' exchangeRate: description: '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. ' type: number format: float rateType: description: '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. | ' type: string enum: - SPOT - SALE - AGRD contractIdentification: description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. type: string maxLength: 35 estimatedPayerAmount: $ref: '#/components/schemas/AmountType_3' estimatedPayeeAmount: $ref: '#/components/schemas/AmountType_3' required: - rateType example: "{\n \"unitCurrency\" : \"USD\",\n \"exchangeRate\" : 1.1,\n \"rateType\" : \"AGRD\",\n \"contractIdentification\" : \"CTRCT37H8\"\n}" PriorityCode_3: description: '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. API: This field is useless for SCTInst and thus should be ignored. ' type: string enum: - HIGH - NORM ExecutionRule_3: description: 'Execution date shifting rule for standing orders This data attribute defines the behaviour when recurring payment dates falls on a weekend or bank holiday. The payment is then executed either the "preceding" or "following" working day. ASPSP might reject the request due to the communicated value, if rules in Online-Banking are not supporting this execution rule. | Code | Description | | ---- | ----------- | | FWNG | following | | PREC | preceding | ' type: string enum: - FWNG - PREC RegulatoryReportingCodes_3: description: 'List of needed regulatory reporting codes for international payments ' type: array items: $ref: '#/components/schemas/RegulatoryReportingCode_3' minItems: 1 maxItems: 10 TitleAndName_3: description: Title and Name of the party or the party's authorised reprensentative. type: object properties: title: description: Title or position of the party or the party's authorised reprensentative. type: string maxLength: 35 name: description: Name of the party or the party's authorised reprensentative. type: string maxLength: 140 example: "{\n \"title\" : \"M.\",\n \"name\" : \"John Doe\"\n}" CreationDateTime_3: description: 'ISO20022: Date and time at which a (group of) payment instruction(s) was created by the instructing party. ' type: string format: date-time RemittanceInformation_3: description: 'ISO20022: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts'' receivable system. API: - Only one occurrence of the unstructured information is allowed. - Only one occurrence of the structured information is allowed. - Structured and unstructured information can coexist. ' type: object properties: unstructured: description: "Unstructured remittance information.\nEach implementation may add a pattern in order to specify its own character set constraints. \n" type: array items: title: remittanceLine description: Relevant information to the transaction type: string maxLength: 140 minItems: 1 structured: description: Structured remittance information type: array items: $ref: '#/components/schemas/StructuredRemittanceInformation_3' minItems: 1 example: "{\n \"unstructured\" : [ \"MyRemittanceInformation\" ]\n}" ServiceLevelCode_3: description: '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. API: Only "SEPA" (SEPA Credit Transfer) value is allowed ' type: string enum: - SEPA CreditDebitIndicator_3: description: 'Accounting flow of the amount | Code | Description | | ---- | ----------- | | CRDT | Credit type amount | | DBIT | Debit type amount | ' type: string enum: - CRDT - DBIT ClearingSystemMemberIdentification_3: description: 'ISO20022: Information used to identify a member within a clearing system. API: to be used for some specific international credit transfers in order to identify the beneficiary bank ' type: object properties: clearingSystemId: description: 'ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed. ' type: string maxLength: 35 memberId: description: 'ISO20022: Identification of a member of a clearing system. ' type: string maxLength: 35 required: - clearingSystemId - memberId example: "{\n \"clearingSystemId\" : \"NZNCC\",\n \"memberId\" : \"020368\"\n}" TypedAmount_3: description: 'ISO20022: Typed Amount API: Amounts must always be set as positive values. ' type: object properties: type: description: Type of the amount type: string maxLength: 35 amount: $ref: '#/components/schemas/AmountType_3' required: - amount example: "{\n \"type\" : \"CHRG\",\n \"amount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n}" LineDetail_3: description: Set of elements used to provide the content of the referred document line. type: object properties: identification: $ref: '#/components/schemas/DocumentLineIdentification_3' description: description: Description associated with the document line. type: string maxLength: 2048 amount: $ref: '#/components/schemas/RemittanceAmount_3' example: "{\n \"identification\" : {\n \"type\" : {\n \"code\" : \"CD01\",\n \"issuer\" : \"MyIssuer\"\n },\n \"number\" : \"1\",\n \"relatedDate\" : \"2020-02-09\"\n },\n \"description\" : \"Some comments\",\n \"amount\" : {\n \"remittedAmount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n }\n}" CategoryPurposeCode_3: description: '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. API: The following values are allowed: | 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. | ' type: string enum: - CASH - CORT - DVPM - INTC - TREA - SALA PaymentInformationStatusCode_3: description: 'ISO20022: Specifies the status of the payment information. API: Mandatory. The following values are allowed to provide the status of the Payment Request | 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. | ![](https://www.stet.eu//assets/files/documents-api/payment-request-status-1-4-2.png) ' type: string enum: - ACCP - ACSC - ACSP - ACTC - ACWC - ACWP - CANC - PART - RCVD - PDNG - RJCT - ACCO EndDate_3: description: 'The last applicable day of execution for a given period. If not given, the period is considered as endless. ' type: string format: date-time CreditTransferTransactionResource_2: description: "ISO20022: Payment processes required to transfer cash from the debtor to the creditor.\nThe [instructedAmount] property indicates 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.\n Usage: This amount has to be transported unchanged through the transaction chain.\nAPI: Amounts must always be set as positive values.\n" type: object properties: paymentId: $ref: '#/components/schemas/PaymentIdentification_3' resourceId: $ref: '#/components/schemas/ResourceId_3' requestedExecutionDate: $ref: '#/components/schemas/RequestedExecutionDate_3' cancellableTill: description: '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. ' type: string format: date-time acceptanceDateTime: description: '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. ' type: string format: date-time debtorDecisionDate: description: 'ISO20022: Date and time on when the debtor has accepted or rejected the request. ' type: string format: date-time appliedExecutionDate: description: 'ISO20022: Date and time on when the payment was executed. ' type: string format: date-time standingOrderCharacteristics: $ref: '#/components/schemas/StandingOrderCharacteristics_2' instructedAmount: $ref: '#/components/schemas/AmountType_3' equivalentAmount: $ref: '#/components/schemas/EquivalentAmountType_3' exchangeRateInformation: $ref: '#/components/schemas/ExchangeRate_3' ultimateDebtor: $ref: '#/components/schemas/PartyIdentification_3' intermediaryAgent: $ref: '#/components/schemas/IntermediaryAgent_3' beneficiary: $ref: '#/components/schemas/Beneficiary_3' ultimateCreditor: $ref: '#/components/schemas/PartyIdentification_3' instructionForCreditorAgent: description: Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent. type: array items: $ref: '#/components/schemas/InstructionForCreditorAgent_3' purpose: $ref: '#/components/schemas/PurposeCode_3' regulatoryReportingCodes: $ref: '#/components/schemas/RegulatoryReportingCodes_3' remittanceInformation: $ref: '#/components/schemas/RemittanceInformation_3' transactionStatus: $ref: '#/components/schemas/TransactionIndividualStatusCode_3' statusReasonInformation: $ref: '#/components/schemas/StatusReasonInformation_3' supplementaryData: $ref: '#/components/schemas/SupplementaryData_3' required: - paymentId - beneficiary example: "{\n \"paymentId\" : {\n \"instructionId\" : \"MyInstrId3\",\n \"endToEndId\" : \"MyEndToEndId3\"\n },\n \"requestedExecutionDate\" : \"2020-02-19T12:56:54.639Z\",\n \"instructedAmount\" : {\n \"amount\" : 124.35,\n \"currency\" : \"EUR\"\n },\n \"beneficiary\" : {\n \"creditor\" : {\n \"name\" : \"myMerchant\",\n \"postalAddress\" : {\n \"country\" : \"FR\",\n \"addressLine\" : [ \"18 rue de la DSP2\", \"75008 PARIS\" ]\n },\n \"organisationId\" : {\n \"identification\" : \"852126789\",\n \"schemeName\" : \"SIREN\",\n \"issuer\" : \"FR\"\n }\n },\n \"creditorAccount\" : {\n \"iban\" : \"YY64COJH41059545330222956960771321\",\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}" RegulatoryReportingCode_3: description: 'Information needed due to regulatory and statutory requirements. Economical codes to be used are provided by the National Competent Authority ' type: string maxLength: 10 GenericIdentification_3: description: 'ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support. ' type: object properties: identification: description: 'API: Identifier ' type: string maxLength: 70 schemeName: description: '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 ' type: string maxLength: 70 issuer: description: 'ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties ' type: string maxLength: 35 required: - identification - schemeName example: "{\n \"identification\" : \"12FR5\",\n \"schemeName\" : \"COID\",\n \"issuer\" : \"ACPR\"\n}" PaymentRequestResourceCreationLinks_3: description: 'links that can be used for further navigation, especially in REDIRECT approach | Link | Description | | ---- | ----------- | | consentApproval | URL to be used by the PISP in order to start the ASPSP authentication and consent management process | ' type: object properties: consentApproval: $ref: '#/components/schemas/GenericLink_3' readOnly: true example: "{\n \"consentApproval\" : {\n \"href\" : \"https://psd2.aspsp/consent-approval\"\n }\n}" IntermediaryAgent_3: description: Agent and agent account between the debtor's agent and the creditor's agent. type: object properties: agent: $ref: '#/components/schemas/PartyIdentification_3' agentAccount: $ref: '#/components/schemas/AccountIdentification_3' example: "{\n \"agent\" : {\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 \"agentAccount\" : {\n \"iban\" : \"YY64COJH41059545330222956960771321\",\n \"currency\" : \"EUR\"\n }\n}" TaxParty_3: description: 'Set of elements used to identify a party of the transaction to which the tax applies. The [authorization] property aims to provide the details of the authorised tax paying party. ' type: object properties: taxIdentification: description: Tax identification number of the party. type: string maxLength: 35 registrationIdentification: description: Unique identification, as assigned by an organisation, to unambiguously identify a party. type: string maxLength: 35 taxType: description: Type of tax payer. type: string maxLength: 35 authorisation: $ref: '#/components/schemas/TitleAndName_3' example: "{\n \"taxIdentification\" : \"TaxIdHGH5445\",\n \"registrationIdentification\" : \"REGId387H\",\n \"taxType\" : \"VAT\",\n \"authorisation\" : {\n \"title\" : \"M.\",\n \"name\" : \"John Doe\"\n }\n}" SupplementaryData_3: description: 'ISO20022: Additional information that cannot be captured in the structured elements and/or any other specific block. API: This structure is used to embed the relevant URLs for returning the status report to the PISP and to specify which authentication approaches are accepted by the PISP and which was chosen by the ASPSP The [acceptedAuthenticationApproach] property can only be set by the PISP. - Authentication approaches that are supported by the PISP. The PISP can provide several choices separated by commas. - Case of none of the accepted approaches is supported by the ASPSP, the latest will respond with HTTP400 (Bad request) and specify wich approaches are actually supported. The [appliedAuthentication] will be set by the ASPSP. - The ASPSP, based on the authentication approaches proposed by the PISP, choose the one that it can processed, in respect with the preferences and constraints of the PSU and indicates in this field which approach was chosen. - It may happen that the ASPSP considers that, in case of payment cancellation request, there is no need for authentication and will then return "NONE". ' type: object properties: acceptedAuthenticationApproach: $ref: '#/components/schemas/AuthenticationApproaches' appliedAuthenticationApproach: $ref: '#/components/schemas/AuthenticationApproach' appliedAuthentication: description: '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. ' type: string enum: - noAuthentication - oneFactorAuthentication - strongAuthentication scaHint: description: 'can only be set by the PISP Hint given by the merchant and/or the PISP about an SCA exemption context ' type: string enum: - noScaExemption - scaExemption successfulReportUrl: description: '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 ' type: string unsuccessfulReportUrl: description: '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 ' type: string nextStatusRequestHint: description: 'Date and time at which the PISP is suggested to ask again for the status of the payment request. ' type: string format: date-time example: "{\n \"successfulReportUrl\" : \"http://myPisp/PaymentSuccess\",\n \"unsuccessfulReportUrl\" : \"http://myPisp/PaymentFailure\"\n}" CreditTransferTransactionLinks_2: description: 'links that can be used for further navigation when retrieving the transaction of a payment request. | Link | Description | | ---- | ----------- | | self | link to the transactions | | parent | This link shall point to the parent payment request. | | first | link to the first page of the transactions result | | last | link to the last page of the transactions result | | next | link to the next page of the transactions result | | prev | link to the previous page of the transactions result | ' type: object properties: self: $ref: '#/components/schemas/GenericLink_3' parent: $ref: '#/components/schemas/GenericLink_3' first: $ref: '#/components/schemas/GenericLink_3' last: $ref: '#/components/schemas/GenericLink_3' next: $ref: '#/components/schemas/GenericLink_3' prev: $ref: '#/components/schemas/GenericLink_3' readOnly: true example: "{\n \"self\": {\n \"href\": \"/v1/payment-requests/MyPmtInfRscId/creditTransfertTransactions\"\n },\n \"parent\": {\n \"href\": \"/v1/payment-requests/MyPmtInfRscId\"\n }\n}" CodeAndIssuer_3: description: 'Specifies a code and the issuer of this code. ' type: object properties: code: description: Provides the code. type: string maxLength: 4 issuer: description: Identification of the issuer of the code. type: string maxLength: 35 required: - code example: "{\n \"code\" : \"CD01\",\n \"issuer\" : \"MyIssuer\"\n}" StructuredRemittanceInformation_3: description: 'Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts'' receivable system, in a structured form. ' type: object properties: referredDocumentInformation: $ref: '#/components/schemas/ReferredDocumentInformations_3' referredDocumentAmount: $ref: '#/components/schemas/RemittanceAmount_3' creditorReferenceInformation: $ref: '#/components/schemas/CreditorReferenceInformation_3' invoicer: $ref: '#/components/schemas/PartyIdentification_3' invoicee: $ref: '#/components/schemas/PartyIdentification_3' taxRemittance: $ref: '#/components/schemas/TaxInformation_3' example: "{\n \"referredDocumentInformation\" : [ {\n \"type\" : {\n \"code\" : \"CD01\",\n \"issuer\" : \"MyIssuer\"\n },\n \"number\" : \"1\",\n \"relatedDate\" : \"2020-02-19\",\n \"lineDetails\" : [ {\n \"amount\" : {\n \"remittedAmount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n }\n } ]\n } ],\n \"referredDocumentAmount\" : {\n \"remittedAmount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n },\n \"creditorReferenceInformation\" : {\n \"type\" : {\n \"code\" : \"CD01\",\n \"issuer\" : \"MyIssuer\"\n },\n \"reference\" : \"CredRef56FH6\"\n },\n \"invoicee\" : {\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 \"taxRemittance\" : {\n \"creditor\" : {\n \"taxIdentification\" : \"TaxIdHGH5445\",\n \"registrationIdentification\" : \"REGId387H\",\n \"taxType\" : \"VAT\",\n \"authorisation\" : {\n \"title\" : \"M.\",\n \"name\" : \"John Doe\"\n }\n },\n \"debtor\" : {\n \"taxIdentification\" : \"TaxIdHGH5445\",\n \"registrationIdentification\" : \"REGId387H\",\n \"taxType\" : \"VAT\",\n \"authorisation\" : {\n \"title\" : \"M.\",\n \"name\" : \"John Doe\"\n }\n },\n \"administrationZone\" : \"FR\",\n \"method\" : \"CT\",\n \"date\" : \"2020-02-19\",\n \"record\" : [ {\n \"type\" : \"NationalTax\",\n \"category\" : \"VAT\",\n \"categoryDetails\" : \"VAT02\",\n \"debtorStatus\" : \"Valid\",\n \"certificateIdentification\" : \"CertId56RD\",\n \"formsCode\" : \"FormHJH7\",\n \"period\" : {\n \"year\" : \"2020\",\n \"type\" : \"QTR4\",\n \"fromDate\" : \"2019-10-01\",\n \"toDate\" : \"2020-01-01\"\n },\n \"taxAmount\" : {\n \"details\" : [ {\n \"period\" : {\n \"year\" : \"2020\",\n \"type\" : \"QTR4\",\n \"fromDate\" : \"2019-10-01\",\n \"toDate\" : \"2020-01-01\"\n },\n \"amount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n } ]\n },\n \"additionalInformation\" : \"Some comment\"\n } ]\n }\n}" ReferredDocumentInformation_3: description: Provides the identification and the content of the referred document. type: object properties: type: $ref: '#/components/schemas/CodeAndIssuer_3' number: description: Unique and unambiguous identification of the referred document. type: string maxLength: 35 relatedDate: description: Date associated with the referred document. type: string format: date lineDetails: description: Sets of elements used to provide the content of the referred document line. type: array items: $ref: '#/components/schemas/LineDetail_3' minItems: 1 example: "{\n \"type\" : {\n \"code\" : \"CD01\",\n \"issuer\" : \"MyIssuer\"\n },\n \"number\" : \"1\",\n \"relatedDate\" : \"2020-02-19\",\n \"lineDetails\" : [ {\n \"amount\" : {\n \"remittedAmount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n }\n } ]\n}" TaxPeriod_3: description: 'Set of elements used to provide details on the period of time related to the tax payment. The [type] property aims to identify the period related to the tax payment. ' type: object properties: year: description: Year related to the tax payment. type: string pattern: ^[0-9]{4,4}$ type: $ref: '#/components/schemas/TaxRecordPeriodCode' fromDate: description: Start date of the range. type: string format: date toDate: description: End date of the range. type: string format: date example: "{\n \"year\" : \"2020\",\n \"type\" : \"QTR4\",\n \"fromDate\" : \"2019-10-01\",\n \"toDate\" : \"2020-01-01\"\n}" TaxInformation_3: description: 'ISO20022: Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account. API: Amounts must always be set as positive values. The [totalTaxableBaseAmount] property indicates the total amount of money on which the tax is based. The [totalTaxAmount] property indicates the total amount of money as result of the calculation of the tax. ' type: object properties: creditor: $ref: '#/components/schemas/TaxParty_3' debtor: $ref: '#/components/schemas/TaxParty_3' ultimateDebtor: $ref: '#/components/schemas/TaxParty_3' administrationZone: description: Territorial part of a country to which the tax payment is related. type: string maxLength: 35 referenceNumber: description: Tax reference information that is specific to a taxing agency. type: string maxLength: 140 method: description: Method used to indicate the underlying business or how the tax is paid. type: string maxLength: 35 totalTaxableBaseAmount: $ref: '#/components/schemas/AmountType_3' totalTaxAmount: $ref: '#/components/schemas/AmountType_3' date: description: Date by which tax is due. type: string format: date sequenceNumber: description: Sequential number of the tax report. type: integer format: int32 record: description: Records of tax details type: array items: $ref: '#/components/schemas/TaxRecord_3' minItems: 1 example: "{\n \"creditor\" : {\n \"taxIdentification\" : \"TaxIdHGH5445\",\n \"registrationIdentification\" : \"REGId387H\",\n \"taxType\" : \"VAT\",\n \"authorisation\" : {\n \"title\" : \"M.\",\n \"name\" : \"John Doe\"\n }\n },\n \"debtor\" : {\n \"taxIdentification\" : \"TaxIdHGH5445\",\n \"registrationIdentification\" : \"REGId387H\",\n \"taxType\" : \"VAT\",\n \"authorisation\" : {\n \"title\" : \"M.\",\n \"name\" : \"John Doe\"\n }\n },\n \"administrationZone\" : \"FR\",\n \"method\" : \"CT\",\n \"date\" : \"2020-02-19\",\n \"record\" : [ {\n \"type\" : \"NationalTax\",\n \"category\" : \"VAT\",\n \"categoryDetails\" : \"VAT02\",\n \"debtorStatus\" : \"Valid\",\n \"certificateIdentification\" : \"CertId56RD\",\n \"formsCode\" : \"FormHJH7\",\n \"period\" : {\n \"year\" : \"2020\",\n \"type\" : \"QTR4\",\n \"fromDate\" : \"2019-10-01\",\n \"toDate\" : \"2020-01-01\"\n },\n \"taxAmount\" : {\n \"details\" : [ {\n \"period\" : {\n \"year\" : \"2020\",\n \"type\" : \"QTR4\",\n \"fromDate\" : \"2019-10-01\",\n \"toDate\" : \"2020-01-01\"\n },\n \"amount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n } ]\n },\n \"additionalInformation\" : \"Some comment\"\n } ]\n}" PaymentIdentification_3: description: 'ISO20022: Set of elements used to reference a payment instruction. ' type: object properties: instructionId: description: '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 ' type: string pattern: ^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$ endToEndId: $ref: '#/components/schemas/EndToEndId' uetr: description: 'ISO20022: Universally unique identifier to provide an end-to-end reference of a payment transaction. ' type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$ required: - instructionId example: "{\n \"resourceId\" : \"MyInstrRscId1\",\n \"instructionId\" : \"MyInstrId1\",\n \"endToEndId\" : \"MyEndToEndId1\"\n}" AmountType_3: description: 'Structure aiming to embed the amount and the currency to be used. ' type: object properties: amount: description: '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. ' type: number format: float pattern: ^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$ currency: $ref: '#/components/schemas/CurrencyCode_3' required: - amount - currency example: "{\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n}" DateAndPlaceOfBirth_3: description: 'Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment. ' type: object properties: birthDate: description: Date on which a person is born. type: string format: date cityOfBirth: description: City where a person was born. type: string maxLength: 35 countryOfBirth: description: Country where a person was born. type: string pattern: ^[A-Z]{2,2}$ required: - birthDate - cityOfBirth - countryOfBirth example: "{\n \"birthDate\" : \"1985-02-19\",\n \"cityOfBirth\" : \"Paris\",\n \"countryOfBirth\" : \"FR\"\n}" BatchBookingIndicator_3: description: '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. Meaning When True: Identifies that a batch entry for the sum of the amounts of all transactions in the batch or message is requested. Meaning When False: Identifies that a single entry for each of the transactions in the batch or message is requested. Default value: each ASPSP must be able to specify its own default value. ' type: boolean FundsAvailabilityInformation_3: description: 'Indicator that the payment can be covered or not by the funds available on the relevant account - true: payment is covered - false: payment is not covered This indicator must be provided by the ASPSP when the Booking Information is present and set to "False". This indicator will not be provided if the Booking Information is absent or set to "True". ' type: boolean readOnly: true DocumentLineIdentification_3: description: 'Provides identification of the document line. the [type] property must be used for specifying the type of referred document type. ' type: object properties: type: $ref: '#/components/schemas/CodeAndIssuer_3' number: description: Unique and unambiguous identification of the referred document line. type: string maxLength: 35 relatedDate: description: Date associated with the referred document line. type: string format: date example: "{\n \"type\" : {\n \"code\" : \"CD01\",\n \"issuer\" : \"MyIssuer\"\n },\n \"number\" : \"1\",\n \"relatedDate\" : \"2020-02-09\"\n}" PaymentRequestLinks_3: description: 'links that can be used for further navigation when having post a Payment Request in order to get the relevant status report. | Link | Description | | ---- | ----------- | | request | This link provides the payment-request URL for retrieving or modifying | | confirmation | This link shall not be provided when the confirmation was already posted. | | transactions | The ASPSP might choose to provide the relevant transactions of a Payment Request through a specific link | ' type: object properties: request: $ref: '#/components/schemas/GenericLink_3' confirmation: $ref: '#/components/schemas/GenericLink_3' transactions: $ref: '#/components/schemas/GenericLink_3' readOnly: true example: "{\n \"request\" : {\n \"href\" : \"/v1/payment-requests/MyPmtInfRscId\"\n },\n \"confirmation\" : {\n \"href\" : \"/v1/payment-requests/MyPmtInfRscId/confirmation\"\n }\n}" GenericLink_3: description: hypertext reference type: object properties: href: description: URI to be used. HREF stands for Hypertext REFerence. type: string maxLength: 2000 templated: description: '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 ' type: boolean required: - href example: "{\n \"href\" : \"/v1/accounts\"\n}" TaxRecordDetails_3: description: 'ISO20022: Elements used to provide details on the tax period and amount. API: Amounts must always be set as positive values. | Property | Description | | -------- | ----------- | | period | Set of elements used to provide details on the period of time related to the tax payment. | | amount | Underlying tax amount related to the specified period. | ' type: object properties: period: $ref: '#/components/schemas/TaxPeriod_3' amount: $ref: '#/components/schemas/AmountType_3' required: - amount example: "{\n \"period\" : {\n \"year\" : \"2020\",\n \"type\" : \"QTR4\",\n \"fromDate\" : \"2019-10-01\",\n \"toDate\" : \"2020-01-01\"\n },\n \"amount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n}" FrequencyCode_3: description: 'Frequency rule for standing orders. The following codes from the "EventFrequency7Code" of ISO 20022 are supported. | Code | Description | | ---- | ----------- | | DAIL | Daily | | WEEK | Weekly | | TOWK | EveryTwoWeeks | | MNTH | Monthly | | TOMN | EveryTwoMonths | | QUTR | Quarterly | | SEMI | SemiAnnual | | YEAR | Annual | However, each ASPSP might restrict these values into a subset if needed. ' type: string enum: - DAIL - WEEK - TOWK - MNTH - TOMN - QUTR - SEMI - YEAR PaymentTypeInformation_3: description: 'ISO20022: Set of elements used to further specify the type of transaction. ' type: object properties: instructionPriority: $ref: '#/components/schemas/PriorityCode_3' serviceLevel: $ref: '#/components/schemas/ServiceLevelCode_3' localInstrument: $ref: '#/components/schemas/LocalInstrumentCode_3' categoryPurpose: $ref: '#/components/schemas/CategoryPurposeCode_3' example: "{\n \"serviceLevel\" : \"SEPA\",\n \"localInstrument\" : \"INST\",\n \"categoryPurpose\" : \"CASH\"\n}" TaxRecord_3: description: 'Record of tax details the [period] property embbeds the set of elements used to provide details on the period of time related to the tax payment. the [amount] property embbeds the set of elements used to provide information on the amount of the tax record. ' type: object properties: type: description: High level code to identify the type of tax details. type: string maxLength: 35 category: description: Specifies the tax code as published by the tax authority. type: string maxLength: 35 categoryDetails: description: Provides further details of the category tax code. type: string maxLength: 35 debtorStatus: description: Code provided by local authority to identify the status of the party that has drawn up the settlement document. type: string maxLength: 35 certificateIdentification: description: Identification number of the tax report as assigned by the taxing authority. type: string maxLength: 35 formsCode: description: Identifies, in a coded form, on which template the tax report is to be provided. type: string maxLength: 35 period: $ref: '#/components/schemas/TaxPeriod_3' taxAmount: $ref: '#/components/schemas/TaxAmount_3' additionalInformation: description: Further details of the tax record. type: string maxLength: 140 example: "{\n \"type\" : \"NationalTax\",\n \"category\" : \"VAT\",\n \"categoryDetails\" : \"VAT02\",\n \"debtorStatus\" : \"Valid\",\n \"certificateIdentification\" : \"CertId56RD\",\n \"formsCode\" : \"FormHJH7\",\n \"period\" : {\n \"year\" : \"2020\",\n \"type\" : \"QTR4\",\n \"fromDate\" : \"2019-10-01\",\n \"toDate\" : \"2020-01-01\"\n },\n \"taxAmount\" : {\n \"details\" : [ {\n \"period\" : {\n \"year\" : \"2020\",\n \"type\" : \"QTR4\",\n \"fromDate\" : \"2019-10-01\",\n \"toDate\" : \"2020-01-01\"\n },\n \"amount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n } ]\n },\n \"additionalInformation\" : \"Some comment\"\n}" RemittanceAmount_3: description: 'ISO20022: Provides details on the amounts of the document line. API: Amounts must always be set as positive values. | Property | Description | | -------- | ----------- | | duePayableAmount | Amount specified is the exact amount due and payable to the creditor. | | discountAppliedAmount | Amount of discount to be applied to the amount due and payable to the creditor. | | creditNoteAmount | Amount of a credit note. | | taxAmount | Amount of the tax. | | adjustmentAmountAndReason | Specifies detailed information on the amount and reason of the adjustment. | | remittedAmount | Amount of money remitted. | ' type: object properties: duePayableAmount: $ref: '#/components/schemas/AmountType_3' discountAppliedAmount: $ref: '#/components/schemas/TypedAmount_3' creditNoteAmount: $ref: '#/components/schemas/AmountType_3' taxAmount: $ref: '#/components/schemas/TypedAmount_3' adjustmentAmountAndReason: $ref: '#/components/schemas/DocumentAdjustment_3' remittedAmount: $ref: '#/components/schemas/AmountType_3' example: "{\n \"remittedAmount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n }\n}" RequestedExecutionDate_3: description: 'ISO20022: Date at which the initiating party requests the clearing agent to process the payment. API: When set by the PISP, this field indicates the future date at which the payment instruction should be executed and the debtor account should be debited. if this field is not set by the PISP, the ASPSP is requested to execute the payment instruction as soon as possible. In most of the cases, especially for international payments, the date of the credit on the credit account cannot be set. Only SCTInst can guarantee having the same date for this credit. When the payment cannot be processed at the requested date, the ASPSP is allowed to shift the applied execution date to the next possible execution date for non-standing orders. For standing orders, this field is useless since the [startDate] parameter already provides the needed information for the first payment instruction to be executed. ' type: string format: date-time ErrorModel_3: description: Generic error report structure type: object properties: timestamp: description: current timestamp type: string format: date-time status: description: HTTP error code type: integer format: int32 error: description: HTTP error text type: string maxLength: 140 message: description: HTTP textual reason phrase type: string maxLength: 140 path: description: Relevant path that was used type: string maxLength: 140 details: description: list of detailed errors that were encountered type: array items: $ref: '#/components/schemas/ErrorDetail' minItems: 1 required: - status - message example: "{\n \"timestamp\" : \"2021-03-17T16:47:00.187248+01:00\",\n \"status\" : 400,\n \"error\" : \"Bad Request\",\n \"message\" : \"This Authentication Approach is not available\",\n \"details\" : [ {\n \"path\" : \"$.supplementaryData.acceptedAuthenticationApproach\",\n \"erroneousValue\" : \"EMBEDDED\",\n \"expectedEnumeration\" : [ \"REDIRECT\", \"DECOUPLED\" ]\n } ]\n}" DocumentAdjustment_3: description: 'ISO20022: Specifies detailed information on the amount and reason of the adjustment. API: Amounts must always be set as positive values. ' type: object properties: amount: $ref: '#/components/schemas/AmountType_3' creditDebitIndicator: $ref: '#/components/schemas/CreditDebitIndicator_3' reason: description: Specifies the reason for the adjustment. type: string maxLength: 4 additionalInformation: description: Provides further details on the document adjustment. type: string maxLength: 140 required: - amount example: "{\n \"amount\" : {\n \"amount\" : 123.45,\n \"currency\" : \"EUR\"\n },\n \"creditDebitIndicator\" : \"CRDT\",\n \"reason\" : \"RFND\",\n \"additionalInformation\" : \"Some comment\"\n}" ChargeBearerCode_3: description: 'ISO20022: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. The following values are allowed: | 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. | ' type: string enum: - DEBT - CRED - SHAR - SLEV CurrencyCode_3: description: 'Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". ' type: string pattern: ^[A-Z]{3,3}$ LocalInstrumentCode_3: description: 'ISO20022: User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. API: "INST" value is to be used in order to ask for an SEPA instant Payment (SCTInst). For 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. ' type: string PostalAddress_3: description: 'ISO20022: Information that locates and identifies a specific address, as defined by postal services. ' type: object properties: addressType: description: '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 | Business | Address is the home address | ' type: string enum: - BIZZ - DLVY - MLTO - PBOX - ADDR - HOME department: description: 'ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments. ' type: string maxLength: 70 subDepartment: description: 'ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments. ' type: string maxLength: 70 streetName: description: 'ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments. ' type: string maxLength: 70 buildingNumber: description: 'ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments. ' type: string maxLength: 16 buildingName: description: 'ISO20022: Name of the building or house. API: Cannot be used for SEPA payments. ' type: string maxLength: 16 postCode: description: '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. ' type: string maxLength: 16 townName: description: 'ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments. ' type: string maxLength: 35 countrySubDivision: description: 'ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments. ' type: string maxLength: 35 country: description: '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. ' type: string pattern: ^([A-Z]{2,2})$ addressLine: description: 'Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed. ' type: array items: description: Address line type: string maxLength: 70 minItems: 1 maxItems: 7 required: - country example: "{\n \"country\" : \"FR\",\n \"addressLine\" : [ \"18 rue de la DSP2\", \"75008 PARIS\" ]\n}" ResourceId_3: description: 'API: Identifier assigned by the ASPSP for further use of the created resource through API calls. The API client cannot set or modify the value of this field. Since this value can be exchanged between the server and the client as an URL element or for support information, it must not contain sensitive value such as personal or business data. However it is the duty of each ASPSP to perform its own risk analysis on this topic. ' type: string pattern: ^([a-zA-Z0-9_ /\-?:\()\.,']{1,100})$ readOnly: true CreditorReferenceInformation_3: description: Reference information provided by the creditor to allow the identification of the underlying documents. type: object properties: type: $ref: '#/components/schemas/CodeAndIssuer_3' reference: description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. type: string maxLength: 35 example: "{\n \"type\" : {\n \"code\" : \"CD01\",\n \"issuer\" : \"MyIssuer\"\n },\n \"reference\" : \"CredRef56FH6\"\n}" PaymentRequestResource_3: description: '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 ' type: object properties: resourceId: $ref: '#/components/schemas/ResourceId_3' paymentInformationId: $ref: '#/components/schemas/PaymentInformationId_3' batchBooking: $ref: '#/components/schemas/BatchBookingIndicator_3' creationDateTime: $ref: '#/components/schemas/CreationDateTime_3' numberOfTransactions: description: '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 ' type: integer minimum: 1 initiatingParty: $ref: '#/components/schemas/PartyIdentification_3' acceptDebtorAccountChange: description: '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 ' type: boolean acceptChargeHandlingChange: description: '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 ' type: boolean acceptInstantPaymentDowngrade: description: '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) ' type: boolean paymentTypeInformation: $ref: '#/components/schemas/PaymentTypeInformation_3' debtor: $ref: '#/components/schemas/PartyIdentification_3' debtorAccount: $ref: '#/components/schemas/AccountIdentification_3' debtorAgent: $ref: '#/components/schemas/FinancialInstitutionIdentification_3' chargeBearer: $ref: '#/components/schemas/ChargeBearerCode_3' paymentInformationStatus: $ref: '#/components/schemas/PaymentInformationStatusCode_3' statusReasonInformation: $ref: '#/components/schemas/StatusReasonInformation_3' fundsAvailability: $ref: '#/components/schemas/FundsAvailabilityInformation_3' booking: $ref: '#/components/schemas/BookingInformation_3' creditTransferTransaction: description: '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 ' type: array items: $ref: '#/components/schemas/CreditTransferTransactionResource_2' minItems: 1 supplementaryData: $ref: '#/components/schemas/SupplementaryData_3' required: - paymentInformationId - creationDateTime - numberOfTransactions - initiatingParty - paymentTypeInformation - creditTransferTransaction - supplementaryData example: "{\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}" InstructionForCreditorAgent_3: description: 'Further information related to the processing of the payment instruction that may need to be acted upon by the creditor''s agent. The instruction may relate to a level of service, or may be an instruction that has to be executed by the creditor''s agent, or may be information required by the creditor''s agent. ' type: object properties: code: description: '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. |' type: string enum: - CHQB - HOLD - PHOB - TELB instructionInformation: description: Further information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community. type: string maxLength: 140 example: "{\n \"code\" : \"TELB\",\n \"instructionInformation\" : \"Please contact M. John Doe\"\n}" TransactionIndividualStatusCode_3: description: 'ISO20022: Specifies the status of the payment information group. API: Only the following values are allowed to provide the status of the subsequent CREDIT TRANSFER to the Payment Request | Code | Name | Description | | ---- | ---- | ---------- | | ACSC | AcceptedSettlementCompleted | Settlement on the debtor''s account was completed. In the case of SCTInst, this status must not been set by the debtor''s Bank before the reception of the positive confirmation. The transaction cannot be cancelled. | | ACSP | AcceptedSettlementInProcess | All preceding checks such as technical validation and customer profile were successful and therefore the Payment Request was accepted for execution. The transaction cannot be cancelled. | | ACTC | AcceptedTechnicalValidation | Authentication and syntactical and semantical validation are successful. The transaction might be cancelled. | | CANC | Cancelled | Payment initiation was successfully cancelled after having received a request for cancellation. | | PDNG | Pending | Payment request or individual transaction included in the Payment Request is pending. Further checks and status update will be performed. The transaction might be cancelled. | | RJCT | Rejected | Payment request or individual transaction included in the Payment Request was rejected. | ![](https://www.stet.eu//assets/files/documents-api/transaction-status-1-4-2.png) ' type: string enum: - ACSC - ACSP - ACTC - CANC - PDNG - RJCT AccountIdentification_3: description: 'Unique and unambiguous identification for the account between the account owner and the account servicer. Card accounts must provide the identification of the card through the "other" substructure by giving, for instance, the masked PAN (MPAN). The currency used for the account, when needed, can be specified through the [currency] field. ' type: object properties: workspace: description: '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. ' type: string maxLength: 32 iban: description: '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. ' type: string pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ other: $ref: '#/components/schemas/GenericIdentification_3' currency: $ref: '#/components/schemas/CurrencyCode_3' example: "{\n \"workspace\": \"PRO_1\",\n \"iban\" : \"YY64COJH41059545330222956960771321\",\n \"currency\" : \"EUR\"\n}" StandingOrderCharacteristics_2: description: 'Specifies the characteristics of a standing order. ' type: object properties: startDate: $ref: '#/components/schemas/StartDate' endDate: $ref: '#/components/schemas/EndDate_3' executionRule: $ref: '#/components/schemas/ExecutionRule_3' frequency: $ref: '#/components/schemas/FrequencyCode_3' required: - startDate - executionRule - frequency example: "{\n \"startDate\" : \"2020-02-24T00:00Z\",\n \"executionRule\" : \"FWNG\",\n \"frequency\" : \"MNTH\"\n}" PartyIdentification_3: description: 'API : Description of a Party which can be either a person or an organization. ' type: object properties: name: description: '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. ' type: string maxLength: 140 dateAndPlaceOfBirth: $ref: '#/components/schemas/DateAndPlaceOfBirth_3' postalAddress: $ref: '#/components/schemas/PostalAddress_3' contactDetails: $ref: '#/components/schemas/ContactDetails' organisationId: $ref: '#/components/schemas/GenericIdentification_3' privateId: $ref: '#/components/schemas/GenericIdentification_3' lei: $ref: '#/components/schemas/LeiIdentification' required: - name example: "{\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}" Beneficiary_3: description: Specification of a beneficiary type: object properties: workspace: $ref: '#/components/schemas/Workspace' id: description: Id of the beneficiary type: string pattern: ^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$ isTrusted: description: '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 ' type: boolean readOnly: true creditorAgent: $ref: '#/components/schemas/FinancialInstitutionIdentification_3' creditor: $ref: '#/components/schemas/PartyIdentification_3' creditorAccount: $ref: '#/components/schemas/AccountIdentification_3' required: - creditor example: "{\n \"creditor\" : {\n \"name\" : \"myMerchant\",\n \"postalAddress\" : {\n \"country\" : \"FR\",\n \"addressLine\" : [ \"18 rue de la DSP2\", \"75008 PARIS\" ]\n },\n \"organisationId\" : {\n \"identification\" : \"852126789\",\n \"schemeName\" : \"SIREN\",\n \"issuer\" : \"FR\"\n }\n },\n \"creditorAccount\" : {\n \"iban\" : \"YY64COJH41059545330222956960771321\",\n \"currency\" : \"EUR\"\n }\n}" HalPaymentRequest_3: description: HYPERMEDIA structure used for returning the original Payment Request to the PISP type: object properties: paymentRequest: $ref: '#/components/schemas/PaymentRequestResource_3' _links: $ref: '#/components/schemas/PaymentRequestLinks_3' required: - paymentRequest - _links example: "{\n \"paymentRequest\" : {\n \"resourceId\" : \"MyPmtInfRscId\",\n \"paymentInformationId\" : \"MyPmtInfId\",\n \"creationDateTime\" : \"2020-02-19T13:56:54.758+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 \"debtorAgent\" : {\n \"bicFi\" : \"BNKAFRPPXXX\"\n },\n \"chargeBearer\" : \"SLEV\",\n \"paymentInformationStatus\" : \"PDNG\",\n \"creditTransferTransaction\" : [ {\n \"paymentId\" : {\n \"instructionId\" : \"MyInstrId3\",\n \"endToEndId\" : \"MyEndToEndId3\"\n\n },\n \"requestedExecutionDate\" : \"2020-02-19T13:56:54.759+01:00\",\n \"instructedAmount\" : {\n \"amount\" : 124.35,\n \"currency\" : \"EUR\"\n\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 \"transactionStatus\" : \"PDNG\"\n }, {\n \"paymentId\" : {\n \"instructionId\" : \"MyInstrId4\",\n \"endToEndId\" : \"MyEndToEndId4\"\n },\n \"requestedExecutionDate\" : \"2020-02-19T13:56:54.759+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 \"transactionStatus\" : \"PDNG\"\n } ],\n \"supplementaryData\" : {\n \"acceptedAuthenticationApproach\" : [ \"REDIRECT\", \"DECOUPLED\" ],\n \"appliedAuthenticationApproach\" : \"REDIRECT\",\n \"successfulReportUrl\" : \"http://myPisp/PaymentSuccess\",\n \"unsuccessfulReportUrl\" : \"http://myPisp/PaymentFailure\"\n }\n },\n \"_links\" : {\n \"request\" : {\n \"href\" : \"/v1/payment-requests/MyPmtInfRscId\"\n },\n \"confirmation\" : {\n \"href\" : \"/v1/payment-requests/MyPmtInfRscId/confirmation\"\n }\n }\n}" BookingInformation_3: description: 'Indicator that the payment can be immediately booked or not - true: payment is booked - false: payment is not booked Booking 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. However, usual fraud detection mechanisms might still be triggered and result as a rejection of the payment. This indicator must be provided when the relevant Credit Transfer will be executed as soon as possible but not as an instant payment. This indicator is irrelevant and will not be provided for delayed payments. This 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. Case the Information System cannot handle this immediate booking, the ASPSP will have to provide the funds availability information. ' type: boolean readOnly: true ReferredDocumentInformations_3: description: 'Provides the identification and the content of the referred documents. ' type: array items: $ref: '#/components/schemas/ReferredDocumentInformation_3' minItems: 1 EquivalentAmountType_3: description: 'Amount of money to be moved between debtor and creditor, before deduction of charges, expressed in the currency of the debtor''s account, and to be moved in a different currency. Usage: The first agent will convert the equivalent amount into the amount to be moved. ' type: object properties: amount: description: '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. ' type: number format: float pattern: ^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$ currency: $ref: '#/components/schemas/CurrencyCode_3' currencyOfTransfer: $ref: '#/components/schemas/CurrencyCode_3' required: - amount - currency - currencyOfTransfer example: "{\n \"amount\" : 140.45,\n \"currency\" : \"EUR\",\n \"currencyOfTransfer\" : \"USD\"\n}" FinancialInstitutionIdentification_3: description: 'ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme. ' type: object properties: bicFi: description: '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)". ' type: string pattern: ^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$ clearingSystemMemberId: $ref: '#/components/schemas/ClearingSystemMemberIdentification_3' lei: $ref: '#/components/schemas/LeiIdentification' name: description: Name of the financial institution type: string maxLength: 140 postalAddress: $ref: '#/components/schemas/PostalAddress_3' required: - bicFi example: "{\n \"bicFi\" : \"BNKAFRPPXXX\"\n}" HalAuthenticationRequest_2: description: 'Data forwarded by the ASPSP top the PISP after creation of the Payment Request resource creation The ASPSP, based on the authentication approaches proposed by the PISP, choose the one that it can processed, in respect with the preferences and constraints of the PSU and indicates in this field which approach was chosen. It may happen that the ASPSP considers that, in case of payment cancellation request, there is no need for authentication and will then return "NONE". ' type: object properties: appliedAuthenticationApproach: $ref: '#/components/schemas/AuthenticationApproach' nonce: $ref: '#/components/schemas/Nonce' _links: $ref: '#/components/schemas/PaymentRequestResourceCreationLinks_3' example: "{\n \"appliedAuthenticationApproach\" : \"REDIRECT\",\n \"nonce\" : \"GH6HGH5CGH763\",\n \"_links\" : {\n \"consentApproval\" : {\n \"href\" : \"https://psd2.aspsp/consent-approval\"\n }\n }\n}" parameters: PaymentRequestResourceIdentification: name: paymentRequestResourceId in: path description: Identification of the Payment Request Resource required: true schema: type: string pattern: ^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$ PsuAcceptLanguageHeader: name: PSU-Accept-Language in: header description: '"Accept-Language" header field sent by the PSU terminal when connecting to the TPP ' schema: type: string SignatureHeader: name: Signature in: header required: true description: '[http-signature of the request](https://datatracker.ietf.org/doc/draft-cavage-http-signatures/) The keyId must specify the way to get the relevant qualified certificate. It is requested that this identifier is an URL aiming to provide the relevant Qualified Certificate. ' schema: type: string PsuAcceptEncodingHeader: name: PSU-Accept-Encoding in: header description: '"Accept-Encoding" header field sent by the PSU terminal when connecting to the TPP ' schema: type: string PsuGeoLocation: name: PSU-GEO-Location in: header description: Geographical location of the PSU as provided by the PSU mobile terminal if any to the TPP schema: type: string PsuUserAgentHeader: name: PSU-User-Agent in: header description: '"User-Agent" header field sent by the PSU terminal when connecting to the TPP ' schema: type: string PsuAcceptHeader: name: PSU-Accept in: header description: '"Accept" header field sent by the PSU terminal when connecting to the TPP ' schema: type: string PsuIpPortHeader: name: PSU-IP-Port in: header description: IP port used by the PSU's terminal when connecting to the TPP schema: type: string PsuAcceptCharsetHeader: name: PSU-Accept-Charset in: header description: '"Accept-Charset" header field sent by the PSU terminal when connecting to the TPP ' schema: type: string AuthorizationParameter: name: Authorization in: header description: Access token to be passed as a header required: true schema: type: string PsuHttpMethodHeader: name: PSU-HTTP-Method in: header description: Http method for the most relevant PSU’s terminal request to the TTP schema: type: string DigestHeader: name: Digest in: header required: false description: Digest of the body schema: type: string PsuDeviceId: name: PSU-Device-ID in: header description: 'UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of installation identification this ID need to be unaltered until removal from device. ' schema: type: string UiLocales: name: ui_locales in: query description: 'End-User''s preferred languages and scripts for the user interface, represented as a space-separated list of BCP47 [RFC5646] language tag values, ordered by preference. ' required: false schema: type: string maxLength: 140 PsuRefererHeader: name: PSU-Referer in: header description: '"Referer" header field sent by the PSU terminal when connecting to the TPP. Notice that an initial typo in RFC 1945 specifies that "referer" (incorrect spelling) is to be used. The correct spelling "referrer" can be used but might not be understood. ' schema: type: string PsuDateHeader: name: PSU-Date in: header description: Timestamp of the most relevant PSU’s terminal request to the TTP schema: type: string PsuIpAddressHeader: name: PSU-IP-Address in: header description: IP address used by the PSU's terminal when connecting to the TPP schema: type: string Correlation: name: X-Request-ID in: header required: true description: 'Correlation header to be set in a request and retrieved in the relevant response ' schema: type: string maxLength: 70 PaymentRequestResourceIdentification_2: name: paymentRequestResourceId description: Identification of the Payment Request Resource in: path required: true schema: type: string pattern: ^([a-zA-Z0-9_ /\-?:\()\.,']{1,100})$ PsuWorkspace: name: PSU-Workspace description: 'Workspace to be used for processing the PSU authentication when confirming a PISP request. ' in: header schema: type: string maxLength: 32 PaymentRequestResourceIdentification_3: name: paymentRequestResourceId description: Identification of the Payment Request Resource in: path required: true schema: type: string pattern: ^([a-zA-Z0-9_ /\-?:\()\.,']{1,100})$ responses: '409': description: "Conflict. \nThe request could not be completed due to a conflict with the current state of the target resource.\n" headers: X-Request-ID: description: 'Correlation header to be set in a request and retrieved in the relevant response ' schema: type: string Warning: description: 'Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ' schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ErrorModel' '400': description: Invalid status value headers: X-Request-ID: description: 'Correlation header to be set in a request and retrieved in the relevant response ' schema: type: string Warning: description: 'Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ' schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ErrorModel' '408': description: Request Timeout. headers: X-Request-ID: description: 'Correlation header to be set in a request and retrieved in the relevant response ' schema: type: string Warning: description: 'Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ' schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ErrorModel' '406': description: Not Acceptable. headers: X-Request-ID: description: 'Correlation header to be set in a request and retrieved in the relevant response ' schema: type: string Warning: description: 'Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ' schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ErrorModel' '401': description: Unauthorized, authentication failure. headers: X-Request-ID: description: 'Correlation header to be set in a request and retrieved in the relevant response ' schema: type: string Warning: description: 'Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ' schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ErrorModel' '405': description: Method Not Allowed. headers: X-Request-ID: description: 'Correlation header to be set in a request and retrieved in the relevant response ' schema: type: string Warning: description: 'Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ' schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ErrorModel' '503': description: Service unavailable. headers: X-Request-ID: description: 'Correlation header to be set in a request and retrieved in the relevant response ' schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ErrorModel' '404': description: Not found, no request available. headers: X-Request-ID: description: 'Correlation header to be set in a request and retrieved in the relevant response ' schema: type: string Warning: description: 'Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ' schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ErrorModel' '403': description: Forbidden, authentication successful but access to resource is not allowed. headers: X-Request-ID: description: 'Correlation header to be set in a request and retrieved in the relevant response ' schema: type: string Warning: description: 'Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ' schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ErrorModel' '500': description: Internal server error. headers: X-Request-ID: description: 'Correlation header to be set in a request and retrieved in the relevant response ' schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ErrorModel' '429': description: Too many requests. headers: X-Request-ID: description: 'Correlation header to be set in a request and retrieved in the relevant response ' schema: type: string Warning: description: 'Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ' schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ErrorModel' '409_2': description: 'Conflict. The request could not be completed due to a conflict with the current state of the target resource. ' headers: X-Request-ID: description: 'Correlation header to be set in a request and retrieved in the relevant response ' schema: type: string Warning: description: 'Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ' schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ErrorModel_2' '409_3': description: 'Conflict. The request could not be completed due to a conflict with the current state of the target resource. ' headers: X-Request-ID: description: 'Correlation header to be set in a request and retrieved in the relevant response ' schema: type: string Warning: description: 'Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ' schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ErrorModel_3' requestBodies: ConfirmationResource: content: application/json: schema: $ref: '#/components/schemas/ConfirmationResource' description: 'Parameters needed for confirmation of the Payment Request, especially in "EMBEDDED-1-FACTOR" approach Even though there is no parameter, a Json (void) body structure must be provided. ' required: true PaymentRequestResource: content: application/json: schema: $ref: '#/components/schemas/PaymentRequestResource' description: ISO20022 based payment Initiation Request required: true securitySchemes: accessCode: description: "In order to access the PSU's account information, the AISP needs to get either an authorization code grant or a resource owner password OAUTH2 token.\nIn order to post a funds confirmation request, the CBPII needs to get either an authorization code grant or a resource owner password OAUTH2 token when registration of the account has not been previously processed.\nIn order to confirm a Payment or Transfer Request, the PISP needs to get either an authorization code grant or a client credential OAUTH2 token. \nThe client_id field within the token request must be filled with the value of the organization identifier attribute that has been set in the distinguished name of eIDAS certificate of the TPP, according to ETSI recommandations. \n(cf §5.2.1 of [ETSI specfication](https://www.etsi.org/standards-search#page=1&search=TS119495))\n" type: oauth2 flows: authorizationCode: authorizationUrl: /psd2/oauth/authorize tokenUrl: /stet/psd2/oauth/token scopes: pisp: Access by a PISP for posting a confirmation after authentication of the PSU through OAUTH2 Authorization Code refreshUrl: /stet/psd2/oauth/token clientCredentials: description: "In order to post, get or modify a Payment or Transfer Request, the PISP needs to get a client credential OAUTH2 token. \nIn order to confirm a Payment or Transfer Request, the PISP needs to get either an authorization code grant or a client credential OAUTH2 token. \nIn order to post a funds confirmation request, the CBPII needs to get a client credential OAUTH2 token when registration of the account has already been previously processed.\nThe client_id field within the token request must be filled with the value of the organization identifier attribute that has been set in the distinguished name of eIDAS certificate of the TPP, according to ETSI recommandations. \n(cf §5.2.1 of [ETSI specfication](https://www.etsi.org/standards-search#page=1&search=TS119495))\n" type: oauth2 flows: clientCredentials: tokenUrl: /stet/psd2/oauth/token scopes: pisp: Access by a PISP to payments resources refreshUrl: /stet/psd2/oauth/token x-refined-from: - payments-oas3-public-v1.4.2.20-b_0.json - payments-oas3-public-v1.6.2.0-b_0.json - groupe-bpce-psd2-payments-openapi.yml