Skip to main content

Fetch account balance

GET 
/v1/accounts/account-id/balances

Description​

Retrieve balance information for a given account, addressed by account-id.

tip

Access various details such as currency, balance amount and transaction information.

Request​

Path Parameters

    account-id stringrequired

    The account ID is retrieved by the Fetch accounts list and is constant at least throughout the lifecycle of a given consent.

Header Parameters

    X-Request-ID uuidrequired

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

    Certificate stringrequired

    The certificate used for signature verification.

    ClientId stringrequired

    The client ID associated with the request.

    consentID stringrequired

    The unique request identifier associated with the consent.

    Ocp-Apim-Subscription-Key stringrequired

    A unique identifier related to the registered merchant in the corresponding API environment, available within the application's details.

Responses​

OK
Schema
    account objectThe account information associated with the balance.
    iban string

    The International Bank Account Number (IBAN) associated with the account.

    bban string

    The Basic Bank Account Number (BBAN) associated with the account.

    pan string

    The Primary Account Number (PAN) associated with the account.

    maskedPan string

    The masked Primary Account Number (PAN) associated with the account.

    msisdn string

    The Mobile Station International Subscriber Directory Number (MSISDN) associated with the account.

    currency string

    The currency in which the account operates.

    balances object[]The account information associated with the balance.
  • Array [
    • balanceAmount object

    The amount of funds available for the given balance type.

    currency string

    The currency of the balance amount.

    Amount string

    The currency of the balance amount.

    balanceType int32

    The type of the balance.
    Available options:
    0 = "closingBooked"
    1 = "expected"
    2 = "authorised"
    3 = "openingBooked"
    4 = "interimAvailable"
    5 = "interimBooked"
    6 = "forwardAvailable"
    7 = "nonInvoiced"

    creditLimitIncluded boolean

    Indicates whether the credit limit is included in the balance.

    lastChangeDateTime date-time

    The date and time of the last change made to the account details.

    referenceDate date-time

    The date for which the account information is retrieved. If null or empty, consider that reference datetime is equivalent with the datetime that the API call has been made.

    lastCommittedTransaction string

    Information about the last committed transaction on the account.

  • ]
Loading...