Profiles
Introduction
The Business API module allows the application to create, retrieve, update, and delete business profiles.
API Sequence
The Business API consists of five asynchronous endpoints. The process for creating a business profile, listing profiles, retrieving a profile, updating, deleting a profile, and retrieving the business transaction history are as follows:
- Create a business profile |
POST /business-profiles/v1/profiles
POST /business-profiles/v1/profiles
The application can use the “Create a business profile” endpoint to create a new business
profile and generate a unique businessProfileId, which can be passed as a path
parameter in the
retrieve, update, delete, and transaction history business profile API endpoints.
API Sequence Diagram
- List business profiles |
GET /business-profiles/v1/profiles
GET /business-profiles/v1/profiles
The appication can use the "Retrieve a list of business profiles" endpoint for an
agentPartnerId to get an array of business profiles created by the partner.
API Sequence Diagram
- Retrieve a business profile |
GET /business-profiles/v1/profiles/{businessProfileId}
GET /business-profiles/v1/profiles/{businessProfileId}
The application can use the “Retrieve a business profile” endpoint to retrieve a business
profile by a businessProfileId.
API Sequence Diagram
- Update a business Profile |
PUT /business-profiles/v1/profiles/{businessProfileId}
PUT /business-profiles/v1/profiles/{businessProfileId}The application can use the “Update a business profile” endpoint to make changes to a business profile.
API Sequence Diagram
- Delete a business Profile |
DELETE /business-profiles/v1/profiles/{businessProfileId}
DELETE /business-profiles/v1/profiles/{businessProfileId}
The application can use the “Delete a business profile” endpoint to make changes to a business profile.
API Sequence Diagram
- Retrieve business transaction history |
GET /business-profiles/v1/profiles{businessProfileId}/transactions
GET /business-profiles/v1/profiles{businessProfileId}/transactions
The application can use the "Retrieve business transaction history" endpoint to return an
array of
business transactions by businessProfileId.
API Sequence Diagram
Endpoints
| Name | HTTP Method | EndPoints | Description |
|---|---|---|---|
| Create a Business Profile | POST | /business/v1/profiles | The create business profile API creates a new business profile. |
| Retrieve a list of business profiles | GET | /business/v1/profiles | Retrieve a list of business profiles. |
| Retrieve a Business profile | GET | /business/v1/profiles/{businessProfileId} | Retrieve a single business profile. |
| Update a Business Profile | PUT | /business/v1/profiles/{businessProfileId} | Update a business profile. |
| Delete a Business Profile | DELETE | /business/v1/profiles/{businessProfileId} | Delete a business profile. |
Updated about 1 month ago
