Create a new payout entity

post

https://Contact sales to enable your sandbox/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create a new associated entity

payout_entity_id

string

^(?!can_).*$

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

enum

required

Type of associated entity

Allowed:

payout_entity_name

string

required

Entity's name.

external_fields

array,null | object,null

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

The 9 digit routing number of the bank account for payment distributions. The final digit must pass check digit validation.

bank_account_type

string

enum

The type of bank account being stored for the payout entity.

Allowed:

irs_tin

string

The IRS tax identification number of the entity.

payment_processor_config

object | null

The configuration for different payment processors.

Responses

401

Unauthorized.

403

Forbidden.

404

Customer not found

422

Invalid input

429

Too many requests.

default

Unexpected Error.

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200New Associated Entity Created