--- swagger: "2.0" info: description: | The Fund Confirmation Service (FCS) API provides a service to query the availability of a specific amount at the point in time of the call. Access to the FCS API is controlled through the general onboarding/enrollment flow. I.e. the API is only accessible to valid TPPs, who have completed the enrollment in order to upload and verify their qualified certificates. By accessing the API, you confirm that you already have status as an authorized TPP - or (for sandbox access only) that your application has been submitted to a local NCA and is pending approval. Only TPPs who can document their authorization status are elegible for support. The FCS API is part of the general PSD2 XS2A implementation and works in the same security context. In addition to the information contained below, all communication, headers and additional steps adhere to the general [security model and flows](https://apiportal.prod.bec.dk/openbanking/sandbox/security-model-and-flows). Refer to this link for up to date information on required security headers. The API is implemented against [Berlin Group XS2A version 1.3](https://www.berlin-group.org/psd2-access-to-bank-accounts). **Note about this version** This version of the FCS API now also supports testing of security, consent and SCA flows in sandbox with full security context. * The sandbox API works on (stateless) mocked account data, while SCA, security and consent flows are identical to production. * The security model for TPP enrollment and PSU authentication/authorization is implemented and enforced for **both** production and sandbox API **Access to API Endpoints** **Production and sandbox access:** Prior to calling the API the TPP must complete the (one-time) process for [Onboarding](https://apiportal.prod.bec.dk/openbanking/sandbox/start) on a per-bank basis. Separate API URL/host endpoints are required for each bank under the BEC Umbrella. Consult the [Environments section](https://apiportal.prod.bec.dk/openbanking/sandbox/environments) for information on URL schemas in production and sandbox environments. See list of included ASPSPs and their corresponding urls by following [this link](https://apiportal.prod.bec.dk/openbanking/sandbox/included-aspsps). The X-IBM-Client-Id attribute is not required in this version. version: 1.0.2 title: PSD2 BG Fund Confirmation Service API (FCS) contact: name: BEC PSD2 Support url: https://apiportal.prod.bec.dk/openbanking/sandbox/ email: psd2.support@bec.dk license: name: The API is made available to TPPs who have been authorized for the relevant roles by a NCA - or to TPPs applying to be authorized at a NCA with approval pending. x-ibm-name: psd2-bg-fund-confirmation-service-CFS host: api.sandbox.openbanking.bec.dk basePath: /bg/openbanking/v1 tags: - name: Berlin Group Fund Confirmation Service API (CFS) description: | CFS provides a true/false response to queries about whether a specific amount is available at point in time of the call. paths: /funds-confirmations: post: tags: - Berlin Group Confirmation of Funds summary: This endpoint returns true if queried amount is available on the account. operationId: confirmFundsUsingPOST consumes: - application/json produces: - application/json parameters: - name: X-Request-ID in: header type: string format: uuid required: true description: | ID of the request (in UUID format), unique to the call (generated by the initiating party, who must ensure uniqueness). - name: Consent-ID in: header type: string format: uuid required: true description: | Shall be provided if the consent of the PSU has been provided through the consent process as defined in [XS2A-COFC]. - in: body name: confirmationRequest description: confirmationRequest required: false schema: $ref: '#/definitions/ConfirmationOfFunds' responses: 200: description: OK schema: $ref: '#/definitions/ConfirmationOfFundsResponse' 201: description: Created 401: description: Unauthorized 403: description: Forbidden 404: description: Not Found definitions: Account: type: object properties: bban: type: string example: 12345678901234 description: "BBAN (Basic Bank Account Number) up to 14 digits forming the account number used to identify an account intranationally \n Pattern: [0-9]{1,14}" maxLength: 14 iban: type: string example: DK9520000123456789 description: "IBAN (International Bank Account Number) up to 34 alphanumeric characters consisting of a two letter country code, a two digit checksum, and a BBAN \n Pattern: [A-Z]{2}[0-9]{2}[A-Z0-9]{1-30}" maxLength: 34 title: Account description: Account representation. Either iban or bban MUST be filled out Amount: type: object required: - amount - currency properties: amount: type: number example: 5864.850000 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.: -?[0-9]{1,14}(\.[0-9]{1,3})? currency: type: string example: DKK description: The Currency code. This MUST be a valid ISO 4217 currency code. See the ASPSPs' documentation for details of supported currencies. The supplied currency must match the account currency, otherwise unsupported currency error is returned. minLength: 3 maxLength: 3 title: Amount description: Monetary Amount, including currency code and value ConfirmationOfFunds: type: object properties: account: $ref: '#/definitions/Account' amount: $ref: '#/definitions/Amount' title: ConfirmationOfFunds ConfirmationOfFundsResponse: type: object properties: fundsAvailable: type: boolean example: true description: Return value for the query. Returns true if funds are available, false otherwise title: ConfirmationOfFundsResponse x-ibm-configuration: testable: false enforced: true phase: realized produces: - application/json consumes: - application/json x-ibm-endpoints: - endpointUrl: https://api.sandbox.openbanking.bec.dk type: - development ...