Core resources

Users

25min

The user object represents the end users on the Publisher's platform. All rewards generated on the  platform are linked to the user object. 
The table below outlines the available API calls and actions for the user object.
Action
API call
Description
﻿Get all users of the requested API Publishers﻿ 
GET /users
Retrieves a list of all the users for a given Publisher.
﻿Create a user for API Publishers﻿ 
POST /users
Creates a user for the API Publishers.
﻿Delete a user of the requested API Publishers﻿ 
DELETE /users/{publisher_user_id}
Deletes a user from the  system.
﻿Get the status for all users﻿ 
GET /users/status
Retrieves the account status for all users in the  system for a given Publisher.
﻿Get the status for a user﻿ 
GET /users/status/{publisher_user_id}
Retrieves a specific user's account status and rewards in the  system for a given publisher. 
﻿
﻿GET /users
Retrieves a list of all the users for a given Publisher. See Get all users of the requested API publishers﻿ to test the API.
Query parameters
﻿
Name
Data type
Description
email
string
Email address linked to the user which can be used to directly communicate with the user.
Pageable
﻿
Responses
﻿
HTTP status 200
Returns an array of User﻿ objects along with metadata about the response. For more information, see Status and response codes﻿.
﻿
Paginated
See Pageable response﻿ for more information on the returned paginated response.
﻿
Body
Name
Data type              
Description
ff_user_id
string
Unique identifier for the user generated by Finfare.
publisher_user_id
string
Unique identifier for the user sent by the publisher, to identify a user in the publisher’s system.
email
string
Email address linked to the user which can be used to directly communicate with the user.
account_status
enum
This indicates the status of the user in the  system and is used primarily to determine if a user has accepted the Terms and Conditions. This can also be used to determine if a user is still active in the system.
Possible values:
ACTIVE - User has accepted Terms and Conditions.
INACTIVE - Indicates that the publisher has deactivated the user.
PENDING - User has not accepted the Terms and Conditions.
attributes
Object

JsonNode_Schema
Additional user attributes that allow the publisher to uniquely identify the user. This is sent as a json string.
created_at
string

2021-08-25T00:00:00Z
Date and time that the user was created in the  system. The format of this string is: yyyy-MM-dd'T'HH:mm:ss:z
All time values are in the Coordinated Universal Time (UTC) time zone.
updated_at
string
2021-08-25T00:00:00Z
Date and time that the user object was updated in the  system. The format of this string is: yyyy-MM-dd'T'HH:mm:ss:z
All time values are in the Coordinated Universal Time (UTC) time zone.
﻿
﻿POST /users
Creates a user for the API Publishers.
Before users can redeem offers, the publishers must register the users with the . All users must accept the  Terms and Conditions to complete registration. 
﻿
See Create user for API publishers﻿ to test this this API.
Body parameters
﻿
Name
Data type
Description
publisher_user_id  REQUIRED﻿
string
Publisher's unique identifier for the user. This ID is sent by the publisher to  to identify a user in the publisher’s system.**
email
string
Email address linked to the user which can be used to directly communicate with the user.
primary_zip_code
string
90000
Indicates the home zip code of a given user. This helps identify offers that are local to the user.
attributes
Object
JsonNode_Schema
Additional user attributes that allow the publisher to uniquely identify the user. This is sent as a json string.
**The publisher must provide a unique ID for the user; This ID can be anything as long as the publisher is able to use it to uniquely identify their users. These IDs will also be used in transaction reports that  shares with its publishers.
Responses
﻿
HTTP status 200
Returns an array of User﻿ objects along with metadata about the response. For more information, see Status and response codes﻿.
﻿
Body
Name
Data type              
Description
ff_user_id
string
Unique identifier for the user generated by . 
publisher_user_id
string
Unique identifier for the user sent by the publisher, to identify a user in the publisher’s system.
email
string
Email address linked to the user which can be used to directly communicate with the user.
primary_zip_code
string
90000
Indicates the home zip code of a given user. This helps identify offers that are local to the user.
account_status
enum
This indicates the status of the user in the  system and is used primarily to determine if a user has accepted the Terms and Conditions. This can also be used to determine if a user is still active in the system.
Values:
ACTIVE - User has accepted Terms and Conditions.
INACTIVE - Indicates that the publisher has deactivated the user.
PENDING - User has not accepted the Terms and Conditions.
attributes
Object

