components:
  parameters:
    fields:
      description: 'sparse fieldsets: `fields[TYPE]=field1,field2,...`'
      in: query
      name: fields
      schema:
        type: string
      style: deepObject
    filter:
      description: filter[NAME]=value(s)
      in: query
      name: filter
      schema:
        type: string
      style: deepObject
    id:
      description: the identifier of the record
      in: path
      name: id
      required: true
      schema:
        $ref: '#/components/schemas/id'
    include:
      description: >-
        [list of included related
        resources](https://jsonapi.org/format/#fetching-includes)
      in: query
      name: include
      schema:
        type: string
      style: form
    pageLimit:
      description: limit for this page of paginated results
      in: query
      name: page[limit]
      schema:
        format: int32
        type: integer
    pageNumber:
      description: page number of results
      in: query
      name: page[number]
      schema:
        format: int32
        type: integer
    pageOffset:
      description: collection items offset for paginated results
      in: query
      name: page[offset]
      schema:
        format: int32
        type: integer
    pageSize:
      description: size of page for paginated results
      in: query
      name: page[size]
      schema:
        format: int32
        type: integer
    sort:
      description: '[fields to sort by](https://jsonapi.org/format/#fetching-sorting)'
      in: query
      name: sort
      schema:
        type: string
      style: form
    userAgent:
      allowEmptyValue: false
      description: The name and version of the client making the request
      example: CHOAM EPT Client v10191 (Ruby Client v3)
      in: header
      name: User-Agent
      required: true
      schema:
        type: string
  responses:
    bad_request:
      description: >-
        Some or all of the pieces of your request are
        [invalid](https://jsonapi.org/format/#errors-processing) and this
        response details those issues.
    conflict:
      description: '[Conflict](https://jsonapi.org/format/#crud-creating-responses-409)'
    forbidden:
      description: '[Forbidden](https://jsonapi.org/format/#crud-creating-responses-403)'
    not_acceptable:
      description: TODO
    not_found:
      description: >-
        [Not
        found](https://jsonapi.org/format/#fetching-resources-responses-404)
    related_not_found:
      description: >-
        [Related resource does not
        exist](https://jsonapi.org/format/#crud-creating-responses-404).
    unauthorized:
      description: The request was not authorized
    unprocessable_entity:
      content:
        application/vnd.api+json:
          schema:
            properties:
              errors:
                items:
                  $ref: '#/components/schemas/error'
                type: array
                uniqueItems: true
              jsonapi:
                $ref: '#/components/schemas/jsonapi'
              links:
                $ref: '#/components/schemas/links'
              meta:
                $ref: '#/components/schemas/meta'
            required:
              - errors
            type: object
      description: >-
        Some or all of the pieces of your request are
        [invalid](https://jsonapi.org/format/#errors-processing) and this
        response details those issues.
    unsupported_media_type:
      description: TODO
  schemas:
    legal_addresses_member:
      description: A legal_addresses record
      example:
        data:
          attributes:
            city: Anytown
            country: USA
            created_at: '2024-06-06T21:48:33.382755Z'
            line_1: 123 Main St
            line_2: Apt. 1
            state: CA
            updated_at: '2024-06-06T21:48:33.382755Z'
            zip: '12345'
          id: 59b76881-0041-4e45-ad77-c8d3d256f89a
          links: {}
          relationships: {}
          type: legal_addresses
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: >
            `LegalAddress` represents a physical address associated with the
            merchant account opener and the beneficial owners.


            ### Scoping


            Unlike its counterpart, `ConsumerAddress`, `LegalAddress` is not
            scoped to a mode (`sandbox` or `live`).
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                city:
                  description: City
                  type: string
                country:
                  description: Country code
                  type: string
                created_at:
                  format: date-time
                  type: string
                line_1:
                  description: Address line 1
                  type: string
                line_2:
                  description: Address line 2
                  type: string
                state:
                  description: State
                  type: string
                updated_at:
                  format: date-time
                  type: string
                zip:
                  description: Postal code
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - legal_addresses
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    payment_methods_member:
      description: A payment_methods record
      example:
        data:
          attributes:
            created_at: '2024-06-06T21:48:33.382755Z'
            updated_at: '2024-06-06T21:48:33.382755Z'
          id: fc6ef2c8-b538-4452-808c-ad0503cbfaa3
          links: {}
          relationships: {}
          type: payment_methods
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: >
            Use the `PaymentMethod` API to store customer credit/debit card
            details for immediate (charges) or later processing (subscriptions).
            The API does not accept raw card numbers or cvv values. Edge JS will
            provide tokenised values for card numbers (`card_pan_token`) and cvv
            (`card_cvv_token`).


            Edge currently supports credit and debit cards of Visa, Master, AMEX
            and Discovery. Edge intends to introduce support for ACH payments
            soon.
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                card_bin:
                  description: First 6 digits of card number
                  type: string
                card_cvv_token:
                  description: The CVV token
                  type: string
                card_pan_token:
                  description: The card PAN token
                  type: string
                created_at:
                  format: date-time
                  type: string
                description:
                  description: A description of the payment method
                  type: string
                discarded_at:
                  format: date-time
                  type: string
                expiry_month:
                  description: The month of the cards expiry date
                  type: integer
                expiry_year:
                  description: The year of the cards expiry date, in YYYY format
                  type: integer
                external_state:
                  enum:
                    - pending
                    - confirmed
                    - failed
                    - errored
                  type: string
                kind:
                  enum:
                    - checking
                    - savings
                    - visa
                    - mastercard
                    - amex
                    - discover
                    - diners
                    - elo
                    - hiper
                    - hipercard
                    - jcb
                    - maestro
                    - mir
                    - unionpay
                    - unknown
                  type: string
                last_four:
                  description: Last 4 digits of card number
                  type: string
                nickname:
                  description: >-
                    The name given by the cardholder to distinguish between
                    other cards
                  type: string
                updated_at:
                  format: date-time
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - payment_methods
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    memberships_collection:
      description: Zero, one, or many memberships records
      example:
        data:
          - attributes:
              created_at: '2024-06-06T21:48:33.382755Z'
              opener: true
              updated_at: '2024-06-06T21:48:33.382755Z'
            id: 4b401fae-c9bf-4089-b0a9-2d4925d40cd7
            links: {}
            relationships: {}
            type: memberships
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: >
              A `Membership` contains information relating an `Account` to a
              `Merchant`.


              While an `Account` can be related to many merchants, a
              `Membership` contains

              information of the association with a specific one.
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  created_at:
                    format: date-time
                    type: string
                  opener:
                    description: Whether its the account owner
                    type: boolean
                  updated_at:
                    format: date-time
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - memberships
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    red_flags_collection:
      description: Zero, one, or many red_flags records
      example:
        data:
          - attributes:
              created_at: '2024-06-06T21:48:33.382755Z'
              updated_at: '2024-06-06T21:48:33.382755Z'
            id: 8112dd06-ee8a-489d-ae84-b8ceebfce3c7
            links: {}
            relationships: {}
            type: red_flags
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: |
              TODO: Fill in
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  comment:
                    description: Additional details about the violation
                    type: string
                  created_at:
                    format: date-time
                    type: string
                  external_metadata:
                    description: metadata provided by 3rd party services
                    type: object
                  source:
                    enum:
                      - edge
                      - legit_script
                    type: string
                  status:
                    enum:
                      - active
                      - penalized
                      - cleared
                      - warned
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                  violation:
                    enum:
                      - email_concerns
                      - multiple_merchants_for_email
                      - low_risk
                      - moderate_risk
                      - high_risk
                      - bram
                      - gbpp
                      - terms
                      - offline_or_parked
                      - rogue
                      - transaction_laundering_suspected
                      - transaction_laundering_confirmed
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - red_flags
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    payment_subscriptions_collection:
      description: Zero, one, or many payment_subscriptions records
      example:
        data:
          - attributes:
              created_at: '2024-06-06T21:48:33.382755Z'
              line_items:
                - amount_cents: 10000
                  amount_currency: USD
                  description: A toy
                  fee_cents: 500
                  quantity: 1
              status: active
              updated_at: '2024-06-06T21:48:33.382755Z'
            id: 6f85bab2-f3fc-4279-9025-333bf1581e4d
            links: {}
            relationships: {}
            type: payment_subscriptions
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: >
              Payment Subscriptions allow you to charge customers recurringly
              for access to a product or service. Edge supports subscriptions
              with billing cycles `weekly`, `biweekly`, `monthly`, `bimonthly`,
              `quarterly`, `semiannual`, and `yearly`. Edge will create a new
              charge against the associated payment method when a new cycle
              begins.


              ### Events


              You can listen to `payment_subscriptions.created`,
              `payment_subscriptions.updated` and
              `payment_subscriptions.deleted` events on the resource. In
              addition, charges would trigger their respective events as they
              advance through their lifecycle.


              ### Detecting Failures


              A subscription will be in an `active` status unless specified
              otherwise. However, the customer may have entered the card details
              incorrectly. In this case, the subscription `status` will transit
              from `active` to `past_due`. Track this transition using
              `WebhookSubscription` by listening to the `subscription.updated`
              event.
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  acs_transaction_eid:
                    description: The 3DSecure transaction UUID assigned by the issuer
                    type: string
                  address_line1_verification:
                    description: >-
                      The status of the billing address (Line 1) verification
                      process
                    enum:
                      - match
                      - mismatch
                      - retry
                      - unavailable
                      - unverified
                    type: string
                  amount_cents:
                    description: The amount of the payment demand in cents
                    type: integer
                  amount_currency:
                    description: The currency of the charge (ISO 4217)
                    type: string
                  billing_cycle_anchor_at:
                    description: The reference date for the billing_period
                    format: date-time
                    type: string
                  billing_period:
                    description: The reference date for the billing_period
                    enum:
                      - one_day
                      - seven_days
                      - fourteen_days
                      - thirty_days
                      - one_month
                      - six_months
                      - twelve_months
                    type: string
                  canceled_at:
                    description: The date the subscription should be cancelled after
                    type: string
                  confirmed:
                    description: Whether the payment should be processed immediately
                    type: boolean
                  created_at:
                    format: date-time
                    type: string
                  cvc2_check:
                    description: The status of the CVC verification process
                    enum:
                      - match
                      - unprocessed
                      - missing
                      - unavailable
                      - unresponsive
                    type: string
                  description:
                    description: A description of the charge
                    type: string
                  directory_transaction_eid:
                    description: The 3DSecure transaction UUID assigned by the directory
                    type: string
                  discount_cents:
                    description: >-
                      The amount of money given as a discount on the total of
                      the purchase
                    type: integer
                  eci:
                    description: >-
                      The 3DSecure Electronic Commerce Indicator for the
                      verification process
                    type: string
                  fee_cents:
                    type: integer
                  idempotency_key:
                    description: A unique value that prevents double charging
                    type: string
                  line_items:
                    description: >-
                      Itemized list of services or products being paid for in
                      the purchase
                    items:
                      type: object
                    type: array
                  payer_timezone:
                    description: IANA timezone name of the payer at time of purchase
                    type: string
                  postal_code_verification:
                    description: >-
                      The status of the billing address (postal code)
                      verification process
                    enum:
                      - match
                      - mismatch
                      - retry
                      - unavailable
                      - unverified
                    type: string
                  purchase_kind:
                    description: The type of purchase
                    enum:
                      - order
                      - invoice
                    type: string
                  purchase_reference:
                    description: >-
                      The unique identification for the purchase given by the
                      merchant
                    type: string
                  shipping_detail:
                    description: The purchase shipping details
                    type: object
                  slug:
                    description: >-
                      A reference name from which subscriptions can be grouped
                      for
                    type: string
                  status:
                    description: >-
                      The period the subscriptions charge for, in relation to
                      the billing_cycle_anchor
                    enum:
                      - active
                      - paused
                      - cancelled
                    type: string
                  tax_detail:
                    description: The purchase tax details
                    type: object
                  threeds_cryptogram:
                    description: The 3DSecure cryptogram used for verification
                    type: string
                  threeds_status:
                    description: The status of the 3DSecure verification process
                    type: string
                  threeds_version:
                    description: The 3DSecure Version used for verification
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - payment_subscriptions
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    merchant_integrations_member:
      description: A merchant_integrations record
      example:
        data:
          attributes:
            admin_url: https://invoiced.tryedge.io/
            created_at: '2024-06-06T21:48:33.382755Z'
            name: Edge Invoices
            updated_at: '2024-06-06T21:48:33.382755Z'
          id: a7035c37-0830-4629-a04b-774e533a4629
          links: {}
          relationships: {}
          type: merchant_integrations
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: |
            A `MerchantIntegration` contains specific information related to the
            `Integration`` of a partners service to a `Merchant` account.
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                admin_url:
                  description: The admin URL
                  type: string
                created_at:
                  format: date-time
                  type: string
                name:
                  description: The name of the integration
                  type: string
                updated_at:
                  format: date-time
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - merchant_integrations
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    accounts_collection:
      description: Zero, one, or many accounts records
      example:
        data:
          - attributes:
              account_status: active
              created_at: '2024-06-06T21:48:33.382755Z'
              email: user@example.com
              name: Jane Doe
              updated_at: '2024-06-06T21:48:33.382755Z'
            id: 3cd2e207-77a9-4fe2-b1c1-dba16b1637d5
            links: {}
            relationships: {}
            type: accounts
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: >
              An `Account` represents an entity with login access to a merchant
              account in

              the Edge platform.


              Accounts with administrative access to the merchant (for example,
              the merchant

              opener) can use the Edge Dashboard to invite new accounts, update
              existing

              accounts and to remove them.
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  account_status:
                    description: The status of the account
                    enum:
                      - incomplete
                      - active
                      - quarantined
                      - banned
                      - pending
                    type: string
                  created_at:
                    format: date-time
                    type: string
                  email:
                    description: The email address of the account holder
                    type: string
                  name:
                    description: The name of the account holder
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - accounts
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    accounts_member:
      description: A accounts record
      example:
        data:
          attributes:
            account_status: active
            created_at: '2024-06-06T21:48:33.382755Z'
            email: user@example.com
            name: Jane Doe
            updated_at: '2024-06-06T21:48:33.382755Z'
          id: a28e8174-a2d6-45ce-a731-67ac1488d974
          links: {}
          relationships: {}
          type: accounts
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: >
            An `Account` represents an entity with login access to a merchant
            account in

            the Edge platform.


            Accounts with administrative access to the merchant (for example,
            the merchant

            opener) can use the Edge Dashboard to invite new accounts, update
            existing

            accounts and to remove them.
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                account_status:
                  description: The status of the account
                  enum:
                    - incomplete
                    - active
                    - quarantined
                    - banned
                    - pending
                  type: string
                created_at:
                  format: date-time
                  type: string
                email:
                  description: The email address of the account holder
                  type: string
                name:
                  description: The name of the account holder
                  type: string
                updated_at:
                  format: date-time
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - accounts
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    links:
      description: >-
        May contain `self`, `related`, or pagination links (first, last, prev,
        next).
      properties:
        first:
          $ref: '#/components/schemas/link'
        last:
          $ref: '#/components/schemas/link'
        next:
          $ref: '#/components/schemas/link'
        prev:
          $ref: '#/components/schemas/link'
        related:
          $ref: '#/components/schemas/link'
        self:
          $ref: '#/components/schemas/link'
      type: object
    permissions_member:
      description: A permissions record
      example:
        data:
          attributes:
            created_at: '2024-06-06T21:48:33.382755Z'
            updated_at: '2024-06-06T21:48:33.382755Z'
          id: 2d2167ca-4205-40e2-882d-9ec4a5428345
          links: {}
          relationships: {}
          type: permissions
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: |
            TODO: Fill in
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                created_at:
                  format: date-time
                  type: string
                description:
                  description: A description of the permission
                  type: string
                slug:
                  description: The permission identifier
                  type: string
                updated_at:
                  format: date-time
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - permissions
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    customers_collection:
      description: Zero, one, or many customers records
      example:
        data:
          - attributes:
              created_at: '2024-06-06T21:48:33.382755Z'
              description: First customer
              email: johndoe@example.com
              name: John Doe
              phone_number: '+1234567890'
              updated_at: '2024-06-06T21:48:33.382755Z'
            id: 8c98dc97-1773-456a-9095-ee6c518dfb62
            links: {}
            relationships: {}
            type: customers
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: >
              A `Customer` in Edge represents a customer in your business.


              While the

              customer resource is considered optional, it is highly recommended
              that you

              create a customer for each of your customers.


              This will allow you to track

              past transactions involving the customer and will be used as
              evidence in the

              case of a chargeback/dispute.
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  blocked_at:
                    format: date-time
                    type: string
                  created_at:
                    format: date-time
                    type: string
                  description:
                    type: string
                  email:
                    format: email
                    type: string
                  name:
                    description: The name of the customer
                    type: string
                  phone_number:
                    format: phone
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - customers
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    corporate_officials_member:
      description: A corporate_officials record
      example:
        data:
          attributes:
            created_at: '2024-06-06T21:48:33.382755Z'
            daily_contact: true
            payments_decision_maker: true
            role: CEO
            updated_at: '2024-06-06T21:48:33.382755Z'
          id: c039187a-b016-4300-9474-8df926ba8484
          links: {}
          relationships: {}
          type: corporate_officials
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: >
            A `CorporateOfficial` represents a person responsible for managing
            the

            relationship of a `Merchant` with Edge.
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                created_at:
                  format: date-time
                  type: string
                daily_contact:
                  description: >-
                    Whether the corporate official is the companies daily
                    contact with Edge
                  type: boolean
                payments_decision_maker:
                  description: >-
                    Whether the corporate official has the authority to make
                    payments related decisions
                  type: boolean
                role:
                  description: The role of the corporate official (e.g. President, CEO)
                  type: string
                updated_at:
                  format: date-time
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - corporate_officials
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    red_flags_member:
      description: A red_flags record
      example:
        data:
          attributes:
            created_at: '2024-06-06T21:48:33.382755Z'
            updated_at: '2024-06-06T21:48:33.382755Z'
          id: 405d738c-8a58-4b5e-ae00-c74e13684bc5
          links: {}
          relationships: {}
          type: red_flags
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: |
            TODO: Fill in
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                comment:
                  description: Additional details about the violation
                  type: string
                created_at:
                  format: date-time
                  type: string
                external_metadata:
                  description: metadata provided by 3rd party services
                  type: object
                source:
                  enum:
                    - edge
                    - legit_script
                  type: string
                status:
                  enum:
                    - active
                    - penalized
                    - cleared
                    - warned
                  type: string
                updated_at:
                  format: date-time
                  type: string
                violation:
                  enum:
                    - email_concerns
                    - multiple_merchants_for_email
                    - low_risk
                    - moderate_risk
                    - high_risk
                    - bram
                    - gbpp
                    - terms
                    - offline_or_parked
                    - rogue
                    - transaction_laundering_suspected
                    - transaction_laundering_confirmed
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - red_flags
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    personal_identifications_collection:
      description: Zero, one, or many personal_identifications records
      example:
        data:
          - attributes:
              created_at: '2024-06-06T21:48:33.382755Z'
              dob: '1990-01-01'
              email: johndoe@example.com
              full_name: John Doe
              id_number: 123-45-6789
              name_on_document: John Doe
              nationality: USA
              personal_name: John
              phone_number: '+1234567890'
              updated_at: '2024-06-06T21:48:33.382755Z'
            id: d85e7063-2539-443b-8d06-28ee38ca9861
            links: {}
            relationships: {}
            type: personal_identifications
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: |
              TODO: Fill in
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  created_at:
                    format: date-time
                    type: string
                  dob:
                    description: Date of birth
                    format: date
                    type: string
                  email:
                    format: email
                    type: string
                  full_name:
                    description: Full Name
                    type: string
                  id_number:
                    description: >-
                      Identification number (SSN for US citizens and passport
                      number for others)
                    type: string
                  name_on_document:
                    description: Name on the photo ID
                    type: string
                  nationality:
                    description: The legal national identification
                    type: string
                  personal_name:
                    description: Personal name
                    type: string
                  phone_number:
                    format: phone
                    type: string
                  surname:
                    description: Surname
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - personal_identifications
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    processor_details_member:
      description: A processor_details record
      example:
        data:
          attributes:
            created_at: '2024-06-06T21:48:33.382755Z'
            updated_at: '2024-06-06T21:48:33.382755Z'
          id: cbc2e980-e705-4a8a-9b22-9097e289f9bc
          links: {}
          relationships: {}
          type: processor_details
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: |
            TODO: Fill in
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                created_at:
                  format: date-time
                  type: string
                onboarding_state:
                  enum:
                    - pending
                    - approved
                  type: string
                processing_state:
                  enum:
                    - disabled
                    - enabled
                    - monitoring
                  type: string
                type:
                  enum:
                    - legacy
                    - edge
                    - nmi
                    - rs2
                    - eftbop
                  type: string
                updated_at:
                  format: date-time
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - processor_details
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    events_member:
      description: A events record
      example:
        data:
          attributes:
            created_at: '2024-06-06T21:48:33.382755Z'
            data: {}
            mode: live
            resource_id: 9a86612a-f897-45cb-8061-319fcb8eb2ae
            resource_type: transaction.payment_demands
            slug: created
          id: 2a3c7754-308a-4d5a-be06-f644434f4476
          links: {}
          relationships: {}
          type: events
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: >
            Throughout your merchant accounts operation, various operations will
            be

            performed in relation to your accounts resources.


            Such operations trigger the creation of `Event` records along with
            references

            to the resource involved in it.


            For supported events, you can subscribe to receive webhooks through

            `WebhookSubscription` as these events are recorded.


            This is a comprehensive list of events your merchant account will
            encounter.


            | Resource Type                     | Slug      |
            Description                                  |

            | --------------------------------- | --------- |
            -------------------------------------------- |

            | transaction.payment_demands       | created   | A payment demand
            was created.                |

            | transaction.payment_demands       | succeeded | A payment demand
            was successfully processed. |

            | transaction.payment_demands       | failed    | A payment demand
            failed to process.          |

            | transaction.payment_demands       | refunded  | A payment demand
            was refunded.               |

            | transaction.payment_demands       | disputed  | A payment demand
            was disputed.               |

            | transaction.refund_demands        | created   | A refund demand
            was created.                 |

            | transaction.refund_demands        | succeeded | A refund demand
            was successfully processed.  |

            | transaction.refund_demands        | failed    | A refund demand
            failed to process.           |

            | transaction.payment_subscriptions | created   | A payment
            subscription was created.          |

            | transaction.payment_subscriptions | updated   | A payment
            subscription was updated.          |

            | consumer.customers                | created   | A customer was
            created.                      |

            | consumer.customers                | updated   | A customer was
            updated.                      |

            | consumer.addresses                | created   | A consumer address
            was created.              |

            | consumer.addresses                | updated   | A consumer address
            was updated.              |
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                created_at:
                  format: date-time
                  type: string
                data:
                  description: Event data
                  type: object
                mode:
                  description: The mode in which the event was created (sandbox/live)
                  enum:
                    - live
                    - sandbox
                  type: string
                resource_id:
                  description: The ID of the resource the event is related to
                  type: string
                resource_type:
                  description: The type of resource the event is related to
                  type: string
                slug:
                  description: The slug of the event
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - events
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    webhook_subscriptions_member:
      description: A webhook_subscriptions record
      example:
        data:
          attributes:
            active: true
            concurrency_limit: 50
            created_at: '2024-06-06T21:48:33.382755Z'
            description: Webhook for payment demands
            events:
              - transaction.payment_demands.created
              - transaction.payment_demands.succeeded
              - transaction.payment_demands.failed
            secret_key: shh-itsasecret
            updated_at: '2024-06-06T21:48:33.382755Z'
            url: https://example.com/webhook
          id: c3c0de01-3db6-41c3-942f-0c5f8a5a4c07
          links: {}
          relationships: {}
          type: webhook_subscriptions
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: >
            A `WebhookSubscription` allows you to subscribe to events that occur
            in the Edge system and get notified through webhooks.


            You can subscribe one or more of of the following events:


            ## Supported Events


            | Event Code                                    |
            Description                                  |

            |-----------------------------------------------|----------------------------------------------|

            | transaction.payment_demands.created           | A payment demand
            was created.                |

            | transaction.payment_demands.succeeded         | A payment demand
            was successfully processed. |

            | transaction.payment_demands.failed            | A payment demand
            failed to process.          |

            | transaction.payment_demands.refunded          | A payment demand
            was refunded.               |

            | transaction.payment_demands.disputed          | A payment demand
            was disputed.               |

            | transaction.refund_demands.created            | A refund demand
            was created.                 |

            | transaction.refund_demands.succeeded          | A refund demand
            was successfully processed.  |

            | transaction.refund_demands.failed             | A refund demand
            failed to process.           |

            | transaction.payment_subscriptions.created     | A payment
            subscription was created.          |

            | transaction.payment_subscriptions.updated     | A payment
            subscription was updated.          |

            | consumer.customers.created                    | A customer was
            created.                      |

            | consumer.customers.updated                    | A customer was
            updated.                      |

            | consumer.addresses.created                    | A consumer address
            was created.              |

            | consumer.addresses.updated                    | A consumer address
            was updated.              |


            ## Verification


            When created, each `WebhookSubscription` will be assigned a unique
            `secret_key`. This key

            will be used to generate a signature for the webhook payload using
            SHA1 hashing algorithm

            and will be available under the `X-Hub-Signature` header.
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                active:
                  description: Whether the webhook subscription is active
                  type: boolean
                concurrency_limit:
                  description: The number of concurrent requests allowed
                  type: integer
                created_at:
                  format: date-time
                  type: string
                description:
                  description: A description of the webhook subscription
                  type: string
                events:
                  items:
                    type: string
                  type: array
                mode:
                  description: The environment the webhook subscription listens on
                  type: string
                secret_key:
                  description: The secret key used to sign the webhook
                  type: string
                updated_at:
                  format: date-time
                  type: string
                url:
                  description: The URL to send the webhook to
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - webhook_subscriptions
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    processor_details_collection:
      description: Zero, one, or many processor_details records
      example:
        data:
          - attributes:
              created_at: '2024-06-06T21:48:33.382755Z'
              updated_at: '2024-06-06T21:48:33.382755Z'
            id: 9f57a679-eb01-4bfd-8a7d-edd8b475d476
            links: {}
            relationships: {}
            type: processor_details
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: |
              TODO: Fill in
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  created_at:
                    format: date-time
                    type: string
                  onboarding_state:
                    enum:
                      - pending
                      - approved
                    type: string
                  processing_state:
                    enum:
                      - disabled
                      - enabled
                      - monitoring
                    type: string
                  type:
                    enum:
                      - legacy
                      - edge
                      - nmi
                      - rs2
                      - eftbop
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - processor_details
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    merchants_member:
      description: A merchants record
      example:
        data:
          attributes:
            created_at: '2024-06-06T21:48:33.382755Z'
            updated_at: '2024-06-06T21:48:33.382755Z'
          id: 0a40856e-81df-4d29-86cc-265e2c0d2441
          links: {}
          relationships: {}
          type: merchants
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: >
            The legal entity of a merchant business in Edge's system.


            Edge periodically reviews the accuracy of the information provided,
            and

            keeping your merchant profile up-to-date is essential.


            You can manage this information via the merchant dashboard or the
            API.
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                account_status:
                  description: The status of the merchant account
                  enum:
                    - incomplete
                    - pending
                    - manual_review
                    - active
                    - quarantined
                    - banned
                    - abandoned
                    - archived
                    - spam
                  type: string
                active_at:
                  format: date-time
                  type: string
                business_description:
                  description: The  business description
                  type: string
                business_email:
                  description: The business email address
                  type: string
                business_name:
                  description: The legal name of the business
                  type: string
                business_privacy_policy_url:
                  description: The URL to the business' privacy policy
                  type: string
                business_support_email:
                  description: The business support email
                  type: string
                business_support_url:
                  description: The business support URL
                  type: string
                business_terms_url:
                  description: Terms of service URL
                  type: string
                business_timezone:
                  description: The timezone of the business
                  type: string
                business_website:
                  description: The business website
                  type: string
                business_zip_code:
                  description: The business postal code
                  type: string
                category_code:
                  description: The Merchant Category Code for the business
                  type: string
                created_at:
                  format: date-time
                  type: string
                entity_type:
                  description: The entity type
                  type: string
                phone_number:
                  description: The business phone number
                  type: string
                prior_bankruptcies:
                  description: Whether the business has had prior bankruptcies
                  type: string
                tax_id_type:
                  description: The type of tax ID used by the business
                  enum:
                    - ein
                    - ssn
                    - itin
                  type: string
                updated_at:
                  format: date-time
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - merchants
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    meta:
      additionalProperties: true
      description: >-
        Non-standard meta-information that can not be represented as an
        attribute or relationship.
      properties:
        authors:
          description: A list of all the authors of this work
          items:
            type: string
          type: array
        copyright:
          type: string
      type: object
    webhook_deliveries_collection:
      description: Zero, one, or many webhook_deliveries records
      example:
        data:
          - attributes:
              created_at: '2024-06-06T21:48:33.382755Z'
              fails_count: 0
              first_try_at: '2024-06-06T21:48:33.382755Z'
              updated_at: '2024-06-06T21:48:33.382755Z'
            id: 09683e82-db72-41c4-b1db-e54450f06db1
            links: {}
            relationships: {}
            type: webhook_deliveries
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: |
              TODO: Fill in
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  created_at:
                    format: date-time
                    type: string
                  fails_count:
                    description: Number of delivery failures
                    type: integer
                  first_try_at:
                    description: Timestamp of the first delivery attempt
                    format: date-time
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - webhook_deliveries
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    merchant_integrations_collection:
      description: Zero, one, or many merchant_integrations records
      example:
        data:
          - attributes:
              admin_url: https://invoiced.tryedge.io/
              created_at: '2024-06-06T21:48:33.382755Z'
              name: Edge Invoices
              updated_at: '2024-06-06T21:48:33.382755Z'
            id: 5fb039b5-61eb-428c-aea8-54c19ffe1353
            links: {}
            relationships: {}
            type: merchant_integrations
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: >
              A `MerchantIntegration` contains specific information related to
              the

              `Integration`` of a partners service to a `Merchant` account.
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  admin_url:
                    description: The admin URL
                    type: string
                  created_at:
                    format: date-time
                    type: string
                  name:
                    description: The name of the integration
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - merchant_integrations
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    account_alerts_collection:
      description: Zero, one, or many account_alerts records
      example:
        data:
          - attributes:
              acknowledged_at: '2024-06-06T21:48:33.382755Z'
              created_at: '2024-06-06T21:48:33.382755Z'
              status: pending
              updated_at: '2024-06-06T21:48:33.382755Z'
            id: fed81dfe-d44f-4ce2-ac33-b065c1a346e6
            links: {}
            relationships: {}
            type: account_alerts
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: |
              An entity representing an alert to a merchant.
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  acknowledged_at:
                    description: The time when the alert was acknowledged by the merchant
                    format: date-time
                    type: string
                  created_at:
                    format: date-time
                    type: string
                  status:
                    description: Status of the red flag
                    enum:
                      - pending
                      - acknowledged
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - account_alerts
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    link:
      description: >-
        A link **MUST** be represented as either: a string containing the link's
        URL or a link object.
      oneOf:
        - description: A string containing the link's URL.
          format: uri-reference
          type: string
        - properties:
            href:
              description: A string containing the link's URL.
              format: uri-reference
              type: string
            meta:
              $ref: '#/components/schemas/meta'
          required:
            - href
          type: object
    consumer_addresses_collection:
      description: Zero, one, or many consumer_addresses records
      example:
        data:
          - attributes:
              city: Anytown
              country: USA
              created_at: '2024-06-06T21:48:33.382755Z'
              line_1: 123 Main St
              line_2: Apt. 1
              state: CA
              updated_at: '2024-06-06T21:48:33.382755Z'
              zip: '12345'
            id: 22656d05-664c-49ce-976b-d2a19424533e
            links: {}
            relationships: {}
            type: consumer_addresses
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: >
              `ConsumerAddress` represents a physical address related to a
              customer, a charge (as a shipping address) or a payment method (as
              a billing address).


              ### Scoping


              `ConsumerAddresses` are scoped to your current mode (`sandbox` or
              `live`) denoted by the API Key.
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  city:
                    description: City
                    type: string
                  country:
                    description: Country code
                    type: string
                  created_at:
                    format: date-time
                    type: string
                  discarded_at:
                    format: date-time
                    type: string
                  line_1:
                    description: Address line 1
                    type: string
                  line_2:
                    description: Address line 2
                    type: string
                  state:
                    description: State
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                  zip:
                    description: Postal code
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - consumer_addresses
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    beneficial_owners_member:
      description: A beneficial_owners record
      example:
        data:
          attributes:
            created_at: '2024-06-06T21:48:33.382755Z'
            updated_at: '2024-06-06T21:48:33.382755Z'
          id: ad8c984a-81bd-44f7-87f0-2d2b06a67304
          links: {}
          relationships: {}
          type: beneficial_owners
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: >
            A `FinancialInstitution` refers to an entity that can act as an
            intermediary

            for financial transactions, most likely a Bank.
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                created_at:
                  format: date-time
                  type: string
                icon_url:
                  description: The URL of the financial institution's icon
                  type: string
                login_url:
                  description: The URL of the financial institution's login page
                  type: string
                logo_url:
                  description: The URL of the financial institution's logo
                  type: string
                name:
                  description: The name of the financial institution
                  type: string
                primary_colour:
                  description: The primary colour (HEX) of the financial institution
                  type: string
                state:
                  description: The state of the institution (pending, verified)
                  type: string
                updated_at:
                  format: date-time
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - beneficial_owners
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    id:
      description: >-
        [resource object
        identifier](https://jsonapi.org/format/#document-resource-object-identification)
      format: uuid
      type: string
    integrations_member:
      description: A integrations record
      example:
        data:
          attributes:
            created_at: '2024-06-06T21:48:33.382755Z'
            name: Example Integration
            updated_at: '2024-06-06T21:48:33.382755Z'
            url: https://example.com/integration
          id: 2f6f42fd-9c88-4645-aa0a-df455d4fe69a
          links: {}
          relationships: {}
          type: integrations
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: >
            An `Integration` refers to a partner service that can be integrated
            with a

            `Merchant` account through `MerchantIntegration`.
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                created_at:
                  format: date-time
                  type: string
                name:
                  description: The name of the integration
                  type: string
                updated_at:
                  format: date-time
                  type: string
                url:
                  description: The URL of the integration
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - integrations
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    payment_demands_collection:
      description: Zero, one, or many payment_demands records
      example:
        data:
          - attributes:
              created_at: '2024-06-06T21:48:33.382755Z'
              updated_at: '2024-06-06T21:48:33.382755Z'
            id: 43a27878-5451-4686-acf7-66e8f4a68f33
            links: {}
            relationships: {}
            type: payment_demands
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: >
              A `Payment Demand` instance signifies an attempt to transfer money
              from a customer's payment method to your Edge merchant account.


              A payment demand optionally belongs to a `customer`, but it is
              recommended to associate a payment demand with the customer.
              Customer payment demand history can be used as evidence in case of
              a chargeback or dispute.


              ### Pre-authorization / Hold


              Pre-authorization holds a certain amount from the customer's card.
              Such authorizations must be captured within 7 days time, or the
              hold will be removed.


              You can opt into a pre-authorization by creating a payment demand
              with the `capture_method` attribute set to `manual`.


              ### Refund a payment demand


              TODO: Fill this out


              ### Events


              A payment demand through its lifecycle will emit events. You can
              listen to these events as webhooks through `WebhookSubscription`.


              - `payment_demand.created`

              - `payment_demand.updated`

              - `payment_demand.refunded`

              - `payment_demand.succeeded`

              - `payment_demand.failed`

              - `payment_demand.disputed`

              - `payment_demand.deleted`
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  acs_transaction_eid:
                    description: The 3DSecure transaction UUID assigned by the issuer
                    type: string
                  address_line1_verification:
                    description: >-
                      The status of the billing address (Line 1) verification
                      process
                    enum:
                      - match
                      - mismatch
                      - retry
                      - unavailable
                      - unverified
                    type: string
                  amount_cents:
                    description: The amount of the payment demand in cents
                    type: integer
                  amount_currency:
                    description: The currency of the charge (ISO 4217)
                    type: string
                  capture_method:
                    description: >-
                      Determines whether a manual capture is required after
                      preauthorization or not
                    enum:
                      - automatic
                      - manual
                    type: string
                  confirmed:
                    description: Whether the payment should be processed immediately
                    type: boolean
                  created_at:
                    format: date-time
                    type: string
                  cvc2_check:
                    description: The status of the CVC verification process
                    enum:
                      - match
                      - unprocessed
                      - missing
                      - unavailable
                      - unresponsive
                    type: string
                  description:
                    description: A description of the charge
                    type: string
                  directory_transaction_eid:
                    description: The 3DSecure transaction UUID assigned by the directory
                    type: string
                  discount_cents:
                    description: >-
                      The amount of money given as a discount on the total of
                      the purchase
                    type: integer
                  eci:
                    description: >-
                      The 3DSecure Electronic Commerce Indicator for the
                      verification process
                    type: string
                  fee_cents:
                    type: integer
                  idempotency_key:
                    description: A unique value that prevents double charging
                    type: string
                  line_items:
                    description: >-
                      Itemized list of services or products being paid for in
                      the purchase
                    items:
                      type: object
                    type: array
                  payer_timezone:
                    description: IANA timezone name of the payer at time of purchase
                    type: string
                  postal_code_verification:
                    description: >-
                      The status of the billing address (postal code)
                      verification process
                    enum:
                      - match
                      - mismatch
                      - retry
                      - unavailable
                      - unverified
                    type: string
                  processor_state:
                    description: ...
                    enum:
                      - pending
                      - processing
                      - succeeded
                      - reversed
                      - refunded
                      - failed
                      - disputed
                    type: string
                  purchase_kind:
                    description: The type of purchase
                    enum:
                      - order
                      - invoice
                    type: string
                  purchase_reference:
                    description: >-
                      The unique identification for the purchase given by the
                      merchant
                    type: string
                  shipping_detail:
                    description: The purchase shipping details
                    type: object
                  succeeded_at:
                    description: Date and time when the charge succeeded (format iso8601)
                    format: date-time
                    type: string
                  tax_detail:
                    description: The purchase tax details
                    type: object
                  threeds_cryptogram:
                    description: The 3DSecure cryptogram used for verification
                    type: string
                  threeds_status:
                    description: The status of the 3DSecure verification process
                    type: string
                  threeds_version:
                    description: The 3DSecure Version used for verification
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - payment_demands
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    pagination:
      properties:
        first:
          description: The first page of data
          format: uri-reference
          nullable: true
          type: string
        last:
          description: The last page of data
          format: uri-reference
          nullable: true
          type: string
        next:
          description: The next page of data
          format: uri-reference
          nullable: true
          type: string
        prev:
          description: The previous page of data
          format: uri-reference
          nullable: true
          type: string
      type: object
    merchant_punitive_actions_member:
      description: A merchant_punitive_actions record
      example:
        data:
          attributes:
            action: quarantine
            created_at: '2024-06-06T21:48:33.382755Z'
            updated_at: '2024-06-06T21:48:33.382755Z'
          id: c16f5e92-4a30-4092-a9a7-b1b7fa0be1fa
          links: {}
          relationships: {}
          type: merchant_punitive_actions
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: >
            A `MerchantPunitiveAction` relates a `Merchant` to a `RedFlag`,
            indicating

            what action is applied.
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                action:
                  enum:
                    - quarantine
                    - ban
                  type: string
                created_at:
                  format: date-time
                  type: string
                updated_at:
                  format: date-time
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - merchant_punitive_actions
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    beneficial_owners_collection:
      description: Zero, one, or many beneficial_owners records
      example:
        data:
          - attributes:
              created_at: '2024-06-06T21:48:33.382755Z'
              updated_at: '2024-06-06T21:48:33.382755Z'
            id: 8b886f49-384f-4473-a4cb-4c7dadb9076e
            links: {}
            relationships: {}
            type: beneficial_owners
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: >
              A `FinancialInstitution` refers to an entity that can act as an
              intermediary

              for financial transactions, most likely a Bank.
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  created_at:
                    format: date-time
                    type: string
                  icon_url:
                    description: The URL of the financial institution's icon
                    type: string
                  login_url:
                    description: The URL of the financial institution's login page
                    type: string
                  logo_url:
                    description: The URL of the financial institution's logo
                    type: string
                  name:
                    description: The name of the financial institution
                    type: string
                  primary_colour:
                    description: The primary colour (HEX) of the financial institution
                    type: string
                  state:
                    description: The state of the institution (pending, verified)
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - beneficial_owners
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    merchant_punitive_actions_collection:
      description: Zero, one, or many merchant_punitive_actions records
      example:
        data:
          - attributes:
              action: quarantine
              created_at: '2024-06-06T21:48:33.382755Z'
              updated_at: '2024-06-06T21:48:33.382755Z'
            id: 4a7aaa84-b9c4-4300-be28-0863c3177c9f
            links: {}
            relationships: {}
            type: merchant_punitive_actions
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: >
              A `MerchantPunitiveAction` relates a `Merchant` to a `RedFlag`,
              indicating

              what action is applied.
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  action:
                    enum:
                      - quarantine
                      - ban
                    type: string
                  created_at:
                    format: date-time
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - merchant_punitive_actions
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    events_collection:
      description: Zero, one, or many events records
      example:
        data:
          - attributes:
              created_at: '2024-06-06T21:48:33.382755Z'
              data: {}
              mode: live
              resource_id: 076fd60a-c0e7-4683-88ae-a86528bff3da
              resource_type: transaction.payment_demands
              slug: created
            id: f2c771d7-425f-4db7-8f47-a745fd8669c4
            links: {}
            relationships: {}
            type: events
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: >
              Throughout your merchant accounts operation, various operations
              will be

              performed in relation to your accounts resources.


              Such operations trigger the creation of `Event` records along with
              references

              to the resource involved in it.


              For supported events, you can subscribe to receive webhooks
              through

              `WebhookSubscription` as these events are recorded.


              This is a comprehensive list of events your merchant account will
              encounter.


              | Resource Type                     | Slug      |
              Description                                  |

              | --------------------------------- | --------- |
              -------------------------------------------- |

              | transaction.payment_demands       | created   | A payment demand
              was created.                |

              | transaction.payment_demands       | succeeded | A payment demand
              was successfully processed. |

              | transaction.payment_demands       | failed    | A payment demand
              failed to process.          |

              | transaction.payment_demands       | refunded  | A payment demand
              was refunded.               |

              | transaction.payment_demands       | disputed  | A payment demand
              was disputed.               |

              | transaction.refund_demands        | created   | A refund demand
              was created.                 |

              | transaction.refund_demands        | succeeded | A refund demand
              was successfully processed.  |

              | transaction.refund_demands        | failed    | A refund demand
              failed to process.           |

              | transaction.payment_subscriptions | created   | A payment
              subscription was created.          |

              | transaction.payment_subscriptions | updated   | A payment
              subscription was updated.          |

              | consumer.customers                | created   | A customer was
              created.                      |

              | consumer.customers                | updated   | A customer was
              updated.                      |

              | consumer.addresses                | created   | A consumer
              address was created.              |

              | consumer.addresses                | updated   | A consumer
              address was updated.              |
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  created_at:
                    format: date-time
                    type: string
                  data:
                    description: Event data
                    type: object
                  mode:
                    description: The mode in which the event was created (sandbox/live)
                    enum:
                      - live
                      - sandbox
                    type: string
                  resource_id:
                    description: The ID of the resource the event is related to
                    type: string
                  resource_type:
                    description: The type of resource the event is related to
                    type: string
                  slug:
                    description: The slug of the event
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - events
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    webhook_subscriptions_collection:
      description: Zero, one, or many webhook_subscriptions records
      example:
        data:
          - attributes:
              active: true
              concurrency_limit: 50
              created_at: '2024-06-06T21:48:33.382755Z'
              description: Webhook for payment demands
              events:
                - transaction.payment_demands.created
                - transaction.payment_demands.succeeded
                - transaction.payment_demands.failed
              secret_key: shh-itsasecret
              updated_at: '2024-06-06T21:48:33.382755Z'
              url: https://example.com/webhook
            id: 1310d4f2-fc2b-42ac-bd5e-0399d7b67b3d
            links: {}
            relationships: {}
            type: webhook_subscriptions
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: >
              A `WebhookSubscription` allows you to subscribe to events that
              occur in the Edge system and get notified through webhooks.


              You can subscribe one or more of of the following events:


              ## Supported Events


              | Event Code                                    |
              Description                                  |

              |-----------------------------------------------|----------------------------------------------|

              | transaction.payment_demands.created           | A payment demand
              was created.                |

              | transaction.payment_demands.succeeded         | A payment demand
              was successfully processed. |

              | transaction.payment_demands.failed            | A payment demand
              failed to process.          |

              | transaction.payment_demands.refunded          | A payment demand
              was refunded.               |

              | transaction.payment_demands.disputed          | A payment demand
              was disputed.               |

              | transaction.refund_demands.created            | A refund demand
              was created.                 |

              | transaction.refund_demands.succeeded          | A refund demand
              was successfully processed.  |

              | transaction.refund_demands.failed             | A refund demand
              failed to process.           |

              | transaction.payment_subscriptions.created     | A payment
              subscription was created.          |

              | transaction.payment_subscriptions.updated     | A payment
              subscription was updated.          |

              | consumer.customers.created                    | A customer was
              created.                      |

              | consumer.customers.updated                    | A customer was
              updated.                      |

              | consumer.addresses.created                    | A consumer
              address was created.              |

              | consumer.addresses.updated                    | A consumer
              address was updated.              |


              ## Verification


              When created, each `WebhookSubscription` will be assigned a unique
              `secret_key`. This key

              will be used to generate a signature for the webhook payload using
              SHA1 hashing algorithm

              and will be available under the `X-Hub-Signature` header.
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  active:
                    description: Whether the webhook subscription is active
                    type: boolean
                  concurrency_limit:
                    description: The number of concurrent requests allowed
                    type: integer
                  created_at:
                    format: date-time
                    type: string
                  description:
                    description: A description of the webhook subscription
                    type: string
                  events:
                    items:
                      type: string
                    type: array
                  mode:
                    description: The environment the webhook subscription listens on
                    type: string
                  secret_key:
                    description: The secret key used to sign the webhook
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                  url:
                    description: The URL to send the webhook to
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - webhook_subscriptions
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    error:
      description: >-
        An individual [error object](https://jsonapi.org/format/#error-objects)
        that needs consideration
      properties:
        code:
          description: An application-specific error code, expressed as a string value.
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          type: string
        id:
          description: A unique identifier for this particular occurrence of the problem.
          type: string
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
        source:
          properties:
            parameter:
              description: A string indicating which query parameter caused the error.
              type: string
            pointer:
              description: >-
                A JSON Pointer [RFC6901] to the associated entity in the request
                document [e.g. `/data` for a primary data object, or
                `/data/attributes/title` for a specific attribute].
              type: string
          type: object
        status:
          description: >-
            The HTTP status code applicable to this problem, expressed as a
            string value.
          type: string
        title:
          description: >-
            A short, human-readable summary of the problem. It **SHOULD NOT**
            change from occurrence to occurrence of the problem, except for
            purposes of localization.
          type: string
      type: object
    memberships_member:
      description: A memberships record
      example:
        data:
          attributes:
            created_at: '2024-06-06T21:48:33.382755Z'
            opener: true
            updated_at: '2024-06-06T21:48:33.382755Z'
          id: 6f48c284-420e-4466-8040-d0755d6be49c
          links: {}
          relationships: {}
          type: memberships
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: >
            A `Membership` contains information relating an `Account` to a
            `Merchant`.


            While an `Account` can be related to many merchants, a `Membership`
            contains

            information of the association with a specific one.
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                created_at:
                  format: date-time
                  type: string
                opener:
                  description: Whether its the account owner
                  type: boolean
                updated_at:
                  format: date-time
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - memberships
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    integrations_collection:
      description: Zero, one, or many integrations records
      example:
        data:
          - attributes:
              created_at: '2024-06-06T21:48:33.382755Z'
              name: Example Integration
              updated_at: '2024-06-06T21:48:33.382755Z'
              url: https://example.com/integration
            id: 76cb7925-dff3-4bc5-9e15-e767dc461c9f
            links: {}
            relationships: {}
            type: integrations
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: >
              An `Integration` refers to a partner service that can be
              integrated with a

              `Merchant` account through `MerchantIntegration`.
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  created_at:
                    format: date-time
                    type: string
                  name:
                    description: The name of the integration
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                  url:
                    description: The URL of the integration
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - integrations
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    refund_demands_collection:
      description: Zero, one, or many refund_demands records
      example:
        data:
          - attributes:
              amount_cents: 1000
              amount_currency: USD
              created_at: '2024-06-06T21:48:33.382755Z'
              reason: duplicate_charge
              state: succeeded
              updated_at: '2024-06-06T21:48:33.382755Z'
            id: 055f0b2c-f188-4bde-b040-05343785fb0d
            links: {}
            relationships: {}
            type: refund_demands
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: |2
                A `RefundDemand` instance signifies an attempt to refund a `PaymentDemand`.
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  amount_cents:
                    description: The amount of the refund demand in cents
                    type: integer
                  amount_currency:
                    description: The currency of the refund demand (ISO 4217)
                    type: string
                  created_at:
                    format: date-time
                    type: string
                  reason:
                    enum:
                      - service_not_delivered
                      - duplicate_charge
                      - unauthorized_transaction
                      - technical_issue
                      - customer_canceled
                      - dissatisfied_experience
                      - compliance_issue
                    type: string
                  state:
                    enum:
                      - pending
                      - processing
                      - succeeded
                      - failed
                      - errored
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - refund_demands
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    webhook_deliveries_member:
      description: A webhook_deliveries record
      example:
        data:
          attributes:
            created_at: '2024-06-06T21:48:33.382755Z'
            fails_count: 0
            first_try_at: '2024-06-06T21:48:33.382755Z'
            updated_at: '2024-06-06T21:48:33.382755Z'
          id: d0a562bd-8dbf-4e54-837f-a9582ddec85f
          links: {}
          relationships: {}
          type: webhook_deliveries
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: |
            TODO: Fill in
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                created_at:
                  format: date-time
                  type: string
                fails_count:
                  description: Number of delivery failures
                  type: integer
                first_try_at:
                  description: Timestamp of the first delivery attempt
                  format: date-time
                  type: string
                updated_at:
                  format: date-time
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - webhook_deliveries
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    corporate_officials_collection:
      description: Zero, one, or many corporate_officials records
      example:
        data:
          - attributes:
              created_at: '2024-06-06T21:48:33.382755Z'
              daily_contact: true
              payments_decision_maker: true
              role: CEO
              updated_at: '2024-06-06T21:48:33.382755Z'
            id: dcbfae55-12af-4eee-84ac-8227565a4eb6
            links: {}
            relationships: {}
            type: corporate_officials
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: >
              A `CorporateOfficial` represents a person responsible for managing
              the

              relationship of a `Merchant` with Edge.
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  created_at:
                    format: date-time
                    type: string
                  daily_contact:
                    description: >-
                      Whether the corporate official is the companies daily
                      contact with Edge
                    type: boolean
                  payments_decision_maker:
                    description: >-
                      Whether the corporate official has the authority to make
                      payments related decisions
                    type: boolean
                  role:
                    description: The role of the corporate official (e.g. President, CEO)
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - corporate_officials
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    consumer_addresses_member:
      description: A consumer_addresses record
      example:
        data:
          attributes:
            city: Anytown
            country: USA
            created_at: '2024-06-06T21:48:33.382755Z'
            line_1: 123 Main St
            line_2: Apt. 1
            state: CA
            updated_at: '2024-06-06T21:48:33.382755Z'
            zip: '12345'
          id: 9c637cba-69c6-4549-b578-720cdadfc932
          links: {}
          relationships: {}
          type: consumer_addresses
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: >
            `ConsumerAddress` represents a physical address related to a
            customer, a charge (as a shipping address) or a payment method (as a
            billing address).


            ### Scoping


            `ConsumerAddresses` are scoped to your current mode (`sandbox` or
            `live`) denoted by the API Key.
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                city:
                  description: City
                  type: string
                country:
                  description: Country code
                  type: string
                created_at:
                  format: date-time
                  type: string
                discarded_at:
                  format: date-time
                  type: string
                line_1:
                  description: Address line 1
                  type: string
                line_2:
                  description: Address line 2
                  type: string
                state:
                  description: State
                  type: string
                updated_at:
                  format: date-time
                  type: string
                zip:
                  description: Postal code
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - consumer_addresses
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    permissions_collection:
      description: Zero, one, or many permissions records
      example:
        data:
          - attributes:
              created_at: '2024-06-06T21:48:33.382755Z'
              updated_at: '2024-06-06T21:48:33.382755Z'
            id: c62319b7-4566-4e61-9ee4-70f9d2de699e
            links: {}
            relationships: {}
            type: permissions
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: |
              TODO: Fill in
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  created_at:
                    format: date-time
                    type: string
                  description:
                    description: A description of the permission
                    type: string
                  slug:
                    description: The permission identifier
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - permissions
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    merchants_collection:
      description: Zero, one, or many merchants records
      example:
        data:
          - attributes:
              created_at: '2024-06-06T21:48:33.382755Z'
              updated_at: '2024-06-06T21:48:33.382755Z'
            id: 4bb7ca0e-af43-4d1b-868e-197f2a94cac0
            links: {}
            relationships: {}
            type: merchants
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: >
              The legal entity of a merchant business in Edge's system.


              Edge periodically reviews the accuracy of the information
              provided, and

              keeping your merchant profile up-to-date is essential.


              You can manage this information via the merchant dashboard or the
              API.
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  account_status:
                    description: The status of the merchant account
                    enum:
                      - incomplete
                      - pending
                      - manual_review
                      - active
                      - quarantined
                      - banned
                      - abandoned
                      - archived
                      - spam
                    type: string
                  active_at:
                    format: date-time
                    type: string
                  business_description:
                    description: The  business description
                    type: string
                  business_email:
                    description: The business email address
                    type: string
                  business_name:
                    description: The legal name of the business
                    type: string
                  business_privacy_policy_url:
                    description: The URL to the business' privacy policy
                    type: string
                  business_support_email:
                    description: The business support email
                    type: string
                  business_support_url:
                    description: The business support URL
                    type: string
                  business_terms_url:
                    description: Terms of service URL
                    type: string
                  business_timezone:
                    description: The timezone of the business
                    type: string
                  business_website:
                    description: The business website
                    type: string
                  business_zip_code:
                    description: The business postal code
                    type: string
                  category_code:
                    description: The Merchant Category Code for the business
                    type: string
                  created_at:
                    format: date-time
                    type: string
                  entity_type:
                    description: The entity type
                    type: string
                  phone_number:
                    description: The business phone number
                    type: string
                  prior_bankruptcies:
                    description: Whether the business has had prior bankruptcies
                    type: string
                  tax_id_type:
                    description: The type of tax ID used by the business
                    enum:
                      - ein
                      - ssn
                      - itin
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - merchants
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    payment_demands_member:
      description: A payment_demands record
      example:
        data:
          attributes:
            created_at: '2024-06-06T21:48:33.382755Z'
            updated_at: '2024-06-06T21:48:33.382755Z'
          id: e16e0ef8-cb8a-44fe-ad78-ec4a19b8c2f8
          links: {}
          relationships: {}
          type: payment_demands
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: >
            A `Payment Demand` instance signifies an attempt to transfer money
            from a customer's payment method to your Edge merchant account.


            A payment demand optionally belongs to a `customer`, but it is
            recommended to associate a payment demand with the customer.
            Customer payment demand history can be used as evidence in case of a
            chargeback or dispute.


            ### Pre-authorization / Hold


            Pre-authorization holds a certain amount from the customer's card.
            Such authorizations must be captured within 7 days time, or the hold
            will be removed.


            You can opt into a pre-authorization by creating a payment demand
            with the `capture_method` attribute set to `manual`.


            ### Refund a payment demand


            TODO: Fill this out


            ### Events


            A payment demand through its lifecycle will emit events. You can
            listen to these events as webhooks through `WebhookSubscription`.


            - `payment_demand.created`

            - `payment_demand.updated`

            - `payment_demand.refunded`

            - `payment_demand.succeeded`

            - `payment_demand.failed`

            - `payment_demand.disputed`

            - `payment_demand.deleted`
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                acs_transaction_eid:
                  description: The 3DSecure transaction UUID assigned by the issuer
                  type: string
                address_line1_verification:
                  description: >-
                    The status of the billing address (Line 1) verification
                    process
                  enum:
                    - match
                    - mismatch
                    - retry
                    - unavailable
                    - unverified
                  type: string
                amount_cents:
                  description: The amount of the payment demand in cents
                  type: integer
                amount_currency:
                  description: The currency of the charge (ISO 4217)
                  type: string
                capture_method:
                  description: >-
                    Determines whether a manual capture is required after
                    preauthorization or not
                  enum:
                    - automatic
                    - manual
                  type: string
                confirmed:
                  description: Whether the payment should be processed immediately
                  type: boolean
                created_at:
                  format: date-time
                  type: string
                cvc2_check:
                  description: The status of the CVC verification process
                  enum:
                    - match
                    - unprocessed
                    - missing
                    - unavailable
                    - unresponsive
                  type: string
                description:
                  description: A description of the charge
                  type: string
                directory_transaction_eid:
                  description: The 3DSecure transaction UUID assigned by the directory
                  type: string
                discount_cents:
                  description: >-
                    The amount of money given as a discount on the total of the
                    purchase
                  type: integer
                eci:
                  description: >-
                    The 3DSecure Electronic Commerce Indicator for the
                    verification process
                  type: string
                fee_cents:
                  type: integer
                idempotency_key:
                  description: A unique value that prevents double charging
                  type: string
                line_items:
                  description: >-
                    Itemized list of services or products being paid for in the
                    purchase
                  items:
                    type: object
                  type: array
                payer_timezone:
                  description: IANA timezone name of the payer at time of purchase
                  type: string
                postal_code_verification:
                  description: >-
                    The status of the billing address (postal code) verification
                    process
                  enum:
                    - match
                    - mismatch
                    - retry
                    - unavailable
                    - unverified
                  type: string
                processor_state:
                  description: ...
                  enum:
                    - pending
                    - processing
                    - succeeded
                    - reversed
                    - refunded
                    - failed
                    - disputed
                  type: string
                purchase_kind:
                  description: The type of purchase
                  enum:
                    - order
                    - invoice
                  type: string
                purchase_reference:
                  description: >-
                    The unique identification for the purchase given by the
                    merchant
                  type: string
                shipping_detail:
                  description: The purchase shipping details
                  type: object
                succeeded_at:
                  description: Date and time when the charge succeeded (format iso8601)
                  format: date-time
                  type: string
                tax_detail:
                  description: The purchase tax details
                  type: object
                threeds_cryptogram:
                  description: The 3DSecure cryptogram used for verification
                  type: string
                threeds_status:
                  description: The status of the 3DSecure verification process
                  type: string
                threeds_version:
                  description: The 3DSecure Version used for verification
                  type: string
                updated_at:
                  format: date-time
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - payment_demands
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    payment_subscriptions_member:
      description: A payment_subscriptions record
      example:
        data:
          attributes:
            created_at: '2024-06-06T21:48:33.382755Z'
            line_items:
              - amount_cents: 10000
                amount_currency: USD
                description: A toy
                fee_cents: 500
                quantity: 1
            status: active
            updated_at: '2024-06-06T21:48:33.382755Z'
          id: 246daff2-e2d3-4ed4-9ffc-546460c9d129
          links: {}
          relationships: {}
          type: payment_subscriptions
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: >
            Payment Subscriptions allow you to charge customers recurringly for
            access to a product or service. Edge supports subscriptions with
            billing cycles `weekly`, `biweekly`, `monthly`, `bimonthly`,
            `quarterly`, `semiannual`, and `yearly`. Edge will create a new
            charge against the associated payment method when a new cycle
            begins.


            ### Events


            You can listen to `payment_subscriptions.created`,
            `payment_subscriptions.updated` and `payment_subscriptions.deleted`
            events on the resource. In addition, charges would trigger their
            respective events as they advance through their lifecycle.


            ### Detecting Failures


            A subscription will be in an `active` status unless specified
            otherwise. However, the customer may have entered the card details
            incorrectly. In this case, the subscription `status` will transit
            from `active` to `past_due`. Track this transition using
            `WebhookSubscription` by listening to the `subscription.updated`
            event.
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                acs_transaction_eid:
                  description: The 3DSecure transaction UUID assigned by the issuer
                  type: string
                address_line1_verification:
                  description: >-
                    The status of the billing address (Line 1) verification
                    process
                  enum:
                    - match
                    - mismatch
                    - retry
                    - unavailable
                    - unverified
                  type: string
                amount_cents:
                  description: The amount of the payment demand in cents
                  type: integer
                amount_currency:
                  description: The currency of the charge (ISO 4217)
                  type: string
                billing_cycle_anchor_at:
                  description: The reference date for the billing_period
                  format: date-time
                  type: string
                billing_period:
                  description: The reference date for the billing_period
                  enum:
                    - one_day
                    - seven_days
                    - fourteen_days
                    - thirty_days
                    - one_month
                    - six_months
                    - twelve_months
                  type: string
                canceled_at:
                  description: The date the subscription should be cancelled after
                  type: string
                confirmed:
                  description: Whether the payment should be processed immediately
                  type: boolean
                created_at:
                  format: date-time
                  type: string
                cvc2_check:
                  description: The status of the CVC verification process
                  enum:
                    - match
                    - unprocessed
                    - missing
                    - unavailable
                    - unresponsive
                  type: string
                description:
                  description: A description of the charge
                  type: string
                directory_transaction_eid:
                  description: The 3DSecure transaction UUID assigned by the directory
                  type: string
                discount_cents:
                  description: >-
                    The amount of money given as a discount on the total of the
                    purchase
                  type: integer
                eci:
                  description: >-
                    The 3DSecure Electronic Commerce Indicator for the
                    verification process
                  type: string
                fee_cents:
                  type: integer
                idempotency_key:
                  description: A unique value that prevents double charging
                  type: string
                line_items:
                  description: >-
                    Itemized list of services or products being paid for in the
                    purchase
                  items:
                    type: object
                  type: array
                payer_timezone:
                  description: IANA timezone name of the payer at time of purchase
                  type: string
                postal_code_verification:
                  description: >-
                    The status of the billing address (postal code) verification
                    process
                  enum:
                    - match
                    - mismatch
                    - retry
                    - unavailable
                    - unverified
                  type: string
                purchase_kind:
                  description: The type of purchase
                  enum:
                    - order
                    - invoice
                  type: string
                purchase_reference:
                  description: >-
                    The unique identification for the purchase given by the
                    merchant
                  type: string
                shipping_detail:
                  description: The purchase shipping details
                  type: object
                slug:
                  description: A reference name from which subscriptions can be grouped for
                  type: string
                status:
                  description: >-
                    The period the subscriptions charge for, in relation to the
                    billing_cycle_anchor
                  enum:
                    - active
                    - paused
                    - cancelled
                  type: string
                tax_detail:
                  description: The purchase tax details
                  type: object
                threeds_cryptogram:
                  description: The 3DSecure cryptogram used for verification
                  type: string
                threeds_status:
                  description: The status of the 3DSecure verification process
                  type: string
                threeds_version:
                  description: The 3DSecure Version used for verification
                  type: string
                updated_at:
                  format: date-time
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - payment_subscriptions
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    account_alerts_member:
      description: A account_alerts record
      example:
        data:
          attributes:
            acknowledged_at: '2024-06-06T21:48:33.382755Z'
            created_at: '2024-06-06T21:48:33.382755Z'
            status: pending
            updated_at: '2024-06-06T21:48:33.382755Z'
          id: fdcaff3d-f7e2-4a7c-80f6-00cdf69af5ce
          links: {}
          relationships: {}
          type: account_alerts
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: |
            An entity representing an alert to a merchant.
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                acknowledged_at:
                  description: The time when the alert was acknowledged by the merchant
                  format: date-time
                  type: string
                created_at:
                  format: date-time
                  type: string
                status:
                  description: Status of the red flag
                  enum:
                    - pending
                    - acknowledged
                  type: string
                updated_at:
                  format: date-time
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - account_alerts
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    jsonapi:
      description: An object describing the server's implementation
      properties:
        meta:
          $ref: '#/components/schemas/meta'
        version:
          type: string
      type: object
    personal_identifications_member:
      description: A personal_identifications record
      example:
        data:
          attributes:
            created_at: '2024-06-06T21:48:33.382755Z'
            dob: '1990-01-01'
            email: johndoe@example.com
            full_name: John Doe
            id_number: 123-45-6789
            name_on_document: John Doe
            nationality: USA
            personal_name: John
            phone_number: '+1234567890'
            updated_at: '2024-06-06T21:48:33.382755Z'
          id: 80c815a1-6a8d-4cd3-957e-b2705f6cdab0
          links: {}
          relationships: {}
          type: personal_identifications
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: |
            TODO: Fill in
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                created_at:
                  format: date-time
                  type: string
                dob:
                  description: Date of birth
                  format: date
                  type: string
                email:
                  format: email
                  type: string
                full_name:
                  description: Full Name
                  type: string
                id_number:
                  description: >-
                    Identification number (SSN for US citizens and passport
                    number for others)
                  type: string
                name_on_document:
                  description: Name on the photo ID
                  type: string
                nationality:
                  description: The legal national identification
                  type: string
                personal_name:
                  description: Personal name
                  type: string
                phone_number:
                  format: phone
                  type: string
                surname:
                  description: Surname
                  type: string
                updated_at:
                  format: date-time
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - personal_identifications
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    merchant_tokens_collection:
      description: Zero, one, or many merchant_tokens records
      example:
        data:
          - attributes:
              created_at: '2024-06-06T21:48:33.382755Z'
              updated_at: '2024-06-06T21:48:33.382755Z'
            id: b828a34b-5aa8-444a-b486-ef623ca04f67
            links: {}
            relationships: {}
            type: merchant_tokens
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: >
              A `MerchantToken` provides the access mechanism through which
              financial

              operations are performed, relating a `Merchant` to a
              `ProcessorDetail`.
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  context:
                    enum:
                      - secret
                      - browser
                    type: string
                  created_at:
                    format: date-time
                    type: string
                  expiry:
                    description: The expiry date of the token
                    format: date-time
                    type: string
                  name:
                    description: The name of the token
                    type: string
                  schema:
                    enum:
                      - live
                      - sandbox
                    type: string
                  token:
                    description: The token
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - merchant_tokens
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    payment_methods_collection:
      description: Zero, one, or many payment_methods records
      example:
        data:
          - attributes:
              created_at: '2024-06-06T21:48:33.382755Z'
              updated_at: '2024-06-06T21:48:33.382755Z'
            id: 5bf7356e-3d5b-4df3-8d9d-abab5e944d03
            links: {}
            relationships: {}
            type: payment_methods
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: >
              Use the `PaymentMethod` API to store customer credit/debit card
              details for immediate (charges) or later processing
              (subscriptions). The API does not accept raw card numbers or cvv
              values. Edge JS will provide tokenised values for card numbers
              (`card_pan_token`) and cvv (`card_cvv_token`).


              Edge currently supports credit and debit cards of Visa, Master,
              AMEX and Discovery. Edge intends to introduce support for ACH
              payments soon.
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  card_bin:
                    description: First 6 digits of card number
                    type: string
                  card_cvv_token:
                    description: The CVV token
                    type: string
                  card_pan_token:
                    description: The card PAN token
                    type: string
                  created_at:
                    format: date-time
                    type: string
                  description:
                    description: A description of the payment method
                    type: string
                  discarded_at:
                    format: date-time
                    type: string
                  expiry_month:
                    description: The month of the cards expiry date
                    type: integer
                  expiry_year:
                    description: The year of the cards expiry date, in YYYY format
                    type: integer
                  external_state:
                    enum:
                      - pending
                      - confirmed
                      - failed
                      - errored
                    type: string
                  kind:
                    enum:
                      - checking
                      - savings
                      - visa
                      - mastercard
                      - amex
                      - discover
                      - diners
                      - elo
                      - hiper
                      - hipercard
                      - jcb
                      - maestro
                      - mir
                      - unionpay
                      - unknown
                    type: string
                  last_four:
                    description: Last 4 digits of card number
                    type: string
                  nickname:
                    description: >-
                      The name given by the cardholder to distinguish between
                      other cards
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - payment_methods
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    refund_demands_member:
      description: A refund_demands record
      example:
        data:
          attributes:
            amount_cents: 1000
            amount_currency: USD
            created_at: '2024-06-06T21:48:33.382755Z'
            reason: duplicate_charge
            state: succeeded
            updated_at: '2024-06-06T21:48:33.382755Z'
          id: 21107383-69fe-42a5-bafd-3c594788b2bc
          links: {}
          relationships: {}
          type: refund_demands
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: |2
              A `RefundDemand` instance signifies an attempt to refund a `PaymentDemand`.
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                amount_cents:
                  description: The amount of the refund demand in cents
                  type: integer
                amount_currency:
                  description: The currency of the refund demand (ISO 4217)
                  type: string
                created_at:
                  format: date-time
                  type: string
                reason:
                  enum:
                    - service_not_delivered
                    - duplicate_charge
                    - unauthorized_transaction
                    - technical_issue
                    - customer_canceled
                    - dissatisfied_experience
                    - compliance_issue
                  type: string
                state:
                  enum:
                    - pending
                    - processing
                    - succeeded
                    - failed
                    - errored
                  type: string
                updated_at:
                  format: date-time
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - refund_demands
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    customers_member:
      description: A customers record
      example:
        data:
          attributes:
            created_at: '2024-06-06T21:48:33.382755Z'
            description: First customer
            email: johndoe@example.com
            name: John Doe
            phone_number: '+1234567890'
            updated_at: '2024-06-06T21:48:33.382755Z'
          id: ebbad55c-0734-403f-aa09-d5ae0c1c96da
          links: {}
          relationships: {}
          type: customers
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: >
            A `Customer` in Edge represents a customer in your business.


            While the

            customer resource is considered optional, it is highly recommended
            that you

            create a customer for each of your customers.


            This will allow you to track

            past transactions involving the customer and will be used as
            evidence in the

            case of a chargeback/dispute.
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                blocked_at:
                  format: date-time
                  type: string
                created_at:
                  format: date-time
                  type: string
                description:
                  type: string
                email:
                  format: email
                  type: string
                name:
                  description: The name of the customer
                  type: string
                phone_number:
                  format: phone
                  type: string
                updated_at:
                  format: date-time
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - customers
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    legal_addresses_collection:
      description: Zero, one, or many legal_addresses records
      example:
        data:
          - attributes:
              city: Anytown
              country: USA
              created_at: '2024-06-06T21:48:33.382755Z'
              line_1: 123 Main St
              line_2: Apt. 1
              state: CA
              updated_at: '2024-06-06T21:48:33.382755Z'
              zip: '12345'
            id: 58c2bdac-9c20-48c9-89f5-c526468de32c
            links: {}
            relationships: {}
            type: legal_addresses
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          items:
            description: >
              `LegalAddress` represents a physical address associated with the
              merchant account opener and the beneficial owners.


              ### Scoping


              Unlike its counterpart, `ConsumerAddress`, `LegalAddress` is not
              scoped to a mode (`sandbox` or `live`).
            properties:
              attributes:
                description: >-
                  Members of the attributes object (`attributes`) represent
                  information about the resource object in which it's defined.
                properties:
                  city:
                    description: City
                    type: string
                  country:
                    description: Country code
                    type: string
                  created_at:
                    format: date-time
                    type: string
                  line_1:
                    description: Address line 1
                    type: string
                  line_2:
                    description: Address line 2
                    type: string
                  state:
                    description: State
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                  zip:
                    description: Postal code
                    type: string
                type: object
              id:
                $ref: '#/components/schemas/id'
              links:
                description: The links of the type
                properties: {}
                type: object
              relationships:
                description: The relationships of the type
                properties: {}
                type: object
              type:
                description: >-
                  [resource object
                  type](https://jsonapi.org/format/#document-resource-object-identification)
                enum:
                  - legal_addresses
                type: string
            required:
              - id
              - type
              - links
            type: object
          type: array
          uniqueItems: true
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
    merchant_tokens_member:
      description: A merchant_tokens record
      example:
        data:
          attributes:
            created_at: '2024-06-06T21:48:33.382755Z'
            updated_at: '2024-06-06T21:48:33.382755Z'
          id: 625413d0-4b6b-445c-a51e-353bbf035219
          links: {}
          relationships: {}
          type: merchant_tokens
        links: {}
        meta:
          authors:
            - Ziyan Judaideen
            - James Stuessy
            - Amadeus Folego
            - Kurtis Rainbolt-Greene
          copyright: 2026 Edge Payment Technologies, Inc.
      properties:
        data:
          description: >
            A `MerchantToken` provides the access mechanism through which
            financial

            operations are performed, relating a `Merchant` to a
            `ProcessorDetail`.
          properties:
            attributes:
              description: >-
                Members of the attributes object (`attributes`) represent
                information about the resource object in which it's defined.
              properties:
                context:
                  enum:
                    - secret
                    - browser
                  type: string
                created_at:
                  format: date-time
                  type: string
                expiry:
                  description: The expiry date of the token
                  format: date-time
                  type: string
                name:
                  description: The name of the token
                  type: string
                schema:
                  enum:
                    - live
                    - sandbox
                  type: string
                token:
                  description: The token
                  type: string
                updated_at:
                  format: date-time
                  type: string
              type: object
            id:
              $ref: '#/components/schemas/id'
            links:
              description: The links of the type
              properties: {}
              type: object
            relationships:
              description: The relationships of the type
              properties: {}
              type: object
            type:
              description: >-
                [resource object
                type](https://jsonapi.org/format/#document-resource-object-identification)
              enum:
                - merchant_tokens
              type: string
          required:
            - id
            - type
            - links
          type: object
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
        meta:
          $ref: '#/components/schemas/meta'
      required:
        - links
      type: object
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http
externalDocs:
  description: Read more about {json:api} here
  url: https://jsonapi.org/
info:
  contact:
    email: support@tryedge.io
    name: Support
    url: https://www.tryedge.io/contact
  description: "Edge Payment Technologies offers payment solutions for merchants in diverse legal industries. To learn more about Edge's proposition see our [about](https://tryedge.io/about) page.\n\n## Authentication\n\nBefore starting with the API, you must [create a merchant account](https://dashboard.tryedge.io/register/your-details) and obtain API keys from the [Developer tab](https://dashboard.tryedge.io/developers) in your account dashboard. You will use the “Publishable key” with Edge JavaScript SDK and the “Secret key” with any SDK or HTTP API call. The Edge HTTP API requires in every request a `Authorization` header with a `Bearer` token.\n\n## JSONAPI\n\nThe Edge API is based upon REST principles, returns JSON responses, and uses standard HTTP response codes. We speficially use the [JSON:API](https://jsonapi.org/) specification.\n\n## Browser SDK\n\nIf you're wanting to use Edge Payment Technologies in the browser to make a charge you're going to need to include the Edge javascript SDK. The\_Edge JavaScript SDK is a toolkit for encrypting data in the browser. Using the Edge JavaScript SDK means your customer's data never leaves their browser unencrypted. You can get the URL to the SDK on the [Developers page](https://dashboard.tryedge.io/developers).\n\nThen after that you need to initialize the client:\n\n```javascript\nconst publishableToken = \"publishableToken\";\nconst formFactor = \"inputs\";\nconst paymentButton = document.querySelector(\"button#pay\");\n\nconsole.log(\"Initializing Edge JS with Payment ID:\", paymentId);\nconsole.log(\"Publishable Key:\", publishableToken);\nconst edgeClient = new Edge(publishableToken, {});\n```\n\nOnce initialized you'll need to wait for webhook subscriptions in your backend, but you can also define optimistic\njavascript event callbacks:\n\n```javascript\nedgeClient.on(\"payment_method_verifying\", (payload) => {\n  console.log(\"Verifying payment method\", payload.detail);\n  // ...\n});\n\nedgeClient.on(\"payment_method_ready\", (payload) => {\n  console.log(\"Payment method ready\", payload.detail);\n  if (paymentButton) {\n    // ...\n  }\n});\n\nedgeClient.on(\"payment_approved\", (payload) => {\n  console.log(\"Payment approved\", payload.detail);\n});\n\nedgeClient.on(\"subscription_approved\", (payload) => {\n  console.log(\"Subscription approved\", payload.detail);\n  // ...\n});\n\nedgeClient.on(\"payment_method_verified\", async (payload) => {\n  console.log(\"Payment method verified\", payload.detail);\n  // ...\n});\n\nedgeClient.on(\"payment_failed\", (payload) => {\n  console.log(\"Payment failed\", payload.detail);\n  // ...\n});\n\nedgeClient.on(\"payment_timeout\", (payload) => {\n  console.log(\"Payment timeout\", payload.detail);\n  // ...\n});\n\n// Pay button click triggers payment method verification\npaymentButton.addEventListener(\"click\", function () {\n  // ...\n  edgeClient.verifyPaymentMethod().catch((err) => {\n    console.error(\"Payment method verification failed\", err);\n    // ...\n  });\n});\n```\n\nFinally you need to mount the edge client to the form:\n\n```javascript\nedgeClient.mountPaymentForm(\"edge-js\", paymentId);\n```\n\n## Test Card Numbers (By network)\n\n| Card Number         | 3DS Result                   | Network Result              |\n| ------------------- | ---------------------------- | --------------------------- |\n| 4005519200000004    | Frictionless Success         | Visa Success                |\n| 4444333322221111455 | Frictionless Success         | Visa (19 Digit Pan) Success |\n| 5406004444444443    | Frictionless Success         | Mastercard Success          |\n| 6011450103333333    | Frictionless Success         | Discover Success            |\n| 370000999999990     | Frictionless Success         | AmEx Success                |\n| 36006666333344      | Frictionless Success         | Dinner's Club Success       |\n| 6771798021000008    | Frictionless Success         | Maestro Success             |\n| 4124939999999990    | Frictionless Success         | Generic Decline             |\n| 4444333322221111    | Frictionless Success         | Insufficient Funds          |\n| 5555341244441115    | Frictionless Success         | Lost Card                   |\n| 6011601160116611    | Frictionless Success         | Stolen Card                 |\n| 370000000000002     | Frictionless Success         | Incorrect CVC               |\n| 4917300800000000    | Frictionless Success         | Always Blocked              |\n| 5407721000353481    | Frictionless Success         | Highest risk                |\n| 370000000100018     | Frictionless Rejection       | -                           |\n| 5100060000000002    | Challenge Prompt             | Success                     |\n| 4012000077777777    | Not Enrolled                 | -                           |\n| 4166676667666746    | Issuer Rejected, Unattempted | -                           |\n\n#### JSON:API Filtering\n\nEPT supports advanced filtering for all JSON:API resources via query parameters. You can filter by attributes, relationships, and relationship attributes using dot notation.\n\nFilter by a direct attribute:\n\n```\nGET /api/payment_demands?filter[status]=pending\n```\n\nFilter by a relationship's ID:\n\n```\nGET /api/payment_demands?filter[payer]=<payer_id>\n```\n\nFilter by an attribute of a related resource using dot notation:\n\n```\nGET /api/payment_demands?filter[payer.email]=john@example.com\n```\n\nThis works for any resource and any relationship chain, e.g. `consumer_addresses?filter[customer.name]=John+Doe`.\n\n**Notes**\n- Multiple filters can be combined: `filter[status]=pending&filter[payer.email]=john@example.com`\n- Relationship chains of arbitrary depth are supported: `filter[merchant.account.owner.email]=ceo@acme.com`\n- All filters are applied as SQL `AND` conditions.\n"
  license:
    name: CC0 1.0 Universal
    url: https://creativecommons.org/publicdomain/zero/1.0/
  termsOfService: https://legal.tryedge.io/end-user-terms-of-service.pdf
  title: Edge Payment Technologies, Inc {json:api} Specification
  version: '1.0'
openapi: 3.0.0
paths:
  /v2/merchant_integrations:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MerchantIntegrationsController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchant_integrations_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Merchant Integrations
  /v2/payment_demands/{id}/relationships/payer:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentDemandsController.related_payer
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/customers_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related payer
      tags:
        - Payment Demands
  /v2/merchants/{id}/relationships/corporate_officials:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MerchantsController.related_corporate_officials
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/corporate_officials_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: A list of related corporate_officials
      tags:
        - Merchants
  /v2/legal_addresses/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.LegalAddressesController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/legal_addresses_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch by unique id
      tags:
        - Legal Addresses
  /v2/payment_demands/{id}/relationships/buyer:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentDemandsController.related_buyer
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/customers_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related buyer
      tags:
        - Payment Demands
  /v2/account_alerts:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.AccountAlertsController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/account_alerts_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Account Alerts
  /v2/payment_methods/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentMethodsController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/payment_methods_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch by unique id
      tags:
        - Payment Methods
  /v2/memberships:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MembershipsController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/memberships_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Memberships
    post:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#crud-creating
      operationId: CoreHTTP.MembershipsController.create
      parameters:
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/memberships_member'
          description: >-
            [Created](https://jsonapi.org/format/#crud-creating-responses-201).
            Assigned `id` and/or any other changes are in this response.
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '409':
          $ref: '#/components/responses/conflict'
        '415':
          $ref: '#/components/responses/unsupported_media_type'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Create a new record
      tags:
        - Memberships
  /v2/financial_institutions:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.FinancialInstitutionsController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/beneficial_owners_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Financial Institutions
  /v2/customers:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.CustomersController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/customers_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Customers
    post:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#crud-creating
      operationId: CoreHTTP.CustomersController.create
      parameters:
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/customers_member'
          description: >-
            [Created](https://jsonapi.org/format/#crud-creating-responses-201).
            Assigned `id` and/or any other changes are in this response.
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '409':
          $ref: '#/components/responses/conflict'
        '415':
          $ref: '#/components/responses/unsupported_media_type'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Create a new record
      tags:
        - Customers
  /v2/consumer_addresses:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.ConsumerAddressesController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/consumer_addresses_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Consumer Addresses
    post:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#crud-creating
      operationId: CoreHTTP.ConsumerAddressesController.create
      parameters:
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/consumer_addresses_member'
          description: >-
            [Created](https://jsonapi.org/format/#crud-creating-responses-201).
            Assigned `id` and/or any other changes are in this response.
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '409':
          $ref: '#/components/responses/conflict'
        '415':
          $ref: '#/components/responses/unsupported_media_type'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Create a new record
      tags:
        - Consumer Addresses
  /v2/webhook_deliveries/{id}/relationships/merchant:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.WebhookDeliveriesController.related_merchant
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related merchant
      tags:
        - Webhook Deliveries
  /v2/payment_subscriptions/{id}/relationships/shipping_address:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentSubscriptionsController.related_shipping_address
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/consumer_addresses_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related shipping_address
      tags:
        - Payment Subscriptions
  /v2/webhook_subscriptions/{id}/relationships/merchant:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.WebhookSubscriptionsController.related_merchant
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related merchant
      tags:
        - Webhook Subscriptions
  /v2/corporate_officials:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.CorporateOfficialsController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/corporate_officials_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Corporate Officials
    post:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#crud-creating
      operationId: CoreHTTP.CorporateOfficialsController.create
      parameters:
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/corporate_officials_member'
          description: >-
            [Created](https://jsonapi.org/format/#crud-creating-responses-201).
            Assigned `id` and/or any other changes are in this response.
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '409':
          $ref: '#/components/responses/conflict'
        '415':
          $ref: '#/components/responses/unsupported_media_type'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Create a new record
      tags:
        - Corporate Officials
  /v2/payment_subscriptions/{id}/relationships/payment_method:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentSubscriptionsController.related_payment_method
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/payment_methods_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related payment_method
      tags:
        - Payment Subscriptions
  /v2/personal_identifications/{id}/relationships/corporate_officials:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PersonalIdentificationsController.related_corporate_officials
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/corporate_officials_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: A list of related corporate_officials
      tags:
        - Personal Identifications
  /v2/payment_demands:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentDemandsController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/payment_demands_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Payment Demands
    post:
      callbacks: {}
      operationId: CoreHTTP.PaymentDemandsController.create
      parameters:
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/payment_demands_member'
          description: >-
            [Created](https://jsonapi.org/format/#crud-creating-responses-201).
            Assigned `id` and/or any other changes are in this response.
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '409':
          $ref: '#/components/responses/conflict'
        '415':
          $ref: '#/components/responses/unsupported_media_type'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Create a new payment demand
      tags:
        - Payment Demands
  /v2/payment_demands/{id}/relationships/receiver:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentDemandsController.related_receiver
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/customers_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related receiver
      tags:
        - Payment Demands
  /v2/webhook_subscriptions:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.WebhookSubscriptionsController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/webhook_subscriptions_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Webhook Subscriptions
    post:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#crud-creating
      operationId: CoreHTTP.WebhookSubscriptionsController.create
      parameters:
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/webhook_subscriptions_member'
          description: >-
            [Created](https://jsonapi.org/format/#crud-creating-responses-201).
            Assigned `id` and/or any other changes are in this response.
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '409':
          $ref: '#/components/responses/conflict'
        '415':
          $ref: '#/components/responses/unsupported_media_type'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Create a new record
      tags:
        - Webhook Subscriptions
  /v2/customers/{id}/relationships/payment_demands:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.CustomersController.related_payment_demands
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/payment_demands_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: A list of related payment_demands
      tags:
        - Customers
  /v2/payment_methods:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentMethodsController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/payment_methods_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Payment Methods
  /v2/personal_identifications/{id}/relationships/merchant:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PersonalIdentificationsController.related_merchant
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related merchant
      tags:
        - Personal Identifications
  /v2/payment_demands/{id}/relationships/merchant:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentDemandsController.related_merchant
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related merchant
      tags:
        - Payment Demands
  /v2/merchants/{id}/relationships/beneficial_owners:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MerchantsController.related_beneficial_owners
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/beneficial_owners_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: A list of related beneficial_owners
      tags:
        - Merchants
  /v2/processor_details/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.ProcessorDetailsController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/processor_details_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch by unique id
      tags:
        - Processor Details
  /v2/webhook_subscriptions/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.WebhookSubscriptionsController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/webhook_subscriptions_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch by unique id
      tags:
        - Webhook Subscriptions
  /v2/payment_subscriptions/{id}/relationships/payer:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentSubscriptionsController.related_payer
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/customers_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related payer
      tags:
        - Payment Subscriptions
  /v2/merchants/{id}/relationships/payment_demands:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MerchantsController.related_payment_demands
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/payment_demands_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: A list of related payment_demands
      tags:
        - Merchants
  /v2/processor_details/{id}/relationships/merchant:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.ProcessorDetailsController.related_merchant
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related merchant
      tags:
        - Processor Details
  /v2/payment_demands/{id}/confirm:
    patch:
      callbacks: {}
      operationId: CoreHTTP.PaymentDemandsController.confirm
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/payment_demands_member'
          description: '[OK](https://jsonapi.org/format/#crud-deleting-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '409':
          $ref: '#/components/responses/conflict'
        '415':
          $ref: '#/components/responses/unsupported_media_type'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Confirm a payment demand as ready for processing
      tags:
        - Payment Demands
  /v2/legal_addresses:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.LegalAddressesController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/legal_addresses_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Legal Addresses
    post:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#crud-creating
      operationId: CoreHTTP.LegalAddressesController.create
      parameters:
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/legal_addresses_member'
          description: >-
            [Created](https://jsonapi.org/format/#crud-creating-responses-201).
            Assigned `id` and/or any other changes are in this response.
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '409':
          $ref: '#/components/responses/conflict'
        '415':
          $ref: '#/components/responses/unsupported_media_type'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Create a new record
      tags:
        - Legal Addresses
  /v2/merchant_integrations/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MerchantIntegrationsController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchant_integrations_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch by unique id
      tags:
        - Merchant Integrations
  /v2/red_flags/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.RedFlagsController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/red_flags_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch by unique id
      tags:
        - Red Flags
  /v2/payment_subscriptions/{id}/confirm:
    patch:
      callbacks: {}
      operationId: CoreHTTP.PaymentSubscriptionsController.confirm
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/payment_subscriptions_member'
          description: '[OK](https://jsonapi.org/format/#crud-deleting-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '409':
          $ref: '#/components/responses/conflict'
        '415':
          $ref: '#/components/responses/unsupported_media_type'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Confirm a payment subscription as ready for processing
      tags:
        - Payment Subscriptions
  /v2/consumer_addresses/{id}/relationships/merchant:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.ConsumerAddressesController.related_merchant
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related merchant
      tags:
        - Consumer Addresses
  /v2/refund_demands/{id}/relationships/merchant:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.RefundDemandsController.related_merchant
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related merchant
      tags:
        - Refund Demands
  /v2/events:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.EventsController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/events_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Events
  /v2/payment_methods/{id}/relationships/customer:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentMethodsController.related_customer
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/customers_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related customer
      tags:
        - Payment Methods
  /v2/merchant_punitive_actions/{id}/relationships/merchant:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MerchantPunitiveActionsController.related_merchant
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related merchant
      tags:
        - Merchant Punitive Actions
  /v2/merchants:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MerchantsController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Merchants
  /v2/events/{id}/relationships/merchant:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.EventsController.related_merchant
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related merchant
      tags:
        - Events
  /v2/personal_identifications:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PersonalIdentificationsController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/personal_identifications_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Personal Identifications
    post:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#crud-creating
      operationId: CoreHTTP.PersonalIdentificationsController.create
      parameters:
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/personal_identifications_member'
          description: >-
            [Created](https://jsonapi.org/format/#crud-creating-responses-201).
            Assigned `id` and/or any other changes are in this response.
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '409':
          $ref: '#/components/responses/conflict'
        '415':
          $ref: '#/components/responses/unsupported_media_type'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Create a new record
      tags:
        - Personal Identifications
  /v2/merchant_tokens/{id}/relationships/merchant:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MerchantTokensController.related_merchant
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related merchant
      tags:
        - Merchant Tokens
  /v2/merchants/{id}/relationships/customers:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MerchantsController.related_customers
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/customers_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: A list of related customers
      tags:
        - Merchants
  /v2/payment_subscriptions/{id}/relationships/billing_address:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentSubscriptionsController.related_billing_address
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/consumer_addresses_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related billing_address
      tags:
        - Payment Subscriptions
  /v2/customers/{id}/relationships/addresses:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.CustomersController.related_addresses
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/consumer_addresses_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: A list of related addresses
      tags:
        - Customers
  /v2/merchant_integrations/{id}/relationships/merchant:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MerchantIntegrationsController.related_merchant
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related merchant
      tags:
        - Merchant Integrations
  /v2/memberships/{id}/relationships/merchant:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MembershipsController.related_merchant
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related merchant
      tags:
        - Memberships
  /v2/integrations/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.IntegrationsController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/integrations_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch by unique id
      tags:
        - Integrations
  /v2/financial_institutions/{id}/relationships/personal_identification:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.FinancialInstitutionsController.related_personal_identification
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/personal_identifications_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related personal_identification
      tags:
        - Financial Institutions
  /v2/webhook_subscriptions/{id}/relationships/webhook_deliveries:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.WebhookSubscriptionsController.related_webhook_deliveries
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/webhook_deliveries_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: A list of related webhook_deliveries
      tags:
        - Webhook Subscriptions
  /v2/payment_demands/{id}/relationships/shipping_address:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentDemandsController.related_shipping_address
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/consumer_addresses_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related shipping_address
      tags:
        - Payment Demands
  /v2/merchant_tokens/{id}/relationships/permissions:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MerchantTokensController.related_permissions
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/permissions_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: A list of related permissions
      tags:
        - Merchant Tokens
  /v2/events/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.EventsController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/events_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch by unique id
      tags:
        - Events
  /v2/refund_demands:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.RefundDemandsController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/refund_demands_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Refund Demands
    post:
      callbacks: {}
      operationId: CoreHTTP.RefundDemandsController.create
      parameters:
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/refund_demands_member'
          description: >-
            [Created](https://jsonapi.org/format/#crud-creating-responses-201).
            Assigned `id` and/or any other changes are in this response.
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '409':
          $ref: '#/components/responses/conflict'
        '415':
          $ref: '#/components/responses/unsupported_media_type'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Create a new refund demand
      tags:
        - Refund Demands
  /v2/processor_details:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.ProcessorDetailsController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/processor_details_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Processor Details
  /v2/personal_identifications/{id}/relationships/beneficial_owners:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PersonalIdentificationsController.related_beneficial_owners
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/beneficial_owners_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: A list of related beneficial_owners
      tags:
        - Personal Identifications
  /v2/merchants/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MerchantsController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch by unique id
      tags:
        - Merchants
  /v2/merchants/{id}/relationships/payment_methods:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MerchantsController.related_payment_methods
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/payment_methods_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: A list of related payment_methods
      tags:
        - Merchants
  /v2/integrations/{id}/relationships/merchant_integrations:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.IntegrationsController.related_merchant_integrations
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchant_integrations_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: A list of related merchant_integrations
      tags:
        - Integrations
  /v2/payment_subscriptions/{id}/relationships/merchant:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentSubscriptionsController.related_merchant
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related merchant
      tags:
        - Payment Subscriptions
  /v2/refund_demands/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.RefundDemandsController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/refund_demands_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch a singular record by its unique id
      tags:
        - Refund Demands
  /v2/corporate_officials/{id}/relationships/merchant:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.CorporateOfficialsController.related_merchant
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related merchant
      tags:
        - Corporate Officials
  /v2/accounts/{id}/relationships/memberships:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.AccountsController.related_memberships
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/memberships_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: A list of related memberships
      tags:
        - Accounts
  /v2/merchant_punitive_actions/{id}:
    get:
      callbacks: {}
      operationId: CoreHTTP.MerchantPunitiveActionsController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchant_punitive_actions_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Show specific merchant_punitive_actions accessible by the token
      tags:
        - Merchant Punitive Actions
  /v2/merchant_punitive_actions:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MerchantPunitiveActionsController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchant_punitive_actions_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Merchant Punitive Actions
  /v2/customers/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.CustomersController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/customers_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch by unique id
      tags:
        - Customers
    patch:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#crud-deleting
      operationId: CoreHTTP.CustomersController.update
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/customers_member'
          description: '[OK](https://jsonapi.org/format/#crud-deleting-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '409':
          $ref: '#/components/responses/conflict'
        '415':
          $ref: '#/components/responses/unsupported_media_type'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Update by unique id
      tags:
        - Customers
  /v2/webhook_deliveries/{id}/relationships/event:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.WebhookDeliveriesController.related_event
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/events_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related event
      tags:
        - Webhook Deliveries
  /v2/memberships/{id}/relationships/permissions:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MembershipsController.related_permissions
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/permissions_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: A list of related permissions
      tags:
        - Memberships
  /v2/webhook_deliveries:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.WebhookDeliveriesController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/webhook_deliveries_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Webhook Deliveries
  /v2/payment_methods/{id}/relationships/merchant:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentMethodsController.related_merchant
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related merchant
      tags:
        - Payment Methods
  /v2/account_alerts/{id}/relationships/red_flag:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.AccountAlertsController.related_red_flag
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/red_flags_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related red_flag
      tags:
        - Account Alerts
  /v2/merchant_tokens/{id}/relationships/processor_detail:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MerchantTokensController.related_processor_detail
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/processor_details_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related processor_detail
      tags:
        - Merchant Tokens
  /v2/customers/{id}/relationships/merchant:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.CustomersController.related_merchant
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related merchant
      tags:
        - Customers
  /v2/payment_subscriptions/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentSubscriptionsController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/payment_subscriptions_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch by unique id
      tags:
        - Payment Subscriptions
  /v2/merchant_punitive_actions/{id}/relationships/red_flag:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MerchantPunitiveActionsController.related_red_flag
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/red_flags_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related red_flag
      tags:
        - Merchant Punitive Actions
  /v2/personal_identifications/{id}/relationships/legal_address:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PersonalIdentificationsController.related_legal_address
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/legal_addresses_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related legal_address
      tags:
        - Personal Identifications
  /v2/merchant_tokens/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MerchantTokensController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchant_tokens_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch by unique id
      tags:
        - Merchant Tokens
  /v2/accounts/{id}:
    get:
      callbacks: {}
      operationId: CoreHTTP.AccountsController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/accounts_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Show an account accessible by the token
      tags:
        - Accounts
  /v2/red_flags/{id}/relationships/merchant:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.RedFlagsController.related_merchant
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related merchant
      tags:
        - Red Flags
  /v2/account_alerts/{id}:
    get:
      callbacks: {}
      operationId: CoreHTTP.AccountAlertsController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/account_alerts_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Show a account_alerts accessible by the token
      tags:
        - Account Alerts
  /v2/consumer_addresses/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.ConsumerAddressesController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/consumer_addresses_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch by unique id
      tags:
        - Consumer Addresses
    patch:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification.
        url: https://jsonapi.org/format/#crud-deleting
      operationId: CoreHTTP.ConsumerAddressesController.update
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/consumer_addresses_member'
          description: '[OK](https://jsonapi.org/format/#crud-deleting-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '409':
          $ref: '#/components/responses/conflict'
        '415':
          $ref: '#/components/responses/unsupported_media_type'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Update by unique id
      tags:
        - Consumer Addresses
  /v2/red_flags:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.RedFlagsController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/red_flags_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Red Flags
  /v2/memberships/{id}/relationships/account:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MembershipsController.related_account
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/accounts_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related account
      tags:
        - Memberships
  /v2/payment_demands/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentDemandsController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/payment_demands_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch by unique id
      tags:
        - Payment Demands
    patch:
      callbacks: {}
      operationId: CoreHTTP.PaymentDemandsController.update
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/payment_demands_member'
          description: '[OK](https://jsonapi.org/format/#crud-deleting-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '409':
          $ref: '#/components/responses/conflict'
        '415':
          $ref: '#/components/responses/unsupported_media_type'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Update an incomplete payment demand to prepare it for processing
      tags:
        - Payment Demands
  /v2/payment_methods/{id}/relationships/payment_demands:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentMethodsController.related_payment_demands
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/payment_demands_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: A list of related payment_demands
      tags:
        - Payment Methods
  /v2/accounts:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.AccountsController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/accounts_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Accounts
  /v2/processor_details/{id}/relationships/merchant_tokens:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.ProcessorDetailsController.related_merchant_tokens
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchant_tokens_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: A list of related merchant_tokens
      tags:
        - Processor Details
  /v2/webhook_deliveries/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.WebhookDeliveriesController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/webhook_deliveries_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch by unique id
      tags:
        - Webhook Deliveries
  /v2/permissions:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PermissionsController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/permissions_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Permissions
  /v2/accounts/{id}/relationships/personal_identification:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.AccountsController.related_personal_identification
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/personal_identifications_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related personal_identification
      tags:
        - Accounts
  /v2/corporate_officials/{id}/relationships/personal_identification:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.CorporateOfficialsController.related_personal_identification
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/personal_identifications_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related personal_identification
      tags:
        - Corporate Officials
  /v2/integrations:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.IntegrationsController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/integrations_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Integrations
  /v2/webhook_deliveries/{id}/relationships/webhook_subscription:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.WebhookDeliveriesController.related_webhook_subscription
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/webhook_subscriptions_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related webhook_subscription
      tags:
        - Webhook Deliveries
  /v2/beneficial_owners:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.BeneficialOwnersController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/beneficial_owners_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Beneficial Owners
    post:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#crud-creating
      operationId: CoreHTTP.BeneficialOwnersController.create
      parameters:
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/beneficial_owners_member'
          description: >-
            [Created](https://jsonapi.org/format/#crud-creating-responses-201).
            Assigned `id` and/or any other changes are in this response.
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '409':
          $ref: '#/components/responses/conflict'
        '415':
          $ref: '#/components/responses/unsupported_media_type'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Create a new record
      tags:
        - Beneficial Owners
  /v2/payment_methods/{id}/relationships/address:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentMethodsController.related_address
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/consumer_addresses_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related address
      tags:
        - Payment Methods
  /v2/personal_identifications/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PersonalIdentificationsController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/personal_identifications_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch by unique id
      tags:
        - Personal Identifications
  /v2/merchant_tokens:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MerchantTokensController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchant_tokens_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Merchant Tokens
    post:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#crud-creating
      operationId: CoreHTTP.MerchantTokensController.create
      parameters:
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchant_tokens_member'
          description: >-
            [Created](https://jsonapi.org/format/#crud-creating-responses-201).
            Assigned `id` and/or any other changes are in this response.
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '409':
          $ref: '#/components/responses/conflict'
        '415':
          $ref: '#/components/responses/unsupported_media_type'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Create a new record
      tags:
        - Merchant Tokens
  /v2/permissions/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PermissionsController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/permissions_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch by unique id
      tags:
        - Permissions
  /v2/merchant_integrations/{id}/relationships/integration:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MerchantIntegrationsController.related_integration
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/integrations_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related integration
      tags:
        - Merchant Integrations
  /v2/beneficial_owners/{id}/relationships/personal_identification:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.BeneficialOwnersController.related_personal_identification
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/personal_identifications_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related personal_identification
      tags:
        - Beneficial Owners
  /v2/payment_demands/{id}/relationships/billing_address:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentDemandsController.related_billing_address
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/consumer_addresses_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related billing_address
      tags:
        - Payment Demands
  /v2/refund_demands/{id}/relationships/payment_demand:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.RefundDemandsController.related_payment_demand
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/payment_demands_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related payment_demand
      tags:
        - Refund Demands
  /v2/beneficial_owners/{id}:
    get:
      callbacks: {}
      operationId: CoreHTTP.BeneficialOwnersController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/beneficial_owners_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Find by unique id
      tags:
        - Beneficial Owners
  /v2/merchant_integrations/{id}/relationships/merchant_token:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MerchantIntegrationsController.related_merchant_token
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchant_tokens_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related merchant_token
      tags:
        - Merchant Integrations
  /v2/account_alerts/{id}/relationships/merchant:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.AccountAlertsController.related_merchant
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related merchant
      tags:
        - Account Alerts
  /v2/beneficial_owners/{id}/relationships/merchant:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.BeneficialOwnersController.related_merchant
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchants_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related merchant
      tags:
        - Beneficial Owners
  /v2/financial_institutions/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.FinancialInstitutionsController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/beneficial_owners_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch by unique id
      tags:
        - Financial Institutions
  /v2/consumer_addresses/{id}/relationships/customer:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.ConsumerAddressesController.related_customer
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/customers_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related customer
      tags:
        - Consumer Addresses
  /v2/corporate_officials/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.CorporateOfficialsController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/corporate_officials_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch by unique id
      tags:
        - Corporate Officials
  /v2/payment_subscriptions:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentSubscriptionsController.index
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/payment_subscriptions_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: List all records
      tags:
        - Payment Subscriptions
    post:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#crud-creating
      operationId: CoreHTTP.PaymentSubscriptionsController.create
      parameters:
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/payment_subscriptions_member'
          description: >-
            [Created](https://jsonapi.org/format/#crud-creating-responses-201).
            Assigned `id` and/or any other changes are in this response.
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '409':
          $ref: '#/components/responses/conflict'
        '415':
          $ref: '#/components/responses/unsupported_media_type'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Create a new record
      tags:
        - Payment Subscriptions
  /v2/permissions/{id}/relationships/merchant_tokens:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PermissionsController.related_merchant_tokens
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageOffset'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/merchant_tokens_collection'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: A list of related merchant_tokens
      tags:
        - Permissions
  /v2/payment_demands/{id}/relationships/payment_method:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.PaymentDemandsController.related_payment_method
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/payment_methods_member'
          description: >-
            [OK](https://jsonapi.org/format/#fetching-relationships-responses-200)
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/related_not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch related payment_method
      tags:
        - Payment Demands
  /v2/memberships/{id}:
    get:
      callbacks: {}
      externalDocs:
        description: Learn more from the JSON:API Specification
        url: https://jsonapi.org/format/#fetching
      operationId: CoreHTTP.MembershipsController.show
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/fields'
        - $ref: '#/components/parameters/include'
        - $ref: '#/components/parameters/userAgent'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/memberships_member'
          description: '[OK](https://jsonapi.org/format/#fetching-resources-responses-200)'
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '406':
          $ref: '#/components/responses/not_acceptable'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
      security:
        - bearerAuth: []
      summary: Fetch by unique id
      tags:
        - Memberships
security: []
servers:
  - url: https://api.tryedge.test
    variables: {}
tags:
  - description: Relating to alerts and notifications
    name: Account Alerts
  - description: Relating to user accounts and profiles
    name: Accounts
  - description: Related to account memberships of merchants
    name: Memberships
  - description: Related to punitive actions against merchants
    name: Merchant Punitive Actions
  - description: Related to API tokens
    name: Merchant Tokens
  - description: Relating to merchant businesses
    name: Merchants
  - description: Related to membership permissions
    name: Permissions
  - description: Related to ownership of merchants
    name: Beneficial Owners
  - description: Related to corporate responsibilities of merchants
    name: Corporate Officials
  - description: Related to known financial institutions in the edge network
    name: Financial Institutions
  - description: Related to physical locations for legal purposes
    name: Legal Addresses
  - description: Related to personal information for people
    name: Personal Identifications
  - description: Related to payment processor information
    name: Processor Details
  - description: Related to physical consumer locations
    name: Consumer Addresses
  - description: Related to people who participate in a transaction
    name: Customers
  - description: Related to payment methods
    name: Payment Methods
  - description: Related to events
    name: Events
  - description: Related to third party services
    name: Integrations
  - description: Related to the direct integration of services to merchants
    name: Merchant Integrations
  - description: Related to information about webhook delieveries
    name: Webhook Deliveries
  - description: Related to the subscriptions to notifications of events
    name: Webhook Subscriptions
  - description: Related to transactions
    name: Payment Demands
  - description: Related to refunds
    name: Refund Demands
  - description: Related to recurring payments
    name: Payment Subscriptions
  - description: Related to official notices against merchants
    name: Red Flags
x-tagGroups:
  - name: Consumer
    tags:
      - Consumer Addresses
      - Customers
      - Payment Methods
  - name: Banking
    tags:
      - Beneficial Owners
      - Corporate Officials
      - Financial Institutions
      - Legal Addresses
      - Personal Identifications
      - Processor Details
  - name: Developers
    tags:
      - Events
      - Integrations
      - Merchant Integrations
      - Webhook Deliveries
      - Webhook Subscriptions
  - name: Transactions
    tags:
      - Payment Demands
      - Refund Demands
      - Payment Subscriptions
  - name: Users
    tags:
      - Account Alerts
      - Accounts
      - Memberships
      - Merchant Punitive Actions
      - Merchant Tokens
      - Merchants
      - Permissions
      - Red Flags
