> ## Documentation Index
> Fetch the complete documentation index at: https://docs.quidkey.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List transactions

> Lists payment transactions, refunds and reversals, newest first. Unfiltered, it returns live records of every type and status, and `is_test=true` returns test ones. The "Transaction export" reference lists the columns of its file. A file also needs `transactions:get`, since each row is a full transaction.

With `Accept: text/csv` or `Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`, answers the whole result as one file, with one row per record. A file takes no `limit`, `cursor` or `include`, and a result of more than 10000 rows answers `EXPORT_TOO_LARGE`.

Credentials: `partner`, `merchant`

Permission: `transactions:list`



## OpenAPI

````yaml /api-reference/v1/openapi.json get /merchants/{id}/transactions
openapi: 3.1.0
info:
  title: Quidkey API
  version: 1.0.0
  description: >-
    The Quidkey public API.


    Within a version, a response can carry what this document doesn't list yet:
    a new field, a new value of an enum, a new error code. Handle a value you
    don't recognise rather than refusing the response. A client generated from
    this document turns an `enum` into a closed type unless told otherwise, so
    turn on its option for unknown values, such as openapi-generator's
    `enumUnknownDefaultCase`. A request is held to what's listed: a value it
    doesn't list is refused.
  contact:
    name: Quidkey
    url: https://docs.quidkey.com
servers:
  - url: https://api.quidkey.com/v1
security:
  - bearer: []
tags:
  - name: account_owner
  - name: agreement
  - name: agreement_acceptance
  - name: api_key
  - name: bank
  - name: bank_account
  - name: capability
  - name: country
  - name: identity_verification
  - name: legal_entity
  - name: merchant
  - name: party
  - name: payment_link
  - name: payout
  - name: transaction
  - name: webhook_endpoint
