Page Comparison

Register Contact

Create a new contact of type ‘person’. A contact is created as part of the contact registration process via an app or portal. Contacts can register and authenticate their registration using one of the following methods subject to configuration:

• email & password

• email & OTP

• phone & OTP

• Facebook

• Google

Contact Authentication

Authenticate a contact and get a token to be used for subsequent API requests.

Contact WiFi Authorization

Authorize a contact over to a WiFi platform for usage allowance consumption.

Verify Contact Email

Verify a contact’s email address after an email verification communication (email communication with a verification link) has been sent to the contact.

Anchor
add-credentials-to-contact add-credentials-to-contact

Add Authorisation Credentials to Existing Contact

Create a set of credentials for a contact which exists on CRM.COM but has never used the app or portal before.

Request One Time Password

Request a one-time-password to identify a contact based on the provided details (credentials). An outbound communication (SMS or Email) will be sent with a 6-digit number that can be used to verify the contact.

Sign Up/Out Organisation

Sign-up or sign-out a contact from an existing organisation. Used in cases where a Service Owner owns a contact registry.

Request Contact Token

Request to create a contact token to spend. The API will generate an OTP for the requested amount.

Reclaim Purchase to Contact

Reclaim a purchase customer event for a contact by scanning a QR code or a bar code.

Submit Order

Place an order for a contact, based on an order’s estimation.

Order Preview

Preview the order information prior to placing the order, including fulfilment location details and invoice estimations.

Business Locations

Get a list of business locations for a specific service owner

Locations

Get a list of organisations (merchants, venues) ordered by nearest first.

Search Products

Retrieves a list of products that can be purchased by contacts through an order. Modifier and Variant products are excluded.

Create Service Request

Create a service request for a specific contact.

Create Intent

Create a JCC payment intent for a specific contact

Add Card

Add a card for a contact, the card will be hashed and added as a CIM.

Add Payment Method

Add a new payment method for a contact. Card, Account Debits and Wallet payment methods are supported.

List Account Journals

Retrieve a list of account journals. Only journals of Posted transactions are returned. By default, accounts journals of the last 12 months are retrieved.

Redeem Pass

Redeem a single pass for a contact.

Create Top-up

Create a top-up for a contact’s account or wallet.

Transfer Money

Transfers an amount of money from one of the contact’s accounts or wallets to another account or wallet or the same contact or another contact.

List Wallet (Journal) Transactions

Get all wallet journal transactions for a specific wallet with amount information, as well as reasoning on how they originated.

Contact Reward Schemes Actions

Sign-up a contact to a reward scheme, or sign-out a contact from a reward scheme.

Add Service

Subscribes the contact to one or more new subscription services.

Update Service

Update a single subscription service by changing the service’s terms, or its life cycle state.

Authorise Usage Consumption

Returns an estimation on whether the contact is allowed to consume a usage allowance, and if so, returns the remaining allowance.

Service Delivery

Returns an estimation of a change for a subscription service, without applying the change. The estimation is based on existing services owned by the contact, plus any requested changes.