Transactions

Update transaction

For most users, this endpoint is not needed. Transactions are normally synced (and updated) automatically once a financial connection is established. We do not recommend editing transactions manually unless you have a good reason, as this can lead to inconsistencies in your data.

PUT

/finance/transactions/{transactionId}

Update transaction

curl --request PUT \
  --url https://api.synci.io/api/v1/finance/transactions/{transactionId} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "additional_data_structured": "<string>",
    "additional_information": "<string>",
    "additional_information_structured": "<string>",
    "amount": "<string>",
    "attempted_transfers": "<string>",
    "balance_after_transaction": "<string>",
    "booked": "<string>",
    "booking_date": "<string>",
    "booking_datetime": "<string>",
    "codes": {
      "bank_transaction_code": "<string>",
      "merchant_category_code": "<string>",
      "proprietary_bank_transaction_code": "<string>",
      "purpose_code": "<string>"
    },
    "created_at": "<string>",
    "creditor": {
      "agent": "<string>",
      "bban": "<string>",
      "currency": "<string>",
      "iban": "<string>",
      "id": "<string>",
      "masked_pan": "<string>",
      "msisdn": "<string>",
      "name": "<string>",
      "pan": "<string>"
    },
    "currency": "<string>",
    "currency_exchange": {
      "contract_identification": "<string>",
      "exchange_rate": "<string>",
      "quotation_date": "<string>",
      "source_currency": "<string>",
      "target_currency": "<string>",
      "unit_currency": "<string>"
    },
    "debtor": {
      "agent": "<string>",
      "bban": "<string>",
      "currency": "<string>",
      "iban": "<string>",
      "masked_pan": "<string>",
      "msisdn": "<string>",
      "name": "<string>",
      "pan": "<string>"
    },
    "enriched": {
      "category_general": "<string>",
      "certainty_score": "<string>",
      "counterparty": {
        "logo_url": "<string>",
        "mccs": "<string>",
        "name": "<string>",
        "website": "<string>"
      },
      "intermediary": {
        "logo_url": "<string>",
        "mccs": "<string>",
        "name": "<string>",
        "website": "<string>"
      },
      "is_personal": "<string>",
      "is_subscription": "<string>",
      "location": {
        "apple_maps_url": "<string>",
        "google_maps_url": "<string>",
        "raw_address": "<string>"
      },
      "provider": "<string>"
    },
    "external_identifiers": {
      "check_id": "<string>",
      "end_to_end_id": "<string>",
      "entry_reference": "<string>",
      "institution_transaction_id": "<string>",
      "integrator_transaction_id": "<string>",
      "mandate_id": "<string>"
    },

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

transactionIdintegerrequired

The transaction ID

Body

additional_data_structuredstring | null

An umbrella datapoint used for information that is outside of Berlin Group specification, such as bank- or country-specific fields.

additional_informationstring | null

Might be used by the financial institution to transport additional transaction related information.

additional_information_structuredstring | null

amountnumber

The amount of the transaction as billed to the account.

balance_after_transactionnumber | null

The account balance after this transaction. Recommended balance type is INTERIM_BOOKED.

bookedboolean | null

Whether the transaction is booked (cleared) or not. If false, the transaction is pending.

booking_datestring

The date when an entry is posted to an account on the financial institutions books. Booking date is required if value date is not provided.

booking_datetimestring | null

The date and time when an entry is posted to an account on the financial institutions books.

codesobject

Show child attributes

creditorobject

Show child attributes

currencystring

ISO 4217 currency code.

Required string length: 3 - 3

Pattern: ^[A-Z]{3}$

currency_exchangeobject

Show child attributes

debtorobject

Show child attributes

external_identifiersobject

Show child attributes

financial_account_idinteger

The ID of the financial account this transaction belongs to. Scoped to the caller's own accounts so a transaction can't be reassigned into another user's account.

remittance_informationobject

Show child attributes

ultimate_creditorstring | null

ultimate_debtorstring | null

value_datestring

The date at which assets become available to the account owner in case of a credit. Value date is required if booking date is not provided.

value_datetimestring | null

The date and time at which assets become available to the account owner in case of a credit.

Response

dataobjectrequired

Show child attributes

messagestringrequired

Still need help? Ask the team