Last active
December 15, 2017 14:03
-
-
Save amilos/606d85c6b1e65c3ec3a72113bfca6123 to your computer and use it in GitHub Desktop.
PSD2 XS2A API in OAS2 format
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| swagger: '2.0' | |
| info: | |
| version: '1.0.0' | |
| title: PSD2 XS2A API | |
| description: Uniform, interoperable and PSD2 compliant Access to Account interface | |
| license: | |
| name: MIT | |
| url: http://github.com/gruntjs/grunt/blob/master/LICENSE-MIT | |
| contact: | |
| name: Aleksandar Milosevic | |
| email: aca@asseco-see.rs | |
| url: http://asseco.com/see | |
| host: api.testbank.com | |
| tags: | |
| - name: PIS | |
| description: Payment Initiation Service | |
| - name: AIS | |
| description: Account Information Service | |
| - name: FCS | |
| description: Funds Confirmation Service | |
| - name: Common | |
| description: Used commonly in AIS and PIS Services | |
| basePath: / | |
| schemes: | |
| - https | |
| consumes: | |
| - application/json | |
| produces: | |
| - application/json | |
| paths: | |
| /v1/payments/{payment-product}: | |
| post: | |
| operationId: Payments_Initiate | |
| summary: 5.3.1 Payment Initiation Request | |
| description: Creates a payment initiation request at the ASPSP as a resource addressable under {resource-id} with all data relevant for the corresponding payment product. This is the first step in the API to initiate the related payment | |
| tags: [PIS] | |
| produces: | |
| - application/json | |
| - application/xml | |
| consumes: | |
| - application/json | |
| - application/xml | |
| parameters: | |
| - $ref: '#/parameters/payment-product' | |
| - $ref: '#/parameters/Process-ID' | |
| - $ref: '#/parameters/Request-ID' | |
| - $ref: '#/parameters/Date' | |
| - $ref: '#/parameters/PSU-ID' | |
| - $ref: '#/parameters/PSU-Corporate-ID' | |
| - $ref: '#/parameters/PSU-User-Agent' | |
| - $ref: '#/parameters/PSU-IP-Address' | |
| - $ref: '#/parameters/PSU-Geo-Location' | |
| - $ref: '#/parameters/Corporate-ID-Type' | |
| - $ref: '#/parameters/PSU-Additional-Device-Information' | |
| - $ref: '#/parameters/Certificate' | |
| - $ref: '#/parameters/Signature' | |
| - name: body | |
| in: body | |
| required: true | |
| description: Payment initiation instruction. The payment data to be transported in the request body are dependent of the chosen API endpoint. Some standard definitions related to the above mentioned standard products are defined in Section 10 of Implementation Guidelines document. Further definitions might be done community or ASPSP specific. In Annex A, a list of community specific payment product definitions and links regarding community/ASPSP specific payment product definitions are given. ASPSP or community definitions should reuse standard attribute names. | |
| schema: | |
| $ref: '#/definitions/PaymentInstruction' | |
| responses: | |
| 201: | |
| description: Payment initation response | |
| schema: | |
| $ref: '#/definitions/PaymentInitiationResponse' | |
| /v1/payments/{payment-product}/{resource-id}: | |
| parameters: | |
| - $ref: '#/parameters/payment-product' | |
| - $ref: '#/parameters/resource-id' | |
| - $ref: '#/parameters/Process-ID' | |
| - $ref: '#/parameters/Request-ID' | |
| - $ref: '#/parameters/Date' | |
| - $ref: '#/parameters/Certificate' | |
| - $ref: '#/parameters/Signature' | |
| get: | |
| summary: Get payment instruction details | |
| operationId: Payments_GetById | |
| tags: [PIS] | |
| produces: | |
| - application/json | |
| - application/xml | |
| responses: | |
| 200: | |
| description: Payment instruction | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/PaymentInstruction' | |
| put: | |
| operationId: Payments_UpdatePSUData | |
| summary: 7.1 Update PSU Data in Case of Payment Initiation | |
| description: Updates the payment initiation data on the server by PSU data, if requested by the ASPSP | |
| tags: [Common] | |
| produces: | |
| - application/json | |
| - application/xml | |
| consumes: | |
| - application/json | |
| - application/xml | |
| parameters: | |
| - $ref: '#/parameters/PSU-ID' | |
| - $ref: '#/parameters/PSU-Corporate-ID' | |
| - $ref: '#/parameters/Corporate-ID-Type' | |
| - name: body | |
| in: body | |
| required: true | |
| description: Update PSU data request | |
| schema: | |
| $ref: '#/definitions/PsuUpdateRequest' | |
| responses: | |
| 200: | |
| description: PSU data updated succesfully | |
| schema: | |
| $ref: '#/definitions/PaymentInitiationResponse' | |
| /v1/payments/{payment-product}/{resource-id}/status: | |
| get: | |
| summary: 5.4 Get Status Request | |
| description: Reads the transaction status of the payment | |
| operationId: Payments_GetStatus | |
| tags: [PIS] | |
| produces: | |
| - application/json | |
| - application/xml | |
| parameters: | |
| - $ref: '#/parameters/payment-product' | |
| - $ref: '#/parameters/resource-id' | |
| - $ref: '#/parameters/Process-ID' | |
| - $ref: '#/parameters/Request-ID' | |
| - $ref: '#/parameters/PSU-Corporate-ID' | |
| - $ref: '#/parameters/Corporate-ID-Type' | |
| - $ref: '#/parameters/Date' | |
| - $ref: '#/parameters/Certificate' | |
| - $ref: '#/parameters/Signature' | |
| responses: | |
| 200: | |
| description: Payment status response | |
| schema: | |
| $ref: '#/definitions/PaymentStatusResponse' | |
| /v1/consents: | |
| post: | |
| operationId: Consents_RequestNewOnDedicatedAccounts | |
| summary: 6.3.1.1 Consent Request on Dedicated Accounts | |
| description: Creates an account information consent resource at the ASPSP regarding access to accounts specified in this request. | |
| tags: [AIS] | |
| parameters: | |
| - $ref: '#/parameters/Process-ID' | |
| - $ref: '#/parameters/Request-ID' | |
| - $ref: '#/parameters/Date' | |
| - $ref: '#/parameters/PSU-ID' | |
| - $ref: '#/parameters/PSU-Corporate-ID' | |
| - $ref: '#/parameters/Certificate' | |
| - $ref: '#/parameters/Signature' | |
| - name: body | |
| in: body | |
| required: true | |
| description: Account information consent request body | |
| schema: | |
| $ref: '#/definitions/AccountInformationConsentRequest' | |
| responses: | |
| 201: | |
| description: Account information consent response | |
| schema: | |
| $ref: '#/definitions/PaymentInitiationResponse' | |
| /v1/consents/account-list: | |
| post: | |
| operationId: Consents_RequestNewOnAccountList | |
| summary: 6.3.1.2 Consent Request on Account List | |
| description: Creates an account information consent resource at the ASPSP to return a list of all accessible accounts | |
| tags: [AIS] | |
| parameters: | |
| - $ref: '#/parameters/Process-ID' | |
| - $ref: '#/parameters/Request-ID' | |
| - $ref: '#/parameters/Date' | |
| - $ref: '#/parameters/PSU-ID' | |
| - $ref: '#/parameters/PSU-Corporate-ID' | |
| - $ref: '#/parameters/Certificate' | |
| - $ref: '#/parameters/Signature' | |
| - name: body | |
| in: body | |
| required: true | |
| description: Account information consent request on account list body | |
| schema: | |
| $ref: '#/definitions/AccountInformationConsentAccountListRequest' | |
| responses: | |
| 201: | |
| description: Account information consent response | |
| schema: | |
| $ref: '#/definitions/PaymentInitiationResponse' | |
| /v1/consents/{consent-id}/status: | |
| get: | |
| summary: 6.3.2 Get Status Request | |
| description: Reads the status of the account information resource | |
| operationId: Consents_GetStatus | |
| tags: [AIS] | |
| parameters: | |
| - $ref: '#/parameters/consent-id' | |
| - $ref: '#/parameters/Process-ID' | |
| - $ref: '#/parameters/Request-ID' | |
| - $ref: '#/parameters/Date' | |
| - $ref: '#/parameters/Certificate' | |
| - $ref: '#/parameters/Signature' | |
| responses: | |
| 200: | |
| description: Account information consent status response | |
| schema: | |
| $ref: '#/definitions/PaymentStatusResponse' | |
| /v1/consents/{consent-id}: | |
| parameters: | |
| - $ref: '#/parameters/consent-id' | |
| - $ref: '#/parameters/Process-ID' | |
| - $ref: '#/parameters/Request-ID' | |
| - $ref: '#/parameters/Date' | |
| - $ref: '#/parameters/PSU-ID' | |
| - $ref: '#/parameters/PSU-Corporate-ID' | |
| - $ref: '#/parameters/Certificate' | |
| - $ref: '#/parameters/Signature' | |
| get: | |
| summary: 6.3.3 Get consent request | |
| description: Returns the content of an account information consent object. This is returning the data for the TPP especially in cases, where the consent was directly managed between ASPSP and PSU e.g. in a re-direct SCA Approach. | |
| operationId: Consents_GetById | |
| tags: [AIS] | |
| responses: | |
| 200: | |
| description: Account information consent response | |
| schema: | |
| $ref: '#/definitions/AccountInformationConsent' | |
| put: | |
| operationId: Consents_UpdatePSUData | |
| summary: 7.1 Update PSU Data in Case of Account Information consent Request | |
| description: Updates the account information consent data on the server by PSU data, if requested by the ASPS | |
| tags: [Common] | |
| parameters: | |
| - $ref: '#/parameters/PSU-ID' | |
| - $ref: '#/parameters/PSU-Corporate-ID' | |
| - name: body | |
| in: body | |
| required: true | |
| description: Instruction to update PSU data | |
| schema: | |
| $ref: '#/definitions/PsuUpdateRequest' | |
| responses: | |
| 200: | |
| description: Account information consent response | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/PaymentInitiationResponse' | |
| delete: | |
| operationId: Consents_Delete | |
| summary: 6.4 Delete an Account Information Consent Object | |
| description: The TPP can delete an account information consent object if needed. | |
| tags: [AIS] | |
| responses: | |
| 204: | |
| description: Consent deleted succesffully | |
| /v1/accounts: | |
| get: | |
| summary: 6.5.1 Read Account List | |
| description: Reads a list of accounts, with balances where required . It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed list of accounts depends then on the PSU ID and the stored consent addressed by consent-id, respectively the OAuth2 token | |
| operationId: Accounts_Get | |
| tags: [AIS] | |
| parameters: | |
| - $ref: '#/parameters/with-balance' | |
| - $ref: '#/parameters/psu-involved' | |
| - $ref: '#/parameters/Process-ID' | |
| - $ref: '#/parameters/Request-ID' | |
| - $ref: '#/parameters/Date' | |
| - $ref: '#/parameters/Consent-ID-Header' | |
| - $ref: '#/parameters/PSU-ID' | |
| - $ref: '#/parameters/Certificate' | |
| - $ref: '#/parameters/Signature' | |
| responses: | |
| 200: | |
| description: List of accounts | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/Account' | |
| /v1/accounts/{account-id}/balances: | |
| get: | |
| summary: 6.5.2 Read Balance | |
| description: Reads account balances from a given account addressed by "account-id". | |
| operationId: Accounts_GetBalances | |
| tags: [AIS] | |
| parameters: | |
| - $ref: '#/parameters/account-id' | |
| - $ref: '#/parameters/psu-involved' | |
| - $ref: '#/parameters/Process-ID' | |
| - $ref: '#/parameters/Request-ID' | |
| - $ref: '#/parameters/Date' | |
| - $ref: '#/parameters/Consent-ID-Header' | |
| - $ref: '#/parameters/PSU-ID' | |
| - $ref: '#/parameters/Certificate' | |
| - $ref: '#/parameters/Signature' | |
| responses: | |
| 200: | |
| description: A list of balances regarding this account, e.g. the current balance, the last booked balance | |
| schema: | |
| $ref: '#/definitions/BalancesResponse' | |
| /v1/accounts/{account-id}/transactions: | |
| get: | |
| summary: 6.5.3 Read Transaction List | |
| description: Reads account transactions from a given account addressed by "account-id". | |
| operationId: Accounts_GetTransactions | |
| tags: [AIS] | |
| produces: | |
| - application/json | |
| - application/xml | |
| - text/plain | |
| parameters: | |
| - $ref: '#/parameters/account-id' | |
| - $ref: '#/parameters/date-from' | |
| - $ref: '#/parameters/date-to' | |
| - $ref: '#/parameters/transaction-id' | |
| - $ref: '#/parameters/psu-involved' | |
| - $ref: '#/parameters/Process-ID' | |
| - $ref: '#/parameters/Request-ID' | |
| - $ref: '#/parameters/Date' | |
| - $ref: '#/parameters/Consent-ID-Header' | |
| - $ref: '#/parameters/PSU-ID' | |
| - $ref: '#/parameters/Certificate' | |
| - $ref: '#/parameters/Signature' | |
| responses: | |
| 200: | |
| description: > | |
| Depending on the format indicated in the Accept header of request, response can be formatted as JSON, ISO 20022 compliant XML or S.W.I.F.T. MT94x compliant text. | |
| In case the ASPSP returns a camt.05x XML structure, the response body consists of either a camt.052 or camt.053 format. The camt.052 may include pending payments which are not yet finally booked. The ASPSP will decide on the format due to the chosen parameters, specifically on the chosen dates relative to the time of the request. | |
| In case the ASPSP returns a MT94x content, the response body consists of an MT940 or MT942 format in a text structure. The camt.052 may include pending payments which are not yet finally booked. The ASPSP will decide on the format due to the chosen parameters, specifically on the chosen dates relative to the time of the request. | |
| schema: | |
| $ref: '#/definitions/TransactionsResponse' | |
| /v1/confirmation-of-funds: | |
| post: | |
| summary: 9.2 Confirmation of Funds Request | |
| description: Creates a confirmation of funds request at the ASPSP | |
| operationId: Payments_ConfirmFundsAvailability | |
| tags: [FCS] | |
| parameters: | |
| - $ref: '#/parameters/Process-ID' | |
| - $ref: '#/parameters/Request-ID' | |
| - $ref: '#/parameters/Date' | |
| - $ref: '#/parameters/Certificate' | |
| - $ref: '#/parameters/Signature' | |
| - name: body | |
| in: body | |
| required: true | |
| description: Funds confirmation request body | |
| schema: | |
| $ref: '#/definitions/ConfirmationOfFundsRequest' | |
| responses: | |
| 200: | |
| description: Funds confirmation response | |
| schema: | |
| $ref: '#/definitions/ConfirmationOfFundsResponse' | |
| parameters: | |
| payment-product: | |
| description: | | |
| The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The default list of products supported in this standard is: | |
| - sepa-credit-transfers | |
| - instant-sepa-credit-transfers | |
| - target-2-payments | |
| - cross-border-credit-transfers | |
| - pain.001-sepa-credit-transfers | |
| - pain.001-instant-sepa-credit-transfers | |
| - pain.001-target-2-payments | |
| - pain.001-cross-border-credit-transfers | |
| The ASPSP will publish which of the payment products / endpoints will be supported. | |
| For definitions of basic non euro generic products see Annex A. | |
| Further products might be published by the ASPSP within its XS2A documentation. These new product types will end in further endpoints of the XS2A Interface. | |
| name: payment-product | |
| in: path | |
| required: true | |
| type: string | |
| enum: | |
| - sepa-credit-transfers | |
| - instant-sepa-credit-transfers | |
| - target-2-payments | |
| - cross-border-credit-transfers | |
| resource-id: | |
| name: resource-id | |
| in: path | |
| description: Identification of payment instruction | |
| required: true | |
| type: string | |
| consent-id: | |
| name: consent-id | |
| in: path | |
| description: ID of the corresponding consent object as returned by an Account Information Consent Request | |
| required: true | |
| type: string | |
| account-id: | |
| name: account-id | |
| in: path | |
| description: This identification is denoting the addressed account. The `account-id` is retrieved by using a *Read Account List* call. The `account-id` is the `id` attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent. | |
| required: true | |
| type: string | |
| with-balance: | |
| name: with-balance | |
| in: query | |
| description: If contained, this function reads the list of accessible payment accounts including the balance | |
| required: false | |
| type: boolean | |
| psu-involved: | |
| name: psu-involved | |
| in: query | |
| description: If contained, it is indicated that a PSU has directly asked this account access in real-time. The PSU then might be involved in an additional consent process, if the given consent is not any more sufficient | |
| required: false | |
| type: boolean | |
| date-from: | |
| name: date-from | |
| in: query | |
| description: Starting date of the account statement | |
| required: true | |
| type: string | |
| format: date | |
| date-to: | |
| name: date-to | |
| in: query | |
| description: End date of the account statement. It is contained if this is a Read Account Data Request for transaction reports. | |
| required: true | |
| type: string | |
| format: date | |
| transaction-id: | |
| name: transaction-id | |
| in: query | |
| description: This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification transaction_id alternatively to the above defined period. (Implementation of a delta-report). If this data element is contained, the entries `date_from` and `date_to` might be ignored by the ASPSP if a delta report is supported. | |
| required: false | |
| type: string | |
| Process-ID: | |
| name: Process-ID | |
| in: header | |
| required: true | |
| description: ID of the transaction as determined by the initiating party | |
| type: string | |
| Request-ID: | |
| name: Request-ID | |
| in: header | |
| required: true | |
| description: ID of the request, unique to the call, as determined by the initiating party. | |
| type: string | |
| Date: | |
| name: Date | |
| in: header | |
| required: true | |
| description: Standard https header element date and time | |
| type: string | |
| Certificate: | |
| name: Certificate | |
| in: header | |
| required: false | |
| description: The certificate used for signing the request. | |
| type: string | |
| Signature: | |
| name: Signature | |
| in: header | |
| required: false | |
| description: A signature of the request by the TPP on application level. This might be mandated by ASPSP. | |
| type: string | |
| PSU-ID: | |
| name: PSU-ID | |
| in: header | |
| required: false | |
| description: PSU identification | |
| type: string | |
| PSU-Corporate-ID: | |
| name: PSU-Corporate-ID | |
| in: header | |
| required: false | |
| description: Corporate identification | |
| type: string | |
| Corporate-ID-Type: | |
| name: Corporate-ID | |
| in: header | |
| required: false | |
| description: Corporate identification type | |
| type: string | |
| Consent-ID-Header: | |
| name: Consent-ID | |
| in: header | |
| required: false | |
| description: This data element may be contained, if the payment initiation transaction is part of a combined AIS/PIS service. This then contains the consent id of the related AIS consent. | |
| type: string | |
| PSU-IP-Address: | |
| name: PSU-ID-Address | |
| in: header | |
| required: true | |
| description: IP address of PSU | |
| type: string | |
| format: ipv4-address | |
| PSU-User-Agent: | |
| name: PSU-User-Agent | |
| in: header | |
| required: true | |
| description: PSU user agent | |
| type: string | |
| PSU-Geo-Location: | |
| name: PSU-Geo-Location | |
| in: header | |
| required: true | |
| description: The forwarded Geo Location header field of the corresponding http request between PSU and TPP if available. | |
| type: string | |
| PSU-Additional-Device-Information: | |
| name: PSU-Additional-Device-Information | |
| in: header | |
| required: true | |
| description: Additional device information | |
| type: string | |
| definitions: | |
| PaymentInstruction: | |
| title: payment_instruction | |
| type: object | |
| properties: | |
| debtor_account: | |
| $ref: '#/definitions/AccountReference' | |
| instructed_amount: | |
| $ref: '#/definitions/Amount' | |
| end_to_end_identification: | |
| description: '' | |
| type: string | |
| debtor_account_currency: | |
| description: '' | |
| type: string | |
| ultimate_debtor: | |
| description: '' | |
| type: string | |
| creditor-account: | |
| $ref: '#/definitions/AccountReference' | |
| creditor-agent: | |
| description: '' | |
| type: string | |
| creditor-name: | |
| description: '' | |
| type: string | |
| creditor-address: | |
| $ref: '#/definitions/Address' | |
| ultimate_creditor: | |
| description: '' | |
| type: string | |
| purpose-code: | |
| description: '' | |
| type: string | |
| remittance_information_unstructured: | |
| description: '' | |
| type: string | |
| remittance_information_structured: | |
| description: '' | |
| type: object | |
| requested_execution_time: | |
| description: '' | |
| type: string | |
| format: date-time | |
| required: | |
| - debtor_account | |
| - instructed_amount | |
| AccountReference: | |
| title: account_reference | |
| type: object | |
| properties: | |
| iban: | |
| description: This data element can be used in the body of the Consent Request Message for retrieving account access consent from this payment account, cp. Section 6.3.1.1. | |
| type: string | |
| bban: | |
| description: This data element can be used in the body of the Consent Request Message for retrieving account access consent from this account, cp. Section 6.3.1.1. This data elements is used for payment accounts which have no IBAN. | |
| type: string | |
| pan: | |
| description: Primary Account Number (PAN) of a card, can be tokenized by the ASPSP due to PCI DSS requirements. This data element can be used in the body of the Consent Request Message for retrieving account access consent from this card, cp. Section 6.3.1.1. | |
| type: string | |
| misidn: | |
| description: An alias to access a payment account via a registered mobile phone number. This alias might be needed e.g. in the payment initiation service, cp. Section 5.3.1. The support of this alias must be explicitly documented by the ASPSP for the corresponding API calls. | |
| type: string | |
| Amount: | |
| title: amount | |
| type: object | |
| properties: | |
| content: | |
| description: '' | |
| type: number | |
| format: double | |
| currency: | |
| description: '' | |
| type: string | |
| required: | |
| - content | |
| - currency | |
| Address: | |
| title: address | |
| type: object | |
| properties: | |
| street: | |
| description: '' | |
| type: string | |
| city: | |
| description: '' | |
| type: string | |
| country: | |
| description: '' | |
| type: string | |
| PaymentInitiationResponse: | |
| title: payment_initiation_response | |
| type: object | |
| properties: | |
| transaction_status: | |
| $ref: '#/definitions/TransactionStatus' | |
| sca_methods: | |
| description: '' | |
| type: array | |
| items: | |
| $ref: '#/definitions/AuthenticationObject' | |
| choosen_sca_method: | |
| $ref: '#/definitions/AuthenticationObject' | |
| sca_challenge_data: | |
| $ref: '#/definitions/Challenge' | |
| _links: | |
| $ref: '#/definitions/Links' | |
| psu_message: | |
| description: '' | |
| type: string | |
| tpp_messages: | |
| description: '' | |
| type: array | |
| items: | |
| $ref: '#/definitions/Message' | |
| TransactionStatus: | |
| title: TransactionStatus | |
| example: AcceptedCustomerProfile | |
| type: string | |
| enum: | |
| - AcceptedCustomerProfile | |
| - AcceptedSettlementCompleted | |
| - AcceptedSettlementInProcess | |
| - AcceptedTechnicalValidation | |
| - AcceptedWithChange | |
| - AcceptedWithoutPosting | |
| - Received | |
| - Pending | |
| - Rejected | |
| AuthenticationObject: | |
| title: authentication_object | |
| type: object | |
| properties: | |
| authentication_type: | |
| $ref: '#/definitions/AuthenticationType' | |
| authentication_method_id: | |
| description: '' | |
| type: string | |
| name: | |
| description: '' | |
| type: string | |
| explanation: | |
| description: '' | |
| type: string | |
| AuthenticationType: | |
| title: AuthenticationType | |
| example: SMS_OTP | |
| type: string | |
| enum: | |
| - SMS_OTP | |
| - CHIP_OTP | |
| - PHOTO_OTP | |
| - PUSH_OTP | |
| Challenge: | |
| title: challenge | |
| type: object | |
| properties: | |
| image: | |
| description: '' | |
| type: string | |
| OTP_max_length: | |
| description: '' | |
| type: integer | |
| format: int32 | |
| OTP_format: | |
| $ref: '#/definitions/OTPFormat' | |
| additional_information: | |
| description: '' | |
| type: string | |
| OTPFormat: | |
| title: OTPFormat | |
| example: characters | |
| type: string | |
| enum: | |
| - characters | |
| - integer | |
| Message: | |
| title: message | |
| type: object | |
| properties: | |
| category: | |
| description: '' | |
| type: string | |
| code: | |
| description: '' | |
| type: string | |
| text: | |
| description: '' | |
| type: string | |
| PsuUpdateRequest: | |
| title: psu_update_request | |
| type: object | |
| properties: | |
| psu_data: | |
| $ref: '#/definitions/PsuData' | |
| authentication_method_id: | |
| description: '' | |
| type: string | |
| sca_authentication_data: | |
| description: '' | |
| type: string | |
| PsuData: | |
| title: psu_data | |
| type: object | |
| properties: | |
| password: | |
| description: '' | |
| type: string | |
| authentication: | |
| description: '' | |
| type: string | |
| PaymentStatusResponse: | |
| title: payment_status_response | |
| type: object | |
| properties: | |
| transaction_status: | |
| $ref: '#/definitions/TransactionStatus' | |
| AccountInformationConsentRequest: | |
| title: account_information_consent_request | |
| type: object | |
| properties: | |
| access_accounts: | |
| description: '' | |
| type: array | |
| items: | |
| type: object | |
| recurring_indicator: | |
| description: '' | |
| type: boolean | |
| valid_until: | |
| description: '' | |
| type: string | |
| format: date-time | |
| frequency_per_day: | |
| description: '' | |
| type: integer | |
| format: int32 | |
| combined_service_indicator: | |
| description: '' | |
| type: boolean | |
| required: | |
| - access_accounts | |
| - recurring_indicator | |
| - valid_until | |
| - frequency_per_day | |
| - combined_service_indicator | |
| AccountInformationConsentAccountListRequest: | |
| title: account_information_consent_account_list_request | |
| type: object | |
| properties: | |
| with_balance: | |
| description: '' | |
| type: boolean | |
| required: | |
| - with_balance | |
| AccountInformationConsent: | |
| title: account_information_consent | |
| type: object | |
| properties: | |
| access_accounts: | |
| description: '' | |
| type: array | |
| items: | |
| type: object | |
| recurring_indicator: | |
| description: '' | |
| type: boolean | |
| valid_until: | |
| description: '' | |
| type: string | |
| format: date-time | |
| frequency_per_day: | |
| description: '' | |
| type: integer | |
| format: int32 | |
| transaction_status: | |
| $ref: '#/definitions/TransactionStatus' | |
| consent_status: | |
| $ref: '#/definitions/ConsentStatus' | |
| ConsentStatus: | |
| title: ConsentStatus | |
| example: empty | |
| type: string | |
| enum: | |
| - empty | |
| - valid | |
| - blocked | |
| - expired | |
| - deleted | |
| Account: | |
| title: account | |
| type: object | |
| properties: | |
| id: | |
| description: '' | |
| type: string | |
| iban: | |
| description: '' | |
| type: string | |
| bban: | |
| description: '' | |
| type: string | |
| pan: | |
| description: '' | |
| type: string | |
| msisdn: | |
| description: '' | |
| type: string | |
| name: | |
| description: '' | |
| type: string | |
| account_type: | |
| description: '' | |
| type: string | |
| BIC: | |
| description: '' | |
| type: string | |
| balances: | |
| $ref: '#/definitions/Balances' | |
| currency: | |
| description: '' | |
| type: string | |
| _links: | |
| $ref: '#/definitions/Links' | |
| Balances: | |
| title: balances | |
| type: object | |
| properties: | |
| booked: | |
| $ref: '#/definitions/SingleBalance' | |
| expected: | |
| $ref: '#/definitions/SingleBalance' | |
| authorised: | |
| $ref: '#/definitions/SingleBalance' | |
| opening_booked: | |
| $ref: '#/definitions/SingleBalance' | |
| closing_booked: | |
| $ref: '#/definitions/SingleBalance' | |
| interim_available: | |
| $ref: '#/definitions/SingleBalance' | |
| SingleBalance: | |
| title: single_balance | |
| type: object | |
| properties: | |
| amount: | |
| $ref: '#/definitions/Amount' | |
| last_action_date_time: | |
| description: '' | |
| type: string | |
| format: date-time | |
| BalancesResponse: | |
| title: balances_response | |
| type: object | |
| properties: | |
| balances: | |
| $ref: '#/definitions/Balances' | |
| TransactionsResponse: | |
| title: transactions_response | |
| type: object | |
| properties: | |
| _links: | |
| $ref: '#/definitions/Links' | |
| transactions: | |
| $ref: '#/definitions/AccountReport' | |
| AccountReport: | |
| title: account_report | |
| type: object | |
| properties: | |
| booked: | |
| description: '' | |
| type: array | |
| items: | |
| $ref: '#/definitions/Transaction' | |
| pending: | |
| description: '' | |
| type: array | |
| items: | |
| $ref: '#/definitions/Transaction' | |
| Transaction: | |
| title: transaction | |
| type: object | |
| properties: | |
| transaction_id: | |
| description: '' | |
| type: string | |
| entry_date: | |
| description: '' | |
| type: string | |
| format: date | |
| amount: | |
| $ref: '#/definitions/Amount' | |
| credit_debit: | |
| $ref: '#/definitions/CreditDebit' | |
| creditor: | |
| description: '' | |
| type: string | |
| creditor-account: | |
| $ref: '#/definitions/AccountReference' | |
| ultimate_creditor: | |
| description: '' | |
| type: string | |
| debtor: | |
| description: '' | |
| type: string | |
| debtor-account: | |
| $ref: '#/definitions/AccountReference' | |
| ultimate_debtor: | |
| description: '' | |
| type: string | |
| remittance_information: | |
| description: '' | |
| type: string | |
| CreditDebit: | |
| title: CreditDebit | |
| example: Credite | |
| type: string | |
| enum: | |
| - Credite | |
| - Debited | |
| ConfirmationOfFundsRequest: | |
| title: confirmation_of_funds_request | |
| type: object | |
| properties: | |
| psu_account: | |
| $ref: '#/definitions/AccountReference' | |
| instructed_amount: | |
| $ref: '#/definitions/Amount' | |
| card_number: | |
| description: '' | |
| type: string | |
| payee: | |
| description: '' | |
| type: string | |
| required: | |
| - psu_account | |
| - instructed_amount | |
| ConfirmationOfFundsResponse: | |
| title: confirmation_of_funds_response | |
| type: object | |
| properties: | |
| tpp_messages: | |
| description: '' | |
| type: array | |
| items: | |
| $ref: '#/definitions/Message' | |
| Links: | |
| title: links | |
| type: object | |
| properties: | |
| redirect: | |
| description: '' | |
| type: string | |
| update_psu_identification: | |
| description: '' | |
| type: string | |
| update_psu_authentication: | |
| description: '' | |
| type: string | |
| select_authentication_method: | |
| description: '' | |
| type: string | |
| authorise_transaction: | |
| description: '' | |
| type: string | |
| self: | |
| description: '' | |
| type: string | |
| status: | |
| description: '' | |
| type: string | |
| account-link: | |
| description: '' | |
| type: string | |
| balances: | |
| description: '' | |
| type: string | |
| transactions: | |
| description: '' | |
| type: string | |
| first_page_link: | |
| description: '' | |
| type: string | |
| second_page_link: | |
| description: '' | |
| type: string | |
| current_page_ link: | |
| description: '' | |
| type: string | |
| last_page_ link: | |
| description: '' | |
| type: string |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment