SpareSpare Docs
GuidesAPI Reference

Transaction Data Object

The field-level structure of an AIS transaction, parties, amounts, codes, and dates.

The transaction object describes a single financial movement, organized into groups covering the account, the parties involved, the amounts, and the transaction codes. Some fields are always present (mandatory); others appear only when relevant to the transaction (conditional).

Field groups

Account details

Account ID, currency (English/Arabic names + ISO code), servicer identification, status, type, opening/maturity dates, and servicer address components.

Balance

The balance at transaction time, currency, credit/debit indicator, balance type, and amount.

Parties

PartyMeaning
Creditor AgentThe receiving institution/individual
Debtor AgentThe initiating institution/individual
Creditor AccountThe destination account
Debtor AccountThe source account

Amounts

The primary amount with currency, plus (when applicable):

  • Local exchange rate, source/target currency, rate, value
  • Charge amount, fees applied to the transaction
  • Currency exchange, exchange rate, unit currency, instructed amount

Identifiers & codes

FieldMeaning
Transaction IDUnique identifier for the movement
ReferenceTransaction reference
InformationFree-text information line
Statement referenceReference on the account statement
Bank Transaction CodeStandardized transaction-type indicator
Proprietary CodeInstitution-specific type (e.g. domestic vs. international)

Additional fields

Status, booking date, value date, credit/debit indicator, and merchant category code + name.

Mandatory vs. conditional

Mandatory fields are always present. Conditional fields (e.g. exchange-rate details) appear only when they apply to the specific transaction.

On this page