basePath: /corporate/
definitions:
  ActiveOrHistoricCurrencyAndAmount:
    description: A number of monetary units specified in an active or a historic currency
      where the unit of currency is explicit and compliant with ISO 4217.
    properties:
      amount:
        description: Amount of the transfer
        example: 20.59
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      currency:
        description: Currency of the amount.
        example: EUR
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    required:
    - amount
    - currency
    title: ActiveOrHistoricCurrencyAndAmount
    type: object
  Amount:
    description: A number of monetary units specified in an active or a historic currency
      where the unit of currency is explicit and compliant with ISO 4217.
    properties:
      amount:
        description: Amount of the transfer.
        example: 680
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      currency:
        description: Currency of the amount.
        example: CAD
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    required:
    - amount
    - currency
    title: Amount
    type: object
  ChargeAmount:
    description: Amount charged for processing the payment.
    properties:
      amount:
        description: Amount charged for processing the payment.
        example: 5
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      currency:
        description: Currency of the amount charged for processing the payment.
        example: USD
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    required:
    - amount
    - currency
    title: ChargeAmount
    type: object
  ConfirmedAmount:
    description: Specifies the actual amount that has been paid to the ultimate beneficiary,
      after all charges etc... have been deducted.
    properties:
      amount:
        description: Amount of the transfer.
        example: 0
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      currency:
        description: Currency of the amount.
        example: USD
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    required:
    - amount
    - currency
    title: ConfirmedAmount
    type: object
  Contact4:
    description: Specifies the details of the contact person.
    properties:
      department:
        description: Specifies a character string with a maximum length of 70characters.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      email_address:
        description: Specifies a character string with a maximum length of 2048 characters.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      email_purpose:
        description: Specifies a character string with a maximum length of 35 characters.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      fax_number:
        description: The collection of information which identifies a specific phone
          or FAX number as defined by telecom services. It consists of a "+" followed
          by the country code (from 1 to 3 characters) then a "-" and finally, any
          combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      job_title:
        description: Specifies a character string with a maximum length of 35 characters.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      mobile_number:
        description: The collection of information which identifies a specific phone
          or FAX number as defined by telecom services. It consists of a "+" followed
          by the country code (from 1 to 3 characters) then a "-" and finally, any
          combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      name:
        description: Specifies a character string with a maximum length of 140 characters.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      name_prefix:
        description: Specifies the terms used to formally address a person.
        enum:
        - DOCT
        - MADM
        - MISS
        - MIST
        - MIKS
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      other:
        description: Specifies other contact information.
        items:
          $ref: '#/definitions/OtherContact1'
        type: array
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      phone_number:
        description: The collection of information which identifies a specific phone
          or FAX number as defined by telecom services. It consists of a "+" followed
          by the country code (from 1 to 3 characters) then a "-" and finally, any
          combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      preferred_method:
        description: Specifies preferred contact method.
        enum:
        - LETT
        - MAIL
        - PHON
        - FAXX
        - CELL
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      responsibility:
        description: Specifies a character string with a maximum length of 35 characters.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: Contact4
    type: object
  Creditor:
    description: Party to which an amount of money is due.
    properties:
      any_bic:
        description: Specifies the identification of a person or an organisation by
          BIC code.
        example: BICBANKXXXX
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      name:
        description: Specifies the identification of a person or an organisation by
          name.
        example: Jakob Thomsen
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: Creditor
    type: object
  CreditorAccount:
    description: Unambiguous identification of the account of the creditor to which
      a credit entry will be posted as a result of the payment transaction.
    properties:
      identification:
        $ref: '#/definitions/CreditorIdentification'
        description: Specifies the unique identification of an account as assigned
          by the account service.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: CreditorAccount
    type: object
  CreditorIdentification:
    description: Specifies the unique identification of an account as assigned by
      the account service.
    properties:
      iban:
        description: Creditor account in IBAN format.
        example: HU93116000060000000012345676
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      identification:
        description: Creditor other account identification ex. BBAN.
        example: 1.1600001e+24
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: CreditorIdentification
    type: object
  CreditorReferenceInformation:
    description: Reference information provided by the creditor to allow the identification
      of the underlying documents.
    properties:
      reference:
        description: Unique reference, as assigned by the Creditor, to unambiguously
          refer to the payment transaction.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      type:
        $ref: '#/definitions/CreditorReferenceType'
        description: Specifies the type of Creditor Reference.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: CreditorReferenceInformation
    type: object
  CreditorReferenceType:
    description: Specifies the type of creditor reference.
    properties:
      code_or_proprietary:
        $ref: '#/definitions/CreditorReferenceTypeChoice'
        description: Code or Proprietary value under Type. Proprietary value is used
          within some communities where the embedded codes from the Usage Guideline
          do not cover the use case.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      issuer:
        description: Field used to further identify the type of Creditor Reference
          supplied.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: CreditorReferenceType
    type: object
  CreditorReferenceTypeChoice:
    description: Specifies the type of document referred by the creditor.
    properties:
      code:
        description: Code used to identify Creditor Reference Type.
        enum:
        - RADM
        - RPIN
        - FXDR
        - DISP
        - PUOR
        - SCOR
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      proprietary:
        description: Proprietary value is used within some communities where the embedded
          codes from the Usage Guideline do not cover the required use case.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: CreditorReferenceTypeChoice
    type: object
  DatePeriod:
    description: Range of time defined by a start date and an end date.
    properties:
      from_date:
        description: Start date for defined range of time.
        format: date-time
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      to_date:
        description: End date for defined range of time.
        format: date-time
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: DatePeriod
    type: object
  Debtor:
    description: Party that owes an amount of money to the (ultimate) creditor.
    properties:
      any_bic:
        description: Specifies the identification of a person or an organisation by
          BIC code.
        example: BICBANKXXXX
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      name:
        description: Specifies the identification of a person or an organisation by
          name.
        example: Jakob Thomsen
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: Debtor
    type: object
  DebtorAccount:
    description: Unambiguous identification of the account of the debtor to which
      a debit entry will be made as a result of the transaction.
    properties:
      identification:
        $ref: '#/definitions/DebtorIdentification'
        description: Specifies the unique identification of an account as assigned
          by the account service.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: DebtorAccount
    type: object
  DebtorIdentification:
    description: Specifies the unique identification of an account as assigned by
      the account service.
    properties:
      iban:
        description: Debtor account in IBAN format.
        example: NO6564520501507
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      identification:
        description: Debtor other account identification ex. BBAN.
        example: 64520501507
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: DebtorIdentification
    type: object
  DiscountAmountAndType:
    description: Specifies the amount with a specific type.
    properties:
      amount:
        $ref: '#/definitions/ActiveOrHistoricCurrencyAndAmount'
        description: Amount of money, which has been typed.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      type:
        $ref: '#/definitions/DiscountAmountAndTypeCodeAndProprietary'
        description: Specifies the type of the amount.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: DiscountAmountAndType
    type: object
  DiscountAmountAndTypeCodeAndProprietary:
    description: Specifies the amount type.
    properties:
      code:
        description: Specifies the amount type, in a coded form.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      proprietary:
        description: Specifies the amount type, in a free-text form.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: DiscountAmountAndTypeCodeAndProprietary
    type: object
  DocumentAdjustment:
    description: Set of elements used to provide information on the amount and reason
      of the document adjustment.
    properties:
      additional_information:
        description: Additional information on the amount and reason of the document
          adjustment.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      amount:
        $ref: '#/definitions/ActiveOrHistoricCurrencyAndAmount'
        description: Amount of the document adjustment.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      credit_debit_indicator:
        description: Specifies if an operation is an increase or a decrease.
        enum:
        - CRDT
        - DBIT
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      reason:
        description: Reason of the document adjustment.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: DocumentAdjustment
    type: object
  DocumentLineIdentification:
    description: Identifies the documents referred to in the remittance information.
    properties:
      number:
        description: Identification of the type specified for the  document line.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      related_date:
        description: Date associated with the document line.
        format: date-time
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      type:
        $ref: '#/definitions/DocumentLineType'
        description: Specifies the type of document line identification.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: DocumentLineIdentification
    type: object
  DocumentLineType:
    description: Specifies the type of the document line identification.
    properties:
      code:
        description: Line identification type in a coded form.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      issuer:
        description: Identification of the issuer of the document type.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: DocumentLineType
    type: object
  EquivalentAmount:
    description: Amount of money to be moved between the debtor and creditor, expressed
      in the currency of the debtor's account, and the currency in which the amount
      is to be moved.
    properties:
      amount:
        $ref: '#/definitions/Amount'
        description: A number of monetary units specified in an active or a historic
          currency where the unit of currency is explicit and compliant with ISO 4217.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      currency_of_transfer:
        description: Currency of the transfer.
        example: CAD
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    required:
    - amount
    - currency_of_transfer
    title: EquivalentAmount
    type: object
  ErrorPayload:
    description: Error response body
    properties:
      failures:
        description: More details on the occurred error
        items:
          $ref: '#/definitions/Failure'
        type: array
        x-availabilityStatus: Stable
      request:
        $ref: '#/definitions/RequestEcho'
        description: Error details
        x-availabilityStatus: Stable
    title: ErrorPayload
    type: object
  ErrorResponse:
    description: Error response
    properties:
      error:
        $ref: '#/definitions/ErrorPayload'
        description: Payload
        x-availabilityStatus: Stable
      group_header:
        $ref: '#/definitions/ResponseHeader'
        description: Standard format response header
        x-availabilityStatus: Stable
    title: ErrorResponse
    type: object
  ExchangeRateData:
    description: Contains the set of elements used to provide details of the currency
      exchange.
    properties:
      exchange_rate:
        description: Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.
        example: 1.36
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      source_currency:
        description: Source currency of the exchange rate.
        example: USD
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      target_currency:
        description: Target currency of the exchange rate.
        example: CAD
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    required:
    - exchange_rate
    - source_currency
    - target_currency
    title: ExchangeRateData
    type: object
  Failure:
    description: Validation error
    properties:
      code:
        description: Failure code
        type: string
        x-availabilityStatus: Stable
      description:
        description: Failure description
        type: string
        x-availabilityStatus: Stable
      path:
        description: JSON path of the failing element if applicable
        type: string
        x-availabilityStatus: Stable
      type:
        description: Type of the validation error, e.g. NotNull
        type: string
        x-availabilityStatus: Stable
    title: Failure
    type: object
  Garnishment:
    description: Provides remittance information about a payment for garnishment-related
      purposes.
    properties:
      date:
        description: Date of payment which garnishment was taken from.
        format: date-time
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      employee_termination_indicator:
        description: Indicates if the employment of the person to whom the garnishment
          applies (that is, the ultimate debtor) has been terminated.
        type: boolean
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      family_medical_insurance_indicator:
        description: Indicates if the person to whom the garnishment applies (that
          is, the ultimate debtor) has family medical insurance coverage available.
        type: boolean
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      garnishee:
        $ref: '#/definitions/PartyIdentification2'
        description: Ultimate party that owes an amount of money to the (ultimate)
          creditor, in this case, to the garnisher.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      garnishment_administrator:
        $ref: '#/definitions/PartyIdentification2'
        description: Party on the credit side of the transaction who administers the
          garnishment on behalf of the ultimate beneficiary.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      reference_number:
        description: Reference information that is specific to the agency receiving
          the garnishment.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      remitted_amount:
        $ref: '#/definitions/ActiveOrHistoricCurrencyAndAmount'
        description: Amount of money remitted for Garnishment.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      type:
        $ref: '#/definitions/GarnishmentType'
        description: Code or Proprietary value can be provided for garnishment type.
          If using a Code, then the following codes are available from the External
          code list. This is a mandatory field if Garnishment Remittance is provided.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: Garnishment
    type: object
  GarnishmentType:
    description: Specifies the type of garnishment.
    properties:
      code_or_proprietary:
        $ref: '#/definitions/GarnishmentTypeCode'
        description: Provides the type details of the garnishment.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      issuer:
        description: Identification of the issuer of the garnishment type.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: GarnishmentType
    type: object
  GarnishmentTypeCode:
    description: Specifies the garnishment type as published in an external document
      type code list.
    properties:
      code:
        description: Garnishment type in a coded form.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      proprietary:
        description: Proprietary identification of the type of garnishment.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: GarnishmentTypeCode
    type: object
  InstructedAmount:
    description: 'Specifies the amount of money to be moved between the debtor and
      creditor, before deduction of charges, expressed in the currency as ordered
      by the initiating party. Usage: This amount has to be transported unchanged
      through the transaction chain.'
    properties:
      amount:
        description: Amount of the transfer.
        example: 500
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      currency:
        description: Currency of the amount.
        example: USD
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    required:
    - amount
    - currency
    title: InstructedAmount
    type: object
  InterbankSettlementAmount:
    description: Amount of money moved between the instructing agent and the instructed
      agent.
    properties:
      amount:
        description: Amount of the transfer.
        example: 500
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      currency:
        description: Currency of the amount.
        example: USD
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    required:
    - amount
    - currency
    title: InterbankSettlementAmount
    type: object
  LineDetails:
    description: Set of elements used to provide the content of the referred document
      line.
    properties:
      amount:
        $ref: '#/definitions/RemittanceAmount'
        description: Provides details on the amounts of the document line.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      description:
        description: Description associated with the document line.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      identification:
        description: Provides identification of the document line.
        items:
          $ref: '#/definitions/DocumentLineIdentification'
        type: array
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: LineDetails
    type: object
  Link:
    description: Context specific link (only GET supported)
    properties:
      href:
        description: Relative path to the linked resource
        type: string
        x-availabilityStatus: Stable
      rel:
        description: Describes the nature of the link, e.g. 'details' for a link to
          the detailed information of a listed resource.
        type: string
        x-availabilityStatus: Stable
    title: Link
    type: object
  NameAndAddress:
    description: Information that locates and identifies a party.
    properties:
      address:
        $ref: '#/definitions/PostalAddress'
        description: Postal address
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      name:
        description: Specifies a character string with a maximum length of 140 characters
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: NameAndAddress
    type: object
  OtherContact1:
    description: Communication device number or electronic address used for communication.
    properties:
      channel_type:
        description: Specifies a character string with a maximum length of 4 characters.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      identification:
        description: Specifies a character string with a maximum length of 128 characters.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    required:
    - channel_type
    title: OtherContact1
    type: object
  PartyIdentification2:
    description: Specifies the identification of a person or an organisation.
    properties:
      contact_details:
        $ref: '#/definitions/Contact4'
        description: Communication device number or electronic address used for communication.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      country_of_residence:
        description: Specifies country of residence of a person or an organisation.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      identification:
        description: Specifies the identification of a person or an organisation.
        type: object
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      name:
        description: Name of a person or an organisation.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      postal_address:
        $ref: '#/definitions/PostalAddress'
        description: Information that locates and identifies a specific address, as
          defined by postal services.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: PartyIdentification2
    type: object
  PaymentEvent:
    description: Groups the information of an event, namely of a payment message or
      status confirmation update. It is repeated as many times as there are events
      to be returned.
    properties:
      charge_amount:
        $ref: '#/definitions/ChargeAmount'
        description: Amount charged for processing the payment.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      charge_bearer:
        description: Specifies which party/parties will bear the charges associated
          with the processing of the payment transaction.
        example: CRED
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      exchange_rate_data:
        $ref: '#/definitions/ExchangeRateData'
        description: Contains the set of elements used to provide details of the currency
          exchange.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      from:
        description: Code allocated to a financial or non-financial institution.
        example: NDEANOKK
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      interbank_settlement_amount:
        $ref: '#/definitions/InterbankSettlementAmount'
        description: Amount of money moved between the instructing agent and the instructed
          agent.
        example: NDEANOKK
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      processing_date_time:
        description: Date time when payment instruction was processed.
        example: '2023-04-08T11:00:01.000Z'
        format: date-time
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      to:
        description: Code allocated to a financial or non-financial institution.
        example: BICBANKXXXX
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    required:
    - from
    - processing_date_time
    title: PaymentEvent
    type: object
  PaymentExternalResponse:
    description: Response which specifies the status of a single payment transaction.
    properties:
      group_header:
        $ref: '#/definitions/ResponseHeader'
        description: Standard format response header
        x-availabilityStatus: Stable
      response:
        $ref: '#/definitions/PaymentResponse'
        description: Payload
        x-availabilityStatus: Stable
    title: PaymentExternalResponse
    type: object
  PaymentListExternalResponse:
    description: List of responses which specifies the status of a single payment
      transaction.
    properties:
      group_header:
        $ref: '#/definitions/ResponseHeader'
        description: Standard format response header
        x-availabilityStatus: Stable
      response:
        $ref: '#/definitions/PaymentListResponse'
        description: Payload
        x-availabilityStatus: Stable
    title: PaymentListExternalResponse
    type: object
  PaymentListResponse:
    description: Response with list of payment transactions.
    properties:
      _links:
        description: 'HATEOAS inspired links: ''rel'' and ''href'''
        items:
          $ref: '#/definitions/Link'
        type: array
        x-availabilityStatus: Stable
      continuation_key:
        description: Resource listing may return a continuation_key if there are more
          results available. Request may be retried with the continuation_key in order
          to get more results.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      payment_list:
        description: List of payment transactions.
        items:
          $ref: '#/definitions/PaymentResponse'
        type: array
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: PaymentListResponse
    type: object
  PaymentResponse:
    description: Specifies the status of a single payment transaction.
    properties:
      _links:
        description: 'HATEOAS inspired links: ''rel'' and ''href'''
        items:
          $ref: '#/definitions/Link'
        type: array
        x-availabilityStatus: Stable
      confirmed_amount:
        $ref: '#/definitions/ConfirmedAmount'
        description: Specifies the actual amount that has been paid to the ultimate
          beneficiary, after all charges etc... have been deducted.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      confirmed_date:
        description: Specifies the date and time at which the funds are available,
          as reported in the ACCC status update.
        example: '2023-04-08T12:00:01.000Z'
        format: date-time
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      creditor:
        $ref: '#/definitions/Creditor'
        description: Ultimate party that owes an amount of money to the (ultimate)
          creditor.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      creditor_account:
        $ref: '#/definitions/CreditorAccount'
        description: Unambiguous identification of the account of the creditor to
          which a credit entry will be posted as a result of the payment transaction.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      creditor_agent:
        description: Financial institution servicing an account for the creditor.
        example: CREDGB22XXX
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      debit_confirmation_url_address:
        description: Address for a Univeral Resource Locator (URL), for example an
          address used over the www (HTTP) service that provides confirmation that
          the payment has debited an account.
        example: wwww.sampleurl.com
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      debtor:
        $ref: '#/definitions/Debtor'
        description: Party that owes an amount of money to the (ultimate) creditor.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      debtor_account:
        $ref: '#/definitions/DebtorAccount'
        description: Unambiguous identification of the account of the debtor to which
          a debit entry will be made as a result of the transaction.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      end_to_end_identification:
        description: 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.
        example: e2e-id-810104805
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      equivalent_amount:
        $ref: '#/definitions/EquivalentAmount'
        description: Amount of money to be moved between the debtor and creditor,
          expressed in the currency of the debtor's account, and the currency in which
          the amount is to be moved.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      instructed_amount:
        $ref: '#/definitions/InstructedAmount'
        description: 'Specifies the amount of money to be moved between the debtor
          and creditor, before deduction of charges, expressed in the currency as
          ordered by the initiating party. Usage: This amount has to be transported
          unchanged through the transaction chain.'
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      instruction_identification:
        description: Unique identification, as assigned by an instructing party for
          an instructed party, to unambiguously identify the instruction.
        example: 948109926091052
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      interbank_settlement_amount:
        $ref: '#/definitions/InterbankSettlementAmount'
        description: Amount of money moved between the instructing agent and the instructed
          agent.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      interbank_settlement_date:
        description: Date on which the amount of money ceases to be available to the
          agent that owes it and when the amount of money becomes available to the
          agent to which it is due.
        example: '2023-04-08'
        format: date
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      payment_event:
        description: Groups the information of an event, namely of a payment message
          or status confirmation update. It is repeated as many times as there are
          events to be returned.
        example: wwww.sampleurl.com
        items:
          $ref: '#/definitions/PaymentEvent'
        type: array
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      previously_confirmed_amount:
        $ref: '#/definitions/PreviouslyConfirmedAmount'
        description: Amount of money previously credited to the creditor and confirmed
          to the tracking system by the agent.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      purpose:
        description: Underlying reason for the payment transaction.
        example: SCVE
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      reject_return_reason:
        description: Provides detailed information on the reject/return reason.
        example: RJCT
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      remaining_to_be_confirmed_amount:
        $ref: '#/definitions/RemainingToBeConfirmedAmount'
        description: Amount of money remaining to be confirmed.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      remittance_information:
        $ref: '#/definitions/RemittanceInformation'
        description: Specifies the remittance resource for direct access to the remittance
          information. Either unstructured or structured is supplied.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      requested_execution_date:
        description: Date and time at which the initiating party requests the clearing
          agent to process the payment.
        example: '2023-04-08T12:00:01.000Z'
        format: date-time
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      service_level:
        description: "Agreement under which or rules under which the transaction should\
          \ be processed. \n* G003 - Outgoing payments.\n* G007 - Incoming payments."
        enum:
        - G003
        - G007
        example: outgoing
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      tracker_informing_party:
        description: Identifies the party that issues the status.
        example: BICBANKXXXX
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      transaction_status:
        description: Specifies the status of a single payment transaction.
        example: RJCT
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      transaction_status_date:
        description: Date time for the status.
        example: '2023-04-08T13:00:01.000Z'
        format: date-time
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      transaction_status_reason:
        description: "Specifies the status of a single payment transaction. \n* ACCC\
          \ - Settlement on the creditor's account has been completed. *ACCP-Preceding\
          \ check of technical validation was successful. Customer profile check was\
          \ also successful. * ACSC - Settlement on the debtor's account has been\
          \ completed.\nUsage : this can be used by the first agent to report to the\
          \ debtor that the transaction has been completed. Warning : this status\
          \ is provided for transaction status reasons, not for financial information.\
          \ It can only be used after bilateral agreement \n* ACSP - All preceding\
          \ checks such as technical validation and customer profile were successful\
          \ and therefore the payment initiation has been accepted for execution.\
          \ \n* PDNG - Payment initiation or individual transaction included in the\
          \ payment initiation is pending. Further checks and status update will be\
          \ performed. \n* RCVD - Payment initiation has been received by the receiving\
          \ agent. \n* RJCT - Payment initiation or individual transaction included\
          \ in the payment initiation has been rejected."
        example: G001
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      uetr:
        description: Unique End-to-End Transaction Reference.
        example: f1a7d5b4-8c3e-4e2f-93b0-6d2a8e1c9f5b
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      ultimate_creditor:
        $ref: '#/definitions/UltimateCreditor'
        description: Ultimate party to which an amount of money is due.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      ultimate_debtor:
        $ref: '#/definitions/UltimateDebtor'
        description: Ultimate party that owes an amount of money to the (ultimate)
          creditor.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    required:
    - payment_event
    - service_level
    - tracker_informing_party
    - transaction_status
    - uetr
    title: PaymentResponse
    type: object
  PostalAddress:
    description: Information that locates and identifies a specific address, as defined
      by postal services.
    properties:
      address_line:
        description: Address line
        items:
          type: string
        type: array
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      address_type:
        description: Specifies the type of address.
        type: object
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      building_name:
        description: Building name
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      building_number:
        description: Building number
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      country:
        description: Code to identify a country, a dependency, or another area of
          particular geopolitical interest, on the basis of country names obtained
          from the United Nations (ISO 3166, Alpha-2 code).
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      country_sub_division:
        description: Country sub-division
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      department:
        description: Department name
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      district_name:
        description: District Name
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      floor:
        description: Floor number
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      post_box:
        description: Post box
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      post_code:
        description: Postal code
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      room:
        description: Room number
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      street_name:
        description: Street name
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      sub_department:
        description: Sub-department
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      town_location_name:
        description: Town Location Name
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      town_name:
        description: Town name
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: PostalAddress
    type: object
  PreviouslyConfirmedAmount:
    description: Amount of money previously credited to the creditor and confirmed
      to the tracking system by the agent.
    properties:
      amount:
        description: Amount of the transfer.
        example: 0
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      currency:
        description: Currency of the transfer.
        example: USD
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    required:
    - amount
    - currency
    title: PreviouslyConfirmedAmount
    type: object
  ReferredDocumentInformation:
    description: Provides the identification and the content of the referred document.
    properties:
      line_details:
        description: Set of elements used to provide the content of the referred document
          line.
        items:
          $ref: '#/definitions/LineDetails'
        type: array
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      number:
        description: Unique and unambiguous identification of the referred document.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      related_date:
        description: 'A particular point in the progression of time in a calendar
          year expressed in the YYYY-MM-DD format. This representation is defined
          in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28
          October 2004" which is aligned with ISO 8601.'
        format: date-time
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      type:
        $ref: '#/definitions/ReferredDocumentType'
        description: Specifies the type of referred document.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: ReferredDocumentInformation
    type: object
  ReferredDocumentType:
    description: Specifies the type of the document referred in the remittance information.
    properties:
      code_or_proprietary:
        $ref: '#/definitions/ReferredDocumentTypeCode'
        description: Provides the type details of the referred document.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      issuer:
        description: Identification of the issuer of the reference document type.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: ReferredDocumentType
    type: object
  ReferredDocumentTypeCode:
    description: Specifies the type of the document referred in the remittance information.
    properties:
      code:
        description: Document type in a coded form.
        enum:
        - MSIN
        - CNFA
        - DNFA
        - CINV
        - CREN
        - DEBN
        - HIRI
        - SBIN
        - CMCN
        - SOAC
        - DISP
        - BOLD
        - VCHR
        - AROI
        - TSUT
        - PUOR
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      proprietary:
        description: Proprietary identification of the type of the referred document.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: ReferredDocumentTypeCode
    type: object
  RemainingToBeConfirmedAmount:
    description: Amount of money remaining to be confirmed.
    properties:
      amount:
        description: Amount of the transfer.
        example: 500
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      currency:
        description: Currency of the amount.
        example: USD
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    required:
    - amount
    - currency
    title: RemainingToBeConfirmedAmount
    type: object
  RemittanceAmount:
    description: Nature of the amount and currency on a document referred to in the
      remittance section, typically either the original amount due/payable or the
      amount actually remitted for the referenced document.
    properties:
      adjustment_amount_and_reason:
        description: Specifies detailed information on the amount and reason of the
          document adjustment.
        items:
          $ref: '#/definitions/DocumentAdjustment'
        type: array
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      credit_note_amount:
        $ref: '#/definitions/ActiveOrHistoricCurrencyAndAmount'
        description: Amount specified for the referred document is the amount of a
          credit note.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      discount_applied_amount:
        description: Amount specified for the referred document is the amount of discount
          to be applied to the amount due and payable to the creditor.
        items:
          $ref: '#/definitions/DiscountAmountAndType'
        type: array
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      due_payable_amount:
        $ref: '#/definitions/ActiveOrHistoricCurrencyAndAmount'
        description: Amount specified is the exact amount due and payable to the creditor.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      remitted_amount:
        $ref: '#/definitions/ActiveOrHistoricCurrencyAndAmount'
        description: Amount of money remitted for the referred document.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      tax_amount:
        description: Quantity of cash resulting from the calculation of the tax.
        items:
          $ref: '#/definitions/TaxAmountAndType'
        type: array
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: RemittanceAmount
    type: object
  RemittanceInformation:
    description: Specifies the remittance resource for direct access to the remittance
      information. Either unstructured or structured is supplied.
    properties:
      remittance_location:
        description: Provides information on the remittance advice.
        items:
          $ref: '#/definitions/RemittanceLocation'
        type: array
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      structured:
        description: Specifies the remittance resource for direct access to the remittance
          information. Either unstructured or structured is supplied.
        items:
          $ref: '#/definitions/StructuredRemittanceInformation'
        type: array
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      unstructured:
        description: Specifies the remittance resource for direct access to the remittance
          information. Either unstructured or structured is supplied.
        example: 'Payment for invoice #6682'
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: RemittanceInformation
    type: object
  RemittanceLocation:
    description: Provides information on the remittance advice.
    properties:
      remittance_identification:
        description: Specifies a character string with a maximum length of 35 characters.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      remittance_location_details:
        $ref: '#/definitions/RemittanceLocationDetails'
        description: Provides additional details on the remittance advice.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: RemittanceLocation
    type: object
  RemittanceLocationDetails:
    description: Provides details on the remittance advice.
    properties:
      electronic_address:
        description: Electronic address
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      method:
        description: Specifies the method used to deliver the remittance advice information.
        enum:
        - FAXI
        - EDDIC
        - URID
        - EMAL
        - POST
        - SMSM
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      postal_address:
        description: Information that locates and identifies a party.
        items:
          $ref: '#/definitions/NameAndAddress'
        type: array
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: RemittanceLocationDetails
    type: object
  RequestEcho:
    description: Original request information
    properties:
      url:
        description: Original request url
        type: string
        x-availabilityStatus: Stable
    title: RequestEcho
    type: object
  ResponseHeader:
    description: External response header
    properties:
      creation_date_time:
        description: Response creation time
        format: date-time
        type: string
        x-availabilityStatus: Stable
      http_code:
        description: HTTP code for response
        example: 200
        format: int32
        type: integer
        x-availabilityStatus: Stable
      message_identification:
        description: Original request id for correlation purposes
        type: string
        x-availabilityStatus: Stable
    title: ResponseHeader
    type: object
  StructuredRemittanceInformation:
    description: Information supplied to enable the matching/reconciliation of an
      entry with the items that the payment is intended to settle, such as commercial
      invoices in an accounts' receivable system, in a structured form.
    properties:
      additional_remittance_information:
        description: This element provides the ability to add information in free
          text form to complement the Structured Remittance Information
        items:
          type: string
        type: array
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      creditor_reference_information:
        $ref: '#/definitions/CreditorReferenceInformation'
        description: Used to provide a unique reference issued by the Creditor
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      garnishment_remittance:
        $ref: '#/definitions/Garnishment'
        description: Garnishment refers to a court-ordered process for collecting
          on a judgement, which takes money directly from the defendant's wages or
          other third party who owes the defendant a debt.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      invoicee:
        $ref: '#/definitions/PartyIdentification2'
        description: Identification of the party to whom an invoice is issued, when
          it is different from the debtor or ultimate debtor.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      invoicer:
        $ref: '#/definitions/PartyIdentification2'
        description: Identification of the organisation issuing the invoice, when
          it is different from the creditor or ultimate creditor.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      referred_document_amount:
        $ref: '#/definitions/RemittanceAmount'
        description: Details about the amounts of the Referred Documents or items
          listed under the creditor reference element.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      referred_document_information:
        description: Identification and the content of the Referred Document.
        items:
          $ref: '#/definitions/ReferredDocumentInformation'
        type: array
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      tax_remittance:
        $ref: '#/definitions/TaxInformation'
        description: Remittance information about a payment made for tax-related purposes.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: StructuredRemittanceInformation
    type: object
  TaxAmount:
    description: Set of elements used to provide information on the tax amount(s)
      of tax record.
    properties:
      details:
        description: Set of elements used to provide details on the tax period and
          amount.
        items:
          $ref: '#/definitions/TaxRecordDetails'
        type: array
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      rate:
        description: Rate used to calculate the tax.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      taxable_base_amount:
        $ref: '#/definitions/ActiveOrHistoricCurrencyAndAmount'
        description: Amount of money on which the tax is based.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      total_amount:
        $ref: '#/definitions/ActiveOrHistoricCurrencyAndAmount'
        description: Total amount that is the result of the calculation of the tax
          for the record.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: TaxAmount
    type: object
  TaxAmountAndType:
    description: Specifies the amount with a specific type.
    properties:
      amount:
        $ref: '#/definitions/ActiveOrHistoricCurrencyAndAmount'
        description: Amount of money, which has been typed.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      type:
        $ref: '#/definitions/TaxAmountAndTypeAndProprietary'
        description: Specifies the type of the amount.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: TaxAmountAndType
    type: object
  TaxAmountAndTypeAndProprietary:
    description: Specifies the amount type.
    properties:
      code:
        description: Specifies the amount type, in a coded form.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      proprietary:
        description: Specifies the amount type, in a free-text form.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: TaxAmountAndTypeAndProprietary
    type: object
  TaxAuthorisation:
    description: Details of the authorised tax paying party.
    properties:
      name:
        description: Name of the debtor or the debtor's authorised representative.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      title:
        description: Title or position of debtor or the debtor's authorised representative.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: TaxAuthorisation
    type: object
  TaxInformation:
    description: Details about tax paid, or to be paid, to the government in accordance
      with the law, including pre-defined parameters such as thresholds and type of
      account.
    properties:
      administration_zone:
        description: Territorial part of a country to which the tax payment is related.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      creditor:
        $ref: '#/definitions/TaxParty'
        description: Party on the credit side of the transaction to which the tax
          applies.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      date:
        description: Date by which tax is due.
        format: date-time
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      debtor:
        $ref: '#/definitions/TaxParty2'
        description: Party on the debit side of the transaction to which the tax applies.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      method:
        description: Method used to indicate the underlying business or how the tax
          is paid.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      record:
        description: Record of tax details.
        items:
          $ref: '#/definitions/TaxRecord'
        type: array
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      reference_number:
        description: Tax reference information that is specific to a taxing agency.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      sequence_number:
        description: Sequential number of the tax report.
        format: int32
        type: integer
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      total_tax_amount:
        $ref: '#/definitions/ActiveOrHistoricCurrencyAndAmount'
        description: Total amount of money as result of the calculation of the tax.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      total_taxable_base_amount:
        $ref: '#/definitions/ActiveOrHistoricCurrencyAndAmount'
        description: Total amount of money on which the tax is based.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      ultimate_debtor:
        $ref: '#/definitions/TaxParty2'
        description: Ultimate party that owes an amount of money to the (ultimate)
          creditor, in this case, to the taxing authority.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: TaxInformation
    type: object
  TaxParty:
    description: Details about the entity involved in the tax paid or to be paid.
    properties:
      registration_identification:
        description: Unique identification, as assigned by an organisation, to unambiguously
          identify a party.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      tax_identification:
        description: Tax identification number of the party.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      tax_type:
        description: Type of tax payer.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: TaxParty
    type: object
  TaxParty2:
    description: Details about the entity involved in the tax paid or to be paid.
    properties:
      authorisation:
        $ref: '#/definitions/TaxAuthorisation'
        description: Details of the authorised tax paying party.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      registration_identification:
        description: Unique identification, as assigned by an organisation, to unambiguously
          identify a party.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      tax_identification:
        description: Tax identification number of the party.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      tax_type:
        description: Type of tax payer.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: TaxParty2
    type: object
  TaxPeriod:
    description: Period of time details related to the tax payment.
    properties:
      from_to_date:
        $ref: '#/definitions/DatePeriod'
        description: Range of time between a start date and an end date for which
          the tax report is provided.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      type:
        description: Identification of the period related to the tax payment.
        enum:
        - MM01
        - MM02
        - MM03
        - MM04
        - MM05
        - MM06
        - MM07
        - MM08
        - MM09
        - MM10
        - MM11
        - MM12
        - QTR1
        - QTR2
        - QTR3
        - QTR4
        - HLF1
        - HLF2
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      year:
        description: Year related to the tax payment.
        format: date
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: TaxPeriod
    type: object
  TaxRecord:
    description: Set of elements used to define the tax record.
    properties:
      additional_information:
        description: Further details of the tax record.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      category:
        description: Specifies the tax code as published by the tax authority.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      category_details:
        description: Provides further details of the category tax code.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      certificate_identification:
        description: Identification number of the tax report as assigned by the taxing
          authority.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      debtor_status:
        description: Code provided by local authority to identify the status of the
          party that has drawn up the settlement document.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      forms_code:
        description: Identifies, in a coded form, on which template the tax report
          is to be provided.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      period:
        $ref: '#/definitions/TaxPeriod'
        description: Set of elements used to provide details on the period of time
          related to the tax payment.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      tax_amount:
        $ref: '#/definitions/TaxAmount'
        description: Set of elements used to provide information on the amount of
          the tax record.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      type:
        description: High level code to identify the type of tax details.
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: TaxRecord
    type: object
  TaxRecordDetails:
    description: Provides information on the individual tax amount(s) per period of
      the tax record.
    properties:
      amount:
        $ref: '#/definitions/ActiveOrHistoricCurrencyAndAmount'
        description: Set of elements used to provide information on the amount of
          the tax record.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      period:
        $ref: '#/definitions/TaxPeriod'
        description: Set of elements used to provide details on the period of time
          related to the tax payment.
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: TaxRecordDetails
    type: object
  UltimateCreditor:
    description: Ultimate party to which an amount of money is due.
    properties:
      any_bic:
        description: Specifies the identification of a person or an organisation by
          BIC code.
        example: BICBANKXXXX
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      name:
        description: Specifies the identification of a person or an organisation by
          name.
        example: Ultimate Beneficiary
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: UltimateCreditor
    type: object
  UltimateDebtor:
    description: Ultimate party that owes an amount of money to the (ultimate) creditor.
    properties:
      any_bic:
        description: Specifies the identification of a person or an organisation by
          BIC code.
        example: BICBANKXXXX
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      name:
        description: Specifies the identification of a person or an organisation by
          name.
        example: Jakob Productions
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
    title: UltimateDebtor
    type: object
