Confirmation of funds request

v1.0.0

Creates a confirmation of funds request at the ASPSP. Checks whether a specific amount is available at point of time of the request on an account linked to a given tuple card issuer(TPP)/card number, or addressed by IBAN and TPP respectively. If the related extended services are used a conditional Consent-ID is contained in the header. This field is contained but commented out in this specification.

Input

{
  "type": "object",
  "properties": {
    "Digest": {
      "type": "string"
    },
    "Signature": {
      "type": "string"
    },
    "TPP-Signature-Certificate": {
      "type": "string",
      "format": "byte"
    },
    "X-Request-ID": {
      "type": "string"
    },
    "account": {
      "type": "object",
      "description": "Reference to an account by either\n  * IBAN, of a payment accounts, or\n  * otherAccountIdentification, for payment accounts if there is no IBAN\nadapted from ISO pain.001.001.03.ch.02 CashAccount16-CH_IdTpCcy\n",
      "properties": {
        "cashAccountType": {
          "type": "string",
          "description": "ExternalCashAccountType1Code from ISO 20022.\n"
        },
        "currency": {
          "type": "string",
          "description": "ISO 4217 Alpha 3 currency code.\n"
        },
        "iban": {
          "type": "string",
          "description": "IBAN of an account."
        },
        "otherAccountIdentification": {
          "type": "string",
          "description": "Other payment account Identifier.\nadapted from ISO pain.001.001.03.ch.02 GenericAccountIdentification1-CH\n"
        }
      }
    },
    "cardNumber": {
      "type": "string",
      "description": "Card Number of the card issued by the PIISP.\nShould be delivered if available.\n"
    },
    "instructedAmount": {
      "type": "object",
      "required": [
        "amount",
        "currency"
      ],
      "properties": {
        "amount": {
          "type": "string",
          "description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n  * 1056\n  * 5768.2\n  * -1.50\n  * 5877.78\n"
        },
        "currency": {
          "type": "string",
          "description": "ISO 4217 Alpha 3 currency code.\n"
        }
      }
    },
    "payee": {
      "type": "string",
      "description": "Name payee."
    }
  },
  "required": [
    "X-Request-ID",
    "account",
    "instructedAmount"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Equals \"true\" if sufficient funds are available at the time of the request,\n\"false\" otherwise.\n",
  "required": [
    "fundsAvailable"
  ],
  "properties": {
    "fundsAvailable": {
      "type": "boolean",
      "description": "Equals true if sufficient funds are available at the time of the request, false otherwise.\n\nThis datalemenet is allways contained in a confirmation of funds response.\n\nThis data element is contained in a payment status response, \nif supported by the ASPSP, if a funds check has been performed and \nif the transactionStatus is \"ACTC\", \"ACWC\" or \"ACCP\".\n"
    }
  }
}