Merchant Integration

Overview

TxFind allows Merchants to store a copy of their cart/transaction data. You can update the cart data with relevant information over the lifetime of a transaction if you wish, or you can just leave it as the uploaded data.

The data that you may want to update could be the settlement data for an asynchronous transaction, where the settlement only happened hours / days later. Or updated parcel tracking information if available.

Integration Steps

Merchant signup

When a merchant signs up you will be provided a merchantId and a JWT Bearer token. Keep these safe and private. They are used for authentication into the merchant endpoints and all costs for use are raised against those credentials.

Store cart/transaction details

For every transaction that you do, you should store the full details of the cart/ transaction into TxFind. This is done by calling the /transactionDetails. This accepts a strict JSON string representing the details of the transaction.

Upon a successful store, the return data from the transactionDetails call will have a txShieldOICartReference , you should keep a record of this reference against the transaction in your system. You will need this reference if you want to update the cart later.

To help during integration there is the /cartValidation endpoint. This allows you to test your JSON data during integration with out storing a lot of test transactions in the database. You can also use this later for debugging transactions that failed.

Update alert & chargeback status

There are two important transaction lifecycle events that should be updated for the transaction. /alert and /chargeback . In particular, recording that a chargeback was done against a transaction is important for billing information.

Both endpoints accept a reference that can be used to find the details about an alert / chargeback in your system later, and will flag the transaction as having received an alert / chargeback.

Alert /alert An alert is a notification that is sent after a customer initiates a chargeback, but before it is finalized by the issuing bank. For more information about how to receive these talk to the TxShield team and see the documentation here.

Chargeback /chargeback When a chargeback is completed for a transaction, it should be recorded against the transaction in TxFind. This is in particular very important for transactions that are being exposed to Card Provider networks (Visa, Mastercard etc.) as this can significantly impact your billing.

Update cart / transaction details

The /updateTransactionDetails endpoint allows you to update details about the transaction. You may want to update the Settlement data for an asynchronous transaction that you did not have available to you at the time the cart / transaction was stored in TxFind. You may want to update parcel tracking information if available.

The information stored in TxFind will be available to the customer and their Issuing Bank prior to raising a Chargeback. So keeping as much relevant information available to search by (Settlement data) so the transaction can be found, along with as much up-to date cart / transaction information which can assist the customer or their Issuing Bank in making decisions about chargebacks.

Finished

That is all there is to the TxFind integration, you have now finished the Merchant Integration.