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.

Body Required

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.

Format should match the following pattern: ^(?!can_).*$.
payout_entity_type string Required

Type of associated entity

Values are merchant, lender, sponsor, or organization.
payout_entity_name string Required

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

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
Hide response attributes Show response attributes 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.
422

Invalid input
401

Unauthorized.
403

Forbidden.
404

Customer not found
429

Too many requests.
default

Unexpected Error.

POST /payout_entities

curl \
 -X POST https://sandbox-api.canopyservicing.com/payout_entities \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"payout_entity_id":"0x1234","payout_entity_type":"lender","payout_entity_name":"Wonka Industries","external_fields":[{"key":"Umbrella Corporation","value":"22445702-a389-431f-927d-07b8d0750787"}],"parent_payout_entity_id":"31mNprzLd2bKl6koVna68ARM","bank_account_number":"1001001234","bank_routing_number":"012345678","irs_tin":"string"}'

Request example

{
  "payout_entity_id": "0x1234",
  "payout_entity_type": "lender",
  "payout_entity_name": "Wonka Industries",
  "external_fields": [
    {
      "key": "Umbrella Corporation",
      "value": "22445702-a389-431f-927d-07b8d0750787"
    }
  ],
  "parent_payout_entity_id": "31mNprzLd2bKl6koVna68ARM",
  "bank_account_number": "1001001234",
  "bank_routing_number": "012345678",
  "irs_tin": "string"
}

Request examples

{
  "payout_entity_id": "0x1234",
  "payout_entity_type": "lender",
  "payout_entity_name": "Wonka Industries",
  "external_fields": [
    {
      "key": "Umbrella Corporation",
      "value": "22445702-a389-431f-927d-07b8d0750787"
    }
  ],
  "parent_payout_entity_id": "31mNprzLd2bKl6koVna68ARM",
  "bank_account_number": "1001001234",
  "bank_routing_number": "012345678",
  "irs_tin": "string"
}

Response examples (200)

{
  "payout_entity_id": "0x1234",
  "payout_entity_type": "lender",
  "payout_entity_name": "Wonka Industries",
  "external_fields": [
    {
      "key": "Umbrella Corporation",
      "value": "22445702-a389-431f-927d-07b8d0750787"
    }
  ],
  "parent_payout_entity_id": "31mNprzLd2bKl6koVna68ARM",
  "bank_account_number": "1001001234",
  "bank_routing_number": "012345678"
}

Response examples (200)

{
  "payout_entity_id": "0x1234",
  "payout_entity_type": "lender",
  "payout_entity_name": "Wonka Industries",
  "external_fields": [
    {
      "key": "Umbrella Corporation",
      "value": "22445702-a389-431f-927d-07b8d0750787"
    }
  ],
  "parent_payout_entity_id": "31mNprzLd2bKl6koVna68ARM",
  "bank_account_number": "1001001234",
  "bank_routing_number": "012345678"
}