Get started with Finfare Conne...

Publisher onboarding checklist

18min

To get started with the , follow the onboarding steps below. A Checklist to receive production credentials is provided below to track the onboarding progress.

Onboarding steps for new Publishers

1. Obtain authentication

  1. Contact a Finfare representative to obtain a sandbox key.
  2. Securely store the provided API key for backend communications.

Call the categories endpoint first to ensure a 200 response code is returned.

2. Create a user for API Publishers

  1. Prepare the necessary user data (e.g., unique user_id, email, attributes).
  2. Make a POST request to the create user end-point.
  3. Example cURL command:
Curl


3. Display Terms and Conditions

  1. Use a Get command to retrieve the Finfare Terms and Conditions.
  2. The terms and conditions will contain a version number for the terms and conditions which must be passed when accessing the Accept Terms and Conditions end-point.


4. Accept Terms and Conditions

  1. Example cURL command:
Curl


5. Set up webhooks

  1. Contact a Finfare representative to register your webhook endpoint(s).

6. Receive webhooks

  1. Ensure your endpoint can handle webhook payloads.
  2. Example payload format:
JS


7. Link user accounts via Plaid

To view detailed steps on how to link user accounts via Plaid, see Plaid Account Link.

  1. The Publishers front end (FE) application must display the Plaid iframe.
  2. Use GET new link token to receive the users unique token.
  3. Provide the unique link token to render PLAID.
  4. Receive and save the public access token.
  5. Use Get All Linked Cards to verify the successful token exchange.

Follow the complete instructions to remove access token and for re-authentication. Periodically, the Plaid connection will sever, causing the user the need to re-authenticate to continue accruing rewards.

8. Get Brands and Offers

Offers are crafted for each individual and can change or expire at anytime. Thus Finfare highly recommends that Publishers use the Get Brands By User end point to fetch offers at run-time to guarantee each offers' validity.

  1. Using the Publishers user_ID from step 2 above, use Get Brands By User.

Checklist to receive production credentials

To receive production credentials, the Publisher must pass the following qualifications. After the checklist is verified by Finfare, the production keys will be generated, and the Publisher can activate their program.

1. Create a sample user

2. Get Terms and Conditions for the user

3. Accept terms and conditions for the aforementioned user

4. Check user status and verify the user is active

5. Register the user with PLAID and verify a successful account linking

Verify re-auth. Periodically, the plaid connection will sever, and the end-user will need to relink their account. Contact Finfare to trigger the situation in sandbox for the user.

6. After a successful re-linking of the account, Finfare will send a series of transactions related to the given end-user. Finfare will verify how many transactions are sent, and the following information for each transaction:

Time Stamp

Transaction Amount

Status

Customer_Share

7. For the given user verify the following information:

account_status

pending_cashback

available_cashback

8. Run a test transaction by making a purchase from an affiliate link. Then, verify that the transaction has gone through.



Updated 15 Nov 2024
Doc contributor
Doc contributor
Did this page help you?
PREVIOUS
Glossary
NEXT
Payment-linked dining offers
Docs powered by Archbee