title: PaymentIdentification13
description: |
  Provides further means of referencing a payment transaction.
type: object
additionalProperties: false
properties:
  InstrId:
    allOf:
      - $ref: ./ULIDIdentifier.yaml
      - description: |
          InstructionIdentification (FSPIOP equivalent: transactionRequestId)

          Definition: Unique identification, as assigned by an instructing party for an instructed party, to
          unambiguously identify the instruction.

          Usage: The instruction identification is a point to point reference that can be used between the
          instructing party and the instructed party to refer to the individual instruction. It can be included in
          several messages related to the instruction.

          This field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.
  EndToEndId:
    allOf:
      - $ref: ./ULIDIdentifier.yaml
      - description: |
          EndToEndIdentification (FSPIOP equivalent: transactionId)

          Definition: Unique identification, as assigned by the initiating party, to unambiguously identify the
          transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

          Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the
          transaction. It can be included in several messages related to the transaction.

          Usage: In case there are technical limitations to pass on multiple references, the end-to-end
          identification must be passed on throughout the entire end-to-end chain.

          This field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.
  TxId:
    allOf:
      - $ref: ./ULIDIdentifier.yaml
      - description: |
          TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)

          Definition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the
          transaction that is passed on, unchanged, throughout the entire interbank chain.

          Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to
          the transaction on the interbank level.

          Usage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.

          This field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.
  UETR:
    allOf:
      - $ref: ./UUIDv4Identifier.yaml
      - description: >
          UETR

          Universally unique identifier to provide an end-to-end reference of a payment transaction.
  ClrSysRef:
    allOf:
      - $ref: ./Max35Text.yaml
      - description: >
          ClearingSystemReference

          Unique reference, as assigned by a clearing system, to unambiguously identify the
          instruction.
required:
  - TxId
example:
  InstrId: INSTRUCTIONID
  EndToEndId: ENDTOENDID
  TxId: TRANSACTIONID
  UETR: 123e4567-e89b-12d3-a456-426614174000
  ClrSysRef: CLRSYSREF