Provider Integration

Overview

Provider integrations are for companies that will be providing customers with a way to search for their transactions which may be stored in TxFind.

Merchants will not have to complete this integration, and will not be provided with credentials to do so.

Integration

Provider signup

To signup, you will need to make contact with the TxFind team. When signup is completed you will be provided with a key that can be used to sign JWT Bearer tokens.

Authentication

Authentication is completed by sending a JWT Bearer token that has been created using the private key sent during registration.

At a minimum, the JWT Bearer token must contain the iat and exp fields.

If authentication fails TxFind will return a 401 Unauthorized status code and terminate the call.

For more information on how JWT Bearer tokens work please see here

JWT Bearer Token

Please note that when you were given access to the system as a provider you would have been provided your JWT Signature Key. To generate a Bearer token to test your call, you will need to use that key to encode your Bearer Token, JWT.io will let you build one to test with. Make sure that you have set the following:

• Algorithm: HS256

• Leave the header as is

• Payload: { "iat": 1632265844560, "exp": 1632266144560 }

• verify signature: in the box provided enter your JWT Signature Key

Note that the iat can be generated from your browsers console by typing Date.now(). The exp is 5 minutes later, this can be calculated by adding 300,000 to the iat (the iat is in milliseconds, not seconds).

Search

Call the search endpoint that is relevant to you. During the onboarding process, the TxFind team will discuss with you your needs and point you at the correct search endpoint. In many cases, this may require a custom search endpoint with search fields and results tailored to your use case.

It should be noted that you will not have access to all search endpoints with your credentials, just the ones relevant to your needs.