Vendors (C3) are entities that your customers (C2) pay. They can be individuals or businesses.
They can also automatically be created when a customer adds a new vendor through the react component or embed.
Creating the Vendor Entity
Using the create entity endpoint, create a new entity, and make sure the following are set
This will automatically add the vendor to the
Capturing Vendor Details
If you don't have the vendor's details, you can use the generate onboarding link endpoint to create a link that the vendor can use to provide their details. This link will be valid for 24 hours. You can also use the send onboarding email endpoint to send the link to the vendor via email. This link will be valid for 7 days, and will be emailed to the entity email.
Adding the Vendor to the Payer as a Counterparty
Once the vendor entity is created, you need to link it to the payer.
You can link the vendor to any entity using the link payees endpoint. This will create a relationship between the two entities, and allow the payer to pay the vendor.
For example, if you have a payer Entity with id
ent_123, and a vendor Entity with id
ent_456, you can link them using the following request
Once you have created and linked vendors to the payer, you can use the get counterparties endpoint to find the vendors linked to the payer.
Hiding / Archiving Counterparties
If you don't want a counterparty to show up for an Entity in the counterparty search, you can hide them using the hide payee from search endpoint.