openapi: 3.0.1 info: title: PAYMENT API version: 1.7.9 description: | # Summary ## Services The Payment API offers the following services. * Create payment and payment authorisation. * Read payment and payment authorisation details and status. * Delete payment and create cancellation-authorisation. * Create signing basket and signing basket authorisation. * Read signing basket and signing basket authorisation details and status. * Delete signing basket. The API follows the Berlin group standard version 1.3 (errata included). Attributes not implemented are removed. Examples uses the same mock-data as the sandbox environment. OBS. The total size of headers must not exceed 32 KB. ## Security All endpoints uses an 2-leg token (BearerAuthOAuth). All authorisations needs to be created explicit to use in the standard redirect OAuth2 flow. ## Versions ### Version 1.7.x * instant-domestic-credit-transfer description updated with new requirements * Headers total size max 32 KB * support link updated * change reqx for sepa iban payment * Added SLA/SLO for all endpoints * Remove headers * Split POST multible type payment endpoint into specifik endpoints ### Version 1.6.x * added maxItems to arrays * signing basket supported. ### Version 1.5.0 (25.02.2021) * payment-slip (indbetalingskort) supported. ### Version 1.4.1 (17.07.2020) * bban documentation updated. ### Version 1.4.0 (02.07.2020) * Debitor can name transactiontext on own account (debtorAccount). RemittanceInformationUnstructured are used. ### Version 1.3.2 (14.05.2020) * Length of CreditorName field is now 35 characters. ### Version 1.3.1 (03.03.2020) * Periodic payment documentation upgraded. ### Version 1.3.0 (28.01.2020) * Multiple approval implemented for coporate. There are no new end-points, but it is now possible to start a authorizationprocess on a existing payment with paymentStatus PATC (partially accepted). ### Version 1.2.0 (22.11.2019) * Delete single payment (not periodic payments) implemented. ### Version 1.1.1 (02.10.2019) * periodic-payments (live): post fully implemented. ### Version 1.1.0 (05.09.2019) * periodic-payments (sandbox): released ### Version 1.0.5 (02.09.2019) * periodic-payments changed. Not supporting executionRule when posting and only. supporting dayOfExecution 1 and 31 when Monthly and Quarterly. ### Version 1.0.4 (09.08.2019) * periodic-payments only valid for domestic-credit-transfer (not sepa). * periodic-payments attributes changed to mandatory. ### Version 1.0.3 Jun 17th 2019 * requestedExecutionDate made optional for IntraDay and Instant Domestic payments. ### Version 1.0.2 (12.06.2019) * DebtorId og CreditorId added to Sepa and Cross-border. ### Version 1.0.1 (19.03.2019) * Bugfixing regarding remittanceInformation. ### Version 1.0 (14.03.2019) * First Version contact: name: Contact url: 'https://bankdata.dk/developers/' externalDocs: description: External Documentation url: 'https://bankdata.dk/developers/' servers: - url: 'https://{bankdomain-prod}/openbanking-payment' variables: bankdomain-prod: default: api.sydbank.dk enum: - api.sydbank.dk - api.jyskebank.dk - api.djurslandsbank.dk - api.kreditbanken.dk - api.landbobanken.dk - api.nordfynsbank.dk - api.skjernbank.dk - api.spks.dk - url: 'https://{bankdomain-sandbox}/openbanking-payment' variables: bankdomain-sandbox: default: sandbox-api.sydbank.dk enum: - sandbox-api.sydbank.dk - sandbox-api.jyskebank.dk - sandbox-api.djurslandsbank.dk - sandbox-api.kreditbanken.dk - sandbox-api.landbobanken.dk - sandbox-api.nordfynsbank.dk - sandbox-api.skjernbank.dk - sandbox-api.spks.dk paths: '/v1/payments/domestic-credit-transfers': post: summary: Domestic Credit Transfer Payment initiation request description: | This method is used to initiate a payment in json only (not xml). operationId: initiateDomesticCreditTransfer tags: - Payment Initiation Service (PIS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' - $ref: '#/components/parameters/TPP-Redirect-Preferred' - $ref: '#/components/parameters/TPP-Redirect-URI' - $ref: '#/components/parameters/TPP-Explicit-Authorisation-Preferred' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/paymentInitiationDomesticCredit_json' examples: Example 1: $ref: '#/components/examples/DomesticPaymentInitiation' responses: '201': $ref: '#/components/responses/CREATED_201_PaymentInitiation' '400': $ref: '#/components/responses/BAD_REQUEST_400_PIS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_PIS' '403': $ref: '#/components/responses/FORBIDDEN_403_PIS' '406': $ref: '#/components/responses/NOT_ACCEPTABLE_406_PIS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_PIS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_PIS' x-dk-bankdata-slo: response-time-ms: "170" x-dk-bankdata-sla: response-time-ms: "3000" '/v1/payments/instant-domestic-credit-transfers': post: summary: Instant Domestic Credit Transfer Payment initiation request description: | This method is used to initiate a payment in json only (not xml). operationId: initiateInstantDomesticCreditTransfer tags: - Payment Initiation Service (PIS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' - $ref: '#/components/parameters/TPP-Redirect-Preferred' - $ref: '#/components/parameters/TPP-Redirect-URI' - $ref: '#/components/parameters/TPP-Explicit-Authorisation-Preferred' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/paymentInitiationInstaDomesticCredit_json' responses: '201': $ref: '#/components/responses/CREATED_201_PaymentInitiation' '400': $ref: '#/components/responses/BAD_REQUEST_400_PIS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_PIS' '403': $ref: '#/components/responses/FORBIDDEN_403_PIS' '406': $ref: '#/components/responses/NOT_ACCEPTABLE_406_PIS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_PIS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_PIS' x-dk-bankdata-slo: response-time-ms: "170" x-dk-bankdata-sla: response-time-ms: "3000" '/v1/payments/intraday-domestic-credit-transfers': post: summary: Intra Day Domestic Credit Transfer Payment initiation request description: | This method is used to initiate a payment in json only (not xml). operationId: initiateIntraDayDomesticCreditTransfers tags: - Payment Initiation Service (PIS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' - $ref: '#/components/parameters/TPP-Redirect-Preferred' - $ref: '#/components/parameters/TPP-Redirect-URI' - $ref: '#/components/parameters/TPP-Explicit-Authorisation-Preferred' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/paymentInitiationIntraDomesticCredit_json' responses: '201': $ref: '#/components/responses/CREATED_201_PaymentInitiation' '400': $ref: '#/components/responses/BAD_REQUEST_400_PIS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_PIS' '403': $ref: '#/components/responses/FORBIDDEN_403_PIS' '404': $ref: '#/components/responses/NOT_FOUND_404_PIS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_PIS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_PIS' x-dk-bankdata-slo: response-time-ms: "300" x-dk-bankdata-sla: response-time-ms: "3000" '/v1/payments/sepa-credit-transfers': post: summary: Sepa Credit Transfer Payment initiation request description: | This method is used to initiate a payment in json only (not xml). operationId: initiateSepaCreditTransfer tags: - Payment Initiation Service (PIS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' - $ref: '#/components/parameters/TPP-Redirect-Preferred' - $ref: '#/components/parameters/TPP-Redirect-URI' - $ref: '#/components/parameters/TPP-Explicit-Authorisation-Preferred' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/paymentInitiation_json' responses: '201': $ref: '#/components/responses/CREATED_201_PaymentInitiation' '400': $ref: '#/components/responses/BAD_REQUEST_400_PIS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_PIS' '403': $ref: '#/components/responses/FORBIDDEN_403_PIS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_PIS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_PIS' x-dk-bankdata-slo: response-time-ms: "230" x-dk-bankdata-sla: response-time-ms: "3000" '/v1/payments/cross-border-credit-transfers': post: summary: Cross Border Credit Transfer Payment initiation request description: | This method is used to initiate a payment in json only (not xml). operationId: initiateCrossBorderCreditTransfer tags: - Payment Initiation Service (PIS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' - $ref: '#/components/parameters/TPP-Redirect-Preferred' - $ref: '#/components/parameters/TPP-Redirect-URI' - $ref: '#/components/parameters/TPP-Explicit-Authorisation-Preferred' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/paymentInitiationCrossBorder_json' responses: '201': $ref: '#/components/responses/CREATED_201_PaymentInitiation' '400': $ref: '#/components/responses/BAD_REQUEST_400_PIS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_PIS' '403': $ref: '#/components/responses/FORBIDDEN_403_PIS' '406': $ref: '#/components/responses/NOT_ACCEPTABLE_406_PIS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_PIS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_PIS' x-dk-bankdata-slo: response-time-ms: "300" x-dk-bankdata-sla: response-time-ms: "3000" '/v1/periodic-payments/domestic-credit-transfers': post: summary: Domestic Credit Transfer Periodic Payment initiation request description: | This method is used to initiate a payment in json only (not xml). operationId: initiatePeriodicPayment tags: - Payment Initiation Service (PIS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' - $ref: '#/components/parameters/TPP-Redirect-Preferred' - $ref: '#/components/parameters/TPP-Redirect-URI' - $ref: '#/components/parameters/TPP-Explicit-Authorisation-Preferred' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/periodicPaymentInitiationDomesticCredit_json' responses: '201': $ref: '#/components/responses/CREATED_201_PaymentInitiation' '400': $ref: '#/components/responses/BAD_REQUEST_400_PIS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_PIS' '403': $ref: '#/components/responses/FORBIDDEN_403_PIS' '406': $ref: '#/components/responses/NOT_ACCEPTABLE_406_PIS' '409': $ref: '#/components/responses/CONFLICT_409_PIS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_PIS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_PIS' x-dk-bankdata-slo: response-time-ms: "300" x-dk-bankdata-sla: response-time-ms: "3000" '/v1/{payment-service}/{payment-product}/{paymentId}': get: summary: Get Payment Information description: Returns the content of a payment object operationId: getPaymentInformation tags: - Payment Initiation Service (PIS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/paymentService' - $ref: '#/components/parameters/paymentProduct' - $ref: '#/components/parameters/paymentId' - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' responses: '200': $ref: '#/components/responses/OK_200_PaymentInitiationInformation' '400': $ref: '#/components/responses/BAD_REQUEST_400_PIS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_PIS' '403': $ref: '#/components/responses/FORBIDDEN_403_PIS' '404': $ref: '#/components/responses/NOT_FOUND_404_PIS' '405': $ref: '#/components/responses/METHOD_NOT_ALLOWED_405_PIS' '406': $ref: '#/components/responses/NOT_ACCEPTABLE_406_PIS' '408': $ref: '#/components/responses/REQUEST_TIMEOUT_408_PIS' '409': $ref: '#/components/responses/CONFLICT_409_PIS' '415': $ref: '#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_PIS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_PIS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_PIS' '503': $ref: '#/components/responses/SERVICE_UNAVAILABLE_503_PIS' x-dk-bankdata-slo: response-time-ms: "180" x-dk-bankdata-sla: response-time-ms: "300" delete: summary: Payment Cancellation Request description: | This method initiates the cancellation of a payment. The response to this DELETE command will tell the TPP whether the * access method was rejected (409 conflict), * access method was successful or * access method is generally applicable, but further authorisation processes are needed. The corresponding hyperlink (cancellation-authorisations) will then be contained in the response. If you need to change a payment, you need to delete it and create it again, operationId: cancelPayment tags: - Payment Initiation Service (PIS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/paymentService' - $ref: '#/components/parameters/paymentProduct' - $ref: '#/components/parameters/paymentId' - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' responses: '202': $ref: '#/components/responses/RECEIVED_202_PaymentInitiationCancel' '204': $ref: '#/components/responses/NO_CONTENT_204_PaymentInitiationCancel' '400': $ref: '#/components/responses/BAD_REQUEST_400_PIS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_PIS' '403': $ref: '#/components/responses/FORBIDDEN_403_PIS' '404': $ref: '#/components/responses/NOT_FOUND_404_PIS' '405': $ref: '#/components/responses/METHOD_NOT_ALLOWED_405_PIS_CANC' '406': $ref: '#/components/responses/NOT_ACCEPTABLE_406_PIS' '408': $ref: '#/components/responses/REQUEST_TIMEOUT_408_PIS' '409': $ref: '#/components/responses/CONFLICT_409_PIS' '415': $ref: '#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_PIS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_PIS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_PIS' x-dk-bankdata-slo: response-time-ms: "300" x-dk-bankdata-sla: response-time-ms: "3000" '/v1/{payment-service}/{payment-product}/{paymentId}/status': get: summary: Payment initiation status request description: Check the transaction status of a payment initiation. operationId: getPaymentInitiationStatus tags: - Payment Initiation Service (PIS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/paymentService' - $ref: '#/components/parameters/paymentProduct' - $ref: '#/components/parameters/paymentId' - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' responses: '200': $ref: '#/components/responses/OK_200_PaymentInitiationStatus' '400': $ref: '#/components/responses/BAD_REQUEST_400_PIS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_PIS' '403': $ref: '#/components/responses/FORBIDDEN_403_PIS' '404': $ref: '#/components/responses/NOT_FOUND_404_PIS' '406': $ref: '#/components/responses/NOT_ACCEPTABLE_406_PIS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_PIS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_PIS' x-dk-bankdata-slo: response-time-ms: "140" x-dk-bankdata-sla: response-time-ms: "300" '/v1/{payment-service}/{payment-product}/{paymentId}/authorisations': post: summary: Start the authorisation process for a payment initiation description: > Create an authorisation sub-resource and start the authorisation process. This method is iterated n times for a n times SCA authorisation in a corporate context. operationId: startPaymentAuthorisation tags: - Payment Initiation Service (PIS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/paymentService' - $ref: '#/components/parameters/paymentProduct' - $ref: '#/components/parameters/paymentId' - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/TPP-Redirect-Preferred' - $ref: '#/components/parameters/TPP-Redirect-URI' - $ref: '#/components/parameters/TPP-Nok-Redirect-URI' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' requestBody: description: Always use an empty request. content: application/json: schema: {} responses: '201': $ref: '#/components/responses/CREATED_201_StartScaProcess' '400': $ref: '#/components/responses/BAD_REQUEST_400_PIS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_PIS' '403': $ref: '#/components/responses/FORBIDDEN_403_PIS' '404': $ref: '#/components/responses/NOT_FOUND_404_PIS' '406': $ref: '#/components/responses/NOT_ACCEPTABLE_406_PIS' '409': $ref: '#/components/responses/CONFLICT_409_PIS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_PIS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_PIS' x-dk-bankdata-slo: response-time-ms: "160" x-dk-bankdata-sla: response-time-ms: "3000" get: summary: Get Payment Initiation Authorisation Sub-Resources Request description: > Read a list of all authorisation subresources IDs which have been created. This function returns an array of hyperlinks to all generated authorisation sub-resources. operationId: getPaymentInitiationAuthorisation tags: - Payment Initiation Service (PIS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/paymentService' - $ref: '#/components/parameters/paymentProduct' - $ref: '#/components/parameters/paymentId' - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' responses: '200': $ref: '#/components/responses/OK_200_Authorisations' '400': $ref: '#/components/responses/BAD_REQUEST_400_PIS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_PIS' '403': $ref: '#/components/responses/FORBIDDEN_403_PIS' '404': $ref: '#/components/responses/NOT_FOUND_404_PIS' '406': $ref: '#/components/responses/NOT_ACCEPTABLE_406_PIS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_PIS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_PIS' x-dk-bankdata-slo: response-time-ms: "200" x-dk-bankdata-sla: response-time-ms: "300" '/v1/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}': get: summary: Read the SCA Status of the payment authorisation description: > This method returns the SCA status of a payment initiation's authorisation sub-resource. operationId: getPaymentInitiationScaStatus tags: - Payment Initiation Service (PIS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/paymentService' - $ref: '#/components/parameters/paymentProduct' - $ref: '#/components/parameters/paymentId' - $ref: '#/components/parameters/authorisationId' - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' responses: '200': $ref: '#/components/responses/OK_200_ScaStatus' '400': $ref: '#/components/responses/BAD_REQUEST_400_PIS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_PIS' '403': $ref: '#/components/responses/FORBIDDEN_403_PIS' '404': $ref: '#/components/responses/NOT_FOUND_404_PIS' '406': $ref: '#/components/responses/NOT_ACCEPTABLE_406_PIS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_PIS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_PIS' x-dk-bankdata-slo: response-time-ms: "200" x-dk-bankdata-sla: response-time-ms: "300" '/v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations': post: summary: >- Start the authorisation process for the cancellation of the addressed payment description: > Creates an authorisation sub-resource and start the authorisation process of the cancellation of the addressed payment. This method is iterated n times for a n times SCA authorisation in a corporate context. operationId: startPaymentInitiationCancellationAuthorisation tags: - Payment Initiation Service (PIS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/paymentService' - $ref: '#/components/parameters/paymentProduct' - $ref: '#/components/parameters/paymentId' - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' - $ref: '#/components/parameters/TPP-Redirect-Preferred' - $ref: '#/components/parameters/TPP-Redirect-URI' - $ref: '#/components/parameters/TPP-Nok-Redirect-URI' responses: '201': $ref: '#/components/responses/CREATED_201_StartScaProcess' '400': $ref: '#/components/responses/BAD_REQUEST_400_PIS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_PIS' '403': $ref: '#/components/responses/FORBIDDEN_403_PIS' '404': $ref: '#/components/responses/NOT_FOUND_404_PIS' '406': $ref: '#/components/responses/NOT_ACCEPTABLE_406_PIS' '409': $ref: '#/components/responses/CONFLICT_409_PIS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_PIS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_PIS' x-dk-bankdata-slo: response-time-ms: "300" x-dk-bankdata-sla: response-time-ms: "3000" get: summary: >- Will deliver an array of resource identifications to all generated cancellation authorisation sub-resources. description: | Retrieve a list of all created cancellation authorisation sub-resources. operationId: getPaymentInitiationCancellationAuthorisationInformation tags: - Payment Initiation Service (PIS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/paymentService' - $ref: '#/components/parameters/paymentProduct' - $ref: '#/components/parameters/paymentId' - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' responses: '200': $ref: '#/components/responses/OK_200_CancellationList' '400': $ref: '#/components/responses/BAD_REQUEST_400_PIS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_PIS' '403': $ref: '#/components/responses/FORBIDDEN_403_PIS' '404': $ref: '#/components/responses/NOT_FOUND_404_PIS' '406': $ref: '#/components/responses/NOT_ACCEPTABLE_406_PIS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_PIS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_PIS' x-dk-bankdata-slo: response-time-ms: "200" x-dk-bankdata-sla: response-time-ms: "300" '/v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations/{cancellationId}': get: summary: Read the SCA status of the payment cancellation's authorisation. description: > This method returns the SCA status of a payment cancellation initiation's authorisation sub-resource. operationId: getPaymentCancellationScaStatus tags: - Payment Initiation Service (PIS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/paymentService' - $ref: '#/components/parameters/paymentProduct' - $ref: '#/components/parameters/paymentId' - $ref: '#/components/parameters/cancellationId' - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' responses: '200': $ref: '#/components/responses/OK_200_ScaStatus' '400': $ref: '#/components/responses/BAD_REQUEST_400_PIS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_PIS' '403': $ref: '#/components/responses/FORBIDDEN_403_PIS' '404': $ref: '#/components/responses/NOT_FOUND_404_PIS' '406': $ref: '#/components/responses/NOT_ACCEPTABLE_406_PIS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_PIS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_PIS' x-dk-bankdata-slo: response-time-ms: "200" x-dk-bankdata-sla: response-time-ms: "300" '/v1/signing-baskets': post: summary: Create a signing basket resource description: > Create a signing basket resource for authorising several payments with one SCA method. The resource identifications of these payments are contained in the payload of this access method. There are the following limitation when creating af signing basket: * Payments must have status RCVD or PATC when the signing basket are created. * Periodic payments are not allowed as part of the Signing Basket. * It is possible to authorize 50 payments or less in one signing basket. operationId: createSigningBasket tags: - Signing Basket Service (SBS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' - $ref: '#/components/parameters/TPP-Redirect-Preferred' - $ref: '#/components/parameters/TPP-Redirect-URI' - $ref: '#/components/parameters/TPP-Explicit-Authorisation-Preferred' requestBody: $ref: '#/components/requestBodies/signingBasket' responses: '201': $ref: '#/components/responses/CREATED_201_SigningBasket' '400': $ref: '#/components/responses/BAD_REQUEST_400_SBS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_SBS' '403': $ref: '#/components/responses/FORBIDDEN_403_SBS' '404': $ref: '#/components/responses/NOT_FOUND_404_SBS' '406': $ref: '#/components/responses/NOT_ACCEPTABLE_406_SBS' '409': $ref: '#/components/responses/CONFLICT_409_SBS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_SBS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_SBS' x-dk-bankdata-slo: response-time-ms: "250" x-dk-bankdata-sla: response-time-ms: "3000" '/v1/signing-baskets/{basketId}': get: summary: Returns the content of an signing basket object. description: Returns the content of an signing basket object. operationId: getSigningBasket tags: - Signing Basket Service (SBS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/basketId_PATH' - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' responses: '200': $ref: '#/components/responses/OK_200_GetSigningBasket' '400': $ref: '#/components/responses/BAD_REQUEST_400_SBS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_SBS' '403': $ref: '#/components/responses/FORBIDDEN_403_SBS' '404': $ref: '#/components/responses/NOT_FOUND_404_SBS' '406': $ref: '#/components/responses/NOT_ACCEPTABLE_406_SBS' '415': $ref: '#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_SBS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_SBS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_SBS' x-dk-bankdata-slo: response-time-ms: "200" x-dk-bankdata-sla: response-time-ms: "300" delete: summary: Delete the signing basket description: > Delete the signing basket structure as long as no (partial) authorisation has yet been applied. The underlying transactions are not affected by this deletion. Remark: The signing basket as such is not deletable after a first (partial) authorisation has been applied. Nevertheless, single transactions might be cancelled on an individual basis aswell. operationId: deleteSigningBasket tags: - Signing Basket Service (SBS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/basketId_PATH' - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' responses: '204': $ref: '#/components/responses/NO_CONTENT_204_SigningBasket' '400': $ref: '#/components/responses/BAD_REQUEST_400_SBS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_SBS' '403': $ref: '#/components/responses/FORBIDDEN_403_SBS' '404': $ref: '#/components/responses/NOT_FOUND_404_SBS' '406': $ref: '#/components/responses/NOT_ACCEPTABLE_406_SBS' '409': $ref: '#/components/responses/CONFLICT_409_SBS' '415': $ref: '#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_SBS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_SBS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_SBS' x-dk-bankdata-slo: response-time-ms: "300" x-dk-bankdata-sla: response-time-ms: "3000" '/v1/signing-baskets/{basketId}/authorisations': post: summary: Start the authorisation process for a signing basket description: > Create an authorisation sub-resource and start the authorisation process of a signing basket. This method is iterated n times for a n times SCA authorisation in a corporate context. operationId: startSigningBasketAuthorisation tags: - Signing Basket Service (SBS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/basketId_PATH' - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' - $ref: '#/components/parameters/TPP-Redirect-Preferred' - $ref: '#/components/parameters/TPP-Redirect-URI' requestBody: description: Always use an empty request. content: application/json: schema: {} responses: '201': $ref: '#/components/responses/CREATED_201_StartScaProcess' '400': $ref: '#/components/responses/BAD_REQUEST_400_SBS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_SBS' '403': $ref: '#/components/responses/FORBIDDEN_403_SBS' '404': $ref: '#/components/responses/NOT_FOUND_404_SBS' '406': $ref: '#/components/responses/NOT_ACCEPTABLE_406_SBS' '409': $ref: '#/components/responses/CONFLICT_409_SBS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_SBS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_SBS' x-dk-bankdata-slo: response-time-ms: "360" x-dk-bankdata-sla: response-time-ms: "3000" get: summary: Get Signing Basket Authorisation Sub-Resources Request description: > Read a list of all authorisation subresources IDs which have been created. This function returns an array of hyperlinks to all generated authorisation sub-resources. operationId: getSigningBasketAuthorisation tags: - Signing Basket Service (SBS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/basketId_PATH' - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' responses: '200': $ref: '#/components/responses/OK_200_Authorisations' '400': $ref: '#/components/responses/BAD_REQUEST_400_SBS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_SBS' '403': $ref: '#/components/responses/FORBIDDEN_403_SBS' '404': $ref: '#/components/responses/NOT_FOUND_404_SBS' '406': $ref: '#/components/responses/NOT_ACCEPTABLE_406_SBS' '409': $ref: '#/components/responses/CONFLICT_409_SBS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_SBS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_SBS' x-dk-bankdata-slo: response-time-ms: "200" x-dk-bankdata-sla: response-time-ms: "300" '/v1/signing-baskets/{basketId}/authorisations/{authorisationId}': get: summary: Read the SCA status of the signing basket authorisation description: > This method returns the SCA status of a signing basket's authorisation sub-resource. operationId: getSigningBasketScaStatus tags: - Signing Basket Service (SBS) security: - OAuth2Auth: - pisprepare parameters: - $ref: '#/components/parameters/basketId_PATH' - $ref: '#/components/parameters/authorisationId' - $ref: '#/components/parameters/X-Request-ID' - $ref: '#/components/parameters/Digest' - $ref: '#/components/parameters/Signature' - $ref: '#/components/parameters/TPP-Signature-Certificate' responses: '200': $ref: '#/components/responses/OK_200_ScaStatus' '400': $ref: '#/components/responses/BAD_REQUEST_400_SBS' '401': $ref: '#/components/responses/UNAUTHORIZED_401_SBS' '403': $ref: '#/components/responses/FORBIDDEN_403_SBS' '404': $ref: '#/components/responses/NOT_FOUND_404_SBS' '406': $ref: '#/components/responses/NOT_ACCEPTABLE_406_SBS' '415': $ref: '#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_SBS' '429': $ref: '#/components/responses/TOO_MANY_REQUESTS_429_SBS' '500': $ref: '#/components/responses/INTERNAL_SERVER_ERROR_500_SBS' x-dk-bankdata-slo: response-time-ms: "200" x-dk-bankdata-sla: response-time-ms: "300" components: securitySchemes: BearerAuthOAuth: description: | Bearer Token. Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding PIS service in the same session. type: http scheme: bearer bearerFormat: JWT ApiKeyAuth: type: apiKey in: header name: x-api-key OAuth2Auth: type: oauth2 flows: authorizationCode: authorizationUrl: https://{bankdomain-sandbox}/authorize tokenUrl: https://{bankdomain-sandbox}/oauth-token scopes: pisprepare: Grants pisprepare access schemas: paymentId: description: Resource identification of the generated payment initiation resource. type: string example: 6e528be2-f6fc-4436-8fae-01920b5dee11 paymentIdList: description: A list of paymentIds type: array minItems: 1 maxItems: 50 items: $ref: '#/components/schemas/paymentId' basketId: description: Resource identification of the generated signing basket resource. type: string example: 6e528be2-f6fc-4436-8fae-01920b5dtt88 authorisationId: description: Resource identification of the related authorisation type: string example: 5aa72f40-4ee3-4ce0-978a-d464bbce1153 authenticationMethodId: description: | An identification provided for the later identification of the authorisation. Is the same as the authorisationId. type: string maxLength: 35 example: 5aa72f40-4ee3-4ce0-978a-d464bbce1153 consentId: description: | ID of the corresponding consent object as returned by an Account Information Consent Request. type: string cancellationId: description: Identification for cancellation resource type: string example: 5aa72f40-4ee3-4ce0-978a-d464bbce1254 transactionStatus: description: | The transaction status is filled with codes of the ISO 20022 data table: - 'RCVD': 'Received' - Payment initiation has been received by the receiving agent. - 'CANC': 'Cancelled' - Payment initiation has been cancelled before execution. Remark: This code is still requested from ISO20022. - 'PATC': 'PartiallyAcceptedTechnical' - Correct The payment initiation needs multiple authentications, where some but not yet all have been performed. Syntactical and semantical validations are successful. Remark: This code is still requested from ISO20022. - 'ACSP': 'AcceptedSettlementInProcess' - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution. - 'ACWC': 'AcceptedWithChange' - Instruction is accepted but a change will be made, such as date or remittance not sent. - 'PDNG': 'Pending' - Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed. - 'RJCT': 'Rejected' - Payment initiation or individual transaction included in the payment initiation has been rejected. - 'CANC': 'Cancelled' - Payment initiation has been cancelled before execution. Remark: This code is still requested from ISO20022. - 'ACSC': 'AcceptedSettlementCompleted' - Settlement on the debtor s account has been completed. type: string enum: - ACSC - ACSP - ACWC - RCVD - PDNG - RJCT - CANC - PATC example: ACCP transactionStatus_SBS: description: | Only the codes RCVD, PATC, ACTC, CANC and RJCT are used: - 'RCVD': 'Received' – Signing basket initiation has been received by the receiving agent. All payments are syntactical and semantical validation are successful and in status RVCD or PATC - 'CANC': 'Cancelled' – The signing basket are deleted. Only allowed when signing basket are in status RCVD. - 'RJCT': 'Rejected' – Authentication are not successful for any payments. - 'PATC': 'PartialAccepted' – Authentication are successful for one or more payments but not all. - 'ACTC': 'AcceptedTechnicalValidation' – Authentication are successful for all payments. type: string enum: - RCVD - CANC - RJCT - PATC - ACTC scaStatus: description: | This data element is containing information about the status of the SCA method applied. The following codes are defined for this data type. * 'scaMethodSelected': This is the first status to be reported instead of 'received'. The SCA method is chosen implicitly since only one SCA method is available. * 'started': The addressed SCA routine has been started. * 'finalised': The SCA routine has been finalised successfully. * 'failed': The SCA routine failed * 'exempted': SCA was exempted for the related transaction, the related authorisation is successful. type: string enum: - scaMethodSelected - started - finalised - failed - exempted example: scaMethodSelected transactionFeeIndicator: description: > If equals 'true', the transaction will involve specific transaction cost as shown by the ASPSP in their public price list or as agreed between ASPSP and PSU. If equals 'false', the transaction will not involve additional specific transaction costs to the PSU. type: boolean chosenScaMethod: $ref: '#/components/schemas/authenticationObject' authenticationType: description: > Type of the authentication method. More authentication types might be added during implementation projects and documented in the ASPSP documentation. - 'SMS_OTP': An SCA method, where an OTP linked to the transaction to be authorised is sent to the PSU through a SMS channel. - 'CHIP_OTP': An SCA method, where an OTP is generated by a chip card, e.g. an TOP derived from an EMV cryptogram. To contact the card, the PSU normally needs a (handheld) device. With this device, the PSU either reads the challenging data through a visual interface like flickering or the PSU types in the challenge through the device key pad. The device then derives an OTP from the challenge data and displays the OTP to the PSU. - 'PHOTO_OTP': An SCA method, where the challenge is a QR code or similar encoded visual data which can be read in by a consumer device or specific mobile app. The device resp. the specific app than derives an OTP from the visual challenge data and displays the OTP to the PSU. - 'PUSH_OTP': An OTP is pushed to a dedicated authentication APP and displayed to the PSU. - 'NEMID_OTP': NEMID_OTP are always used. type: string enum: - SMS_OTP - CHIP_OTP - PHOTO_OTP - PUSH_OTP - NEMID_OTP authenticationObject: description: | Authentication Object type: object required: - authenticationType - authenticationMethodId properties: authenticationType: $ref: '#/components/schemas/authenticationType' authenticationVersion: description: | Depending on the "authenticationType". This version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type. Not used. type: string authenticationMethodId: $ref: '#/components/schemas/authenticationMethodId' name: description: > This is the name of the authentication method defined by the ASPSP. Not used. type: string explanation: description: | Detailed information about the SCA method for the PSU. Not used. type: string signingBasket: description: | JSON Body of a establish signing basket request. The body shall contain at least one entry. type: object properties: paymentIds: $ref: '#/components/schemas/paymentIdList' hrefType: description: Link to a resource type: object properties: href: $ref: '#/components/schemas/hrefEntry' hrefEntry: description: Link to a resource type: string example: /v1/payments/sepa-credit-transfers/856b6f2b-5fc9-4d33-9ef8-a05e87559a1b authorisationsList: description: An array of all authorisationIds type: array items: $ref: '#/components/schemas/authorisationId' authorisations: description: An array of all authorisationIds type: object required: - authorisationIds properties: authorisationIds: $ref: '#/components/schemas/authorisationsList' accountReference: description: | Reference to an account by either * IBAN, of a payment account, or * BBAN, for payment account if there is no IBAN type: object properties: iban: $ref: '#/components/schemas/iban' bban: $ref: '#/components/schemas/bban' other: $ref: '#/components/schemas/otherAccountFormat' currency: $ref: '#/components/schemas/currencyCode' cancellationList: description: An array of all cancellationIds connected to this resource. type: array items: $ref: '#/components/schemas/cancellationId' bicfi: description: | BICFI type: string pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}' example: DKNBDKKK bban: description: | Basic Bank Account Number (BBAN) Identifier (ISO20022). Danish bban needs to follow this format; - always 14 digits - first 4 is the registrationnummer with padding zeroes (example 7925 here with no padding zero) - last 10 is the accountnumber with padding zeroes (example 1234567 here with 3 padding zeroes) BBAN is used in Domestic paymenttypes for both debtor- and creditorAccount. BBAN is used in Sepa and Cross-border payments only for debtorAccount. type: string pattern: '[a-zA-Z0-9]{1,30}' example: 79250001234567 iban: type: string description: IBAN of an account pattern: '[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}' example: DK1299990000223344 otherAccountFormat: type: object properties: identification: type: string description: | Id of account used for different schemeNameProprierietary types. - For all slips it must contain the creditor-/gironumber. schemeNameProprietary: type: string description: | Type of other account format. Supported the following - 01: payment-slip 01. Used for creditorAccount in domestic-credit-transfer only. - 73: payment-slip 73. Used for creditorAccount in domestic-credit-transfer only. - 04: payment-slip 04. Used for creditorAccount in domestic-credit-transfer only. Requires Scor-identification in remittanceInformationStructuredArray. - 15: payment-slip 15. Used for creditorAccount in domestic-credit-transfer only. Requires Scor-identification in remittanceInformationStructuredArray. - 71: payment-slip 71. Used for creditorAccount in domestic-credit-transfer only. Requires Scor-identification in remittanceInformationStructuredArray. - 75: payment-slip 75. Used for creditorAccount in domestic-credit-transfer only. Requires Scor-identification in remittanceInformationStructuredArray. address: type: object required: - country properties: street: type: string maxLength: 70 buildingNumber: type: string city: type: string postalCode: type: string country: $ref: '#/components/schemas/countryCode' example: street: rue blue buildingnNumber: '89' city: Paris postalCode: '75000' country: FR countryCode: description: ISO 3166 ALPHA2 country code type: string pattern: '[A-Z]{2}' example: SE amount: type: object required: - currency - amount properties: currency: $ref: '#/components/schemas/currencyCode' amount: $ref: '#/components/schemas/amountValue' example: currency: EUR amount: '123' currencyCode: description: | ISO 4217 Alpha 3 currency code. Ignored when used for accountReference. type: string pattern: '[A-Z]{3}' example: EUR amountValue: description: | The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 type: string pattern: '-?[0-9]{1,14}(\.[0-9]{1,3})?' example: '5877.78' chargeBearer: description: Charge Bearer. ChargeBearerType1Code from ISO20022 type: string enum: - DEBT - CRED - SHAR - SLEV remittanceInformationStructuredArray: description: | Array of structured remittance information. Field is maximum 4 lines x 35 characters. For payment-slip (indbetalingskort) use the referenceType=SCOR and reference=paymentIdentification (betalingsident) when required. See also accountReference "other". For payment-slip 04, 15 og 75 the reference schould be 16 digits and for payment-slip 71 the reference schould be 15 digits. type: array maxItems: 41 items: $ref: "#/components/schemas/remittanceInformationStructured" remittanceInformationStructured: description: | When used as a seperat attribute (not part of the remittanceInformationStructuredArray) - reference used only (no referencetype) is used for entry Text on creditorAccount (recipient) for domestic payment-products only, not sepa, crossborder and slip. - From 17 April 2025: is ignored on a 'instant-domestic-credit-transfer' type: object required: - reference properties: reference: type: string maxLength: 35 referenceType: type: string maxLength: 35 referenceIssuer: type: string maxLength: 35 remittanceInformationUnstructured: description: | When used as a seperat attribute (not part of the remittanceInformationUnstructuredArray) it is used so Debitor can name entry text on own account (debtorAccount). If not used, default rules apply. Max 35 char. Only relevant for domestic-products (3 types and slip), not sepa and cross-border. type: string maxLength: 140 example: Money transfer to Curt remittanceInformationUnstructuredArray: description: | Contains advisory text for creditor. For Domestic-products (non-instant) and slip (for others than 71, 73 and 75, they will be ignored) it's possible to use a maximum of 41 array-elements containing max 35 char in each element. For instant-domestic-credit-transfer(From 17 April 2025), sepa and cross-border it's possible to use 1 array-element containing 4 lines text of each 35 char. type: array maxItems: 41 items: $ref: '#/components/schemas/remittanceInformationUnstructured' example: - Ref Number Merchant - Some Other Text frequencyCode: description: | The codes of the "EventFrequency7Code" ISO 20022 are supported. type: string enum: - Weekly - EveryTwoWeeks - Monthly - EveryTwoMonths - Quarterly - SemiAnnual - Annual dayOfExecution: description: | Day of execution. 1 is primo and 31 is ultimo of the month. Only supporting these values when posting a periodic payment: - 1: When frequencyCode are Monthly or Quarterly. - 31: When frequencyCode are Monthly or Quarterly. In other scenarios, dayOfExecution will be defaulted to day of startDate. When getting a periodic payment all values are supported. For frequency Monthly these rules apply: - dayOfExecution 1 : * If startDate is before 26.xx, the next paymentdate will be in the next months. * If startDate is after 25.xx, the next paymentdate will not be in the next months but the months after. - dayOfExecution 31 : * If startDate is before 26.xx, the next paymentdate will be in the same months. * If startDate is after 25.xx, the next paymentdate will be in the next months. type: string maxLength: 2 enum: - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' executionRule: description: | "following" or "preceding" supported as values. 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. This attribut are not supported when posting a periodic payment, only when getting. It will default be: - following when startDate is less then 26.xx - preceding when startDate is more then 25.xx Then the actual payment will always be in the same months as the startDate. type: string enum: - following - preceding psuMessageText: description: Text to be displayed to the PSU type: string maxLength: 512 creditorName: description: Creditor Name. Required for slip 01, 04 and 15. From 17 April 2025, required for Instant-Domestic-Credit-Transfer. type: string maxLength: 35 example: Creditor Name creditorAgentName: description: Creditor Agent Name type: string maxLength: 35 example: Creditor Agent Name transactionType: description: '' type: string pattern: '^\d{2}$' requestedExecutionDate: description: Date for execution of the payment og when the money are withdrawn from the debtor account. The creditor will then recieve the money same day or next bank-day. For periodic payments this date will show, when to pay next. type: string format: date startDate: description: > The first applicable day of execution starting from this date is the first payment. Only future dates are supported. Frequency Weekly and EveryTwoWeeks support only startDates Monday to Friday. type: string format: date endDate: description: | The last applicable day of execution If not given, it is an infinite periodic payment. type: string format: date paymentInitiationIntraDomesticCredit_json: description: | Body for a IntraDay Domestic Credit payment initation. type: object required: - debtorAccount - instructedAmount - creditorAccount properties: debtorAccount: $ref: '#/components/schemas/accountReference' debtorId: type: string maxLength: 35 ultimateDebtor: type: string maxLength: 70 instructedAmount: $ref: '#/components/schemas/amount' creditorAccount: $ref: '#/components/schemas/accountReference' creditorId: type: string maxLength: 35 creditorName: $ref: '#/components/schemas/creditorName' creditorAddress: $ref: '#/components/schemas/address' remittanceInformationStructured: $ref: '#/components/schemas/remittanceInformationStructured' remittanceInformationUnstructuredArray: $ref: '#/components/schemas/remittanceInformationUnstructuredArray' remittanceInformationUnstructured: $ref: '#/components/schemas/remittanceInformationUnstructured' requestedExecutionDate: $ref: '#/components/schemas/requestedExecutionDate' paymentInitiationInstaDomesticCredit_json: description: | Body for a Instant Domestic Credit payment initation. type: object required: - debtorAccount - instructedAmount - creditorAccount properties: debtorAccount: $ref: '#/components/schemas/accountReference' debtorId: type: string maxLength: 35 ultimateDebtor: type: string maxLength: 70 instructedAmount: $ref: '#/components/schemas/amount' creditorAccount: $ref: '#/components/schemas/accountReference' creditorId: type: string maxLength: 35 creditorName: $ref: '#/components/schemas/creditorName' ultimateCreditor: type: string maxLength: 70 remittanceInformationStructured: $ref: '#/components/schemas/remittanceInformationStructured' remittanceInformationUnstructuredArray: $ref: '#/components/schemas/remittanceInformationUnstructuredArray' remittanceInformationUnstructured: $ref: '#/components/schemas/remittanceInformationUnstructured' requestedExecutionDate: $ref: '#/components/schemas/requestedExecutionDate' paymentInitiationDomesticCredit_json: description: | Body for a Domestic Credit payment (3 types and slip) initation. type: object required: - debtorAccount - instructedAmount - creditorAccount - requestedExecutionDate properties: debtorAccount: $ref: '#/components/schemas/accountReference' debtorId: type: string maxLength: 35 ultimateDebtor: type: string maxLength: 70 instructedAmount: $ref: '#/components/schemas/amount' creditorAccount: $ref: '#/components/schemas/accountReference' creditorId: type: string maxLength: 35 creditorName: $ref: '#/components/schemas/creditorName' remittanceInformationStructuredArray: $ref: '#/components/schemas/remittanceInformationStructuredArray' remittanceInformationStructured: $ref: '#/components/schemas/remittanceInformationStructured' remittanceInformationUnstructuredArray: $ref: '#/components/schemas/remittanceInformationUnstructuredArray' remittanceInformationUnstructured: $ref: '#/components/schemas/remittanceInformationUnstructured' requestedExecutionDate: $ref: '#/components/schemas/requestedExecutionDate' periodicPaymentInitiationDomesticCredit_json: description: | Body for a Domestic Credit Periodic payment initation. type: object required: - debtorAccount - instructedAmount - creditorAccount - startDate - frequency properties: debtorAccount: $ref: '#/components/schemas/accountReference' debtorId: type: string maxLength: 35 ultimateDebtor: type: string maxLength: 70 instructedAmount: $ref: '#/components/schemas/amount' creditorAccount: $ref: '#/components/schemas/accountReference' creditorId: type: string maxLength: 35 creditorAgent: $ref: '#/components/schemas/bicfi' creditorAgentName: $ref: '#/components/schemas/creditorAgentName' creditorName: $ref: '#/components/schemas/creditorName' creditorAddress: $ref: '#/components/schemas/address' ultimateCreditor: type: string maxLength: 70 chargeBearer: $ref: '#/components/schemas/chargeBearer' remittanceInformationStructured: $ref: '#/components/schemas/remittanceInformationStructured' remittanceInformationUnstructuredArray: $ref: '#/components/schemas/remittanceInformationUnstructuredArray' remittanceInformationUnstructured: $ref: '#/components/schemas/remittanceInformationUnstructured' startDate: $ref: '#/components/schemas/startDate' endDate: $ref: '#/components/schemas/endDate' frequency: $ref: '#/components/schemas/frequencyCode' dayOfExecution: $ref: '#/components/schemas/dayOfExecution' paymentInitiation_json: description: | Body for a Sepa Credit payment initation. type: object required: - debtorAccount - instructedAmount - creditorAccount - creditorName - requestedExecutionDate - endToEndIdentification properties: endToEndIdentification: type: string maxLength: 35 debtorAccount: description: | Reference to an account by either * IBAN, of a payment account, or * BBAN, for payment account if there is no IBAN type: object properties: iban: type: string description: IBAN of an account pattern: "^DK\\d{16}$" example: DK1299990000223344 bban: $ref: '#/components/schemas/bban' other: $ref: '#/components/schemas/otherAccountFormat' currency: $ref: '#/components/schemas/currencyCode' instructedAmount: $ref: '#/components/schemas/amount' debtorId: type: string maxLength: 35 creditorAccount: $ref: '#/components/schemas/accountReference' creditorId: type: string maxLength: 35 creditorAgent: $ref: '#/components/schemas/bicfi' creditorAgentName: $ref: '#/components/schemas/creditorAgentName' creditorName: $ref: '#/components/schemas/creditorName' creditorAddress: $ref: '#/components/schemas/address' requestedExecutionDate: $ref: '#/components/schemas/requestedExecutionDate' remittanceInformationUnstructured: $ref: '#/components/schemas/remittanceInformationUnstructured' remittanceInformationUnstructuredArray: $ref: '#/components/schemas/remittanceInformationUnstructuredArray' paymentInitiationCrossBorder_json: description: | JSON body for a cross-border payment initation. type: object required: - debtorAccount - instructedAmount - creditorAccount - creditorName - requestedExecutionDate - chargeBearer properties: debtorAccount: $ref: '#/components/schemas/accountReference' instructedAmount: $ref: '#/components/schemas/amount' debtorId: type: string maxLength: 35 creditorAccount: $ref: '#/components/schemas/accountReference' creditorId: type: string maxLength: 35 creditorAgent: $ref: '#/components/schemas/bicfi' creditorAgentName: $ref: '#/components/schemas/creditorAgentName' creditorName: $ref: '#/components/schemas/creditorName' creditorAddress: $ref: '#/components/schemas/address' requestedExecutionDate: $ref: '#/components/schemas/requestedExecutionDate' remittanceInformationUnstructured: $ref: '#/components/schemas/remittanceInformationUnstructured' remittanceInformationUnstructuredArray: $ref: '#/components/schemas/remittanceInformationUnstructuredArray' chargeBearer: $ref: '#/components/schemas/chargeBearer' transactionType: $ref: '#/components/schemas/transactionType' paymentInitiationStatusResponse-200_json: description: >- Body of the response for a successful payment initiation status request in case of an JSON based endpoint. type: object required: - transactionStatus properties: transactionStatus: $ref: '#/components/schemas/transactionStatus' paymentInitationRequestResponse-201: description: Body of the response for a successful payment initiation request. type: object required: - transactionStatus - paymentId - _links properties: transactionStatus: $ref: '#/components/schemas/transactionStatus' paymentId: $ref: '#/components/schemas/paymentId' transactionFees: $ref: '#/components/schemas/amount' transactionFeeIndicator: $ref: '#/components/schemas/transactionFeeIndicator' _links: $ref: '#/components/schemas/_linksPaymentInitiation' psuMessage: $ref: '#/components/schemas/psuMessageText' tppMessages: type: array items: $ref: '#/components/schemas/tppMessage2XX' paymentInitiationCancelResponse-202: description: Body of the response for a successful cancel payment request. type: object required: - transactionStatus properties: transactionStatus: $ref: '#/components/schemas/transactionStatus' _links: $ref: '#/components/schemas/_linksPaymentInitiationCancel' paymentInitiationIntraDomesticCreditWithStatusResponse: description: | Body for a IntraDay Domestic Credit payment initation. type: object required: - debtorAccount - instructedAmount - creditorAccount - requestedExecutionDate properties: debtorAccount: $ref: '#/components/schemas/accountReference' debtorId: type: string maxLength: 35 ultimateDebtor: type: string maxLength: 70 instructedAmount: $ref: '#/components/schemas/amount' creditorAccount: $ref: '#/components/schemas/accountReference' creditorId: type: string maxLength: 35 creditorName: $ref: '#/components/schemas/creditorName' creditorAddress: $ref: '#/components/schemas/address' remittanceInformationStructured: $ref: '#/components/schemas/remittanceInformationStructured' remittanceInformationUnstructuredArray: $ref: '#/components/schemas/remittanceInformationUnstructuredArray' remittanceInformationUnstructured: $ref: '#/components/schemas/remittanceInformationUnstructured' requestedExecutionDate: $ref: '#/components/schemas/requestedExecutionDate' transactionStatus: $ref: '#/components/schemas/transactionStatus' paymentInitiationInstaDomesticCreditWithStatusResponse: description: | Body for a Instant Domestic Credit payment initation. type: object required: - debtorAccount - instructedAmount - creditorAccount - requestedExecutionDate properties: debtorAccount: $ref: '#/components/schemas/accountReference' debtorId: type: string maxLength: 35 ultimateDebtor: type: string maxLength: 70 instructedAmount: $ref: '#/components/schemas/amount' creditorAccount: $ref: '#/components/schemas/accountReference' creditorId: type: string maxLength: 35 creditorName: $ref: '#/components/schemas/creditorName' ultimateCreditor: type: string maxLength: 70 remittanceInformationStructured: $ref: '#/components/schemas/remittanceInformationStructured' remittanceInformationUnstructuredArray: $ref: '#/components/schemas/remittanceInformationUnstructuredArray' remittanceInformationUnstructured: $ref: '#/components/schemas/remittanceInformationUnstructured' requestedExecutionDate: $ref: '#/components/schemas/requestedExecutionDate' transactionStatus: $ref: '#/components/schemas/transactionStatus' paymentInitiationDomesticCreditWithStatusResponse: description: | Body for a Domestic Credit payment with status. type: object required: - debtorAccount - instructedAmount - creditorAccount - requestedExecutionDate properties: debtorAccount: $ref: '#/components/schemas/accountReference' debtorId: type: string maxLength: 35 ultimateDebtor: type: string maxLength: 70 instructedAmount: $ref: '#/components/schemas/amount' creditorAccount: $ref: '#/components/schemas/accountReference' creditorId: type: string maxLength: 35 creditorName: $ref: '#/components/schemas/creditorName' remittanceInformationStructured: $ref: '#/components/schemas/remittanceInformationStructured' remittanceInformationStructuredArray: $ref: '#/components/schemas/remittanceInformationStructuredArray' remittanceInformationUnstructuredArray: $ref: '#/components/schemas/remittanceInformationUnstructuredArray' remittanceInformationUnstructured: $ref: '#/components/schemas/remittanceInformationUnstructured' requestedExecutionDate: $ref: '#/components/schemas/requestedExecutionDate' transactionStatus: $ref: '#/components/schemas/transactionStatus' paymentInitiationWithStatusResponse: description: | Body for a Sepa Credit payment with status. type: object required: - debtorAccount - instructedAmount - creditorAccount - creditorName properties: endToEndIdentification: type: string maxLength: 35 debtorAccount: $ref: '#/components/schemas/accountReference' instructedAmount: $ref: '#/components/schemas/amount' debtorId: type: string maxLength: 35 creditorAccount: $ref: '#/components/schemas/accountReference' creditorId: type: string maxLength: 35 creditorAgent: $ref: '#/components/schemas/bicfi' creditorAgentName: $ref: '#/components/schemas/creditorAgentName' creditorName: $ref: '#/components/schemas/creditorName' creditorAddress: $ref: '#/components/schemas/address' requestedExecutionDate: $ref: '#/components/schemas/requestedExecutionDate' remittanceInformationUnstructured: $ref: '#/components/schemas/remittanceInformationUnstructured' remittanceInformationUnstructuredArray: $ref: '#/components/schemas/remittanceInformationUnstructuredArray' transactionStatus: $ref: '#/components/schemas/transactionStatus' paymentInitiationCrossBorderWithStatusResponse: description: | Body for a Cross border Credit payment with status. type: object required: - debtorAccount - instructedAmount - creditorAccount - creditorName properties: debtorAccount: $ref: '#/components/schemas/accountReference' instructedAmount: $ref: '#/components/schemas/amount' debtorId: type: string maxLength: 35 creditorAccount: $ref: '#/components/schemas/accountReference' creditorId: type: string maxLength: 35 creditorAgent: $ref: '#/components/schemas/bicfi' creditorAgentName: $ref: '#/components/schemas/creditorAgentName' creditorName: $ref: '#/components/schemas/creditorName' creditorAddress: $ref: '#/components/schemas/address' requestedExecutionDate: $ref: '#/components/schemas/requestedExecutionDate' remittanceInformationUnstructured: $ref: '#/components/schemas/remittanceInformationUnstructured' remittanceInformationUnstructuredArray: $ref: '#/components/schemas/remittanceInformationUnstructuredArray' chargeBearer: $ref: '#/components/schemas/chargeBearer' transactionStatus: $ref: '#/components/schemas/transactionStatus' periodicPaymentInitiationDomesticCreditWithStatusResponse: description: | Body for a Domestic Credit Periodic payment initation with status. type: object required: - debtorAccount - instructedAmount - creditorAccount - startDate - frequency properties: debtorAccount: $ref: '#/components/schemas/accountReference' debtorId: type: string maxLength: 35 ultimateDebtor: type: string maxLength: 70 instructedAmount: $ref: '#/components/schemas/amount' creditorAccount: $ref: '#/components/schemas/accountReference' creditorId: type: string maxLength: 35 creditorAgent: $ref: '#/components/schemas/bicfi' creditorAgentName: $ref: '#/components/schemas/creditorAgentName' creditorName: $ref: '#/components/schemas/creditorName' creditorAddress: $ref: '#/components/schemas/address' ultimateCreditor: type: string maxLength: 70 chargeBearer: $ref: '#/components/schemas/chargeBearer' remittanceInformationStructured: $ref: '#/components/schemas/remittanceInformationStructured' remittanceInformationUnstructuredArray: $ref: '#/components/schemas/remittanceInformationUnstructuredArray' remittanceInformationUnstructured: $ref: '#/components/schemas/remittanceInformationUnstructured' startDate: $ref: '#/components/schemas/startDate' requestedExecutionDate: $ref: '#/components/schemas/requestedExecutionDate' endDate: $ref: '#/components/schemas/endDate' executionRule: $ref: '#/components/schemas/executionRule' frequency: $ref: '#/components/schemas/frequencyCode' dayOfExecution: $ref: '#/components/schemas/dayOfExecution' transactionStatus: $ref: '#/components/schemas/transactionStatus' scaStatusResponse: description: Body of the JSON response with SCA Status type: object properties: scaStatus: $ref: '#/components/schemas/scaStatus' startScaprocessResponse: description: Body of the JSON response for a Start SCA authorisation request. type: object required: - scaStatus - authorisationId - _links properties: scaStatus: $ref: '#/components/schemas/scaStatus' authorisationId: $ref: "#/components/schemas/authorisationId" chosenScaMethod: $ref: '#/components/schemas/chosenScaMethod' _links: $ref: '#/components/schemas/_linksStartScaProcess' psuMessage: $ref: '#/components/schemas/psuMessageText' signingBasketResponse-200: description: | Body of the JSON response for a successful get signing basket request. type: object required: - transactionStatus properties: payments: $ref: '#/components/schemas/paymentIdList' transactionStatus: $ref: '#/components/schemas/transactionStatus_SBS' _links: $ref: '#/components/schemas/_linksSigningBasket' signingBasketStatusResponse-200: type: object required: - transactionStatus properties: transactionStatus: $ref: '#/components/schemas/transactionStatus_SBS' signingBasketResponse-201: description: >- Body of the JSON response for a successful create signing basket request. type: object required: - transactionStatus - basketId - _links properties: transactionStatus: $ref: '#/components/schemas/transactionStatus_SBS' basketId: $ref: '#/components/schemas/basketId' _links: $ref: '#/components/schemas/_linksSigningBasket' psuMessage: $ref: '#/components/schemas/psuMessageText' tppMessages: type: array items: $ref: '#/components/schemas/tppMessage2XX' _linksAll: description: | A _link object with all availabel link types. type: object properties: scaOAuth: $ref: '#/components/schemas/hrefType' startAuthorisation: $ref: '#/components/schemas/hrefType' self: $ref: '#/components/schemas/hrefType' status: $ref: '#/components/schemas/hrefType' scaStatus: $ref: '#/components/schemas/hrefType' first: $ref: '#/components/schemas/hrefType' next: $ref: '#/components/schemas/hrefType' previous: $ref: '#/components/schemas/hrefType' last: $ref: '#/components/schemas/hrefType' _linksPaymentInitiation: description: | All relative links. type: object properties: startAuthorisation: $ref: '#/components/schemas/hrefType' self: $ref: '#/components/schemas/hrefType' status: $ref: '#/components/schemas/hrefType' _linksPaymentInitiationCancel: description: | All relative links. type: object properties: startAuthorisation: $ref: '#/components/schemas/hrefType' _linksStartScaProcess: description: | - scaOAuth: Absolut link. - scaStatus: Relative links. type: object properties: scaOAuth: $ref: '#/components/schemas/hrefType' scaStatus: $ref: '#/components/schemas/hrefType' _linksSigningBasket: description: | All relative links. type: object properties: startAuthorisation: $ref: '#/components/schemas/hrefType' self: $ref: '#/components/schemas/hrefType' status: $ref: '#/components/schemas/hrefType' tppMessageCategory: description: Category of the TPP message category type: string enum: - ERROR - WARNING MessageCode2XX: description: Message codes for HTTP Error codes 2XX. type: string enum: - WARNING MessageCode400_PIS: description: Message codes defined for PIS for HTTP Error code 400 (BAD_REQUEST). type: string enum: - FORMAT_ERROR - PARAMETER_NOT_CONSISTENT - PARAMETER_NOT_SUPPORTED - SERVICE_INVALID - RESOURCE_UNKNOWN - RESOURCE_EXPIRED - RESOURCE_BLOCKED - TIMESTAMP_INVALID - PERIOD_INVALID - SCA_METHOD_UNKNOWN - CONSENT_UNKNOWN - PAYMENT_FAILED - EXECUTION_DATE_INVALID MessageCode400_SBS: description: >- Message codes defined for signing baskets for HTTP Error code 400 (BAD_REQUEST). type: string enum: - FORMAT_ERROR - PARAMETER_NOT_CONSISTENT - PARAMETER_NOT_SUPPORTED - SERVICE_INVALID - RESOURCE_UNKNOWN - RESOURCE_EXPIRED - RESOURCE_BLOCKED - TIMESTAMP_INVALID - PERIOD_INVALID - SCA_METHOD_UNKNOWN - CONSENT_UNKNOWN - REFERENCE_MIX_INVALID MessageCode401_PIS: description: Message codes defined for PIS for HTTP Error code 401 (UNAUTHORIZED). type: string enum: - CERTIFICATE_INVALID - CERTIFICATE_EXPIRED - CERTIFICATE_BLOCKED - CERTIFICATE_REVOKE - CERTIFICATE_MISSING - SIGNATURE_INVALID - SIGNATURE_MISSING - CORPORATE_ID_INVALID - PSU_CREDENTIALS_INVALID - CONSENT_INVALID - CONSENT_EXPIRED - TOKEN_UNKNOWN - TOKEN_INVALID - TOKEN_EXPIRED - REQUIRED_KID_MISSING MessageCode401_SBS: description: >- Message codes defined for signing baskets for HTTP Error code 401 (UNAUTHORIZED). type: string enum: - CERTIFICATE_INVALID - CERTIFICATE_EXPIRED - CERTIFICATE_BLOCKED - CERTIFICATE_REVOKE - CERTIFICATE_MISSING - SIGNATURE_INVALID - SIGNATURE_MISSING - CORPORATE_ID_INVALID - PSU_CREDENTIALS_INVALID - CONSENT_INVALID - CONSENT_EXPIRED - TOKEN_UNKNOWN - TOKEN_INVALID - TOKEN_EXPIRED MessageCode403_PIS: description: >- Message codes defined defined for PIS for PIS for HTTP Error code 403 (FORBIDDEN). type: string enum: - CONSENT_UNKNOWN - SERVICE_BLOCKED - RESOURCE_UNKNOWN - RESOURCE_EXPIRED - PRODUCT_INVALID MessageCode403_SBS: description: >- Message codes defined for signing baskets for HTTP Error code 403 (FORBIDDEN). type: string enum: - CONSENT_UNKNOWN - SERVICE_BLOCKED - RESOURCE_UNKNOWN - RESOURCE_EXPIRED MessageCode404_PIS: description: Message codes defined for PIS for HTTP Error code 404 (NOT FOUND). type: string enum: - RESOURCE_UNKNOWN - PRODUCT_UNKNOWN MessageCode404_SBS: description: >- Message codes defined for signing baskets for HTTP Error code 404 (NOT FOUND). type: string enum: - RESOURCE_UNKNOWN MessageCode405_PIS: description: >- Message codes defined for payment cancelations PIS for HTTP Error code 405 (METHOD NOT ALLOWED). type: string enum: - SERVICE_INVALID MessageCode405_PIS_CANC: description: >- Message codes defined for payment cancelations PIS for HTTP Error code 405 (METHOD NOT ALLOWED). type: string enum: - CANCELLATION_INVALID - SERVICE_INVALID MessageCode405_SBS: description: >- Message codes defined for SBS for HTTP Error code 405 (METHOD NOT ALLOWED). type: string enum: - SERVICE_INVALID MessageCode409_PIS: description: Message codes defined for PIS for HTTP Error code 409 (CONFLICT). type: string enum: - STATUS_INVALID MessageCode409_SBS: description: >- Message codes defined for signing baskets for HTTP Error code 409 (CONFLICT). type: string enum: - REFERENCE_STATUS_INVALID - STATUS_INVALID tppMessageText: description: Additional explaining text to the TPP. type: string maxLength: 512 tppMessage2XX: type: object required: - category - code properties: category: $ref: '#/components/schemas/tppMessageCategory' code: $ref: '#/components/schemas/MessageCode2XX' path: type: string text: $ref: '#/components/schemas/tppMessageText' tppMessage400_PIS: type: object required: - category - code properties: category: $ref: '#/components/schemas/tppMessageCategory' code: $ref: '#/components/schemas/MessageCode400_PIS' path: type: string text: $ref: '#/components/schemas/tppMessageText' tppMessage400_SBS: type: object required: - category - code properties: category: $ref: '#/components/schemas/tppMessageCategory' code: $ref: '#/components/schemas/MessageCode400_SBS' path: type: string text: $ref: '#/components/schemas/tppMessageText' tppMessage401_PIS: type: object required: - category - code properties: category: $ref: '#/components/schemas/tppMessageCategory' code: $ref: '#/components/schemas/MessageCode401_PIS' path: type: string text: $ref: '#/components/schemas/tppMessageText' tppMessage401_SBS: type: object required: - category - code properties: category: $ref: '#/components/schemas/tppMessageCategory' code: $ref: '#/components/schemas/MessageCode401_SBS' path: type: string text: $ref: '#/components/schemas/tppMessageText' tppMessage403_PIS: type: object required: - category - code properties: category: $ref: '#/components/schemas/tppMessageCategory' code: $ref: '#/components/schemas/MessageCode403_PIS' path: type: string text: $ref: '#/components/schemas/tppMessageText' tppMessage403_SBS: type: object required: - category - code properties: category: $ref: '#/components/schemas/tppMessageCategory' code: $ref: '#/components/schemas/MessageCode403_SBS' path: type: string text: $ref: '#/components/schemas/tppMessageText' tppMessage404_PIS: type: object required: - category - code properties: category: $ref: '#/components/schemas/tppMessageCategory' code: $ref: '#/components/schemas/MessageCode404_PIS' path: type: string text: $ref: '#/components/schemas/tppMessageText' tppMessage404_SBS: type: object required: - category - code properties: category: $ref: '#/components/schemas/tppMessageCategory' code: $ref: '#/components/schemas/MessageCode404_SBS' path: type: string text: $ref: '#/components/schemas/tppMessageText' tppMessage405_PIS: type: object required: - category - code properties: category: $ref: '#/components/schemas/tppMessageCategory' code: $ref: '#/components/schemas/MessageCode405_PIS' path: type: string text: $ref: '#/components/schemas/tppMessageText' tppMessage405_PIS_CANC: type: object required: - category - code properties: category: $ref: '#/components/schemas/tppMessageCategory' code: $ref: '#/components/schemas/MessageCode405_PIS_CANC' path: type: string text: $ref: '#/components/schemas/tppMessageText' tppMessage405_SBS: type: object required: - category - code properties: category: $ref: '#/components/schemas/tppMessageCategory' code: $ref: '#/components/schemas/MessageCode405_SBS' path: type: string text: $ref: '#/components/schemas/tppMessageText' tppMessage409_PIS: type: object required: - category - code properties: category: $ref: '#/components/schemas/tppMessageCategory' code: $ref: '#/components/schemas/MessageCode409_PIS' path: type: string text: $ref: '#/components/schemas/tppMessageText' tppMessage409_SBS: type: object required: - category - code properties: category: $ref: '#/components/schemas/tppMessageCategory' code: $ref: '#/components/schemas/MessageCode409_SBS' path: type: string text: $ref: '#/components/schemas/tppMessageText' tppErrorTitle: description: | Short human readable description of error type. Could be in local language. To be provided by ASPSPs. type: string maxLength: 70 tppErrorDetail: description: > Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath. type: string maxLength: 512 Error400_PIS: description: > Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 400 for PIS. type: object required: - type - code properties: type: description: > A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. type: string format: uri maxLength: 70 title: description: | Short human readable description of error type. Could be in local language. To be provided by ASPSPs. type: string maxLength: 70 detail: description: > Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath. type: string maxLength: 512 code: $ref: '#/components/schemas/MessageCode400_PIS' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: >- This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/components/schemas/tppErrorTitle' detail: $ref: '#/components/schemas/tppErrorDetail' code: $ref: '#/components/schemas/MessageCode400_PIS' _links: $ref: '#/components/schemas/_linksAll' Error400_SBS: description: > Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 400 for signing baskets. type: object required: - type - code properties: type: description: > A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. type: string format: uri maxLength: 70 title: description: | Short human readable description of error type. Could be in local language. To be provided by ASPSPs. type: string maxLength: 70 detail: description: > Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath. type: string maxLength: 512 code: $ref: '#/components/schemas/MessageCode400_SBS' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: >- This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/components/schemas/tppErrorTitle' detail: $ref: '#/components/schemas/tppErrorDetail' code: $ref: '#/components/schemas/MessageCode400_SBS' _links: $ref: '#/components/schemas/_linksAll' Error401_PIS: description: > Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 401 for PIS. type: object required: - type - code properties: type: description: > A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. type: string format: uri maxLength: 70 title: description: | Short human readable description of error type. Could be in local language. To be provided by ASPSPs. type: string maxLength: 70 detail: description: > Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath. type: string maxLength: 512 code: $ref: '#/components/schemas/MessageCode401_PIS' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: >- This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/components/schemas/tppErrorTitle' detail: $ref: '#/components/schemas/tppErrorDetail' code: $ref: '#/components/schemas/MessageCode401_PIS' _links: $ref: '#/components/schemas/_linksAll' Error401_SBS: description: > Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 401 for signing baskets. type: object required: - type - code properties: type: description: > A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. type: string format: uri maxLength: 70 title: description: | Short human readable description of error type. Could be in local language. To be provided by ASPSPs. type: string maxLength: 70 detail: description: > Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath. type: string maxLength: 512 code: $ref: '#/components/schemas/MessageCode401_SBS' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: >- This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/components/schemas/tppErrorTitle' detail: $ref: '#/components/schemas/tppErrorDetail' code: $ref: '#/components/schemas/MessageCode401_SBS' _links: $ref: '#/components/schemas/_linksAll' Error403_PIS: description: > Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 403 for PIS. type: object required: - type - code properties: type: description: > A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. type: string format: uri maxLength: 70 title: description: | Short human readable description of error type. Could be in local language. To be provided by ASPSPs. type: string maxLength: 70 detail: description: > Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath. type: string maxLength: 512 code: $ref: '#/components/schemas/MessageCode403_PIS' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: >- This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/components/schemas/tppErrorTitle' detail: $ref: '#/components/schemas/tppErrorDetail' code: $ref: '#/components/schemas/MessageCode403_PIS' _links: $ref: '#/components/schemas/_linksAll' Error403_SBS: description: > Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 403 for signing baskets. type: object required: - type - code properties: type: description: > A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. type: string format: uri maxLength: 70 title: description: | Short human readable description of error type. Could be in local language. To be provided by ASPSPs. type: string maxLength: 70 detail: description: > Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath. type: string maxLength: 512 code: $ref: '#/components/schemas/MessageCode403_SBS' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: >- This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/components/schemas/tppErrorTitle' detail: $ref: '#/components/schemas/tppErrorDetail' code: $ref: '#/components/schemas/MessageCode403_SBS' _links: $ref: '#/components/schemas/_linksAll' Error404_PIS: description: > Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 404 for PIS. type: object required: - type - code properties: type: description: > A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. type: string format: uri maxLength: 70 title: description: | Short human readable description of error type. Could be in local language. To be provided by ASPSPs. type: string maxLength: 70 detail: description: > Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath. type: string maxLength: 512 code: $ref: '#/components/schemas/MessageCode404_PIS' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: >- This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/components/schemas/tppErrorTitle' detail: $ref: '#/components/schemas/tppErrorDetail' code: $ref: '#/components/schemas/MessageCode404_PIS' _links: $ref: '#/components/schemas/_linksAll' Error404_SBS: description: > Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 404 for signing baskets. type: object required: - type - code properties: type: description: > A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. type: string format: uri maxLength: 70 title: description: | Short human readable description of error type. Could be in local language. To be provided by ASPSPs. type: string maxLength: 70 detail: description: > Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath. type: string maxLength: 512 code: $ref: '#/components/schemas/MessageCode404_SBS' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: >- This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/components/schemas/tppErrorTitle' detail: $ref: '#/components/schemas/tppErrorDetail' code: $ref: '#/components/schemas/MessageCode404_SBS' _links: $ref: '#/components/schemas/_linksAll' Error405_PIS: description: > Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 405 for PIS. type: object required: - type - code properties: type: description: > A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. type: string format: uri maxLength: 70 title: description: | Short human readable description of error type. Could be in local language. To be provided by ASPSPs. type: string maxLength: 70 detail: description: > Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath. type: string maxLength: 512 code: $ref: '#/components/schemas/MessageCode405_PIS' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: >- This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/components/schemas/tppErrorTitle' detail: $ref: '#/components/schemas/tppErrorDetail' code: $ref: '#/components/schemas/MessageCode405_PIS' _links: $ref: '#/components/schemas/_linksAll' Error405_PIS_CANC: description: > Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 405 for a pament cancelation (PIS). type: object required: - type - code properties: type: description: > A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. type: string format: uri maxLength: 70 title: description: | Short human readable description of error type. Could be in local language. To be provided by ASPSPs. type: string maxLength: 70 detail: description: > Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath. type: string maxLength: 512 code: $ref: '#/components/schemas/MessageCode405_PIS_CANC' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: >- This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/components/schemas/tppErrorTitle' detail: $ref: '#/components/schemas/tppErrorDetail' code: $ref: '#/components/schemas/MessageCode405_PIS_CANC' _links: $ref: '#/components/schemas/_linksAll' Error405_SBS: description: > Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 405 for signing baskets. type: object required: - type - code properties: type: description: > A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. type: string format: uri maxLength: 70 title: description: | Short human readable description of error type. Could be in local language. To be provided by ASPSPs. type: string maxLength: 70 detail: description: > Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath. type: string maxLength: 512 code: $ref: '#/components/schemas/MessageCode405_SBS' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: >- This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/components/schemas/tppErrorTitle' detail: $ref: '#/components/schemas/tppErrorDetail' code: $ref: '#/components/schemas/MessageCode405_SBS' _links: $ref: '#/components/schemas/_linksAll' Error409_PIS: description: > Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 409 for PIS. type: object required: - type - code properties: type: description: > A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. type: string format: uri maxLength: 70 title: description: | Short human readable description of error type. Could be in local language. To be provided by ASPSPs. type: string maxLength: 70 detail: description: > Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath. type: string maxLength: 512 code: $ref: '#/components/schemas/MessageCode409_PIS' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: >- This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/components/schemas/tppErrorTitle' detail: $ref: '#/components/schemas/tppErrorDetail' code: $ref: '#/components/schemas/MessageCode409_PIS' _links: $ref: '#/components/schemas/_linksAll' Error409_SBS: description: > Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 409 for signing baskets. type: object required: - type - code properties: type: description: > A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. type: string format: uri maxLength: 70 title: description: | Short human readable description of error type. Could be in local language. To be provided by ASPSPs. type: string maxLength: 70 detail: description: > Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath. type: string maxLength: 512 code: $ref: '#/components/schemas/MessageCode409_SBS' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: >- This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/components/schemas/tppErrorTitle' detail: $ref: '#/components/schemas/tppErrorDetail' code: $ref: '#/components/schemas/MessageCode409_SBS' _links: $ref: '#/components/schemas/_linksAll' Error400_NG_PIS: description: > NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400. type: object properties: tppMessages: type: array items: $ref: '#/components/schemas/tppMessage400_PIS' _links: $ref: '#/components/schemas/_linksAll' Error400_NG_SBS: description: > NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400. type: object properties: tppMessages: type: array items: $ref: '#/components/schemas/tppMessage400_SBS' _links: $ref: '#/components/schemas/_linksAll' Error401_NG_PIS: description: > NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401. type: object properties: tppMessages: type: array items: $ref: '#/components/schemas/tppMessage401_PIS' _links: $ref: '#/components/schemas/_linksAll' Error401_NG_SBS: description: > NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401. type: object properties: tppMessages: type: array items: $ref: '#/components/schemas/tppMessage401_SBS' _links: $ref: '#/components/schemas/_linksAll' Error403_NG_PIS: description: > NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403. type: object properties: tppMessages: type: array items: $ref: '#/components/schemas/tppMessage403_PIS' _links: $ref: '#/components/schemas/_linksAll' Error403_NG_SBS: description: > NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403. type: object properties: tppMessages: type: array items: $ref: '#/components/schemas/tppMessage403_SBS' _links: $ref: '#/components/schemas/_linksAll' Error404_NG_PIS: description: > NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404. type: object properties: tppMessages: type: array items: $ref: '#/components/schemas/tppMessage404_PIS' _links: $ref: '#/components/schemas/_linksAll' Error404_NG_SBS: description: > NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404. type: object properties: tppMessages: type: array items: $ref: '#/components/schemas/tppMessage404_SBS' _links: $ref: '#/components/schemas/_linksAll' Error405_NG_PIS: description: > NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401. type: object properties: tppMessages: type: array items: $ref: '#/components/schemas/tppMessage405_PIS' _links: $ref: '#/components/schemas/_linksAll' Error405_NG_PIS_CANC: description: > NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401. type: object properties: tppMessages: type: array items: $ref: '#/components/schemas/tppMessage405_PIS_CANC' _links: $ref: '#/components/schemas/_linksAll' Error405_NG_SBS: description: > NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401. type: object properties: tppMessages: type: array items: $ref: '#/components/schemas/tppMessage405_SBS' _links: $ref: '#/components/schemas/_linksAll' Error409_NG_PIS: description: > NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409. type: object properties: tppMessages: type: array items: $ref: '#/components/schemas/tppMessage409_PIS' _links: $ref: '#/components/schemas/_linksAll' example: - category: ERROR code: STATUS_INVALID text: additional text information of the ASPSP up to 512 characters Error409_NG_SBS: description: > NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409. type: object properties: tppMessages: type: array items: $ref: '#/components/schemas/tppMessage409_SBS' _links: $ref: '#/components/schemas/_linksAll' example: - category: ERROR code: STATUS_INVALID text: additional text information of the ASPSP up to 512 characters parameters: paymentService: name: payment-service in: path description: | Payment service: Possible values are: * payments * periodic-payments required: true schema: type: string enum: - payments - periodic-payments paymentProduct: name: payment-product in: path description: > The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). required: true schema: type: string enum: - domestic-credit-transfers - instant-domestic-credit-transfers - intraday-domestic-credit-transfers - sepa-credit-transfers - cross-border-credit-transfers paymentId: name: paymentId in: path description: Resource identification of the generated payment initiation resource. required: true schema: $ref: '#/components/schemas/paymentId' cancellationId: name: cancellationId in: path description: Identification for cancellation resource. required: true schema: $ref: '#/components/schemas/cancellationId' authorisationId: name: authorisationId in: path description: Resource identification of the related SCA. required: true schema: $ref: '#/components/schemas/authorisationId' basketId_PATH: name: basketId in: path description: | This identification of the corresponding signing basket object. required: true schema: $ref: '#/components/schemas/basketId' X-Request-ID: name: X-Request-ID in: header description: >- ID of the request, unique to the call, as determined by the initiating party. required: true example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: type: string format: uuid Digest: name: Digest in: header description: >- Is contained if and only if the "Signature" element is contained in the header of the request. schema: type: string required: false example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Signature: name: Signature in: header description: > A signature of the request by the TPP on application level. This might be mandated by ASPSP. schema: type: string required: false example: > keyId="SN=9FA1,CA=CN=D-TRUST%20CA%202-1%202015,O=D-Trust%20GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" TPP-Signature-Certificate: name: TPP-Signature-Certificate in: header description: | The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. schema: type: string format: byte required: false TPP-Redirect-Preferred: name: TPP-Redirect-Preferred in: header description: | The parameter is not used. The SCA approach is always redirect. schema: type: string enum: - 'true' - 'false' required: false TPP-Redirect-URI: name: TPP-Redirect-URI in: header description: | The parameter is not used. The OAuth flow handles the redirect-URI. schema: type: string format: uri required: false TPP-Nok-Redirect-URI: name: TPP-Nok-Redirect-URI in: header description: | The parameter is not used. The OAuth flow handles the redirect-URI. schema: type: string format: uri required: false TPP-Explicit-Authorisation-Preferred: name: TPP-Explicit-Authorisation-Preferred in: header description: | The parameter is not used. The authorisation is always explicit. schema: type: string enum: - 'true' - 'false' required: false requestBodies: signingBasket: description: > Request body for a confirmation of an establishing signing basket request content: application/json: schema: $ref: '#/components/schemas/signingBasket' headers: X-Request-ID: description: >- ID of the request, unique to the call, as determined by the initiating party. required: true example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: type: string format: uuid ASPSP-SCA-Approach: description: > This data element containes the fixed SCA Approach REDIRECT (OAuth SCA approach). schema: type: string enum: - EMBEDDED - DECOUPLED - REDIRECT example: REDIRECT required: false Location: description: | Location of the created resource. schema: type: string format: url required: false responses: OK_200_PaymentInitiationInformation: description: OK headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: oneOf: - $ref: '#/components/schemas/paymentInitiationWithStatusResponse' - $ref: >- #/components/schemas/paymentInitiationIntraDomesticCreditWithStatusResponse - $ref: >- #/components/schemas/paymentInitiationInstaDomesticCreditWithStatusResponse - $ref: >- #/components/schemas/paymentInitiationDomesticCreditWithStatusResponse - $ref: >- #/components/schemas/paymentInitiationCrossBorderWithStatusResponse - $ref: >- #/components/schemas/periodicPaymentInitiationDomesticCreditWithStatusResponse OK_200_PaymentInitiationStatus: description: OK headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/paymentInitiationStatusResponse-200_json' examples: Example 1: $ref: '#/components/examples/paymentInitiationStatusResponse' OK_200_Authorisations: description: OK headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/authorisations' OK_200_ScaStatus: description: OK headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/scaStatusResponse' OK_200_CancellationList: description: OK headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/cancellationList' OK_200_GetSigningBasket: description: OK headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/signingBasketResponse-200' OK_200_SigningBasketStatus: description: OK headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/signingBasketStatusResponse-200' CREATED_201_SigningBasket: description: Created headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' ASPSP-SCA-Approach: $ref: '#/components/headers/ASPSP-SCA-Approach' content: application/json: schema: $ref: '#/components/schemas/signingBasketResponse-201' CREATED_201_PaymentInitiation: description: CREATED headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' Location: $ref: '#/components/headers/Location' ASPSP-SCA-Approach: $ref: '#/components/headers/ASPSP-SCA-Approach' content: application/json: schema: $ref: '#/components/schemas/paymentInitationRequestResponse-201' CREATED_201_StartScaProcess: description: Created headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' ASPSP-SCA-Approach: $ref: '#/components/headers/ASPSP-SCA-Approach' content: application/json: schema: $ref: '#/components/schemas/startScaprocessResponse' RECEIVED_202_PaymentInitiationCancel: description: Received headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/paymentInitiationCancelResponse-202' NO_CONTENT_204_PaymentInitiationCancel: description: No Content headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' NO_CONTENT_204_SigningBasket: description: No Content headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' BAD_REQUEST_400_PIS: description: Bad Request headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/Error400_NG_PIS' application/problem+json: schema: $ref: '#/components/schemas/Error400_PIS' BAD_REQUEST_400_SBS: description: Bad Request headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/Error400_NG_SBS' application/problem+json: schema: $ref: '#/components/schemas/Error400_SBS' UNAUTHORIZED_401_PIS: description: Unauthorized headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/Error401_NG_PIS' application/problem+json: schema: $ref: '#/components/schemas/Error401_PIS' UNAUTHORIZED_401_SBS: description: Unauthorized headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/Error401_NG_SBS' application/problem+json: schema: $ref: '#/components/schemas/Error401_SBS' FORBIDDEN_403_PIS: description: Forbidden headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/Error403_NG_PIS' application/problem+json: schema: $ref: '#/components/schemas/Error403_PIS' FORBIDDEN_403_SBS: description: Forbidden headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/Error403_NG_SBS' application/problem+json: schema: $ref: '#/components/schemas/Error403_SBS' NOT_FOUND_404_PIS: description: Not found headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/Error404_NG_PIS' application/problem+json: schema: $ref: '#/components/schemas/Error404_PIS' NOT_FOUND_404_SBS: description: Not found headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/Error404_NG_SBS' application/problem+json: schema: $ref: '#/components/schemas/Error404_SBS' METHOD_NOT_ALLOWED_405_PIS: description: Method Not Allowed headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/Error405_NG_PIS' application/problem+json: schema: $ref: '#/components/schemas/Error405_PIS' METHOD_NOT_ALLOWED_405_PIS_CANC: description: Method Not Allowed headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/Error405_NG_PIS_CANC' application/problem+json: schema: $ref: '#/components/schemas/Error405_PIS_CANC' METHOD_NOT_ALLOWED_405_SBS: description: Method Not Allowed headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/Error405_NG_SBS' application/problem+json: schema: $ref: '#/components/schemas/Error405_SBS' NOT_ACCEPTABLE_406_PIS: description: Not Acceptable headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' NOT_ACCEPTABLE_406_SBS: description: Not Acceptable headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' REQUEST_TIMEOUT_408_PIS: description: Request Timeout headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' REQUEST_TIMEOUT_408_SBS: description: Request Timeout headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' CONFLICT_409_PIS: description: Conflict headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/Error409_NG_PIS' application/problem+json: schema: $ref: '#/components/schemas/Error409_PIS' CONFLICT_409_SBS: description: Conflict headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' content: application/json: schema: $ref: '#/components/schemas/Error409_NG_SBS' application/problem+json: schema: $ref: '#/components/schemas/Error409_SBS' UNSUPPORTED_MEDIA_TYPE_415_PIS: description: Unsupported Media Type headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' UNSUPPORTED_MEDIA_TYPE_415_SBS: description: Unsupported Media Type headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' TOO_MANY_REQUESTS_429_PIS: description: Too Many Requests headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' TOO_MANY_REQUESTS_429_SBS: description: Too Many Requests headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' INTERNAL_SERVER_ERROR_500_PIS: description: Internal Server Error headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' INTERNAL_SERVER_ERROR_500_SBS: description: Internal Server Error headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' SERVICE_UNAVAILABLE_503_PIS: description: Service Unavailable headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' SERVICE_UNAVAILABLE_503_SBS: description: Service Unavailable headers: Location: $ref: '#/components/headers/Location' X-Request-ID: $ref: '#/components/headers/X-Request-ID' examples: ibanExampleDk_01: value: DK1299990000223344 uuidExample: value: d969f0ed-fca3-4cbc-8d78-a326c953b164 DomesticPaymentInitiation: value: instructedAmount: currency: DKK amount: '1234.56' debtorAccount: bban: 79250001234567 creditorAccount: bban: 99992233445566 remittanceInformationUnstructured: entry text debitor remitanceInformationStructured: reference: entry text creditor remittanceInformationUnstructuredArray: - Further information to creditor 01 - Further information to creditor 02 - Further information to creditor 03 - Further information to creditor 04 - Further information to creditor 05 requestedExecutionDate: '2019-12-02' periodicPaymentInitiation: value: instructedAmount: currency: DKK amount: '1234.56' debtorAccount: bban: 99991234567890 creditorAccount: bban: 99992233445566 startDate: '2020-11-30' endDate: '2025-11-30' frequency: Monthly dayOfExecution: '31' paymentInitiationStatusResponse: value: transactionStatus: ACSC ##################################################### # Global security options ##################################################### security: - ApiKeyAuth: [] tags: - name: Payment Initiation Service (PIS) description: '' - name: Signing Basket Service (SBS) description: ''