URL Expired

The URL for this request expired after 30 days.

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:
merchant lender sponsor organization clearing

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:
CHECKING SAVINGS GL

irs_tin
string
The IRS tax identification number of the entity.

payment_processor_config
object | null
The configuration for different payment processors.

Response Codes

200      New Associated Entity Created  
401      Unauthorized.  
403      Forbidden.  
404      Customer not found  
422      Invalid input  
429      Too many requests.  
default  Unexpected Error.  

Command Example

curl --request POST \
     --url https://contact/%20sales%20to%20enable%20your%20sandbox/payout_entities \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{\n  "payout_entity_type": "merchant"\n}'

Response Example

200