Profiles
Introduction
The Consumer API module allows the application to create consumer profiles and retrieve their transaction history.
API Sequence
The consumer API is comprised of two synchronous endpoints. The general process for creating a consumer profile and retrieving the consumer's transaction history are as follows:
- Create a consumer profile |
POST /consumer/v2/profiles
POST /consumer/v2/profiles
The application will create a profile and generate a unique profileId for the
consumer. To be passed as
a path
path parameter in the consumer transaction history API endpoint or in the request on the
transfers create and
update API endpoints.
API Sequence Diagram
- Retrieve a consumer's transaction history |
GET /consumer/v2/profiles/{profileId}/transactions
GET /consumer/v2/profiles/{profileId}/transactionsThe application will return an array of transactions for the date range provided.
API Sequence Diagram
Endpoints
| Name | HTTP Method | Endpoints | Description |
|---|---|---|---|
| Create a Consumer Profile | POST | /consumer/v2/profiles | The create consumer profile API creates a new consumer profile. |
| Retrieve Transaction History | GET | /consumer/v2/{profileId}/transactions | The retrieve consumer transaction history API returns an array of a consumer's transaction history. |
Updated about 1 month ago
