Subsections
Addresses
Manage business addresses on a partner record.
Principals
Manage beneficial owners and key contacts on a partner record.
Documents
Manage documents attached to a partner record.
Notes
Add and manage internal notes on a partner record.
Pricing
Manage pricing items, packages, templates, and rules for a partner.
Processor Settings
Manage processor-specific configuration for a partner.
What’s included
Core
| Endpoint | Description |
|---|---|
| List partners | Retrieve a paginated list of partners |
| Get partner | Retrieve a single partner by ID |
| Update partner | Update an existing partner record |
| Update status | Transition a partner to a new status (activate, deactivate, close) |
| Decrypt sensitive data | Decrypt a protected field on demand |
Business addresses
| Endpoint | Description |
|---|---|
| List addresses | Retrieve all business addresses for a partner |
| Add address | Add a business address to a partner |
| Get address | Retrieve a single business address |
| Update address | Update a business address |
Principals
| Endpoint | Description |
|---|---|
| List principals | Retrieve all principals associated with a partner |
| Add principal | Add a beneficial owner or key contact |
| Get principal | Retrieve a single principal by ID |
| Update principal | Update a partner principal’s information |
| Decrypt principal data | Decrypt a sensitive field on a principal |
Documents
| Endpoint | Description |
|---|---|
| List documents | Retrieve all documents for a partner |
| Create document | Attach a document to a partner |
| Get document | Retrieve a single partner document |
| Update document | Update document metadata |
| Delete document | Remove a document from a partner |
Notes
| Endpoint | Description |
|---|---|
| List notes | Retrieve all notes on a partner record |
| Create note | Add a note to a partner record |
| Get note | Retrieve a single note |
| Update note | Edit a note on a partner record |
Pricing items
| Endpoint | Description |
|---|---|
| List pricing items | Retrieve all pricing items for a partner |
| Create pricing item | Add a pricing item to a partner |
| Get pricing item | Retrieve a single pricing item |
| Update pricing item | Update a partner pricing item |
| Delete pricing item | Remove a pricing item from a partner |
Pricing packages
| Endpoint | Description |
|---|---|
| List pricing packages | Retrieve all pricing packages for a partner |
| Create pricing package | Add a pricing package to a partner |
| Get pricing package | Retrieve a single pricing package |
| Update pricing package | Update a partner pricing package |
| Delete pricing package | Remove a pricing package from a partner |
Pricing templates
| Endpoint | Description |
|---|---|
| List pricing templates | Retrieve all pricing templates for a partner |
| Create pricing template | Add a pricing template to a partner |
| Get pricing template | Retrieve a single pricing template |
| Update pricing template | Update a partner pricing template |
| Delete pricing template | Remove a pricing template from a partner |
Pricing rules
| Endpoint | Description |
|---|---|
| List pricing rules | Retrieve all pricing rules for a partner |
| Create pricing rule | Add a pricing rule to a partner |
| Get pricing rule | Retrieve a single pricing rule |
| Update pricing rule | Update a partner pricing rule |
| Delete pricing rule | Remove a pricing rule from a partner |
Processor settings
| Endpoint | Description |
|---|---|
| List processor settings | Retrieve all processor-specific settings for a partner |
| Update processor setting | Update a specific processor setting entry |