JsonNode_Schema
Additional user attributes that allow the publisher to uniquely identify the user. This is sent as a json string.
created_at
string

2021-08-25T00:00:00Z
Date and time that the user was created in the  system. The format of this string is: yyyy-MM-dd'T'HH:mm:ss:z
All time values are in the Coordinated Universal Time (UTC) time zone.
updated_at
string

2021-08-25T00:00:00Z
Date and time that the user object was updated in the  system. The format of this string is: yyyy-MM-dd'T'HH:mm:ss:z
All time values are in the Coordinated Universal Time (UTC) time zone.
﻿
﻿DELETE /users/{publisher_user_id}﻿
Deletes a user from the  system. Once a user is deleted, the status of the user changes to INACTIVE.
See Delete user of the requested API publishers﻿ to test the API.
Only users with an ACTIVE status can be deleted. 
Path parameters
﻿
Name
Data type
Description
﻿{publisher_user_id} REQUIRED﻿
string
Unique identifier for the user sent by the publisher, to identify a user in the publisher’s system.
Responses
﻿
HTTP status 200
Returns the User object with account_status as INVALID if successful with a 200 status. For more information, see Status and response codes﻿.
﻿
Body
Name
Data type              
Description
ff_user_id
string
Unique identifier for the user generated by . 
publisher_user_id
string
Unique identifier for the user sent by the publisher, to identify a user in the publisher’s system.
email
string
Email address linked to the user which can be used to directly communicate with the user.
account_status
enum
This indicates the status of the user in the  system and is used primarily to determine if a user has accepted the Terms and Conditions. This can also be used to determine if a user is still active in the system.
Values:
ACTIVE - User has accepted Terms and Conditions.
INACTIVE - Indicates that the publisher has deactivated the user.
PENDING - User has not accepted the Terms and Conditions.
attributes
Object

JsonNode_Schema
Additional user attributes that allow the publisher to uniquely identify the user. This is sent as a json string.
created_at
string

2021-08-25T00:00:00Z
Date and time that the user was created in the  system. The format of this string is: yyyy-MM-dd'T'HH:mm:ss:z
All time values are in the Coordinated Universal Time (UTC) time zone.
updated_at
string

2021-08-25T00:00:00Z
Date and time that the user object was updated in the  system. The format of this string is: yyyy-MM-dd'T'HH:mm:ss:z
All time values are in the Coordinated Universal Time (UTC) time zone.
﻿
﻿GET /users/status
Retrieves the account status for all users in  system for a given publisher. See Get status for all the users﻿ to test the API.
Responses
﻿
HTTP status 200
Returns an array of User﻿ objects along with metadata about the response. For more information, see Status and response codes﻿.
﻿
UserStatusResponse_Paginated
See Pageable response﻿ for more information on the returned paginated response.
﻿
Body
Name
Data type
Description
publisher_user_id  
string
Publisher's unique identifier for the user. This ID is sent by the publisher to  to identify a user in the publisher’s system.
email
string
Email address linked to the user which can be used to directly communicate with the user.
account_status
enum
This indicates the status of the user in the  system and is used primarily to determine if a user has accepted the Terms and Conditions. This can also be used to determine if a user is still active in the system.
Possible values:
ACTIVE - User has accepted Terms and Conditions.
INACTIVE - Indicates that the publisher has deactivated the user.
PENDING - User has not accepted the Terms and Conditions.
pending_cashback
number
Connect rewards that are waiting to become available. These become available once the transactions are past their refund date. Returns a BigDecimal number with precision up to two decimal places.
available_cashback
number
Connect rewards that are ready to be redeemed. Returns a BigDecimal number with precision up to two decimal places.
total_earned_cashback
number
Total Connect rewards earned by the user in their lifetime. Returns a BigDecimal number with precision up to two decimal places.
﻿
﻿GET /users/status/{publisher_user_id}﻿
Retrieves a specific user's account status and rewards in the  system for a given publisher. See Get the status for a user﻿ to test the API.
Path parameters
﻿
Name
Data type
Description
﻿{publisher_user_id} REQUIRED﻿
string
Unique identifier for the user sent by the publisher, to identify a user in the publisher’s system.
Responses
﻿
HTTP status 200
Returns an array of the subset of the User object that contains the user's account status and rewards. For more information, see Status and response codes﻿.
See Pagination﻿ for more information on the returned paginated response.
﻿
Body
Name
Data type
Description
publisher_user_id 
string
Publisher's unique identifier for the user. This ID is sent by the publisher to  to identify a user in the publisher’s system.
email
string
Email address linked to the user which can be used to directly communicate with the user.
account_status
enum
This indicates the status of the user in the  system and is used primarily to determine if a user has accepted the Terms and Conditions. This can also be used to determine if a user is still active in the system.
Possible values:
ACTIVE - User has accepted Terms and Conditions.
INACTIVE - Indicates that the publisher has deactivated the user.
PENDING - User has not accepted the Terms and Conditions.
pending_cashback
number
Connect rewards that are waiting to become available. These become available once the transactions are past their refund date. Returns a BigDecimal number with precision up to two decimal places.
available_cashback
number
Connect rewards that are ready to be redeemed. Returns a BigDecimal number with precision up to two decimal places.
total_earned_cashback
number
Total Connect rewards earned by the user in their lifetime. Returns a BigDecimal number with precision up to two decimal places.
﻿

