Introduction (Spec)
The External Contact Management-API defines the endpoints that the enfore platform will invoke on an external server component when an external contact management is enabled and the user performs specific actions.
The API defines endpoints for:
- resolving a scanned identifier to a contact
- determining what payment options a customer can use
Use cases
Resolve contact
The POST /org/{org-id}/external-contact-management/contacts/resolve is for determining the contact identified by a scanned contact identifier.
The endpoint will receive the scanned identifier, the purpose identifying what type of contact is expected and the usual context information (sales channel/location, device used, etc.). If the passed identifier matches a contact, the endpoint must return a "contact information" structure with data about the customer. As the API is being used when external customer management is enabled, the returned structure should be an AnonymousContactInformation or PlaceholderContactInformation.
Check available payment options
The POST /org/{org-id}/external-contact-management/customers/check-available-payment-options endpoint is used for determining what payment options are available to a customer.
The endpoint will receive information about the customer and the usual context information and is expected to return, for each payment option, whether it is enabled and up to what limit. The check currently only covers the pament options "later", "invoice", and "deferred invoicing", but that may be extended later if necessary.