latestOpenAPI 3.1.02026-08-22124199170.4 KB

8a237f1f704f

rewards

List Rewards Offers

Returns the cashback offers available to an enrolled payment card for the given rewards program. Pass the program_id from the card's active enrollment. Optionally provide latitude/longitude (and radius) to surface location-based in-store offers.

get/v2/payment-cards/{payment_card_id}/rewards/{program_id}/offers/

Path parameters

payment_card_idstring required

External ID of the payment card.

program_idstring required

Rewards program ID from the card's active enrollment.

Query parameters

latitudenumber double

Latitude used to surface nearby in-store offers.

longitudenumber double

Longitude used to surface nearby in-store offers.

radiusnumber double

Search radius, in miles, around the provided coordinates.

searchstring

A search term.

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

Headers

Authorizationstring required

Bearer authentication

Response

countinteger required
nextstring uri nullable
previousstring uri nullable