Skip to main content

Transactions Object

This object represents a transaction in the AIS Module.

ibanstring

The International Bank Account Number (IBAN), associated with the account. The IBAN number consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters (max. length: 34).


Example: CH9300762011623852957
designationstring

The account designation/description (max. length: 140).


Example: Firmenkonto

entriesarray of object

Specifies the entries transactions.

entryIdstring

The entry Unique Identifier defined by the bank.


Example: ENTRY123456
transactionTypestring

The transaction type that indicates if it is credit or debit entry (CREDIT, DEBIT) (max. length: 4).


Possible values: CRDT or DBIT.

entryReferencestring

Mandatory for business cases ISR and QR-IBAN. The attribute indicates the ISR participant number or QR-IBAN of the account owner (max. length: 35).


Example: 010001628
entryReferenceInternalIdstring

Additional grouping criteria for business cases ISR and QR-IBAN. Indicates the BISR-ID or first 6 characters of the QR reference (max. length: 35).


Example: 123456
reversalIndicatorboolean

Indicates if the transaction is a reversing entry. Must always be true.


Possible value: true.

bookingDatedate

The booking date of the transaction set by the bank. Format: YYYY-MM-DD ( ISO 8601, max. length: 10).


Example: 2018-01-02
valueDatedate

The value date of the transaction set by the bank. Format: YYYY-MM-DD ( ISO 8601, max. length: 10).


Example: 2018-01-02
amountobject

Specifies the entry amount according to the account currency.

amountstring

The entry amount, which will be reflected in the account balance (max. length: 18).


Example: 5000.50
currencystring

The currency in which the entry was posed based on the three-letter code (ISO 4217, max. lenght: 3).


Example: CHF
instructedAmountobject

Specifies the instructed amount according to the account currency.

amountstring

The amount instructed by the customer to the bank to carry out the transaction (max. length: 18).


Example: 5000.50
sourceCurrencystring

The currency three-letter code which you use to fund a currency conversion ( ISO 4217, max. length: 3).


Example: EUR
targetCurrencystring

The currency three-letter code which you or your recipient will receive after you convert currency ( ISO 4217, max. length: 3).


Example: CHF
exchangeRatestring

The rate at which one currency will be exchanged for another currency (max. length: 12).


Example: 1.13665
exchangeIndicatorstring

Indicates whether the amount has to be multiplied or divided by the exchange rate (MULT, DIV). Mandatory if the exchange rate is provided (max. length: 4).


Possible values: MULT or DIV.

totalChargesAmountobject

Specifies the total amount of account charges.

amountstring

The total amount of account charges (max. length: 18).


Example: 1000.00
currencystring

The currency in which the total amount of charges was posed based on the three-letter code ( ISO 4217, max. length: 3).


Example: CHF
chargeRecordsobject

Specifies the details about individual charges.

amountstring

The amount of individual charges (max. length: 18).


Example: 1000.00
currencystring

The currency in which the amount of individual charges was posed based on the three-letter code ( ISO 4217, max. length: 3).


Example: CHF
chargesIncludedIndicatorboolean

Indicates whether the charges are included in the entry amount or not.


Possible value: true or false.

typestring

The type of charge (max. length: 35).


Example:
bankTransactionCodeobject

Specifies a set of elements to fully identify the type of underlying transaction resulting in an entry.

domainCodeenum

The code of the business area of the underlying transaction according to the "Bank Transaction Code" (ISO 20022, max. length: 4).


Possible enum values: check the ...
familyCodeenum

The family code within a specific domain according to the "Bank Transaction Code" (ISO 20022, max. length: 4).


Possible enum values: check the ...
subfamilyCodeenum

Specifies the sub-family code within a specific domain according to the "Bank Transaction Code" (ISO 20022, max. length: 4).


Possible enum values: check the ...
additionalEntryInformationstring

Additional entry information.

transactionsarray of object

Specifies the entry amount according to the account currency.

transactionIdstring

The unique identifier to the listed transaction. Defined by the bank (max. length: 35).


Example: trx123456789
transactionTypeenum

The transaction type that indicates if it is credit or debit entry (CREDIT, DEBIT) (max. length: 4).


Possible enum values: CRDT or DBIT.

endToEndIdstring

The unique reference of the debtor/creditor (max. length: 35).


Example: ENDTOENDID-001
bankTransactionCodeobject

Specifies the entry amount according to the account currency.

domainCodeenum

The code of the business area of the underlying transaction according to the "Bank Transaction Code" (ISO 20022, max. length: 4).


Possible enum values: check the ...
familyCodeenum

Specifies the family code within a specific domain according to the "Bank Transaction Code" (ISO 20022, max. length: 4).