host: api.nordeaopenbanking.com
info:
  contact:
    email: support@nordeaopenbanking.com
    name: Open Banking team
    url: https://nordeaopenbanking.com
  description: Payments Track And Trace API
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  title: Payments Track And Trace
  version: '1.1'
  x-ibm-name: payments-track-and-trace-v1
  x-version: '1.1'
paths:
  /premium/v1/gpi-tracker/payments/{service_level}:
    get:
      deprecated: false
      operationId: getPaymentsUsingGET
      parameters:
      - description: Bearer &lt;Access Token&gt; Token provided to TPP in authorization
          flow
        in: header
        name: Authorization
        required: true
        type: string
      - description: "A signature of request by the TPP on application level. The\
          \ process of signing a request is described in 'Signing HTTP Messages' RFC\
          \ draft version 10 (<a href=\"https://tools.ietf.org/html/draft-cavage-http-signatures-10\"\
          \ target=\"_blank\">https://tools.ietf.org/html/draft-cavage-http-signatures-10</a>).\
          \ The request signature needs to be sent in the 'Signature' HTTP header\
          \ as described in the RFC. Additional requirements from Nordea \n - The\
          \ only allowed algorithm is RSA-SHA256 \n- The key size for the used RSA\
          \ key pair has to be at least 2048 bit \n- The keyId is the clientId of\
          \ your application originating from the Nordea Developer Portal \n- We require\
          \ the following headers to be used in the signature \n* Request without\
          \ body: (request-target) X-Nordea-Originating-Host X-Nordea-Originating-Date\
          \ \n* Request with body: (request-target) X-Nordea-Originating-Host X-Nordea-Originating-Date\
          \ Content-type Digest \n* The request-target is a combination of the HTTP\
          \ action verb and the request URI path"
        in: header
        name: Signature
        required: true
        type: string
      - description: Id of the Client
        in: header
        name: X-IBM-Client-Id
        required: true
        type: string
      - description: Secret password generated for the Client
        in: header
        name: X-IBM-Client-Secret
        required: true
        type: string
      - description: 'HTTP header element for date and time represented as RFC 7231
          Full Dates (GMT). Example date: **Wed, 24 Apr 2019 14:00:37 GMT**. It is
          similar to standard HTTP ''Date'' expect that it allows to set it under
          JavaScript in browser while standard ''Date'' is forbidden'
        in: header
        name: X-Nordea-Originating-Date
        required: true
        type: string
      - description: HTTP header element for specification of the domain name of the
          server. It is similar to standard HTTP 'Host' header but it won't be overridden
          by proxies. It also allows to set it under JavaScript in browser while standard
          'Host' is forbidden
        in: header
        name: X-Nordea-Originating-Host
        required: true
        type: string
      - description: End user (i.e. PSU) agent information, to be provided if TPP
          is in session with the PSU
        in: header
        name: X-Nordea-Originating-User-Agent
        required: false
        type: string
      - description: End user (i.e. PSU) IP address, to be provided if TPP is in session
          with the PSU
        in: header
        name: X-Nordea-Originating-User-Ip
        required: false
        type: string
      - description: Resource listing may return a continuation_key if there are more
          results available. Request may be retried with the continuation_key in order
          to get more results.
        in: query
        name: continuation_key
        required: false
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      - description: Payments range end date time.
        in: query
        name: end_date_time
        required: false
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      - description: Debtor or creditor account in IBAN format.
        in: query
        name: iban_account
        required: false
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      - description: Debtor or creditor other account identification ex. BBAN.
        in: query
        name: other_account_identification
        required: false
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      - description: Agreement under which or rules under which the transaction should
          be processed.
        enum:
        - incoming
        - outgoing
        in: path
        name: service_level
        required: true
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
        x-example: incoming
      - description: Number of transactions displayed on one page.
        format: int32
        in: query
        name: size
        required: false
        type: integer
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      - description: Payments range start date time.
        in: query
        name: start_date_time
        required: false
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
      produces:
      - application/json
      responses:
        '200':
          description: List of payments
          schema:
            $ref: '#/definitions/PaymentListExternalResponse'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/ErrorResponse'
        '401':
          description: 'Unauthorized with failure code:

            * error.apikey.missing = Missing API key. This operation requires API
            key, but it was missing.

            * error.token = Unspecified error with supplied token.

            * error.token.invalid = Missing access token or token did not authorized
            requested operation. This operation requires valid access token, but it
            was missing.

            * error.token.expired = Access token has expired.'
          schema:
            $ref: '#/definitions/ErrorResponse'
        '403':
          description: Credential failure
          schema:
            $ref: '#/definitions/ErrorResponse'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/ErrorResponse'
      security:
      - DecoupledAuth:
        - PAYMENTS_BROADBAND
      summary: Get payment list
      tags:
      - payments-track-and-trace-v1
      x-availabilityInfo: Currently only available in sandbox.
      x-availabilityStatus: Beta
  /premium/v1/gpi-tracker/payments/{service_level}/{uetr}:
    get:
      deprecated: false
      operationId: getPaymentDetailsUsingGET_2
      parameters:
      - description: Bearer &lt;Access Token&gt; Token provided to TPP in authorization
          flow
        in: header
        name: Authorization
        required: true
        type: string
      - description: "A signature of request by the TPP on application level. The\
          \ process of signing a request is described in 'Signing HTTP Messages' RFC\
          \ draft version 10 (<a href=\"https://tools.ietf.org/html/draft-cavage-http-signatures-10\"\
          \ target=\"_blank\">https://tools.ietf.org/html/draft-cavage-http-signatures-10</a>).\
          \ The request signature needs to be sent in the 'Signature' HTTP header\
          \ as described in the RFC. Additional requirements from Nordea \n - The\
          \ only allowed algorithm is RSA-SHA256 \n- The key size for the used RSA\
          \ key pair has to be at least 2048 bit \n- The keyId is the clientId of\
          \ your application originating from the Nordea Developer Portal \n- We require\
          \ the following headers to be used in the signature \n* Request without\
          \ body: (request-target) X-Nordea-Originating-Host X-Nordea-Originating-Date\
          \ \n* Request with body: (request-target) X-Nordea-Originating-Host X-Nordea-Originating-Date\
          \ Content-type Digest \n* The request-target is a combination of the HTTP\
          \ action verb and the request URI path"
        in: header
        name: Signature
        required: true
        type: string
      - description: Id of the Client
        in: header
        name: X-IBM-Client-Id
        required: true
        type: string
      - description: Secret password generated for the Client
        in: header
        name: X-IBM-Client-Secret
        required: true
        type: string
      - description: 'HTTP header element for date and time represented as RFC 7231
          Full Dates (GMT). Example date: **Wed, 24 Apr 2019 14:00:37 GMT**. It is
          similar to standard HTTP ''Date'' expect that it allows to set it under
          JavaScript in browser while standard ''Date'' is forbidden'
        in: header
        name: X-Nordea-Originating-Date
        required: true
        type: string
      - description: HTTP header element for specification of the domain name of the
          server. It is similar to standard HTTP 'Host' header but it won't be overridden
          by proxies. It also allows to set it under JavaScript in browser while standard
          'Host' is forbidden
        in: header
        name: X-Nordea-Originating-Host
        required: true
        type: string
      - description: End user (i.e. PSU) agent information, to be provided if TPP
          is in session with the PSU
        in: header
        name: X-Nordea-Originating-User-Agent
        required: false
        type: string
      - description: End user (i.e. PSU) IP address, to be provided if TPP is in session
          with the PSU
        in: header
        name: X-Nordea-Originating-User-Ip
        required: false
        type: string
      - description: Agreement under which or rules under which the transaction should
          be processed.
        enum:
        - incoming
        - outgoing
        in: path
        name: service_level
        required: true
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
        x-example: incoming
      - description: Unique End-to-End Transaction Reference.
        in: path
        name: uetr
        required: true
        type: string
        x-availabilityInfo: Currently only available in sandbox.
        x-availabilityStatus: Beta
        x-example: f1a7d5b4-8c3e-4e2f-93b0-6d2a8e1c9f5b
      produces:
      - application/json
      responses:
        '200':
          description: Details of the payment
          schema:
            $ref: '#/definitions/PaymentExternalResponse'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/ErrorResponse'
        '401':
          description: 'Unauthorized with failure code:

            * error.apikey.missing = Missing API key. This operation requires API
            key, but it was missing.

            * error.token = Unspecified error with supplied token.

            * error.token.invalid = Missing access token or token did not authorized
            requested operation. This operation requires valid access token, but it
            was missing.

            * error.token.expired = Access token has expired.'
          schema:
            $ref: '#/definitions/ErrorResponse'
        '403':
          description: Credential failure
          schema:
            $ref: '#/definitions/ErrorResponse'
        '404':
          description: Resource not found
          schema:
            $ref: '#/definitions/ErrorResponse'
      security:
      - DecoupledAuth:
        - PAYMENTS_BROADBAND
      summary: Get payment details
      tags:
      - payments-track-and-trace-v1
      x-availabilityInfo: Currently only available in sandbox.
      x-availabilityStatus: Beta
securityDefinitions:
  DecoupledAuth:
    authorizationUrl: /v2/authorize
    flow: accessCode
    scopes:
      PAYMENTS_BROADBAND: Scope used to make and access payments for MyOpenBanking
        customers
    tokenUrl: /v2/authorize/token
    type: oauth2
    x-addAuthorizerDescription: Send authorization request to relevant agreement administrator
    x-addAuthorizerUrl: /v2/authorize
    x-authSubType: decoupled-auth
    x-codeStatusDescription: Returns code when authorization second step is finished
    x-codeStatusUrl: /v2/authorize
swagger: '2.0'
tags:
- description: Get incoming/outgoing payment status by UETR
  name: payments-track-and-trace-v1
