Counterparties
A counterparty is a person or business you pay or get paid by. You save their details and payment accounts once, then reuse them in payouts and ramps.
Profiles
| Method | Endpoint | Summary |
|---|---|---|
GET | /v1/counterparties/metadata | Get counterparty field options |
GET | /v1/counterparties | List counterparties |
POST | /v1/counterparties | Create counterparty |
GET | /v1/counterparties/{counterpartyId} | Get counterparty |
PATCH | /v1/counterparties/{counterpartyId} | Update counterparty |
DELETE | /v1/counterparties/{counterpartyId} | Archive counterparty |
Accounts
| Method | Endpoint | Summary |
|---|---|---|
GET | /v1/counterparties/{counterpartyId}/accounts | List counterparty accounts |
POST | /v1/counterparties/{counterpartyId}/accounts | Create counterparty account |
GET | /v1/counterparties/{counterpartyId}/accounts/{counterpartyAccountId} | Get counterparty account |
PATCH | /v1/counterparties/{counterpartyId}/accounts/{counterpartyAccountId} | Update counterparty account |
DELETE | /v1/counterparties/{counterpartyId}/accounts/{counterpartyAccountId} | Archive counterparty account |
Is this page helpful?