Action	API call	Description
Get all users of the requested API Publishers	GET /users	Retrieves a list of all the users for a given Publisher.
Create a user for API Publishers	POST /users	Creates a user for the API Publishers.
Delete a user of the requested API Publishers	DELETE /users/{publisher_user_id}	Deletes a user from the system.
Get the status for all users	GET /users/status	Retrieves the account status for all users in the system for a given Publisher.
Get the status for a user	GET /users/status/{publisher_user_id}	Retrieves a specific user's account status and rewards in the system for a given publisher.

Name	Data type	Description
email	string	Email address linked to the user which can be used to directly communicate with the user.

Name	Data type	Description
ff_user_id	string	Unique identifier for the user generated by Finfare.
publisher_user_id	string	Unique identifier for the user sent by the publisher, to identify a user in the publisher’s system.
email	string	Email address linked to the user which can be used to directly communicate with the user.
account_status	enum	This indicates the status of the user in the system and is used primarily to determine if a user has accepted the Terms and Conditions. This can also be used to determine if a user is still active in the system. Possible values: ACTIVE - User has accepted Terms and Conditions. INACTIVE - Indicates that the publisher has deactivated the user. PENDING - User has not accepted the Terms and Conditions.
attributes	Object JsonNode_Schema	Additional user attributes that allow the publisher to uniquely identify the user. This is sent as a json string.
created_at	string 2021-08-25T00:00:00Z	Date and time that the user was created in the system. The format of this string is: yyyy-MM-dd'T'HH:mm:ss:z All time values are in the Coordinated Universal Time (UTC) time zone.
updated_at	string 2021-08-25T00:00:00Z	Date and time that the user object was updated in the system. The format of this string is: yyyy-MM-dd'T'HH:mm:ss:z All time values are in the Coordinated Universal Time (UTC) time zone.

Name	Data type	Description
publisher_user_id REQUIRED	string	Publisher's unique identifier for the user. This ID is sent by the publisher to to identify a user in the publisher’s system.**
email	string	Email address linked to the user which can be used to directly communicate with the user.
primary_zip_code	string 90000	Indicates the home zip code of a given user. This helps identify offers that are local to the user.
attributes	Object JsonNode_Schema	Additional user attributes that allow the publisher to uniquely identify the user. This is sent as a json string.

Name	Data type	Description
ff_user_id	string	Unique identifier for the user generated by .
publisher_user_id	string	Unique identifier for the user sent by the publisher, to identify a user in the publisher’s system.
email	string	Email address linked to the user which can be used to directly communicate with the user.
primary_zip_code	string 90000	Indicates the home zip code of a given user. This helps identify offers that are local to the user.
account_status	enum	This indicates the status of the user in the system and is used primarily to determine if a user has accepted the Terms and Conditions. This can also be used to determine if a user is still active in the system. Values: ACTIVE - User has accepted Terms and Conditions. INACTIVE - Indicates that the publisher has deactivated the user. PENDING - User has not accepted the Terms and Conditions.
attributes	Object JsonNode_Schema	Additional user attributes that allow the publisher to uniquely identify the user. This is sent as a json string.
created_at	string 2021-08-25T00:00:00Z	Date and time that the user was created in the system. The format of this string is: yyyy-MM-dd'T'HH:mm:ss:z All time values are in the Coordinated Universal Time (UTC) time zone.
updated_at	string 2021-08-25T00:00:00Z	Date and time that the user object was updated in the system. The format of this string is: yyyy-MM-dd'T'HH:mm:ss:z All time values are in the Coordinated Universal Time (UTC) time zone.

