--- title: "Approve credit transfer" method: POST path: "/payments/v2/credit-transfers/{id}:approve" tags: ["Credit Transfers"] --- # Approve credit transfer `POST /payments/v2/credit-transfers/{id}:approve` Approve the specified credit transfer. ## Path parameters - `id` string, required ## Headers - `If-Match` string ## Request body - ApprovePaymentRequest - `approvalStepId` string, required — The id of the approval step to be approved. ## Response `202` The now approved credit transfer. - CreditTransfer - `id` string, required — Unique resource identifier. - `organizationId` string, required — Unique resource identifier for an Organization. - `creatorUserId` string — Unique resource identifier. - `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). - `scheme` 'SCT' | 'SCT_INST' | 'CROSS_BORDER' | 'GB_CT_BACS' | 'GB_CT_CHAPS' | 'GB_CT_FPS' | 'SE_A2A' | 'SE_GIRO' | 'DK_A2A' | 'DK_CT_SAMEDAY' | 'DK_CT_INST' | 'DK_CT_FIK71' | 'DK_CT_FIK73' | 'DK_CT_FIK75' | 'DK_CT_NEMKONTO' | 'CH_CT' | 'NO_CT' | 'NO_CT_KID' | 'US_CT_ACH' | 'US_CT_WIRE' | 'IS_CT' | 'AU_CT' | 'AU_CT_BECS' | 'AU_CT_BPAY' | 'HK_CT' | 'IL_CT' | 'SG_CT' | 'SG_CT_FAST' | 'BG_CT' | 'CZ_CT' | 'MX_CT' | 'MX_CT_SPID' | 'MY_CT_IBG' | 'MY_CT_RENTAS' | 'KR_CT' | 'TH_CT' | 'CA_CT_LYNX' | 'CA_CT_ACSS' | 'PL_CT' | 'RO_CT' | 'TR_CT' | 'AE_CT' | 'AE_CT_IPI' | 'DE_CT' | 'FR_CT' | 'IN_IMPS' | 'IN_NEFT' | 'IN_RTGS' | 'BR_CT_PIX' | 'BR_CT_TED' | 'BOOK_TRANSFER' | 'CN_CT' | 'VN_CT' | 'PH_CT_PESONET' | 'PH_CT_INSTAPAY' | 'PH_CT_PHILPASS' | 'PH_CT_PDDTS' | 'RS_CT' | 'JP_CT', required — Payment scheme. Choose among: - `schemeDetails` SchemeDetails - `instrument` union — The payment instrument used to initiate the payment. For example Citi has a proprietary payment instrument called WorldLink, which can be used to initiate payments. - object - `type` 'US_ACH' | 'CITI_WORLDLINK', required — The type of the payment instrument. - `citiWorldlinkId` string, required — The WorldLink ID assigned to the account to initiate payments. - object - `type` 'US_ACH' | 'CITI_WORLDLINK', required — The type of the payment instrument. - `usAchCompanyId` string, required — The US ACH Company ID assigned to the account to initiate US ACH payments. - `usAchCompanyName` string — Optional US ACH Company Name override. When set, it is used as the debtor name (Dbtr/Nm) on outgoing US ACH payments from this account instead of the account holder's legal name. Only used for US ACH payments. - `usAchImmediateOrigin` string — Optional US ACH Immediate Origin. When set, it populates the Immediate Origin field of the NACHA file header instead of the US ACH Company ID. Some banks assign an Immediate Origin that is distinct from the Company ID. Only used for US ACH payments. - `intraCompany` boolean — Whether the payment is between companies within the same group. - `initiatorId` string - `urgency` 'HIGH' — The urgency of the payment. - `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`. - `status` 'CREATED' | 'APPROVED' | 'REJECTED' | 'PENDING_SUBMISSION' | 'SENT' | 'PENDING_AT_BANK' | 'ACCEPTED' | 'EXECUTED' | 'FAILED' | 'RETURNED' | 'UNKNOWN', required — Status of a payment. Applicable to both credit transfer payments and direct debit payments. - `statusReason` PaymentStatusReason — Reason for the status of a payment. - `code` string — Failure reason code. If present, this is a ISO 20022 error code. - `description` string — Human readable description of the reason. Can be presented to an end-user. - `source` AccountSnapshot, required - `type` 'ACCOUNT' | 'EXTERNAL_ACCOUNT' | 'INLINE', required — Account type specifier. `ACCOUNT` for internal _Account_ resources. `EXTERNAL_ACCOUNT` for _External Account_ resources. - `id` string, required — Unique resource identifier. - `organizationId` string, required — Unique resource identifier for an Organization. - `market` string, required — 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[], required - `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 - `currency` string, required — Three-letter ISO 4217 currency code. - `sourceHolder` AccountHolder, required — Information about the legal holder of an account. - `type` 'COUNTERPARTY' | 'ENTITY', required - `id` string, required — Resource ID of either a `Counterparty` or an `Entity`. - `externalId` string — External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix `external:`. - `legalName` string, required — The legal name of the account holder. Some banks, and for some payment schemes, the correctness of the legal name will be validated and payments may be rejected if legal names do not match. - `address` Address — Postal address. - `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 - `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. - `partyType` 'INDIVIDUAL' | 'COMPANY' — The legal type of a party - `destination` union, required — Destination account to which funds will be sent. This account will be credited. - ExternalAccountSnapshot - `type` 'ACCOUNT' | 'EXTERNAL_ACCOUNT' | 'INLINE', required — Account type specifier. `ACCOUNT` for internal _Account_ resources. `EXTERNAL_ACCOUNT` for _External Account_ resources. - `id` string, required — Unique resource identifier. - `externalId` string — External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix `external:`. - `organizationId` string, required — Unique resource identifier for an Organization. - `market` string, required — 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 - AccountSnapshot - `type` 'ACCOUNT' | 'EXTERNAL_ACCOUNT' | 'INLINE', required — Account type specifier. `ACCOUNT` for internal _Account_ resources. `EXTERNAL_ACCOUNT` for _External Account_ resources. - `id` string, required — Unique resource identifier. - `organizationId` string, required — Unique resource identifier for an Organization. - `market` string, required — 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[], required - `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 - `currency` string, required — Three-letter ISO 4217 currency code. - `destinationHolder` AccountHolder, required — Information about the legal holder of an account. - `type` 'COUNTERPARTY' | 'ENTITY', required - `id` string, required — Resource ID of either a `Counterparty` or an `Entity`. - `externalId` string — External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix `external:`. - `legalName` string, required — The legal name of the account holder. Some banks, and for some payment schemes, the correctness of the legal name will be validated and payments may be rejected if legal names do not match. - `address` Address — Postal address. - `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 - `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. - `partyType` 'INDIVIDUAL' | 'COMPANY' — The legal type of a party - `approvalSteps` PaymentApprovalStep[], required - `id` string, required — The ID of this step. Used when approving/rejecting. - `approvalChainId` string, required — The ID of the approval chain that triggered this approval step. - `requiredRoleIds` string[] — IDs of the Roles that can approve/reject. Not specified if the step was automatically approved based on an auto-approval chain. - `status` 'PENDING' | 'APPROVED' | 'REJECTED', required — The status of the approval step. - `approver` UserAuditInfo — User information for audit trail. - `id` string, required — Unique resource identifier. - `username` string, required - `name` string — User given name(s) information. May be a concatenation of firstname, lastname etc. - `roleId` string — Role ID - `updated` string, date-time — Timestamp when approved/rejected. Omitted if the step is not yet approved/rejected. - `autoApproved` boolean, required - `allowCreatorApproval` boolean — Allow approval by the user creating this resource if they have the role required for this step. By default, this is not allowed to conform with a four-eyes principle where approval by another person is required. - `sequentialApproval` boolean — If true, the approval steps for this approval chain, specified by `approvalChainId`, need to be approved in the the order specified by `sequenceNumber`. - `sequenceNumber` integer — The sequence number of this step in the approval chain. - `attachedTransactions` AttachedTransactionRef[], required - `type` 'TRANSACTION', required — The resource type of the attached transaction - `id` string, required — ID of the attached transaction resource. - `reference` string, required — This reference will be sent to the destination bank and recipient. (This type of reference is sometimes also referred to as remittance information.) - `referenceType` 'STRUCTURED' | 'UNSTRUCTURED' | 'CREDITOR_REFERENCE' — The kind of reference carried by a payment's remittance information. - `UNSTRUCTURED`: free-text remittance information, carried on pain.001 as ``. - `CREDITOR_REFERENCE`: a structured creditor reference such as ISO 11649 (RF), Finnish Viitenumero, Norwegian KID, or Swedish Bankgiro/Plusgiro OCR. Carried on pain.001 as `` with `SCOR`. - `STRUCTURED`: **deprecated** — use `CREDITOR_REFERENCE` instead. Retained so existing persisted records still parse. - `categoryPurpose` string — ISO 20022 Category Purpose Code (ExternalCategoryPurpose1Code). - `chargeBearer` 'SHARED' | 'DEBTOR' | 'CREDITOR' | 'SERVICE_LEVEL' — Charge bearer specifies which party should bear the charges of the transaction. - `regulatoryReporting` RegulatoryReportingDetails[] - `market` string, required — Two-letter ISO 3166-1 alpha2 country code. - `indicator` 'CREDITOR' | 'DEBTOR' | 'BOTH', required — Determines which side of the payment the regulatory reporting code applies to. When making a payment _to_ Thailand, one should supply a `CREDITOR` code (equivalent to iso20022 `CRED`), while making a payment _out of_ Sweden or Norway may require a `DEBTOR` code (equivalent to iso20022 `DEBT`). - `code` string, required — The actual code to report. Codes are market-specific and found on https://docs.atlar.com - `taxDetails` TaxDetails — Tax payment details for split payment schemes. - `type` 'PL_MPP', required — Type of tax payment scheme. - `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). - `creditorId` string - `invoiceNumber` string - `connectionInstructionId` string — The ID of the instruction that was sent to the bank in which this credit transfer was included when it was created. - `batch` BatchDetails - `id` string, required — Unique resource identifier. - `treatment` 'INDIVIDUAL_PAYMENTS' | 'BATCH', required — Deprecated: You can approve or reject on batch and individual level regardless of the treatment type. - `paymentScheduleId` string — Unique resource identifier. - `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. - `externalId` string — External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix `external:`. - `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. - `version` integer, required — Resource version. Starts at value `1` when the resource is created and increases by one for each successive update. - `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. ## Other responses - `404` — Resource not found. --- [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)