paths:
  /merchants/{id}/transactions:
    get:
      tags:
        - transaction
      summary: List transactions
      description: >-
        Lists payment transactions, refunds and reversals, newest first.
        Unfiltered, it returns live records of every type and status, and
        `is_test=true` returns test ones. The "Transaction export" reference
        lists the columns of its file. A file also needs `transactions:get`,
        since each row is a full transaction.


        With `Accept: text/csv` or `Accept:
        application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`,
        answers the whole result as one file, with one row per record. A file
        takes no `limit`, `cursor` or `include`, and a result of more than 10000
        rows answers `EXPORT_TOO_LARGE`.


        Credentials: `partner`, `merchant`


        Permission: `transactions:list`
      operationId: transaction.list
      parameters:
        - name: id
          in: path
          required: true
          schema:
            minLength: 1
            type: string
        - name: amount:gte
          in: query
          required: false
          description: Greater than or equal to this value.
          schema:
            minimum: 0
            maximum: 9007199254740991
            type: integer
        - name: amount:gt
          in: query
          required: false
          description: Greater than this value.
          schema:
            minimum: 0
            maximum: 9007199254740991
            type: integer
        - name: amount:lte
          in: query
          required: false
          description: Less than or equal to this value.
          schema:
            minimum: 0
            maximum: 9007199254740991
            type: integer
        - name: amount:lt
          in: query
          required: false
          description: Less than this value.
          schema:
            minimum: 0
            maximum: 9007199254740991
            type: integer
        - name: created_at:gte
          in: query
          required: false
          description: Greater than or equal to this value.
          schema:
            format: date-time
            pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$
            type: string
        - name: created_at:gt
          in: query
          required: false
          description: Greater than this value.
          schema:
            format: date-time
            pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$
            type: string
        - name: created_at:lte
          in: query
          required: false
          description: Less than or equal to this value.
          schema:
            format: date-time
            pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$
            type: string
        - name: created_at:lt
          in: query
          required: false
          description: Less than this value.
          schema:
            format: date-time
            pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$
            type: string
        - name: currency
          in: query
          required: false
          description: The currency `amount` shows.
          style: form
          explode: false
          schema:
            minItems: 1
            maxItems: 100
            type: array
            items:
              pattern: ^[A-Z]{3}$
              type: string
        - name: cursor
          in: query
          required: false
          description: >-
            An opaque cursor from `next_cursor`, valid with the filters it was
            issued for.
          schema:
            minLength: 1
            maxLength: 1024
            type: string
        - name: include
          in: query
          required: false
          description: >-
            Link fields to hydrate into `entities`, comma-separated. Sending it
            replaces the default, which is nothing.
          style: form
          explode: false
          schema:
            type: array
            items:
              type: string
              enum:
                - customer_details
        - name: is_test
          in: query
          required: false
          description: Lists test records instead of live ones. One list holds one kind.
          schema:
            default: false
            type: boolean
        - name: limit
          in: query
          required: false
          description: The page size.
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: integer
        - name: order_id
          in: query
          required: false
          description: An exact match.
          style: form
          explode: false
          schema:
            minItems: 1
            maxItems: 100
            type: array
            items:
              minLength: 1
              maxLength: 255
              type: string
        - name: payment_link_id
          in: query
          required: false
          style: form
          explode: false
          schema:
            minItems: 1
            maxItems: 100
            type: array
            items:
              type: string
        - name: payout_id
          in: query
          required: false
          style: form
          explode: false
          schema:
            minItems: 1
            maxItems: 100
            type: array
            items:
              type: string
        - name: status
          in: query
          required: false
          style: form
          explode: false
          schema:
            minItems: 1
            maxItems: 6
            type: array
            items:
              type: string
              enum:
                - pending
                - processing
                - completed
                - failed
                - cancelled
                - unresolved
        - name: type
          in: query
          required: false
          style: form
          explode: false
          schema:
            minItems: 1
            maxItems: 3
            type: array
            items:
              type: string
              enum:
                - payment
                - refund
                - reversal
      responses:
        '200':
          description: >-
            A list of transaction, in the summary view. Or the whole result as
            one file, for an `Accept` that asks for one.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            Content-Disposition:
              description: >-
                On a file, `attachment` with its name, such as
                `transactions.csv`.
              schema:
                type: string
          content:
            application/json:
              schema:
                additionalProperties: false
                type: object
                required:
                  - result
                  - entities
                  - not_included
                  - pagination
                properties:
                  result:
                    type: array
                    items:
                      $ref: '#/components/schemas/TransactionSummary'
                  entities:
                    additionalProperties:
                      $ref: '#/components/schemas/CustomerDetailsFull'
                    description: Included linked resources, keyed by URI.
                    type: object
                    properties: {}
                  not_included:
                    type: array
                    items:
                      $ref: '#/components/schemas/NotIncludedEntry'
                  pagination:
                    $ref: '#/components/schemas/CursorPagination'
            text/csv:
              schema:
                type: string
                description: RFC 4180, UTF-8, with a header row.
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                type: string
                format: binary
                description: >-
                  One sheet with a header row, each amount a number and every
                  other cell text.
        '400':
          description: '`VALIDATION_FAILED`: The request is malformed or failed validation.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - VALIDATION_FAILED
        '401':
          description: '`UNAUTHENTICATED`: A valid bearer token is required.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - UNAUTHENTICATED
        '403':
          description: >-
            `FORBIDDEN`: This credential doesn't have permission for this
            endpoint.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - FORBIDDEN
        '404':
          description: '`NOT_FOUND`: Not found.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - NOT_FOUND
        '406':
          description: '`NOT_ACCEPTABLE`: This endpoint doesn''t offer the format in Accept.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - NOT_ACCEPTABLE
        '422':
          description: >-
            `EXPORT_TOO_LARGE`: The result has more rows than a file holds.
            Narrow the filters.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - EXPORT_TOO_LARGE
        '429':
          description: '`RATE_LIMITED`: Too many requests.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - RATE_LIMITED
        '500':
          description: '`INTERNAL_ERROR`: Something went wrong on our side.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - INTERNAL_ERROR
        '503':
          description: '`SERVICE_UNAVAILABLE`: The service is busy. Try again shortly.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - SERVICE_UNAVAILABLE
