# Create a new payout entity

**POST /payout_entities**

Payout entities can be created within Canopy with attached data managed in a secure and compliant way to facilitate providing the best service for products created through Canopy.


## Servers
- Public Sandbox: https://sandbox-api.canopyservicing.com (Public Sandbox)
- Protected UAT Sandbox: https://uat-api.canopyservicing.com (Protected UAT Sandbox)
- Production: https://api.canopyservicing.com (Production)


## Authentication methods
- O auth2


## Parameters



### Body: application/json (object)
Create a new associated entity
- **payout_entity_id** (string)
  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
- **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.
- **parent_payout_entity_id** (string)
  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.
- **irs_tin** (string)
  The IRS tax identification number of the entity.


## Responses
### 200
New Associated Entity Created

#### Body: application/json (object)
- **payout_entity_id** (string)
  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
- **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.
- **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.

### 401
Unauthorized.

### 403
Forbidden.

### 404
Customer not found

### 422
Invalid input

### 429
Too many requests.

### default
Unexpected Error.


[Powered by Bump.sh](https://bump.sh)