Update an existing payout entity

put

https://Contact sales to enable your sandbox/payout_entities/{payout_entity_id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

payout_entity_id

string

required

ID of the Payout Entity

Body Params

Update attributes of an existing associated entity

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.

company_identification

string

The Depository Financial Institution (DFI) ID of the entity.

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:

payment_processor_config

object | null

The configuration for different payment processors.

Responses

401

Unauthorized.

403

Forbidden.

404

Payout Entity 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

200Existing Associated Entity Updated