{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/atlar/main/json-schema/atlar-credit-transfer-schema.json",
  "title": "CreditTransfer",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/atlar-api-v2-openapi.yml#/components/schemas/CreditTransfer",
  "type": "object",
  "properties": {
    "id": {
      "description": "ID of the credit transfer.",
      "$ref": "#/$defs/ResourceID"
    },
    "organizationId": {
      "$ref": "#/$defs/OrganizationID"
    },
    "creatorUserId": {
      "$ref": "#/$defs/ResourceID",
      "description": "ID of the user that created the credit transfer.",
      "readOnly": true
    },
    "amount": {
      "$ref": "#/$defs/Amount",
      "readOnly": true
    },
    "scheme": {
      "$ref": "#/$defs/CreditTransferSchemeType",
      "readOnly": true
    },
    "schemeDetails": {
      "$ref": "#/$defs/SchemeDetails",
      "readOnly": true
    },
    "date": {
      "description": "Requested payment execution date.",
      "$ref": "#/$defs/Date",
      "readOnly": true
    },
    "status": {
      "$ref": "#/$defs/PaymentStatus",
      "readOnly": true
    },
    "statusReason": {
      "$ref": "#/$defs/PaymentStatusReason",
      "readOnly": true
    },
    "source": {
      "$ref": "#/$defs/AccountSnapshot",
      "description": "Source account from which funds will be withdrawn. This account will be debited.",
      "readOnly": true
    },
    "sourceHolder": {
      "$ref": "#/$defs/AccountHolder",
      "readOnly": true
    },
    "destination": {
      "description": "Destination account to which funds will be sent. This account will be credited.",
      "oneOf": [
        {
          "$ref": "#/$defs/ExternalAccountSnapshot"
        },
        {
          "$ref": "#/$defs/AccountSnapshot"
        },
        {
          "$ref": "#/$defs/InlineExternalAccountSnapshot"
        }
      ],
      "readOnly": true
    },
    "destinationHolder": {
      "$ref": "#/$defs/AccountHolder",
      "readOnly": true
    },
    "approvalSteps": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/PaymentApprovalStep"
      },
      "readOnly": true
    },
    "attachedTransactions": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/AttachedTransactionRef"
      },
      "readOnly": true
    },
    "reference": {
      "$ref": "#/$defs/PaymentReference"
    },
    "referenceType": {
      "$ref": "#/$defs/RemittanceType",
      "description": "The reference type requested at creation time, if any.",
      "readOnly": true
    },
    "categoryPurpose": {
      "$ref": "#/$defs/CategoryPurpose"
    },
    "chargeBearer": {
      "$ref": "#/$defs/ChargeBearer"
    },
    "regulatoryReporting": {
      "type": "array",
      "x-omitempty": true,
      "items": {
        "$ref": "#/$defs/RegulatoryReportingDetails"
      },
      "maxItems": 10,
      "readOnly": true
    },
    "taxDetails": {
      "description": "Tax payment details for split payment schemes like Polish MPP.",
      "$ref": "#/$defs/TaxDetails",
      "readOnly": true
    },
    "connectionInstructionId": {
      "type": "string",
      "description": "The ID of the instruction that was sent to the bank in which this credit transfer was included when it was created.",
      "readOnly": true
    },
    "batch": {
      "description": "Details of the associated payments batch if the credit transfer was created as part of a batch.",
      "$ref": "#/$defs/BatchDetails"
    },
    "paymentScheduleId": {
      "description": "ID of the payment schedule associated with this credit transfer.",
      "$ref": "#/$defs/ResourceID"
    },
    "etag": {
      "$ref": "#/$defs/ETag"
    },
    "externalId": {
      "$ref": "#/$defs/ExternalID",
      "readOnly": true
    },
    "metadata": {
      "$ref": "#/$defs/Metadata",
      "readOnly": true
    },
    "version": {
      "$ref": "#/$defs/ResourceVersion"
    },
    "created": {
      "$ref": "#/$defs/CreatedTimestamp"
    },
    "updated": {
      "$ref": "#/$defs/UpdatedTimestamp"
    }
  },
  "required": [
    "id",
    "organizationId",
    "amount",
    "scheme",
    "date",
    "status",
    "source",
    "sourceHolder",
    "destination",
    "destinationHolder",
    "reference",
    "approvalSteps",
    "version",
    "etag",
    "created",
    "updated",
    "attachedTransactions"
  ],
  "$defs": {
    "AccountHolder": {
      "type": "object",
      "description": "Information about the legal holder of an account.",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "COUNTERPARTY",
            "ENTITY",
            "INLINE"
          ],
          "readOnly": true
        },
        "id": {
          "type": "string",
          "description": "Resource ID of either a `Counterparty` or an `Entity`. Absent when `type` is `INLINE`, since an inline holder refers to no resource.",
          "readOnly": true
        },
        "externalId": {
          "$ref": "#/$defs/ExternalID",
          "description": "External ID of either a `Counterparty` or an `Entity`."
        },
        "legalName": {
          "type": "string",
          "description": "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.",
          "readOnly": true
        },
        "address": {
          "description": "Postal address of the account holder.",
          "$ref": "#/$defs/Address",
          "readOnly": true
        },
        "nationalIdentifier": {
          "description": "The national identifier of the account holder.",
          "$ref": "#/$defs/NationalIdentifier",
          "readOnly": true
        },
        "partyType": {
          "description": "The party type of the account holder.",
          "$ref": "#/$defs/PartyType",
          "readOnly": true
        },
        "email": {
          "description": "Email of the account holder.",
          "type": "string",
          "readOnly": true
        }
      },
      "required": [
        "type",
        "legalName"
      ]
    },
    "AccountIdentifier": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/$defs/AccountIdentifierType"
        },
        "market": {
          "$ref": "#/$defs/MarketCode",
          "description": "The market of the `AccountIdentifier` specifies in which market-context the identifier should be treated.\n\nA `NUMBER` from Sweden does not look and does not validate in the same way as a `NUMBER` from GB. The market\ncode is, in most cases, the same as where the account itself is domiciled, but not necessarily. An examples\nof this discrepancy is Jersey which may have domiciled accounts with market `JE`, but the account identifier\nwould be an `IBAN` with country code `GB`."
        },
        "number": {
          "type": "string",
          "description": "The unformatted identifier itself. For type `NUMBER` the structure of the account number is country-specific.",
          "minLength": 1,
          "maxLength": 255
        },
        "invalid": {
          "type": "boolean",
          "description": "Will be `true` if the account identifier is invalid according to Atlar account identifier validation rules.",
          "readOnly": true
        }
      },
      "required": [
        "type",
        "market",
        "number"
      ]
    },
    "AccountIdentifierType": {
      "type": "string",
      "enum": [
        "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_AIRWALLEX_NUMBER",
        "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",
        "WALLET_UNIT"
      ],
      "description": "Account Identifier type. Choose among:\n<ul>\n<li><code>IBAN</code> — IBAN</li>\n<li><code>NUMBER</code> — Account number</li>\n<li><code>ADYEN</code> — Adyen identifier</li>\n<li><code>AU_BPAY_BILLER_CODE</code> — Australian BPAY Biller Code</li>\n<li><code>DK_FIK</code> — FIK creditor number</li>\n<li><code>INVESTMENT_NUMBER</code> — Investment number</li>\n<li><code>NATIONAL_ID_NUMBER</code> — National Identification Number</li>\n<li><code>PAYPAL</code> — PayPal wallet identifier</li>\n<li><code>PROPRIETARY</code> — Proprietary identifier</li>\n<li><code>SE_BANKGIRO</code> — <a href=\"https://www.bankgirot.se/en/\">Bankgiro number</a></li>\n<li><code>SE_PLUSGIRO</code> — <a href=\"https://www.nordea.se/foretag/produkter/betala/plusgirot.html\">Plusgiro number</a></li>\n<li><code>SOLDO</code> — Soldo entity identifier</li>\n<li><code>WALLET_ADYEN_BALANCE_PLATFORM</code> — Adyen balance platform wallet identifier</li>\n<li><code>WALLET_AIRWALLEX</code> — Airwallex wallet identifier</li>\n<li><code>WALLET_AIRWALLEX_NUMBER</code> — Airwallex account number</li>\n<li><code>WALLET_CURRENCYCLOUD</code> — Currencycloud wallet identifier</li>\n<li><code>WALLET_FLASH_PAYMENTS</code> — Flash Payments wallet identifier</li>\n<li><code>WALLET_FREEMARKET</code> — Freemarket wallet identifier</li>\n<li><code>WALLET_HYPERWALLET</code> — Hyperwallet wallet identifier</li>\n<li><code>WALLET_INPAY</code> — Inpay account identifier</li>\n<li><code>WALLET_LEAD</code> — Lead wallet identifier</li>\n<li><code>WALLET_MERCURY</code> — Mercury wallet identifier</li>\n<li><code>WALLET_MONEYCORP</code> — Moneycorp wallet identifier</li>\n<li><code>WALLET_PAYHAWK</code> — Payhawk wallet identifier</li>\n<li><code>WALLET_REVOLUT</code> — Revolut wallet identifier</li>\n<li><code>WALLET_SKRILL</code> — Skrill wallet identifier</li>\n<li><code>WALLET_STRIPE</code> — Stripe wallet identifier</li>\n<li><code>WALLET_SWISSQUOTE</code> — Swissquote wallet identifier</li>\n<li><code>WALLET_UNIT</code> — Unit wallet identifier</li>\n</ul>\nFor further information please refer to <a href=\"https://docs.atlar.com/v2.0/docs/payment-details#account-identifiers\">Account Identifiers</a>"
    },
    "AccountSnapshot": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/$defs/AccountType"
        },
        "id": {
          "description": "ID of the (internal) Account.",
          "$ref": "#/$defs/ResourceID"
        },
        "organizationId": {
          "$ref": "#/$defs/OrganizationID"
        },
        "market": {
          "$ref": "#/$defs/MarketCode",
          "readOnly": true
        },
        "identifiers": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AccountIdentifier"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true
        },
        "routing": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/RoutingIdentifier"
          },
          "uniqueItems": true,
          "maxItems": 5,
          "readOnly": true
        },
        "currency": {
          "$ref": "#/$defs/CurrencyCode",
          "readOnly": true
        }
      },
      "required": [
        "type",
        "id",
        "organizationId",
        "market",
        "currency",
        "identifiers",
        "routing"
      ]
    },
    "AccountType": {
      "type": "string",
      "enum": [
        "ACCOUNT",
        "EXTERNAL_ACCOUNT",
        "INLINE"
      ],
      "description": "Account type specifier. `ACCOUNT` for internal _Account_ resources. `EXTERNAL_ACCOUNT` for _External Account_ resources."
    },
    "Address": {
      "description": "Postal address.",
      "type": "object",
      "properties": {
        "country": {
          "$ref": "#/$defs/CountryCode",
          "x-go-type-skip-optional-pointer": true
        },
        "countrySubdivision": {
          "$ref": "#/$defs/CountrySubdivision",
          "x-go-type-skip-optional-pointer": true
        },
        "city": {
          "type": "string",
          "maxLength": 64
        },
        "postalCode": {
          "type": "string",
          "maxLength": 16
        },
        "streetName": {
          "type": "string",
          "maxLength": 64
        },
        "streetNumber": {
          "type": "string",
          "maxLength": 16
        }
      }
    },
    "Amount": {
      "type": "object",
      "properties": {
        "currency": {
          "$ref": "#/$defs/CurrencyCode"
        },
        "stringValue": {
          "description": "A string representation of the amount value. This will be\na decimal number if the currency has decimals. The number\nis not formatted for display purposes (e.g. with locale\nspecific thousand separator) and always contains the dot\n`.` character as decimal separator.",
          "type": "string"
        },
        "value": {
          "description": "The amount value as an integer (int64) represented in\ncurrency minor units (e.g. 15.02 EUR is represented as the\nvalue 1502).",
          "type": "integer",
          "format": "int64"
        }
      },
      "required": [
        "currency",
        "stringValue",
        "value"
      ]
    },
    "ApprovalStatus": {
      "type": "string",
      "description": "The status of the approval step.",
      "enum": [
        "PENDING",
        "APPROVED",
        "REJECTED"
      ]
    },
    "AttachedTransactionRef": {
      "type": "object",
      "description": "An association between a _transactable_ payment resource, e.g. a _Credit Transfer_, _Direct Debit_, or _Expected Transaction_, and an account _Transaction_.",
      "properties": {
        "type": {
          "type": "string",
          "description": "The resource type of the attached transaction",
          "enum": [
            "TRANSACTION"
          ],
          "readOnly": true
        },
        "id": {
          "type": "string",
          "description": "ID of the attached transaction resource.",
          "readOnly": true
        }
      },
      "required": [
        "type",
        "id"
      ]
    },
    "BatchDetails": {
      "type": "object",
      "properties": {
        "id": {
          "description": "ID of the batch.",
          "$ref": "#/$defs/ResourceID"
        },
        "treatment": {
          "$ref": "#/$defs/BatchTreatmentType"
        }
      },
      "required": [
        "id",
        "treatment"
      ]
    },
    "BatchTreatmentType": {
      "type": "string",
      "deprecated": true,
      "description": "Deprecated: You can approve or reject on batch and individual level regardless of the treatment type.\n",
      "enum": [
        "INDIVIDUAL_PAYMENTS",
        "BATCH"
      ]
    },
    "CategoryPurpose": {
      "type": "string",
      "description": "ISO 20022 Category Purpose Code (ExternalCategoryPurpose1Code)."
    },
    "ChargeBearer": {
      "type": "string",
      "description": "Charge bearer specifies which party should bear the charges of the transaction.",
      "enum": [
        "SHARED",
        "DEBTOR",
        "CREDITOR",
        "SERVICE_LEVEL"
      ]
    },
    "CitiWorldlinkInstrument": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/$defs/InstrumentType"
        },
        "citiWorldlinkId": {
          "type": "string",
          "description": "The WorldLink ID assigned to the account to initiate payments."
        }
      },
      "required": [
        "type",
        "citiWorldlinkId"
      ]
    },
    "CountryCode": {
      "type": "string",
      "description": "Two-letter ISO 3166-1 alpha2 country code.",
      "minLength": 2,
      "maxLength": 2,
      "pattern": "^[A-Z]{2,2}$"
    },
    "CountrySubdivision": {
      "type": "string",
      "description": "Country subdivision code (second part of the ISO 3166-2 code).\nE.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.\nISO 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.\nIn the USA the state code is required for domestic payments, in Canada the province code is required for domestic payments.",
      "maxLength": 6,
      "pattern": "^[A-Z]{2,2}-[A-Z0-9]{1,3}$"
    },
    "CreatedTimestamp": {
      "type": "string",
      "format": "date-time",
      "description": "Time at which the resource was created.",
      "readOnly": true
    },
    "CreditTransferSchemeType": {
      "type": "string",
      "description": "Payment scheme. Choose among: <ul>\n  <li><code>SCT</code> (<a href=\"https://www.europeanpaymentscouncil.eu/what-we-do/sepa-credit-transfer\">SEPA Credit\nTransfer</a>)</li>\n  <li><code>SCT_INST</code> (<a href=\"https://www.europeanpaymentscouncil.eu/what-we-do/sepa-instant-credit-transfer\">SEPA Instant\nCredit Transfer</a>)</li>\n  <li><code>CROSS_BORDER</code> (<a href=\"https://www.swift.com\">Swift</a>)</li>\n  <li><code>GB_CT_BACS</code> (UK account-to-account <a href=\"https://www.bacs.co.uk\">BACS</a>)\n  <li><code>GB_CT_CHAPS</code> (UK account-to-account <a\nhref=\"https://www.bankofengland.co.uk/payment-and-settlement/chaps\">CHAPS</a>)</li>\n  <li><code>GB_CT_FPS</code> (UK account-to-account <a\nhref=\"https://www.wearepay.uk/what-we-do/payment-systems/faster-payment-system/\">Faster Payments</a>)</li>\n  <li><code>SE_A2A</code> (Swedish account-to-account)</li>\n  <li><code>SE_GIRO</code> (Swedish <a href=\"https://www.bankgirot.se\">Bankgiro</a> and/or <a\nhref=\"https://en.wikipedia.org/wiki/PlusGirot\">PlusGiro</a>)</li>\n  <li><code>DK_A2A</code> (Danish account-to-account)</li>\n  <li><code>DK_CT_SAMEDAY</code> (Danish same-day credit transfer)</li>\n  <li><code>DK_CT_INST</code> (Danish instant credit transfer)</li>\n  <li><code>DK_CT_FIK71</code> (Danish FIK71 credit transfer)</li>\n  <li><code>DK_CT_FIK73</code> (Danish FIK73 credit transfer)</li>\n  <li><code>DK_CT_FIK75</code> (Danish FIK75 credit transfer)</li>\n  <li><code>DK_CT_NEMKONTO</code> (Danish NemKonto credit transfer)</li>\n  <li><code>DK_CT_T2</code> (Danish T2 credit transfer)</li>\n  <li><code>CH_CT</code> (Swiss account-to-account)</li>\n  <li><code>NO_CT</code> (Norwegian account-to-account)</li>\n  <li><code>NO_CT_KID</code> (Norwegian KID payment)</li>\n  <li><code>US_CT_ACH</code> (US ACH)</li>\n  <li><code>US_CT_WIRE</code> (US Wire)</li>\n  <li><code>IS_CT</code> (Icelandic account-to-account)</li>\n  <li><code>AU_CT</code> (Australian account-to-account)</li>\n  <li><code>AU_CT_BECS</code> (Australian BECS)</li>\n  <li><code>AU_CT_BPAY</code> (Australian <a href=\"https://www.bpay.com.au/\">BPAY</a>)</li>\n  <li><code>HK_CT</code> (Hong Kong account-to-account)</li>\n  <li><code>HK_CT_CHATS</code> (Hong Kong CHATS)</li>\n  <li><code>HK_CT_FPS</code> (Hong Kong Faster Payment System)</li>\n  <li><code>IL_CT</code> (Israel account-to-account)</li>\n  <li><code>SG_CT</code> (Singapore account-to-account)</li>\n  <li><code>SG_CT_FAST</code> (Singapore FAST)</li>\n  <li><code>SG_CT_GIRO</code> (Singapore Giro)</li>\n  <li><code>SG_CT_MEPS</code> (Singapore MEPS+)</li>\n  <li><code>BG_CT</code> (Bulgarian account-to-account)</li>\n  <li><code>CL_CT</code> (Chilean account-to-account)</li>\n  <li><code>CO_CT</code> (Colombian account-to-account)</li>\n  <li><code>CR_CT</code> (Costa Rican account-to-account)</li>\n  <li><code>CZ_CT</code> (Czech account-to-account)</li>\n  <li><code>MX_CT</code> (Mexican account-to-account)</li>\n  <li><code>MX_CT_SPID</code> (Mexican account-to-account SPID USD)</li>\n  <li><code>MX_CT_SPEI</code> (Mexican SPEI)</li>\n  <li><code>MX_CT_TEF</code> (Mexican TEF)</li>\n  <li><code>MY_CT_IBG</code> (Malaysian Interbank GIRO)</li>\n  <li><code>MY_CT_RENTAS</code> (Malaysian RENTAS)</li>\n  <li><code>KR_CT</code> (South Korean account-to-account)</li>\n  <li><code>TH_CT</code> (Thai account-to-account)</li>\n  <li><code>CA_CT_LYNX</code> (Canadian Lynx credit transfer)</li>\n  <li><code>CA_CT_ACSS</code> (Canadian ACSS credit transfer)</li>\n  <li><code>PE_CT</code> (Peruvian account-to-account)</li>\n  <li><code>PL_CT</code> (Polish account-to-account)</li>\n  <li><code>RO_CT</code> (Romanian account-to-account)</li>\n  <li><code>TR_CT</code> (Turkish account-to-account)</li>\n  <li><code>AE_CT</code> (UAE account-to-account)</li>\n  <li><code>AE_CT_IPI</code> (UAE Instant Payment Instruction)</li>\n  <li><code>DE_CT</code> (Legacy German account-to-account)</li>\n  <li><code>FR_CT</code> (Legacy French account-to-account)</li>\n  <li><code>IN_IMPS</code> (India Immediate Payment Service)</li>\n  <li><code>IN_NEFT</code> (India National Electronic Funds Transfer)</li>\n  <li><code>IN_RTGS</code> (India Real-Time Gross Settlement)</li>\n  <li><code>BR_CT_PIX</code> (Brazilian <a href=\"https://www.bcb.gov.br/en/financialstability/pix_en\">PIX</a>)</li>\n  <li><code>BR_CT_TED</code> (Brazilian <a href=\"https://www.bcb.gov.br/meubc/faqs/p/o-que-e-transferencia-eletronica-disponivel-ted\">TED</a>))</li>\n  <li><code>BOOK_TRANSFER</code> (Book Transfer)</li>\n  <li><code>CN_CT_BEPS</code> (Chinese Bulk Electronic Payment System)</li>\n  <li><code>CN_CT_HVPS</code> (Chinese High Value Payment System)</li>\n  <li><code>VN_CT</code> (Vietnamese account-to-account)</li>\n  <li><code>PH_CT_PESONET</code> (Philippines PESONet)</li>\n  <li><code>PH_CT_INSTAPAY</code> (Philippines InstaPay)</li>\n  <li><code>PH_CT_PHILPASS</code> (Philippines PhilPaSS)</li>\n  <li><code>PH_CT_PDDTS</code> (Philippines Domestic Dollar Transfer System)</li>\n  <li><code>RS_CT</code> (Serbian account-to-account)</li>\n  <li><code>JP_CT</code> (Japanese account-to-account)</li>\n  <li><code>MU_CT</code> (Mauritian account-to-account)</li>\n  <li><code>KE_CT_RTGS</code> (Kenya Real-Time Gross Settlement)</li>\n  <li><code>GE_CT_RTGS</code> (Georgia Real-Time Gross Settlement)</li>\n  <li><code>ZA_CT_EFT</code> (South African domestic EFT)</li>\n  <li><code>BD_CT_BEFTN</code> (Bangladesh Electronic Funds Transfer Network)</li>\n  <li><code>BD_CT_RTGS</code> (Bangladesh Real-Time Gross Settlement)</li>\n  <li><code>MA_CT</code> (Moroccan account-to-account)</li>\n  <li><code>SA_CT_SARIE</code> (Saudi Arabian SARIE)</li>\n</ul>",
      "enum": [
        "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",
        "DK_CT_T2",
        "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",
        "HK_CT_CHATS",
        "HK_CT_FPS",
        "IL_CT",
        "SG_CT",
        "SG_CT_FAST",
        "SG_CT_GIRO",
        "SG_CT_MEPS",
        "BG_CT",
        "CL_CT",
        "CO_CT",
        "CR_CT",
        "CZ_CT",
        "MX_CT",
        "MX_CT_SPID",
        "MX_CT_SPEI",
        "MX_CT_TEF",
        "MY_CT_IBG",
        "MY_CT_RENTAS",
        "KR_CT",
        "TH_CT",
        "CA_CT_LYNX",
        "CA_CT_ACSS",
        "PE_CT",
        "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_BEPS",
        "CN_CT_HVPS",
        "VN_CT",
        "PH_CT_PESONET",
        "PH_CT_INSTAPAY",
        "PH_CT_PHILPASS",
        "PH_CT_PDDTS",
        "RS_CT",
        "JP_CT",
        "MU_CT",
        "KE_CT_RTGS",
        "GE_CT_RTGS",
        "ZA_CT_EFT",
        "BD_CT_BEFTN",
        "BD_CT_RTGS",
        "MA_CT",
        "SA_CT_SARIE"
      ]
    },
    "CurrencyCode": {
      "type": "string",
      "description": "Three-letter ISO 4217 currency code.",
      "minLength": 3,
      "maxLength": 3,
      "pattern": "^[A-Z]{3,3}$"
    },
    "Date": {
      "type": "string",
      "format": "date",
      "description": "`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`."
    },
    "ETag": {
      "type": "string",
      "description": "[ETag](https://en.wikipedia.org/wiki/HTTP_ETag) based on the\nresource version. This can be passed along in `If-Match` HTTP\nheader when updating a resource to perform a conditional\nupdate.",
      "pattern": "^version:\\d{1,4}$",
      "readOnly": true
    },
    "ExternalAccountSnapshot": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/$defs/AccountType",
          "readOnly": true
        },
        "id": {
          "description": "ID of the External Account.",
          "$ref": "#/$defs/ResourceID"
        },
        "externalId": {
          "$ref": "#/$defs/ExternalID",
          "description": "External ID of the External Account."
        },
        "organizationId": {
          "$ref": "#/$defs/OrganizationID"
        },
        "market": {
          "$ref": "#/$defs/MarketCode",
          "readOnly": true
        },
        "identifiers": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AccountIdentifier"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true
        },
        "routing": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/RoutingIdentifier"
          },
          "uniqueItems": true,
          "readOnly": true,
          "x-omitempty": true
        }
      },
      "required": [
        "type",
        "id",
        "organizationId",
        "market",
        "identifiers"
      ]
    },
    "ExternalID": {
      "type": "string",
      "pattern": "^[a-zA-Z0-9._\\-+=]{1,64}$",
      "description": "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:`.",
      "x-omitempty": true
    },
    "InlineExternalAccountSnapshot": {
      "type": "object",
      "description": "A destination account that was defined inline on the payment instruction. It does not refer to an `ExternalAccount` or any other resource, and therefore has no `id`.",
      "properties": {
        "type": {
          "$ref": "#/$defs/AccountType",
          "readOnly": true
        },
        "organizationId": {
          "$ref": "#/$defs/OrganizationID"
        },
        "market": {
          "$ref": "#/$defs/MarketCode",
          "readOnly": true
        },
        "identifiers": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AccountIdentifier"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true
        },
        "routing": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/RoutingIdentifier"
          },
          "uniqueItems": true,
          "readOnly": true,
          "x-omitempty": true
        }
      },
      "required": [
        "type",
        "organizationId",
        "market",
        "identifiers"
      ]
    },
    "Instrument": {
      "type": "object",
      "description": "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.",
      "oneOf": [
        {
          "$ref": "#/$defs/CitiWorldlinkInstrument"
        },
        {
          "$ref": "#/$defs/USACHInstrument"
        }
      ]
    },
    "InstrumentType": {
      "type": "string",
      "description": "The type of the payment instrument.",
      "enum": [
        "US_ACH",
        "CITI_WORLDLINK"
      ]
    },
    "MarketCode": {
      "type": "string",
      "description": "Two-letter ISO 3166-1 alpha2 country code.",
      "minLength": 2,
      "maxLength": 2,
      "pattern": "^[A-Z]{2,2}$"
    },
    "Metadata": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": "string"
      },
      "description": "Metadata is a `string-string` key-value container that\ncan be used to store information known at the time of resource\ncreation. This can be retrieved later on, for instance when a\npayment or expected transaction is reconciled with the booked\ntransaction on the bank statement.\n\nMetadata can have at most 20 entries. Keys may have a\nmaximum length of 64 chars and values a maximum length of 512\nchars.\n\nBy default, this field is optional. It is possible to make it\nrequired in the Atlar Dashboard by visiting the [Metadata keys\npage](https://app.atlar.com/metadata-keys). Requirement rules\ncan be specified per API resource. Both the Dashboard and the\nAPI will then enforce these rules and give validation errors\nwhen the required fields are not set.",
      "maxProperties": 20,
      "x-omitempty": true
    },
    "NationalIdentifier": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Type of the national identifier.",
          "enum": [
            "CIVIC",
            "COMPANY"
          ]
        },
        "market": {
          "$ref": "#/$defs/MarketCode"
        },
        "number": {
          "type": "string",
          "description": "The identifier itself."
        }
      },
      "required": [
        "type",
        "market",
        "number"
      ]
    },
    "OrganizationID": {
      "type": "string",
      "description": "Unique resource identifier for an Organization."
    },
    "PartyType": {
      "type": "string",
      "description": "The legal type of a party",
      "enum": [
        "INDIVIDUAL",
        "COMPANY"
      ]
    },
    "PaymentApprovalStep": {
      "type": "object",
      "properties": {
        "id": {
          "description": "The ID of this step. Used when approving/rejecting.",
          "type": "string",
          "readOnly": true
        },
        "approvalChainId": {
          "description": "The ID of the approval chain that triggered this approval step.",
          "type": "string",
          "readOnly": true
        },
        "requiredRoleIds": {
          "type": "array",
          "description": "IDs of the Roles that can approve/reject. Not specified if the step was automatically approved based on an auto-approval chain.",
          "items": {
            "type": "string"
          },
          "maxItems": 10,
          "uniqueItems": true,
          "readOnly": true,
          "x-omitempty": true
        },
        "status": {
          "description": "The status of the approval step. `PENDING` if step is not yet interacted with.",
          "$ref": "#/$defs/ApprovalStatus",
          "readOnly": true
        },
        "approver": {
          "description": "User information about the user who approved/rejected. Omitted if step is not yet approved/rejected.",
          "$ref": "#/$defs/UserAuditInfo",
          "readOnly": true
        },
        "updated": {
          "description": "Timestamp when approved/rejected. Omitted if the step is not yet approved/rejected.",
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "autoApproved": {
          "type": "boolean"
        },
        "allowCreatorApproval": {
          "description": "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.",
          "type": "boolean",
          "readOnly": true
        },
        "sequentialApproval": {
          "type": "boolean",
          "description": "If true, the approval steps for this approval chain, specified by `approvalChainId`, need to be approved in the the order specified by `sequenceNumber`.",
          "readOnly": true
        },
        "sequenceNumber": {
          "type": "integer",
          "description": "The sequence number of this step in the approval chain.",
          "readOnly": true
        }
      },
      "required": [
        "id",
        "status",
        "approvalChainId",
        "autoApproved"
      ]
    },
    "PaymentReference": {
      "type": "string",
      "description": "This reference will be sent to the destination bank and recipient. (This type of reference is sometimes also referred to as remittance information.)",
      "maxLength": 140
    },
    "PaymentStatus": {
      "description": "Status of a payment. Applicable to both credit transfer payments and direct debit payments.",
      "type": "string",
      "enum": [
        "CREATED",
        "APPROVED",
        "REJECTED",
        "PENDING_SUBMISSION",
        "SENT",
        "PENDING_AT_BANK",
        "ACCEPTED",
        "EXECUTED",
        "FAILED",
        "RETURNED",
        "UNKNOWN"
      ]
    },
    "PaymentStatusReason": {
      "description": "Reason for the status of a payment.",
      "type": "object",
      "properties": {
        "code": {
          "description": "Failure reason code. If present, this is a <a href=\"https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets\">ISO 20022 error code</a>.",
          "type": "string",
          "readOnly": true
        },
        "description": {
          "description": "Human readable description of the reason. Can be presented to an end-user.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "RegulatoryReportingDetails": {
      "type": "object",
      "properties": {
        "market": {
          "$ref": "#/$defs/MarketCode"
        },
        "indicator": {
          "$ref": "#/$defs/RegulatoryReportingIndicator"
        },
        "code": {
          "description": "The actual code to report. Codes are market-specific and found on https://docs.atlar.com",
          "type": "string"
        }
      },
      "required": [
        "market",
        "indicator",
        "code"
      ]
    },
    "RegulatoryReportingIndicator": {
      "type": "string",
      "description": "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`).",
      "enum": [
        "CREDITOR",
        "DEBTOR",
        "BOTH"
      ]
    },
    "RemittanceType": {
      "type": "string",
      "description": "The kind of reference carried by a payment's remittance information.\n\n- `UNSTRUCTURED`: free-text remittance information, carried on\n  pain.001 as `<RmtInf><Ustrd>`.\n- `CREDITOR_REFERENCE`: a structured creditor reference such as\n  ISO 11649 (RF), Finnish Viitenumero, Norwegian KID, or Swedish\n  Bankgiro/Plusgiro OCR. Carried on pain.001 as\n  `<RmtInf><Strd><CdtrRefInf>` with `<Cd>SCOR</Cd>`.\n- `STRUCTURED`: **deprecated** — use `CREDITOR_REFERENCE` instead.\n  Retained so existing persisted records still parse.\n",
      "enum": [
        "STRUCTURED",
        "UNSTRUCTURED",
        "CREDITOR_REFERENCE"
      ]
    },
    "ResourceID": {
      "type": "string",
      "description": "Unique resource identifier.",
      "minLength": 32,
      "maxLength": 64
    },
    "ResourceVersion": {
      "type": "integer",
      "description": "Resource version. Starts at value `1` when the resource is\ncreated and increases by one for each successive update.",
      "minimum": 1,
      "readOnly": true
    },
    "RoutingConstraints": {
      "description": "Constraints on a `RoutingIdentifier`.",
      "type": "object",
      "properties": {
        "accountNumberType": {
          "$ref": "#/$defs/AccountIdentifierType",
          "x-go-type-skip-optional-pointer": true
        },
        "scheme": {
          "type": "string"
        }
      }
    },
    "RoutingIdentifier": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/$defs/RoutingIdentifierType"
        },
        "number": {
          "type": "string",
          "description": "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.",
          "minLength": 1,
          "maxLength": 255
        },
        "invalid": {
          "type": "boolean",
          "description": "Will be `true` if the routing identifier is invalid according to Atlar validation rules.",
          "readOnly": true
        },
        "constraints": {
          "$ref": "#/$defs/RoutingConstraints"
        }
      },
      "required": [
        "type",
        "number"
      ]
    },
    "RoutingIdentifierType": {
      "type": "string",
      "enum": [
        "BIC",
        "AT_BLZ",
        "AU_BSB",
        "BD_BRN",
        "BR_BRANCH",
        "BR_COMPE",
        "BR_ISP",
        "CA_CPA",
        "CH_BCC",
        "CH_SIC",
        "CL_SBIF",
        "CN_APS",
        "CZ_NBC",
        "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",
        "PH_BRSTN",
        "PL_KNR",
        "PT_NCC",
        "RU_CBC",
        "SE_SBA",
        "SG_IBG",
        "TH_CBC",
        "TW_NCC",
        "US_ABA",
        "US_PID",
        "VN_CITAD",
        "ZA_NCC"
      ],
      "description": "A routing identifier of type `BIC` must be provided to support cross-border/SWIFT payments."
    },
    "SchemeDetails": {
      "type": "object",
      "properties": {
        "instrument": {
          "$ref": "#/$defs/Instrument"
        },
        "intraCompany": {
          "type": "boolean",
          "description": "Whether the payment is between companies within the same group."
        },
        "initiatorId": {
          "type": "string"
        },
        "urgency": {
          "$ref": "#/$defs/SchemeDetailsUrgency"
        }
      }
    },
    "SchemeDetailsUrgency": {
      "type": "string",
      "description": "The urgency of the payment.",
      "enum": [
        "HIGH"
      ]
    },
    "TaxDetails": {
      "type": "object",
      "description": "Tax payment details for split payment schemes.",
      "properties": {
        "type": {
          "$ref": "#/$defs/TaxDetailsType"
        },
        "amount": {
          "$ref": "#/$defs/Amount"
        },
        "creditorId": {
          "type": "string"
        },
        "invoiceNumber": {
          "type": "string"
        }
      },
      "required": [
        "type",
        "amount"
      ]
    },
    "TaxDetailsType": {
      "type": "string",
      "description": "Type of tax payment scheme.",
      "enum": [
        "PL_MPP"
      ]
    },
    "USACHInstrument": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/$defs/InstrumentType"
        },
        "usAchCompanyId": {
          "type": "string",
          "description": "The US ACH Company ID assigned to the account to initiate US ACH payments."
        },
        "usAchCompanyName": {
          "type": "string",
          "description": "Optional US ACH Company Name override. When set, it is used as the debtor name (Dbtr/Nm)\non outgoing US ACH payments from this account instead of the account holder's legal name.\nOnly used for US ACH payments.\n"
        },
        "usAchImmediateOrigin": {
          "type": "string",
          "description": "Optional US ACH Immediate Origin. When set, it populates the Immediate Origin field of the\nNACHA file header instead of the US ACH Company ID. Some banks assign an Immediate Origin\nthat is distinct from the Company ID. Only used for US ACH payments.\n"
        }
      },
      "required": [
        "type",
        "usAchCompanyId"
      ]
    },
    "UpdatedTimestamp": {
      "type": "string",
      "format": "date-time",
      "description": "Time at which the resource was last updated.",
      "readOnly": true
    },
    "UserAuditInfo": {
      "type": "object",
      "description": "User information for audit trail.",
      "properties": {
        "id": {
          "$ref": "#/$defs/ResourceID",
          "description": "User ID"
        },
        "username": {
          "type": "string",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "description": "User given name(s) information. May be a concatenation of firstname, lastname etc.",
          "readOnly": true
        },
        "roleId": {
          "type": "string",
          "description": "Role ID",
          "readOnly": true
        }
      },
      "required": [
        "id",
        "username"
      ]
    }
  }
}