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.
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_codemust be included in the purchase, either in the new
discount_codeproperty or as an item, where the item id is set to the
discounts: Add support for
no_customer_idquery parameter when listing public discount rules.
receipts: Add support for
token_expire_daysparameter when creating receipt. The token added to the receipt can be used to retrieve and claim it.
discounts: Add support for specifying
requirement.storewhen creating new discount rules.
discounts: Add support for giving discounts on purchase with no
discounts: Add support for updating rules
accounts: Extend the AccountApplicant with support for
promo_codeand utm campaign codes.
discounts: change minumum number of mixes in a discount rule from 2 to 1
customers: extends settings with support for configuring users
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
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.mccproperty, 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
starting_afterquery 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_tokento get an Access Token from a Refresh Token.
auth: Support for revoking a Refresh Token
webhooks: Implement support for subscription on
discount_customer_updateevent. The event is published after a
receipt_addevent or when discounts are claimed.
discounts: include statistics, usage and stamp count and more in response from:
discounts deprecate the
statistics.usedproperty, replaced by
discounts moved the
discounts add new
mixesproperty 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
privateproperty 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
discounts: increase maximum
limitvalue accepted by eindpoint:
management: rename typo in Account definition all
bussiness_nameproperties renamed to
discounts: extend the
discount_eligible, an optional property for limiting what items in a purchase is eligible for the rule.
discounts: extend the
discount_combination, an optional property for limiting how many other discount rules the rule can be combined with.
discounts: extend the
blacklist, an optional property for blacklisting items by id or group, items not eligible for discount.
receipts: extend the
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.emailis now case insensitive. email case will be ignore on Search and login.
discounts: Add support for claim collection get
receipts: Add support for updating anonymous receipt with customer_id and discounts. Update receipt
customers: Add support for query parameter
totalon GET user/token lists. Includes a
total-countheader 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
discounts: Extend support for update of discount rule to allow update of limitation and requirement Update Discount Include
updated_byproperty container the user/client that last updated the discount rule.
customers: Add support for
delete_token_eventsparameter when creating new customer token
statisticsobject 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.amountto 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_tokensquery parameter. Delete customer
customers: token event status. The status in response from Find / Add token events will now be set to
customer.statusif a customer with status is included in the response.
discounts: filter discounts. Allow the result from Discount Collection to be filtered by
discounts: change default item.quantity requirement from
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
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)
metadataproperty to the discount. Support adding links related to the discount and any key/value metadata
typeproperty 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
typeproperty 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.
refsto 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.