Responses

• 200

  An array of payout entities defined by the organization.

  Hide response attribute Show response attribute object

  • results array[object] Required

    An array of payout entities defined by the organization.

    Not more than 1000 elements.

    Hide results attributes Show results attributes array[object]

    • payout_entity_id string Required

      The ID to be associated with the payout entity for future requests. If not provided on payout entity creation, Canopy will generate this field.

    • payout_entity_type string

      Type of associated entity

      Values are merchant, lender, sponsor, or organization.

    • payout_entity_name string

      Entity's name.

    • external_fields array[object]

      An Array of External Fields. These should be used to connect entities created in Canopy to data in your system and any connected external systems.

      Not more than 1000 elements.

      Hide external_fields attributes Show external_fields attributes array[object]

      • key string

        key: i.e. Name of the External Party

      • value string

        value: i.e. External Account ID

    • parent_payout_entity_id string | null

      A Canopy-generated ID for the parent of this associated entity to establish a parent-child relationship.

    • bank_account_number string

      Account number of the bank account for payment distributions.

    • bank_routing_number string

      Routing number of the bank account for payment distributions.

• default

  Unexpected Error.

• 401

  Unauthorized.

• 403

  Forbidden.

• 429

  Too many requests.