components:
  headers:
    RequestId:
      description: Identifies this request. Quote it to support.
      schema:
        type: string
    RetryAfter:
      description: How many seconds to wait before retrying.
      schema:
        minimum: 0
        type: integer
  schemas:
    TransactionSummary:
      additionalProperties: false
      type: object
      required:
        - _type
        - _uri
        - _view
        - id
        - created_at
        - updated_at
        - type
        - is_test
        - transaction_number
        - status
        - amount
        - payout_amount
        - exchange_rate
        - routing
        - refund_status
        - can_refund
        - order
        - platform
        - merchant
        - customer_details
        - payout
      properties:
        _type:
          const: transaction
          type: string
        _uri:
          pattern: ^/
          description: The canonical URI, relative to the version root.
          type: string
        _view:
          const: summary
          type: string
        id:
          type: string
        created_at:
          anyOf:
            - format: date-time
              pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$
              type: string
            - type: 'null'
        updated_at:
          anyOf:
            - format: date-time
              pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$
              type: string
            - type: 'null'
        type:
          type: string
          enum:
            - payment
            - refund
            - reversal
        is_test:
          type: boolean
          description: >-
            Whether this is a test payment transaction, or a refund or reversal
            of one.
        transaction_number:
          type: string
          description: >-
            A short reference, the same in Console and the API. Quote it to
            support.
        status:
          type: string
          enum:
            - pending
            - processing
            - completed
            - failed
            - cancelled
            - unresolved
          description: >-
            Where this money movement is in its lifecycle. No status confirms
            that money has arrived, `completed` included.


            - `pending`: Nothing has moved. On a payment transaction, the
            customer hasn't finished or the provider hasn't answered, and
            `:issueCheckout` may revive it. On a refund, it's held until
            `:executeRefund`, waiting on `required_actions` or on its payment
            transaction converting, or waiting on Quidkey with
            `required_actions: []`.

            - `processing`: Accepted and moving. On a payment transaction this
            includes money that hasn't landed. A refund can carry
            `required_actions` here, when something stopped it on the way.

            - `completed`: Finished. On a payment transaction, the provider
            reported success, which can be days before the money arrives, or on
            a virtual account the merchant's payout finished. On a refund, the
            payment to the customer's account went out. A reversal is always
            `completed`.

            - `failed`: It didn't happen, and nothing further will. Safe to try
            the order again.

            - `cancelled`: Stopped before moving money. On a payment
            transaction, the customer or Quidkey cancelled it.

            - `unresolved`: The outcome isn't known, and a later `completed` can
            still apply, so don't charge again for this order until it resolves.
            A payment transaction becomes `processing` or `completed`, or
            `failed` once Quidkey confirms.
        amount:
          type: object
          allOf:
            - $ref: '#/components/schemas/Money'
            - type: object
              required:
                - value
              properties:
                value:
                  minimum: 0
                  maximum: 9007199254740991
                  type: integer
          description: >-
            Always the customer's side, in the customer's currency: what they
            were charged, what they get back, or what the bank took back.
        payout_amount:
          anyOf:
            - type: object
              allOf:
                - $ref: '#/components/schemas/Money'
                - type: object
                  required:
                    - value
                  properties:
                    value:
                      minimum: 0
                      maximum: 9007199254740991
                      type: integer
            - type: 'null'
          description: >-
            What this payment transaction adds to the merchant's payouts, after
            fees and any conversion. `null` unless a payment transaction is
            `processing` or `completed`.
        exchange_rate:
          anyOf:
            - $ref: '#/components/schemas/ExchangeRate'
            - type: 'null'
          description: >-
            Explains the amounts, which are authoritative: don't recompute them
            from it. `null` until converted, and when no conversion ran.
        routing:
          anyOf:
            - type: string
              enum:
                - virtual_account
                - direct
            - type: 'null'
          description: >-
            Whether the money passes through a virtual account Quidkey runs for
            the merchant.
        refund_status:
          anyOf:
            - type: string
              enum:
                - refunding
                - refunding_blocked
                - refunding_failed
                - partially_refunded
                - fully_refunded
            - type: 'null'
          description: >-
            How far refunds of this payment transaction have got. None of these
            confirms that money has arrived. A list has no `required_actions`,
            so a single read gives them.


            - `refunding`: A refund is under way, held until `:executeRefund`,
            or waiting on Quidkey with `required_actions: []`.

            - `refunding_blocked`: A refund has `required_actions` other than
            `REFUND_NOT_EXECUTED`, or is waiting for a refund started in the
            merchant's platform.

            - `refunding_failed`: The latest refund outcome is a failure.

            - `partially_refunded`: Some of it has been refunded.

            - `fully_refunded`: All of it has been refunded.

            - `null`: No refunds, or the type is not `payment`.
        can_refund:
          type: boolean
          description: >-
            Whether a refund that moves money can be created now. `false` on a
            payment transaction whose refunds are paid from the merchant's
            platform, where `execution: manual` can still prepare one.
        order:
          anyOf:
            - $ref: '#/components/schemas/Order'
            - type: 'null'
          description: The caller's order. `null` where none was given.
        platform:
          anyOf:
            - type: string
              enum:
                - api
                - payment_link
                - shopify
                - woocommerce
            - type: 'null'
          description: >-
            How the payment transaction came. `null` on a refund and a reversal,
            whose `parent_transaction` has it.
        merchant:
          $ref: '#/components/schemas/MerchantLink'
        customer_details:
          anyOf:
            - $ref: '#/components/schemas/CustomerDetailsSubResourceLink'
            - type: 'null'
          description: >-
            A link on a payment transaction. `null` on a refund and a reversal,
            whose parent payment transaction has it.
        payout:
          anyOf:
            - $ref: '#/components/schemas/PayoutLink'
            - type: 'null'
          description: >-
            The payout that carries this. `null` until batched, and on a test
            transaction. A payout that fails while being sent answers 404 until
            Quidkey staff resolve it, and part or all of its money may have
            moved by then.
    CustomerDetailsFull:
      additionalProperties: false
      type: object
      required:
        - _type
        - _uri
        - _view
        - id
        - created_at
        - updated_at
        - full_name
        - email
        - phone
        - country
        - billing_address
        - transaction
      properties:
        _type:
          const: customer_details
          type: string
        _uri:
          pattern: ^/
          description: The canonical URI, relative to the version root.
          type: string
        _view:
          const: full
          type: string
        id:
          type: string
        created_at:
          anyOf:
            - format: date-time
              pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$
              type: string
            - type: 'null'
        updated_at:
          anyOf:
            - format: date-time
              pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$
              type: string
            - type: 'null'
        full_name:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            As given when the payment transaction was created. `null` when none
            is held.
        email:
          anyOf:
            - format: email
              maxLength: 320
              type: string
            - type: 'null'
          description: >-
            As given when the payment transaction was created. `null` when none
            is held.
        phone:
          anyOf:
            - pattern: ^\+[1-9]\d{1,14}$
              type: string
            - type: 'null'
          description: >-
            As given when the payment transaction was created. `null` when none
            is held.
        country:
          pattern: ^[A-Z]{2}$
          type: string
        billing_address:
          anyOf:
            - $ref: '#/components/schemas/Address'
            - type: 'null'
          description: As held on the payment transaction, which can be set later.
        transaction:
          $ref: '#/components/schemas/TransactionLink'
          description: The payment transaction.
    NotIncludedEntry:
      additionalProperties: false
      type: object
      required:
        - link
        - reason
      properties:
        link:
          $ref: '#/components/schemas/AnyLink'
        reason:
          type: string
          enum:
            - no_permission
            - not_published
          description: >-
            Why this link has no entity.


            - `no_permission`: This credential can't read it. Fetching it
            answers 403, or 404 where a 403 would reveal that it exists.

            - `not_published`: The API doesn't show it: a type it doesn't
            publish, or a record it doesn't show on a type it does, such as a
            failed payout. Fetching it, where it has a URI, answers 404.
    CursorPagination:
      additionalProperties: false
      type: object
      required:
        - type
        - limit
        - next_cursor
        - has_more
      properties:
        type:
          const: cursor
          type: string
        limit:
          minimum: 1
          maximum: 100
          type: integer
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
        has_more:
          type: boolean
    Error:
      additionalProperties: false
      type: object
      required:
        - error
      properties:
        error:
          additionalProperties: false
          type: object
          required:
            - code
            - message
            - details
            - retryable
            - request_id
          properties:
            code:
              description: Branch on this. New codes can appear.
              type: string
            message:
              description: For people. It can change.
              type: string
            details:
              type: array
              items:
                $ref: '#/components/schemas/ErrorDetail'
            retryable:
              description: >-
                Whether sending the same request again unchanged, after a wait,
                can succeed with nothing else changing.
              type: boolean
            request_id:
              description: Quote this to support.
              type: string
    Money:
      description: An amount of money. Decimal values are refused, not rounded.
      additionalProperties: false
      type: object
      required:
        - value
        - currency
      properties:
        value:
          description: In the currency's ISO 4217 minor units, so GBP 45.00 is 4500.
          type: integer
        currency:
          pattern: ^[A-Z]{3}$
          type: string
    ExchangeRate:
      description: 1 unit of from_currency converts to rate units of to_currency.
      additionalProperties: false
      type: object
      required:
        - rate
        - from_currency
        - to_currency
      properties:
        rate:
          pattern: ^\d+(\.\d+)?$
          description: >-
            How many units of `to_currency` one unit of `from_currency` converts
            to, as a decimal string.
          type: string
        from_currency:
          pattern: ^[A-Z]{3}$
          type: string
        to_currency:
          pattern: ^[A-Z]{3}$
          type: string
    Order:
      description: >-
        The caller's order. Not unique: a reusable link puts it on every payment
        transaction.
      additionalProperties: false
      type: object
      required:
        - order_id
      properties:
        order_id:
          minLength: 1
          type: string
    MerchantLink:
      additionalProperties: false
      type: object
      required:
        - _link
        - _type
        - id
      properties:
        _link:
          pattern: ^/
          type: string
        _type:
          const: merchant
          type: string
        id:
          type: string
      x-link-target:
        resource: merchant
        kind: resource
        is_published: true
        views:
          - full
    CustomerDetailsSubResourceLink:
      additionalProperties: false
      type: object
      required:
        - _link
        - _type
        - id
      properties:
        _link:
          pattern: ^/
          type: string
        _type:
          const: customer_details
          type: string
        id:
          type: string
      x-link-target:
        resource: customer_details
        kind: singleton
        is_published: true
        views:
          - full
    PayoutLink:
      additionalProperties: false
      type: object
      required:
        - _link
        - _type
        - id
      properties:
        _link:
          pattern: ^/
          type: string
        _type:
          const: payout
          type: string
        id:
          type: string
      x-link-target:
        resource: payout
        kind: resource
        is_published: true
        views:
          - full
    Address:
      additionalProperties: false
      type: object
      required:
        - line1
        - city
        - country
        - postal_code
        - line2
        - region
      properties:
        line1:
          minLength: 1
          type: string
        city:
          minLength: 1
          type: string
        country:
          pattern: ^[A-Z]{2}$
          type: string
        postal_code:
          anyOf:
            - type: string
            - type: 'null'
        line2:
          anyOf:
            - type: string
            - type: 'null'
          description: Holds the apartment as well, where one was given.
        region:
          anyOf:
            - pattern: ^[A-Z]{2}-[A-Z0-9]{1,3}$
              type: string
            - type: 'null'
          description: >-
            ISO 3166-2, of this address's country. `null` where none is held,
            and for a country with no subdivisions Quidkey knows of, such as
            `GB-LND`.
    TransactionLink:
      additionalProperties: false
      type: object
      required:
        - _link
        - _type
        - id
      properties:
        _link:
          pattern: ^/
          type: string
        _type:
          const: transaction
          type: string
        id:
          type: string
      x-link-target:
        resource: transaction
        kind: resource
        is_published: true
        views:
          - full
          - summary
    AnyLink:
      anyOf:
        - additionalProperties: false
          type: object
          required:
            - _link
            - _type
            - id
          properties:
            _link:
              pattern: ^/
              type: string
            _type:
              type: string
            id:
              type: string
        - additionalProperties: false
          type: object
          required:
            - _type
            - id
          properties:
            _type:
              type: string
            id:
              type: string
      x-link-target:
        resource: any
        kind: any
        is_published: true
    ErrorDetail:
      anyOf:
        - additionalProperties: false
          type: object
          required:
            - field
            - message
          properties:
            field:
              type: string
            message:
              type: string
        - additionalProperties: false
          type: object
          required:
            - required_actions
            - message
          properties:
            required_actions:
              description: The `required_actions` codes holding this back.
              type: array
              items:
                type: string
            message:
              type: string
        - additionalProperties: false
          type: object
          required:
            - available_percent
            - message
          properties:
            available_percent:
              $ref: '#/components/schemas/Percent'
            message:
              type: string
        - additionalProperties: false
          type: object
          required:
            - agreement
            - message
          properties:
            agreement:
              $ref: '#/components/schemas/AgreementLink'
            message:
              type: string
        - additionalProperties: false
          type: object
          required:
            - agreement
            - current_agreement
            - message
          properties:
            agreement:
              $ref: '#/components/schemas/AgreementLink'
            current_agreement:
              $ref: '#/components/schemas/AgreementLink'
            message:
              type: string
        - additionalProperties: false
          type: object
          required:
            - legal_entity
            - message
          properties:
            legal_entity:
              $ref: '#/components/schemas/LegalEntityLink'
            message:
              type: string
    Percent:
      pattern: ^\d+(\.\d+)?$
      description: 'A percentage as a decimal string: `"25.00"` is 25%.'
      type: string
    AgreementLink:
      additionalProperties: false
      type: object
      required:
        - _link
        - _type
        - id
      properties:
        _link:
          pattern: ^/
          type: string
        _type:
          const: agreement
          type: string
        id:
          type: string
      x-link-target:
        resource: agreement
        kind: resource
        is_published: true
        views:
          - full
    LegalEntityLink:
      additionalProperties: false
      type: object
      required:
        - _link
        - _type
        - id
      properties:
        _link:
          pattern: ^/
          type: string
        _type:
          const: legal_entity
          type: string
        id:
          type: string
      x-link-target:
        resource: legal_entity
        kind: resource
        is_published: true
        views:
          - full
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.