Subsections
Addresses
Manage business addresses on a merchant record.
Principals
Manage beneficial owners on a merchant record.
Documents
Manage documents attached to a merchant record.
Notes
Add and manage internal notes on a merchant record.
Pricing
Manage pricing items, packages, templates, and rules for a merchant.
Equipment
Manage terminal equipment models and deployment orders for a merchant.
ISO Package
Associate and manage an ISO package for a merchant.
What’s included
Core
| Endpoint | Description |
|---|---|
| List merchants | Retrieve a paginated list of merchants |
| Get merchant | Retrieve a single merchant by ID |
| Update merchant | Update an existing merchant record |
| Update status | Transition a merchant to a new status (activate, deactivate, close) |
| Get MID | Retrieve the merchant identifier |
| Update risk profile | Update the merchant’s risk classification |
| Get service acceptance | Retrieve service terms acceptance status |
| Update service acceptance | Update service terms acceptance |
| Get terminal setup | Retrieve terminal configuration |
| Update terminal setup | Update terminal configuration |
| Download VAR sheet | Download the VAR sheet PDF for deployment |
| Complete QA review | Mark the quality assurance review as complete |
| Decrypt sensitive data | Decrypt a protected field on demand |
Business addresses
| Endpoint | Description |
|---|---|
| List addresses | Retrieve all business addresses for a merchant |
| Add address | Add a business address to a merchant |
| Get address | Retrieve a single business address |
| Update address | Update a business address |
Principals
| Endpoint | Description |
|---|---|
| List principals | Retrieve all principals associated with a merchant |
| Add principal | Add a beneficial owner to a merchant |
| Get principal | Retrieve a single principal by ID |
| Update principal | Update a merchant principal’s information |
| Decrypt principal data | Decrypt a sensitive field on a principal |
Documents
| Endpoint | Description |
|---|---|
| List documents | Retrieve all documents for a merchant |
| Create document | Attach a document to a merchant |
| Get document | Retrieve a single merchant document |
| Update document | Update document metadata |
| Delete document | Remove a document from a merchant |
Notes
| Endpoint | Description |
|---|---|
| List notes | Retrieve all notes on a merchant record |
| Create note | Add a note to a merchant record |
| Get note | Retrieve a single note |
| Update note | Edit a note on a merchant record |
Pricing items
| Endpoint | Description |
|---|---|
| List pricing items | Retrieve all pricing items for a merchant |
| Create pricing item | Add a pricing item to a merchant |
| Get pricing item | Retrieve a single pricing item |
| Update pricing item | Update a merchant pricing item |
| Delete pricing item | Remove a pricing item from a merchant |
Pricing packages
| Endpoint | Description |
|---|---|
| List pricing packages | Retrieve all pricing packages for a merchant |
| Create pricing package | Add a pricing package to a merchant |
| Get pricing package | Retrieve a single pricing package |
| Update pricing package | Update a merchant pricing package |
| Delete pricing package | Remove a pricing package from a merchant |
Pricing templates
| Endpoint | Description |
|---|---|
| List pricing templates | Retrieve all pricing templates for a merchant |
| Create pricing template | Add a pricing template to a merchant |
| Get pricing template | Retrieve a single pricing template |
| Update pricing template | Update a merchant pricing template |
| Delete pricing template | Remove a pricing template from a merchant |
Pricing rules
| Endpoint | Description |
|---|---|
| List pricing rules | Retrieve all pricing rules for a merchant |
| Create pricing rule | Add a pricing rule to a merchant |
| Get pricing rule | Retrieve a single pricing rule |
| Update pricing rule | Update a merchant pricing rule |
| Delete pricing rule | Remove a pricing rule from a merchant |
Equipment models
| Endpoint | Description |
|---|---|
| List equipment models | Retrieve all equipment models for a merchant |
| Create equipment model | Add an equipment model to a merchant |
| Get equipment model | Retrieve a single equipment model |
| Update equipment model | Update a merchant equipment model |
| Delete equipment model | Remove an equipment model from a merchant |
Equipment orders
| Endpoint | Description |
|---|---|
| List equipment orders | Retrieve all equipment orders for a merchant |
| Create equipment order | Create a new equipment order |
| Get equipment order | Retrieve a single equipment order |
| Update equipment order | Update a merchant equipment order |
| Delete equipment order | Remove an equipment order from a merchant |
| List order items | Retrieve all items in an equipment order |
| Create order item | Add an item to an equipment order |
| Get order item | Retrieve a single order item |
| Update order item | Update an equipment order item |
| Delete order item | Remove an item from an equipment order |
| Create gateway | Add gateway configuration to an equipment order |
| Get gateway | Retrieve the gateway configuration |
| Update gateway | Update the gateway configuration |
| Delete gateway | Remove the gateway configuration |
| Create file build type | Set the file build type for an equipment order |
| Get file build type | Retrieve the file build type |
| Update file build type | Update the file build type |
| Delete file build type | Remove the file build type from an equipment order |
ISO package
| Endpoint | Description |
|---|---|
| Create ISO package | Associate an ISO package with a merchant |
| Get ISO package | Retrieve the ISO package association |
| Delete ISO package | Remove the ISO package association from a merchant |