What's new

Documentation change log

1min

This page contains information about any updates to the  documentation. For updates to the documentation, API, and White Label that correspond to a release, see API and White Label change log﻿.  
﻿
Date
Changes
December 10, 2024
Added a note about gift card limitations under Finfare Payments SDK﻿. 
December 6, 2024
Added a procedure to enable payments for API customers who wish to purchase gift cards: Finfare Payments SDK﻿﻿
December 2, 2024
Updated primary_zip to primary_zip_code under POST /users﻿. 
November 26, 2024
Updated GET /transactions﻿ to indicate that publisher_user_id is no longer required.
November 22, 2024
Added the description for primary_zip under POST /users﻿. 
Updated the GET /plaid/linked-cards/{publisher_user_id}﻿ (Get all linked cards) description to clarify that the response only returns active cards that are currently linked in Plaid. 
November 21, 2024
Added a table to the following core resources topics that show the available API calls and actions at-a-glance:
﻿Users﻿ 
﻿Transactions﻿ 
﻿Offers and Brands﻿ 
﻿Rewards﻿ 
﻿Terms and Conditions﻿ 
﻿Plaid Account Link﻿ 
November 19, 2024
Added a link to the Finfare's status page.
Renamed the Change log section to What's new.
November 13, 2024
Added a note to user_cashback that provides additional information on how this field can be used to calculate the Publisher's commission for the following pages:
﻿Transactions﻿ 
﻿transaction.created﻿﻿
﻿transaction.updated﻿ 
 November 12, 2024
Added data object definitions for the following webhooks:
﻿transaction.created﻿ 
﻿transaction.updated﻿ 
Updated the publisher_share description to include how to accurately interpret the commission amount. The following pages include this update:
﻿Transactions﻿ 
﻿transaction.created﻿﻿
﻿transaction.updated﻿ 
November 11, 2024
Updated the Glossary﻿ to clarify the Rewards and Cashback definitions.
Added a Feedback﻿ page that explains how to submit feedback and suggestions to improve the  documentation. 
Replaced the user_id attribute from the the example responses and example requests in the Playbook and FAQs﻿ with publisher_user_id.
November 8, 2024
Renamed API change log to API and White Label change log﻿.
Added White Label updates to the change log.
Removed the documentation changes section from API and White Label change log﻿. 
Added a new documentation change log page to list documentation changes.
November 6, 2024
Updated the GET /transactions﻿ response to accurately reflect the API.
Updated the offer_locations query parameter to location.
November 5, 2024
Added store_addresses and its description to the responses for GET /publishers/brands﻿ and GET /publishers/brands/{brand_uid}﻿. 
October 31, 2024
Added a note to the DELETE /users/{publisher_user_id}﻿ endpoint that states, "Only users with an ACTIVE status can be deleted."
Added the Webhook types﻿ page to easily view all supported webhooks at-a-glance.
Added a page about Payment-linked dining offers﻿. This page provides guidelines and details about payment-linked dining offers which can be added to a Publisher's rewards platform upon request.
﻿

Date	Changes
December 10, 2024	Added a note about gift card limitations under Finfare Payments SDK.
December 6, 2024	Added a procedure to enable payments for API customers who wish to purchase gift cards: Finfare Payments SDK
December 2, 2024	Updated primary_zip to primary_zip_code under POST /users.
November 26, 2024	Updated GET /transactions to indicate that publisher_user_id is no longer required.
November 22, 2024	Added the description for primary_zip under POST /users. Updated the GET /plaid/linked-cards/{publisher_user_id} (Get all linked cards) description to clarify that the response only returns active cards that are currently linked in Plaid.
November 21, 2024	Added a table to the following core resources topics that show the available API calls and actions at-a-glance: Users Transactions Offers and Brands Rewards Terms and Conditions Plaid Account Link
November 19, 2024	Added a link to the Finfare's status page. Renamed the Change log section to What's new.
November 13, 2024	Added a note to user_cashback that provides additional information on how this field can be used to calculate the Publisher's commission for the following pages: Transactions transaction.created transaction.updated
November 12, 2024	Added data object definitions for the following webhooks: transaction.created transaction.updated Updated the publisher_share description to include how to accurately interpret the commission amount. The following pages include this update: Transactions transaction.created transaction.updated
November 11, 2024	Updated the Glossary to clarify the Rewards and Cashback definitions. Added a Feedback page that explains how to submit feedback and suggestions to improve the documentation. Replaced the user_id attribute from the the example responses and example requests in the Playbook and FAQs with publisher_user_id.
November 8, 2024	Renamed API change log to API and White Label change log. Added White Label updates to the change log. Removed the documentation changes section from API and White Label change log. Added a new documentation change log page to list documentation changes.
November 6, 2024	Updated the GET /transactions response to accurately reflect the API. Updated the offer_locations query parameter to location.
November 5, 2024	Added store_addresses and its description to the responses for GET /publishers/brands and GET /publishers/brands/{brand_uid}.
October 31, 2024	Added a note to the DELETE /users/{publisher_user_id} endpoint that states, "Only users with an ACTIVE status can be deleted." Added the Webhook types page to easily view all supported webhooks at-a-glance. Added a page about Payment-linked dining offers. This page provides guidelines and details about payment-linked dining offers which can be added to a Publisher's rewards platform upon request.

API and White Label change log

Contact customer success