Dintero API (2019-05-31)

API Integration Support: integration@dintero.com License: UNLICENSED

API for managing Receipts, Discounts, Customers, Wallets and Webhooks


The Dintero API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website's client-side code). JSON is returned by all API responses, including errors.

To make the API as explorable as possible, accounts have test mode and live mode API keys. There is no "switch" for changing between modes, just use the appropriate key to perform a live or test transaction. Requests made with test mode incur no cost.


All notable changes to the API.


customers: Add support for enabling automatic tokens when phone numbers or emails change


discounts: Add support for adding requirements for MCC ranges, and currencies in discounts.

auth: Add support for enabling MFA (OOB) for auth users.

discounts: Add support for adding usage ref (usage, stamp, amount) to a customer discount ref.

discounts: Add support for discount rules with discount_code. The discount_code must be included in the purchase, either in the new discount_code property or as an item, where the item id is set to the discount_code.

discounts: Add support for no_customer_id query parameter when listing public discount rules.



receipts: Add support for token_expire_days parameter when creating receipt. The token added to the receipt can be used to retrieve and claim it.

discounts: Add support for specifying requirement.store when creating new discount rules.

discounts: Add support for giving discounts on purchase with no customer_id.

discounts: Add support for updating rules requirement.purchase_to.

accounts: Extend the AccountApplicant with support for promo_code and utm campaign codes.



receipts: Improve documentation for receipt receipt_id property, a non-empty value is required when creating receipts.


auth: add support for creating client with description



discounts: change minumum number of mixes in a discount rule from 2 to 1



customers: extends settings with support for configuring users customer_id_format.

customers: extends the TokenEvent definition with `expires_at read only property.

customers: extends settings with support for configuring token events expiry

management: extend settings with PayEx connections



customers: extend user Address, add support for latitude, longitude and comment properties.

discounts: exclude statistics, usage and stamp count and more in response from:


management: new endpoints for managing PayEx connection

customers: new endpoint for deleting a tag

discounts: new endpoint for retrieving discount usages

receipts: extend the receipt format with store.mcc property, a four-digit merchant category code for classifying the merchant



scopes: The scope required for accessing endpoint has changed, we will continue to support the old scopes but they was removed from the documentation

auth: support search, limit and starting_after query parameter when listing partner accounts


auth: support for issuing exchange token for a sub-account, to allow partner accounts to manage sub accounts.



customers: make type and company property optional when updating a customer user


auth: Support for including a Refresh Token when requesting an Access Token. Use grant-type=refresh_token to get an Access Token from a Refresh Token.

auth: Support for revoking a Refresh Token



webhooks: Implement support for subscription on discount_customer_update event. The event is published after a receipt_add event or when discounts are claimed.

discounts: include statistics, usage and stamp count and more in response from:

discounts deprecate the statistics.used property, replaced by statistics.usage.

discounts moved the debit_balance property into statistics.usage.

discounts add new mixes property to the discount requirement item. The new property can be used to define Mix & Match discounts, discount that requires multiple items to be purchase to enable the reward.



discounts add new private property to the discount rule object. A private discount will be excluded from public discount collection if the rule is given to all customers.

discounts: add new endpoint for getting details about a discount claim.

customers: support new customer type employee.

discounts: increase maximum limit value accepted by eindpoint:



management: rename typo in Account definition all bussiness_name properties renamed to business_name



discounts: extend the discount.limitation with discount_eligible, an optional property for limiting what items in a purchase is eligible for the rule.

discounts: extend the discount.limitation with discount_combination, an optional property for limiting how many other discount rules the rule can be combined with.

discounts: extend the discount.limitation with blacklist, an optional property for blacklisting items by id or group, items not eligible for discount.

receipts: extend the receipt.store object with business_name, an optional property for the store legal name.



discounts: extend support for discount customer requirement. Create new discount

receipts: moved endpoint for receipt search Search by receipt_id query parameter.

customers: adding tokens to deleted customers will now fail with BAD_REQUEST. Create new Token

customers: Duplication control of customer.email is now case insensitive. email case will be ignore on Search and login.


discounts: Add support for claim collection get

discounts: Add support for inactive discount by new active property on discount. create update list An inactive discount will not be included in response from public or customer

receipts: Add support for updating anonymous receipt with customer_id and discounts. Update receipt

customers: Add support for query parameter total on GET user/token lists. Includes a total-count header in the response when enabled..

discounts: Add new endpoint for listing customer a discount has been given to. Get discount customer refs



receipts: rename property store.created_on_terminal_id to store.terminal_id.

discounts: Extend support for update of discount rule to allow update of limitation and requirement Update Discount Include updated_by property container the user/client that last updated the discount rule.

customers: Add support for delete_token_events parameter when creating new customer token

receipts: extend receipt.discount.refs. Add statistics object and stamp property to refs. The statistics object includes total amount, usage, stamp and current debit_balance.

receipts: correct type of receipt.discount.refs.items.amount to integer (was string).

customers: filter token events by since_datetime. Get token events

customers: delete customer and all tokens owed by the customer in one request when using delete_tokens query parameter. Delete customer

customers: token event status. The status in response from Find / Add token events will now be set to customer.status if a customer with status is included in the response.

discounts: filter discounts. Allow the result from Discount Collection to be filtered by state, since_datetime, purchase_from and purchase_to.



discounts: change default item.quantity requirement from 1 to 0. Allows discount on items where quantity is in weigth/volume and value is < 1 by default.

customeres: add minimum length for token token_id/type/value

discounts: add minimum length for token token_id/type/value/customer_id


discounts: add new reward type discount_debit

customers: add endpoint for GET/DELETE token events



receipts: extend receipt.discounts.refs. Include amount and how the amount was applied to the receipt.items in discount.refs (see response from /discounts/available_for_receipt for example)

discounts: add links and metadata property to the discount. Support adding links related to the discount and any key/value metadata

customers: add type property to the customer. Support multiple customer types, add support for Company type for additional properties


customers: move endpoints for retrieving/updating token (events), use one endpoint for both retrieving and updating details about a token



discounts: add type property to the discount. The value is calculated from the discount.requirement, stating if the discount is given on the receipt or limited to specific items.

receipts: add refs to receipt discounts. The value is used to record the reference between the owner of the discount and how many times the discount was used on the purchase.

receipts: add monetary string properties suffixed with _dwh. The new values can be used to store monetary value with a resolution higher than the smallest unit for the currency.