Link Payees | Mercoa | Documentation

1 from mercoa import Mercoa 2 from mercoa.entity_types import ( 3 CounterpartyCustomizationAccount, 4 CounterpartyCustomizationRequest, 5 EntityAddPayeesRequest, 6 ) 7 8 client = Mercoa( 9 token="YOUR_TOKEN", 10 ) 11 client.entity.counterparty.add_payees( 12 entity_id="ent_8545a84e-a45f-41bf-bdf1-33b42a55812c", 13 request=EntityAddPayeesRequest( 14 payees=["ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"], 15 customizations=[ 16 CounterpartyCustomizationRequest( 17 counterparty_id="ent_21661ac1-a2a8-4465-a6c0-64474ba8181d", 18 accounts=[ 19 CounterpartyCustomizationAccount( 20 account_id="85866843", 21 postal_code="94105", 22 name_on_account="John Doe", 23 ) 24 ], 25 ) 26 ], 27 ), 28 )

Create association between Entity and a given list of Payees. If a Payee has previously been archived, unarchive the Payee.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

entityIdstringRequired

Entity ID or Entity ForeignID

Request

This endpoint expects an object.

payeeslist of stringsRequired

List of payee entity IDs or foreign IDs to associate with the entity

customizationslist of objectsOptional

List of customizations to apply to the payees. If the payee is not currently a counterparty of the entity, the counterparty will be created with the provided customizations.

Authentication

Path parameters

Request

Errors