--- title: "Update transaction" method: PATCH path: "/financial-data/v2/transactions/{id}" tags: ["Transactions"] --- # Update transaction `PATCH /financial-data/v2/transactions/{id}` Update a transaction. ## Path parameters - `id` string, required ## Headers - `If-Match` string ## Response `200` The updated transaction. - Transaction - `id` string, required — Unique resource identifier. - `organizationId` string, required — Unique resource identifier for an Organization. - `accountId` string, required — The ID of the account which the transaction is booked on. - `date` string, date, required — `full-date` notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), for example, `2017-07-21`. - `amount` Amount, required - `currency` string, required — Three-letter ISO 4217 currency code. - `stringValue` string, required — A string representation of the amount value. This will be a decimal number if the currency has decimals. The number is not formatted for display purposes (e.g. with locale specific thousand separator) and always contains the dot `.` character as decimal separator. - `value` integer, required — The amount value as an integer (int64) represented in currency minor units (e.g. 15.02 EUR is represented as the value 1502). - `reference` string — Transaction reference. (This type of reference is sometimes also referred to as remittance information.) - `references` TransactionReferences — References and identifiers associated with a transaction. - `mandateReference` string — Populated if a (debit) mandate reference was given on the transaction by the bank. Typically, if a transaction stems from a direct debit payment, the mandate reference that was used to pull the funds will be given. - `endToEndId` string — A reference that can be set by the payment initiator that should follow the payment "end to end". Atlar will utilize this reference for tracking payments. - `bankTransactionReference` string — A reference the bank gives the transaction. - `reconciliationStatus` 'RECONCILED' | 'PARTIALLY_RECONCILED' | 'NOT_RECONCILED', required — Specifies whether the transaction have been reconciled against a payment or an expected transaction. - `counterparty` CounterpartyDetails - `partyType` 'INDIVIDUAL' | 'COMPANY' — The legal type of the counterparty. - `name` string — Name of the counterparty. - `nationalIdentifier` NationalIdentifier - `type` 'CIVIC' | 'COMPANY', required — Type of the national identifier. - `market` string, required — Two-letter ISO 3166-1 alpha2 country code. - `number` string, required — The identifier itself. - `address` object — Address details of the counterparty. - `country` string — Two-letter ISO 3166-1 alpha2 country code. - `countrySubdivision` string — Country subdivision code (second part of the ISO 3166-2 code). E.g. state code `CA` for the state of California in the USA, `ON` for the province of Ontario in Canada, `NSW` for the state of New South Wales in Australia. ISO 3166-2 codes can be found on the ISO website, for example, for the USA: https://www.iso.org/obp/ui/#iso:code:3166:US. In the USA the state code is required for domestic payments, in Canada the province code is required for domestic payments. - `city` string - `postalCode` string - `streetName` string - `streetNumber` string - `rawAddressLines` string[] — International unstructured address lines, as they might appear on a mailing label. - `account` CounterpartyAccount — Account information about the counterparty in the transaction. - `market` string — Two-letter ISO 3166-1 alpha2 country code. - `identifiers` AccountIdentifier[], required - `type` 'IBAN' | 'NUMBER' | 'ADYEN' | 'AU_BPAY_BILLER_CODE' | 'DK_FIK' | 'INVESTMENT_NUMBER' | 'NATIONAL_ID_NUMBER' | 'PAYPAL' | 'PROPRIETARY' | 'SE_BANKGIRO' | 'SE_PLUSGIRO' | 'SOLDO' | 'WALLET_ADYEN_BALANCE_PLATFORM' | 'WALLET_AIRWALLEX' | 'WALLET_CURRENCYCLOUD' | 'WALLET_FLASH_PAYMENTS' | 'WALLET_FREEMARKET' | 'WALLET_HYPERWALLET' | 'WALLET_INPAY' | 'WALLET_LEAD' | 'WALLET_MERCURY' | 'WALLET_MONEYCORP' | 'WALLET_PAYHAWK' | 'WALLET_REVOLUT' | 'WALLET_SKRILL' | 'WALLET_STRIPE' | 'WALLET_SWISSQUOTE', required — Account Identifier type. Choose among: For further information please refer to Account Identifiers - `market` string, required — Two-letter ISO 3166-1 alpha2 country code. - `number` string, required — The unformatted identifier itself. For type `NUMBER` the structure of the account number is country-specific. - `invalid` boolean — Will be `true` if the account identifier is invalid according to Atlar account identifier validation rules. - `routing` RoutingIdentifier[] - `type` 'BIC' | 'AT_BLZ' | 'AU_BSB' | 'BR_BRANCH' | 'BR_COMPE' | 'BR_ISP' | 'CA_CPA' | 'CH_BCC' | 'CH_SIC' | 'CL_SBIF' | 'CN_APS' | 'DE_BLZ' | 'ES_NCC' | 'GB_DSC' | 'GR_BIC' | 'HK_NCC' | 'IE_NCC' | 'IL_NCC' | 'IN_FSC' | 'IT_NCC' | 'JP_ZGN' | 'KR_BOK' | 'KR_KFTC' | 'MX_ABM' | 'MY_NCC' | 'NZ_NCC' | 'PL_KNR' | 'PT_NCC' | 'RU_CBC' | 'SE_SBA' | 'SG_IBG' | 'TH_CBC' | 'TW_NCC' | 'US_ABA' | 'US_PID' | 'VN_CITAD' | 'ZA_NCC', required — A routing identifier of type `BIC` must be provided to support cross-border/SWIFT payments. - `number` string, required — The form of the routing number depends on `type`. E.g. for `BIC` the value should be an 8 or 11 character BIC/SWIFT code. For `GB_DSC` (UK domestic routing) the value should be a six digit sort code. - `invalid` boolean — Will be `true` if the routing identifier is invalid according to Atlar validation rules. - `constraints` RoutingConstraints — Constraints on a `RoutingIdentifier`. - `accountNumberType` 'IBAN' | 'NUMBER' | 'ADYEN' | 'AU_BPAY_BILLER_CODE' | 'DK_FIK' | 'INVESTMENT_NUMBER' | 'NATIONAL_ID_NUMBER' | 'PAYPAL' | 'PROPRIETARY' | 'SE_BANKGIRO' | 'SE_PLUSGIRO' | 'SOLDO' | 'WALLET_ADYEN_BALANCE_PLATFORM' | 'WALLET_AIRWALLEX' | 'WALLET_CURRENCYCLOUD' | 'WALLET_FLASH_PAYMENTS' | 'WALLET_FREEMARKET' | 'WALLET_HYPERWALLET' | 'WALLET_INPAY' | 'WALLET_LEAD' | 'WALLET_MERCURY' | 'WALLET_MONEYCORP' | 'WALLET_PAYHAWK' | 'WALLET_REVOLUT' | 'WALLET_SKRILL' | 'WALLET_STRIPE' | 'WALLET_SWISSQUOTE' — Account Identifier type. Choose among: For further information please refer to Account Identifiers - `scheme` string - `rawIdentifier` string, required - `description` string, required — In most cases, the description will contain the same value (text) as the remittance information. If the remittance information lacks clarity or meaning, the description can be derived from the bank transaction code instead. This description field is intended solely for displaying a meaningful description to users. - `instructedAmount` Amount - `currency` string, required — Three-letter ISO 4217 currency code. - `stringValue` string, required — A string representation of the amount value. This will be a decimal number if the currency has decimals. The number is not formatted for display purposes (e.g. with locale specific thousand separator) and always contains the dot `.` character as decimal separator. - `value` integer, required — The amount value as an integer (int64) represented in currency minor units (e.g. 15.02 EUR is represented as the value 1502). - `bankTransactionCode` BankTransactionCode — ISO 20022 Bank Transaction Code - `domain` string, required — ISO 20022 BTC Domain - Defines the business area of the underlying transaction, e.g. payments or cash management. - `family` string, nullable — ISO 20022 BTC Family - May for example define the type of transaction, e.g. credit transfer or direct debit. - `subfamily` string, nullable — ISO 20022 BTC Subfamily - May for example specify a scheme specific transaction type, e.g. SEPA credit transfer, or a Cross-Border credit transfer. - `proprietary` ProprietaryBankTransactionCode — Proprietary bank transaction codes are provided when the bank provides a proprietary transaction code. This field will be set as the code provided by the bank. - `code` string, nullable - `issuer` string, nullable - `description` string, nullable — Free-form textual description of the Bank Transaction Code. - `valueDate` string, date — `full-date` notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), for example, `2017-07-21`. - `returned` boolean, required — Whether or not the transaction is considered a return or reversal. - `returnReason` ReturnReason - `code` string - `description` string - `originalBankTransactionCode` BankTransactionCode — ISO 20022 Bank Transaction Code - `domain` string, required — ISO 20022 BTC Domain - Defines the business area of the underlying transaction, e.g. payments or cash management. - `family` string, nullable — ISO 20022 BTC Family - May for example define the type of transaction, e.g. credit transfer or direct debit. - `subfamily` string, nullable — ISO 20022 BTC Subfamily - May for example specify a scheme specific transaction type, e.g. SEPA credit transfer, or a Cross-Border credit transfer. - `proprietary` ProprietaryBankTransactionCode — Proprietary bank transaction codes are provided when the bank provides a proprietary transaction code. This field will be set as the code provided by the bank. - `code` string, nullable - `issuer` string, nullable - `description` string, nullable — Free-form textual description of the Bank Transaction Code. - `currencyExchange` CurrencyExchange - `exchangeRate` string, required — The exchange rate that was reported by the bank. Atlar will not try to calculate this in cases where the information isn't present. - `sourceCurrency` string, required — Three-letter ISO 4217 currency code. - `targetCurrency` string — Three-letter ISO 4217 currency code. - `unitCurrency` string — Three-letter ISO 4217 currency code. - `charges` TransactionCharge[] — Charges associated with the transaction, as reported by the bank. - `amount` Amount, required - `currency` string, required — Three-letter ISO 4217 currency code. - `stringValue` string, required — A string representation of the amount value. This will be a decimal number if the currency has decimals. The number is not formatted for display purposes (e.g. with locale specific thousand separator) and always contains the dot `.` character as decimal separator. - `value` integer, required — The amount value as an integer (int64) represented in currency minor units (e.g. 15.02 EUR is represented as the value 1502). - `type` 'BROKERAGE_FEE' | 'COMMISSION' | 'SUMMATION' | 'BATCH' | 'AMENDMENT' | 'CANCELLATION_FEE' | 'CLEARING_FEE' | 'INVESTIGATION' | 'INTEREST' | 'NON_STP_CHARGES' | 'BORNE_BY_DEBTOR' | 'TELECOMMUNICATION_CHARGES' | 'ACCOUNT_MAINTENANCE_FEE' | 'REPORTING_CHARGES' — Charge type specifies the kind of charge on a transaction. - `proprietaryType` string — The proprietary type of the charge, if reported by the bank. - `chargeBearer` 'SHARED' | 'DEBTOR' | 'CREDITOR' | 'SERVICE_LEVEL' — Charge bearer specifies which party should bear the charges of the transaction. - `included` 'INCLUDED' | 'NOT_INCLUDED' | 'UNSPECIFIED', required — Whether the charge is included in the transaction amount. - `virtualAccount` TransactionVirtualAccount — Account information about the virtual account used in the transaction. - `market` string — Two-letter ISO 3166-1 alpha2 country code. - `identifiers` AccountIdentifier[], required - `type` 'IBAN' | 'NUMBER' | 'ADYEN' | 'AU_BPAY_BILLER_CODE' | 'DK_FIK' | 'INVESTMENT_NUMBER' | 'NATIONAL_ID_NUMBER' | 'PAYPAL' | 'PROPRIETARY' | 'SE_BANKGIRO' | 'SE_PLUSGIRO' | 'SOLDO' | 'WALLET_ADYEN_BALANCE_PLATFORM' | 'WALLET_AIRWALLEX' | 'WALLET_CURRENCYCLOUD' | 'WALLET_FLASH_PAYMENTS' | 'WALLET_FREEMARKET' | 'WALLET_HYPERWALLET' | 'WALLET_INPAY' | 'WALLET_LEAD' | 'WALLET_MERCURY' | 'WALLET_MONEYCORP' | 'WALLET_PAYHAWK' | 'WALLET_REVOLUT' | 'WALLET_SKRILL' | 'WALLET_STRIPE' | 'WALLET_SWISSQUOTE', required — Account Identifier type. Choose among: For further information please refer to Account Identifiers - `market` string, required — Two-letter ISO 3166-1 alpha2 country code. - `number` string, required — The unformatted identifier itself. For type `NUMBER` the structure of the account number is country-specific. - `invalid` boolean — Will be `true` if the account identifier is invalid according to Atlar account identifier validation rules. - `routing` RoutingIdentifier[] - `type` 'BIC' | 'AT_BLZ' | 'AU_BSB' | 'BR_BRANCH' | 'BR_COMPE' | 'BR_ISP' | 'CA_CPA' | 'CH_BCC' | 'CH_SIC' | 'CL_SBIF' | 'CN_APS' | 'DE_BLZ' | 'ES_NCC' | 'GB_DSC' | 'GR_BIC' | 'HK_NCC' | 'IE_NCC' | 'IL_NCC' | 'IN_FSC' | 'IT_NCC' | 'JP_ZGN' | 'KR_BOK' | 'KR_KFTC' | 'MX_ABM' | 'MY_NCC' | 'NZ_NCC' | 'PL_KNR' | 'PT_NCC' | 'RU_CBC' | 'SE_SBA' | 'SG_IBG' | 'TH_CBC' | 'TW_NCC' | 'US_ABA' | 'US_PID' | 'VN_CITAD' | 'ZA_NCC', required — A routing identifier of type `BIC` must be provided to support cross-border/SWIFT payments. - `number` string, required — The form of the routing number depends on `type`. E.g. for `BIC` the value should be an 8 or 11 character BIC/SWIFT code. For `GB_DSC` (UK domestic routing) the value should be a six digit sort code. - `invalid` boolean — Will be `true` if the routing identifier is invalid according to Atlar validation rules. - `constraints` RoutingConstraints — Constraints on a `RoutingIdentifier`. - `accountNumberType` 'IBAN' | 'NUMBER' | 'ADYEN' | 'AU_BPAY_BILLER_CODE' | 'DK_FIK' | 'INVESTMENT_NUMBER' | 'NATIONAL_ID_NUMBER' | 'PAYPAL' | 'PROPRIETARY' | 'SE_BANKGIRO' | 'SE_PLUSGIRO' | 'SOLDO' | 'WALLET_ADYEN_BALANCE_PLATFORM' | 'WALLET_AIRWALLEX' | 'WALLET_CURRENCYCLOUD' | 'WALLET_FLASH_PAYMENTS' | 'WALLET_FREEMARKET' | 'WALLET_HYPERWALLET' | 'WALLET_INPAY' | 'WALLET_LEAD' | 'WALLET_MERCURY' | 'WALLET_MONEYCORP' | 'WALLET_PAYHAWK' | 'WALLET_REVOLUT' | 'WALLET_SKRILL' | 'WALLET_STRIPE' | 'WALLET_SWISSQUOTE' — Account Identifier type. Choose among: For further information please refer to Account Identifiers - `scheme` string - `batchInformation` BatchInformation — Information about the batch that the transaction belongs to. - `transactionCount` integer, required — The number of transactions in the batch. - `totalAmount` Amount - `currency` string, required — Three-letter ISO 4217 currency code. - `stringValue` string, required — A string representation of the amount value. This will be a decimal number if the currency has decimals. The number is not formatted for display purposes (e.g. with locale specific thousand separator) and always contains the dot `.` character as decimal separator. - `value` integer, required — The amount value as an integer (int64) represented in currency minor units (e.g. 15.02 EUR is represented as the value 1502). - `attachedTransactables` AttachedTransactableRef[], required - `type` 'CREDIT_TRANSFER' | 'DIRECT_DEBIT' | 'EXPECTED_TRANSACTION' | 'PAYMENT_BATCH' | 'CONNECTION_INSTRUCTION', required — The resource type of the attached transactable. - `id` string, required — Unique resource identifier. - `internalTransfer` InternalTransferRef — Reference to the `InternalTransfer` this transaction is one leg of, plus the counterpart transaction/account. Stamped onto the transaction as soon as its leg is observed — even if the counterpart leg has not yet ingested. In that case `counterpartTransactionId` is empty; it gets filled in when the counterpart transaction ingests and the InternalTransfer is promoted to CONFIRMED. - `internalTransferId` string, required — Unique resource identifier. - `counterpartTransactionId` string — Unique resource identifier. - `counterpartAccountId` string, required — Unique resource identifier. - `status` 'PENDING' | 'CONFIRMED' — Status of the parent `InternalTransfer` at the time this ref was stamped onto the leg. `PENDING` until the counterpart leg has ingested; `CONFIRMED` once both legs are paired. May be absent on legs stamped before this field was introduced. - `created` string, date-time, required — Time at which the resource was created. - `updated` string, date-time, required — Time at which the resource was last updated. - `version` integer, required — Resource version. Starts at value `1` when the resource is created and increases by one for each successive update. - `etag` string, required — [ETag](https://en.wikipedia.org/wiki/HTTP_ETag) based on the resource version. This can be passed along in `If-Match` HTTP header when updating a resource to perform a conditional update. - `metadata` Metadata, nullable — Metadata is a `string-string` key-value container that can be used to store information known at the time of resource creation. This can be retrieved later on, for instance when a payment or expected transaction is reconciled with the booked transaction on the bank statement. Metadata can have at most 20 entries. Keys may have a maximum length of 64 chars and values a maximum length of 512 chars. By default, this field is optional. It is possible to make it required in the Atlar Dashboard by visiting the [Metadata keys page](https://app.atlar.com/metadata-keys). Requirement rules can be specified per API resource. Both the Dashboard and the API will then enforce these rules and give validation errors when the required fields are not set. ## Other responses - `400` — Bad request. --- [API](https://skmtc.net/atlar/apis/atlar-api-v2.md) · [All operations](https://skmtc.net/atlar/apis/atlar-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlar/atlar-api-v2/revisions/9c5e194ccf5d/schema)