Name	Data type	Description
{publisher_user_id} REQUIRED	string	Unique identifier for the user sent by the publisher, to identify a user in the publisher’s system.

Name	Data type	Description
ff_user_id	string	Unique identifier for the user generated by .
publisher_user_id	string	Unique identifier for the user sent by the publisher, to identify a user in the publisher’s system.
email	string	Email address linked to the user which can be used to directly communicate with the user.
account_status	enum	This indicates the status of the user in the system and is used primarily to determine if a user has accepted the Terms and Conditions. This can also be used to determine if a user is still active in the system. Values: ACTIVE - User has accepted Terms and Conditions. INACTIVE - Indicates that the publisher has deactivated the user. PENDING - User has not accepted the Terms and Conditions.
attributes	Object JsonNode_Schema	Additional user attributes that allow the publisher to uniquely identify the user. This is sent as a json string.
created_at	string 2021-08-25T00:00:00Z	Date and time that the user was created in the system. The format of this string is: yyyy-MM-dd'T'HH:mm:ss:z All time values are in the Coordinated Universal Time (UTC) time zone.
updated_at	string 2021-08-25T00:00:00Z	Date and time that the user object was updated in the system. The format of this string is: yyyy-MM-dd'T'HH:mm:ss:z All time values are in the Coordinated Universal Time (UTC) time zone.

Name	Data type	Description
publisher_user_id	string	Publisher's unique identifier for the user. This ID is sent by the publisher to to identify a user in the publisher’s system.
email	string	Email address linked to the user which can be used to directly communicate with the user.
account_status	enum	This indicates the status of the user in the system and is used primarily to determine if a user has accepted the Terms and Conditions. This can also be used to determine if a user is still active in the system. Possible values: ACTIVE - User has accepted Terms and Conditions. INACTIVE - Indicates that the publisher has deactivated the user. PENDING - User has not accepted the Terms and Conditions.
pending_cashback	number	Connect rewards that are waiting to become available. These become available once the transactions are past their refund date. Returns a BigDecimal number with precision up to two decimal places.
available_cashback	number	Connect rewards that are ready to be redeemed. Returns a BigDecimal number with precision up to two decimal places.
total_earned_cashback	number	Total Connect rewards earned by the user in their lifetime. Returns a BigDecimal number with precision up to two decimal places.

Name	Data type	Description
{publisher_user_id} REQUIRED	string	Unique identifier for the user sent by the publisher, to identify a user in the publisher’s system.

Name	Data type	Description
publisher_user_id	string	Publisher's unique identifier for the user. This ID is sent by the publisher to to identify a user in the publisher’s system.
email	string	Email address linked to the user which can be used to directly communicate with the user.
account_status	enum	This indicates the status of the user in the system and is used primarily to determine if a user has accepted the Terms and Conditions. This can also be used to determine if a user is still active in the system. Possible values: ACTIVE - User has accepted Terms and Conditions. INACTIVE - Indicates that the publisher has deactivated the user. PENDING - User has not accepted the Terms and Conditions.
pending_cashback	number	Connect rewards that are waiting to become available. These become available once the transactions are past their refund date. Returns a BigDecimal number with precision up to two decimal places.
available_cashback	number	Connect rewards that are ready to be redeemed. Returns a BigDecimal number with precision up to two decimal places.
total_earned_cashback	number	Total Connect rewards earned by the user in their lifetime. Returns a BigDecimal number with precision up to two decimal places.

Payment-linked dining offers

Transactions

Users

﻿GET /users

Query parameters

Responses

﻿POST /users

Body parameters

Responses

﻿DELETE /users/{publisher_user_id}﻿

Path parameters

Responses

﻿GET /users/status

Responses

﻿GET /users/status/{publisher_user_id}﻿

Path parameters

Responses

GET /users

POST /users

DELETE /users/{publisher_user_id}

GET /users/status

GET /users/status/{publisher_user_id}