Possible enum values: check the ...
subfamilyCodeenum

Specifies the sub-family code within a specific domain according to the "Bank Transaction Code" (ISO 20022, max. length: 4).


Possible enum values: check the ...
amountobject

Specifies the transaction amount according to the account currency.

amountstring

The transaction amount, which will be reflected in the account balance (max. length: 18).


Example: 7388.50
currencystring

The currency in which the transaction was posed based on the three-letter code ( ISO 4217, max. lenght: 3).


Example: CHF
instructedAmountobject

Specifies the transaction amount according to the account currency.

amountstring

The amount instructed by the customer to the bank to carry out the transaction (max. length: 18).


Example: 5000.50
sourceCurrencystring

The currency three-letter code which you use to fund a currency conversion ( ISO 4217, max. length: 3).


Example: EUR
targetCurrencystring

The currency three-letter code which you or your recipient will receive after you convert currency ( ISO 4217, max. length: 3).


Example: CHF
exchangeRatestring

The rate at which one currency will be exchanged for another currency (max. length: 11).


Example: 1.13665
exchangeIndicatorenum

Indicates whether the amount has to be multiplied or divided by the exchange rate (MULT, DIV). Mandatory if the exchange rate is provided (max. length: 4).


Possible enum values: MULT or DIV.

totalChargesAmountobject

Specifies the total amount of account charges.

amountstring

The total amount of account charges (max. length: 18).


Example: 1000.00
currencystring

The currency in which the total amount of charges was posed based on the three-letter code ( ISO 4217, max. length: 3).


Example: CHF
chargeRecordsobject

Specifies the details about individual charges.

amountstring

The amount of individual charges (max. length: 18).


Example: 1000.00
currencystring

The currency in which the amount of individual charges was posed based on the three-letter code ( ISO 4217, max. length: 3).


Example: CHF
chargesIncludedIndicatorboolean

Indicates whether the charges are included in the entry amount or not.


Possible value: true or false.

typestring

The type of charge (max. length: 35).


Example:
counterpartyobject

Specifies the counterparty details (creditor or debtor).

namestring

Name of the counterparty (debtor name if transaction type = CRDT, creditor name if transaction type = DBIT) (max. length: 140).


Example: Peter Haller
postalAddressobject

Specifies the counterparty address (debtor address if transaction type = CRDT, creditor address if transaction type = DBIT).

structuredobject

Specifies the details of the counterparty structured address.

streetNamestring

The counterparty street name (max. length: 70).


Example: Rosenauweg
buildingNumberinteger

The counterparty building number (max. length: 16).


Example: 4
postCodeinteger

The counterparty post code (max. length: 16).


Example: 80036
townNamestring

The counterparty town name (max. length: 35).


Example: Muenchen
countryenum

The counterparty country (max. length: 2).


Possible enum values: Check the Country code list.

unstructuredobject

Specifies the details of the counterparty unstructured address.

addressLinesarray of strings

The counterparty address lines. Only four address lines allowed (max. length: 4x70).


Example: Rosenauweg 4, 80036 Muenchen
countryenum

The counterparty country (max. length: 2).


Possible enum values: Check the Country code list.

accountobject

Specifies the counterparty account (debtor account if transaction type = CRDT, creditor account if transaction type = DBIT).

typeenum

The counterparty identification account type (IBAN, OTHER) (max. length: 5).


Possible enum values: IBANor OTHER.

identificationstring

The account identification: IBAN, ISR participant number, bank account number (max. length: 35).


Example: DE12500105170648489890
agentobject
bicstring

BIC of the debtor's financial institution (agent of the counterparty). If used, then "Clearing System Member Identification‚ÄĚ must not be used (max. length: 11).


Example: UBSWCHZH80A
clearingSystemMemberIdentification object

Specifies the Information used to identify a member within a clearing system.

codestring

Identification code of a clearing system. Only "CHBCC" is permitted in Switzerland (max. length: 5).


Example: CHBCC
memberIdstring

The identification of a clearing system member. Clearing ID (Bank Code, "National Identifier") of the financial institution. (max. length: 35).


Example: 99999
remittanceInformationstring

An unstructured message (max. length: 140). Either remittanceReference or remittanceInformation must be set.


An unstructured message (max. length: 140). Example: Invoice 2317 due April 1st 2018
remittanceReferenceobject

Specifies the structured reference.

typeenum

Allowed reference type (QRR, SCOR, ISR) (max. length: 5).


Possible enum values: QRR, SCOR or ISR.

referencestring

QR-Reference, Creditor Reference according to ISO 11649 or ISR reference (max. length: 35).


Example: 210000000003139471430009017
additionalTransactionInformationstring

Additional transaction information (max. length: 140).