Transactions

Create a new transaction

For most users, this endpoint is not needed. Transactions are normally synced automatically once a financial connection is established. However, if you want to manually push transactions from some other source that is not integrated with Synci, you can use this endpoint.

POST

/finance/transactions

curl --request POST \
  --url https://api.synci.io/api/v1/finance/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "currency": "<string>",
  "financial_account_id": 123
}
'

{
  "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.

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

amountnumberrequired

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

currencystringrequired

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_idintegerrequired

The ID of the financial account this transaction belongs to.

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