DataCandy on Semi-Integrated Terminals

DataCandy on Semi-Integrated Terminals

Account Activation Linked to the Gift Card

Please make sure that your payment terminal is properly configured in order to process DataCandy gift card transactions.

DataCandy provides the terminal configuration information directly to the merchant; the information includes:

  • DataCandy merchant number
  • DataCandy access key
  • DataCandy merchant password

For complete application information, refer to the DataCandy User Guide.

To activate an account linked to a gift card, you must complete the Activation transaction using the payment terminal.

In order to activate an account the merchant must call the Payment API using the following function:

APIEndpoint
DataCandy - Activatehttps://developer.payfacto.com/docs/datacandy-activate

The amount sent in the Activation call is automatically credited on the DataCandy gift card account.

Using this endpoint, the account status of the card in DataCandy dashboard will be updated from Activable to Active.

❗️

Activation Makes All Other Transactions Possible

This step is required to perform other types of DataCandy transactions: Increment, Purchase (Redemption), Balance, Partial Cancel, Complete Cancel.

DataCandy Increment

This transaction is used to increment (add funds to) a DataCandy giftcard. The initial amount is credited on the gift card during the Activation transaction.

In order to process an Increment transaction, the merchant will have to call Payment API using the following function:

APIEndpoint
DataCandy - Incrementhttps://test.api.payfacto.cloud/v1/datacandy/increment

DataCandy Purchase (Redemption)

This transaction is used to redeem a DataCandy gift card.

In order to process a Purchase transaction, the merchant will have to call Payment API using the following function:

APIEndpoint
DataCandy - Purchasehttps://test.api.payfacto.cloud/v1/datacandy/redemption

DataCandy Balance

This transaction is used to get the balance remaining on a DataCandy gift card.

In order to process Balance transaction, the merchant will have to call Payment API using the following function:

APIEndpoint
DataCandy - Balancehttps://test.api.payfacto.cloud/v1/datacandy/balance

DataCandy Partial Cancel

This transaction is used to perform a partial cancel of a previous DataCandy transaction.

In order to process a partial cancel, the merchant will have to call Payment API using the following function:

APIEndpoint
Datacandy - Partial Cancelhttps://test.api.payfacto.cloud/v1/datacandy/partialCancel

DataCandy Complete Cancel

This transaction is used to perform a cancel of a previous DataCandy transaction.

In order to process a complete cancel transaction, the merchant will have to call Payment API using the following function:

APIEndpoint
Datacandy - Complete Cancelhttps://test.api.payfacto.cloud/v1/datacandy/completeCancel

DataCandy Return Code (Acquirer Return Code List)

Return CodeDescription
1Transaction is valid and was accepted.
101The card specified by the CID parameter is invalid or does not exist.
102The amount specified by the AMT parameter is invalid or not properly formatted.
103The card you are trying to activate is already active.
104The card specified by the CID parameter is expired and no longer active.
105The account’s balance is insufficient.
106A value used for authentication could not be validated, such as MID or MPW.
107The transaction specified by the TCR parameter could not be found.
108The transaction is invalid.
109The transaction could not be processed because the actual date/time is outside the allowed transaction processing window.
111The transaction specified by the TCR parameter is not a lock transaction or is the wrong lock transaction.
140The program specified by the PRG parameter is invalid.
141The API version specified by the VER parameter isn’t supported.
142Your request did not include the mandatory VER parameter.
143The API version specified by the VER parameter is in an invalid format. It should bein the YYYY-MM-DD form. For example: 2010-01-06.
144The language specified by the LNG parameter isn’t supported.
146The language you specified in the LNG parameter is in an invalid format.
216The invoice number specified in the INV parameter has already been used for this merchant in current year. This error will be triggered only when client requires to setup this configuration.
222The invoice number specified in the INV parameter is invalid.
223Card locked due to repeat failed PIN attempts.
225Invalid action/transaction type.
228Invalid workstation number.
229Invalid waiter/employee number.
233Invalid PIN number. The PIN number was sent but does not match.
234Empty PIN. A PIN number was required but none was sent.
235Invalid DB PIN value. The server side PIN value is invalid (eg: non-numerical PIN).
260Sample error message: card is valid from 2016-06-01 to 2016-12-31. This error will be triggered when the start date of the card is in the future.
262Too many attached accounts found. Unable to determine which one to use.
264The account is inactive.
265The account is expired.
268The target account’s balance exceeds the maximum possible balance.
270The card can’t be activated due to invalid expiry setting.
277The source account does not support balance transfers.
279The amount specified in the AMT parameter is lower than the minimum increment amount.
280The amount specified in the AMT parameter is lower than the minimum activation amount.
281Emptying cards is not supported at the specified location.
282The source account’s balance is exceeds the maximum amount supported at the specified location.
283The account does not support locking.
284The account is currently locked.
285The account is not currently locked.
286The amount specified in the AMT parameter is higher than the maximum increment amount.
287The amount specified in the AMT parameter is higher than the maximum activation amount.
288Emptying cards is not supported for the account type of given card.
322The maximum number of redemption allowed at this merchant has been met.
500There is an internal problem with the DataCandy API, which you cannot resolve. Retry the request. If the problem persists, contact us.

    • Related Articles

    • About Semi-Integrated Recovery

      Introduction The recovery is an integration principle for semi-integrated terminals to recover a response when certain situations occur during a transaction. After the transaction completes, these situations prevent PayFacto from providing a return ...

    • Credit and Debit on Semi-Integrated Terminals

      Transaction Flow Semi-Integrated Process Flow Send basic transaction information from the Point of Sale (POS) workstation with a transactional application to the merchant environment (back office) server. The merchant must collect the essential data ...

    • Endpoint : Datacandy Activate

      Datacandy Activate This transaction is used to activate a datacandy giftcard. Request Field Mandatory? CompanyNumber MerchantNumber Amount InvoiceNumber MerchantTerminalNumber LanguageCode OperatorID UserEchoData Response Field Mandatory? returnCode ...

    • Endpoint : Datacandy Complete Cancel

      Datacandy Complete Cancel This transaction is used to perform a cancel of a previous datacandy transaction. Request Field Mandatory? CompanyNumber Y MerchantNumber Y Amount Y InvoiceNumber Y OriginalTerminalInvoiceNumber Y MerchantTerminalNumber Y ...

    • Endpoint : Datacandy Partial Cancel

      Datacandy Partial Cancel This transaction is used to perform a partial cancel of a previous datacandy transaction. Request Field Mandatory? CompanyNumber Y MerchantNumber Y Amount Y InvoiceNumber Y OriginalTerminalInvoiceNumber Y ...