Skip to main content

Confirmation of Funds Request.

POST 
/api/v1/funds-confirmations

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

Request​

Header Parameters

    X-Request-ID uuidrequired

    ID of the request, unique to the call, as determined by the initiating party.

    Example: c66d0ad3-4089-4996-bd48-523ae3e484f7
    Consent-ID string

    This data element may be contained, if the payment initiation transaction is part of a session, i.e. combined AIS/PIS service. This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

    Example: 354c3126-be8c-4bcb-8cc6-0c317b8efb30
    Authorization string

    This field might be used in case where a consent was agreed between ASPSP and PSU through an OAuth2 based protocol,facilitated by the TPP.

    Digest string

    Is contained if and only if the "Signature" element is contained in the header of the request.

    Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A=
    Signature string

    A signature of the request by the TPP on application level. This might be mandated by ASPSP.

    TPP-Signature-Certificate string

    The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained..

Body

JSON Request body for the "Confirmation of funds service".

    cardNumber stringnullablerequired

    Possible values: <= 35 characters

    Optional Card Number of the card issued by the PIISP. Should be delivered if available.

    Card Number of the card issued by the PIISP. Should be delivered if available.

    account objectrequired

    Reference to an account by either

    • IBAN, of a payment accounts, or
    • BBAN, for payment accounts if there is no IBAN, or
    • the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
    • the Primary Account Number (PAN) of a card in a masked form, or
    • an alias to access a payment account via a registered mobile phone number (MSISDN).
    iban stringnullablerequired

    Possible values: Value must match regular expression [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}

    IBAN of the account.

    bban stringnullablerequired

    Basic Bank Account Number (BBAN) Identifier.

    This data element can be used in the body of the consent request. Message for retrieving account access consent from this account. This data elements is used for payment accounts which have no IBAN. ISO20022: Basic Bank Account Number (BBAN).

    Identifier used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer

    pan stringnullablerequired

    Possible values: <= 35 characters

    Primary Account Number according to ISO/IEC 7812.

    maskedPan stringnullablerequired

    Possible values: <= 35 characters

    Masked Primary Account Number.

    msisdn stringnullablerequired

    Possible values: <= 35 characters

    Mobile phone number.

    other object

    In cases where the specifically defined criteria (IBAN, BBAN, MSISDN) are not provided to identify an instance of the respective account type (e.g. a savings account), the ASPSP shall include a proprietary ID of the respective account that uniquely identifies the account for this ASPSP.

    identification stringrequired

    Possible values: non-empty and <= 35 characters

    Proprietary identification of the account.

    schemeNameCode stringrequired

    Possible values: non-empty

    An entry provided by an external ISO code list.

    schemeNameProprietary stringnullablerequired

    Possible values: <= 35 characters

    A scheme name defined in a proprietary way.

    issuer stringnullablerequired

    Possible values: <= 35 characters

    Issuer of the identification.

    currency stringnullablerequired

    Possible values: Value must match regular expression [A-Z]{3}

    Account Currency Code.

    cashAccountType stringnullablerequired

    ExternalCashAccountType1Code from ISO 20022.

    payee stringnullablerequired

    Possible values: <= 70 characters

    Optional The merchant where the card is accepted as an information to the PSU.

    Name payee.

    instructedAmount objectrequired

    Base Model for amount.

    currency stringrequired

    Possible values: non-empty, Value must match regular expression [A-Z]{3}

    Currency Code.

    amount stringrequired

    Possible values: non-empty, Value must match regular expression -?[0-9]{1,14}(\.[0-9]{1,3})?

    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

Responses​

Success

Response Headers
  • Location string

    Location of the created resource.

  • X-Request-ID string

    ID of the request, unique to the call, as determined by the initiating party.

Schema
    fundsAvailable booleanrequired

    Equals true if sufficient funds are available at the time of the request, false otherwise. This data element is allways contained in a confirmation of funds response. This data element is contained in a payment status response, if supported by the ASPSP, if a funds check has been performed and if the transactionStatus is "ACTC", "ACWC" or "ACCP".

Loading...