Skip to main content
A counterparty links a party to your merchant with a relationship type. Try in API Reference: Create · List · Retrieve · Update

​
Relationship types

TypeTypical use
CUSTOMERPaying you
SUPPLIERYou pay them
EMPLOYEEPayroll
BENEFICIARYPayout recipient
FRIENDPersonal contact
FAMILYFamily member
DONORDonation source
DONEEDonation recipient
CONTACTGeneral contact
SERVICE_PROVIDERVendor or contractor
PARTNERBusiness partner
SELFYour own entity

​
When to use

Required for POST /v1/invoices/create and POST /v1/orders/create in the document-first flow. Not required when using POST /v1/checkouts/create with payer details.

​
Create

curl -X POST "https://api.heydollr.app/v1/counterparties/create" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"relationship_type": "CUSTOMER", "party_id": 42}'
party_id is optional in the API if Dollr can resolve the party another way — for document-first flows, always pass party_id from party create.

​
List

curl "https://api.heydollr.app/v1/counterparties/list?fullname=Amara&relationship_type=CUSTOMER" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Optional filters: fullname, relationship_type.

​
Retrieve

curl "https://api.heydollr.app/v1/counterparties/retrieve/15" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Returns the counterparty with embedded party details.

​
Update

curl -X PUT "https://api.heydollr.app/v1/counterparties/update/15" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"relationship_type": "SUPPLIER"}'
Last modified on June 23, 2026