Opus Consulting - Customer API Template

API Definition:

Customer API can be used by the merchants to perform various operations for setting up their customers. Merchant can add their customer by getting the customer details. Once the customer is added successfully, the merchant can search, update & delete the customer details. Merchant can add or update the payment method for customers using this API.

Business Description:

Customer APIs can be used by merchant platforms for performing various operations with respect to merchants' customers. Merchants can add their customer using customer details & can onboard the customer, merchants can update, retrieve, search & delete the created customer. Merchant can also perform some customer-specific operations like Add card or ACH details, delete card or ACH details, fetch the payment instruments of the customer, update activation status, update card activation status, update card activation details & update ACH details. Using these APIs and their functionalities to your platform can definitely add some more weightage.

Disclaimer:

This asset provides core functionality specific for integrations aligned to the individual processes described. Please consider this as a template for testing and early-stage development purposes, with production availability dependent on individual products and solutions within an individual organization’s existing payments portfolio.

For support and guidance on aligning asset to the production environment and questions related to compatibility with the product, please contact Opus by emailing mulesoftconnector@opusconsulting.com

UseCase:

When a customer wants to purchase the goods at the merchant, they will reach out to the merchant using customer details and the merchant will create a customer profile to onboard a customer.

Merchant will then configure a payment method for a customer so that customer can initiate a purchase on merchant.

Here merchants can search, update & delete customer profiles. Merchant can add, update or delete the payment methods for customer.

Reference Diagram: