XSxs2a
XS2A.api.accounts

Get a specific bank account of a xs2a.api bank user

Changed on
get/api/accounts/{bank-account-id}

Request

Path parameters

bank-account-idstring required

The bank-account-id for the account to be retrieved.

Response

Request successfully processed

idstring

Bank Account ID

bank_connection_idstring

Id of the originating BankConnection.

holderstring

Name of the account holder as reported by the bank

ibanstring

IBAN of the bank account

descriptionstring

Description of the bank account

bicstring

BIC of the bank account

account_numberstring

Number of the account

bank_codestring

bank code of the bank

bank_namestring

name of the bank

country_id'DE' | 'AT' | 'CH'

The 2-letter country code

type'giro' | 'creditcard' | 'savings' | 'loan' | 'securities' | 'wallet' | 'other'

The type of the bank of the bank connection

joint_accountboolean

Indicates whether this account has more than one owner.

transaction_possiblestring

Indicates whether this account places payments ("1" for true, "0" for false).

created_atstring

Date of creation

objectstring

The value bank_account

Example response

{
  "id": "bac_c8KYwjexO2iO5AE9",
  "bank_connection_id": "bcn_xxxxxxxxxxxxxxxx",
  "holder": "MUSTERMANN, HARTMUT",
  "iban": "DE62888888880012345678",
  "description": "Girokonto",
  "bic": "TESTDE88XXX",
  "account_number": "1234567890",
  "bank_code": "88888888",
  "bank_name": "Testbank",
  "country_id": "DE",
  "type": "giro",
  "transaction_possible": "1",
  "created_at": "2018-03-16 11:14:58",
  "object": "bank_account"
}

Changes

  • ae5fbc5feee3Revision changes
    • info

      removed the ES enum value from the response property for the response status

    • info

      removed the FR enum value from the response property for the response status

    • info

      removed the GB enum value from the response property for the response status

    • info

      removed the IT enum value from the response property for the response status