Version: 0.1.0

finperks API

This is the finperks API for viewing giftcard products, creating orders, and receiving webhook notifications. Recommended usage pattern:

• Retrieve and cache products to display them quickly and prioritize them per customer.
• Refresh the cached product list periodically (e.g., once a day) to ensure updates are reflected.
• Integrate webhook support to process product update events in real-time.
• Use the order creation endpoint to place giftcard orders with selected product and amount.
• Attempt to invalidate the order if unsure whether the transaction succeeded.

Authentication

API Key: Authorization

finperks Signature Version 1. Clients must sign the request and include:

• Authorization: FP1-HMAC-SHA256 KeyId=..., Signature=...

Security Scheme Type:	apiKey
Header parameter name:	Authorization

API Key: Date

RFC7231 Date Header

Security Scheme Type:	apiKey
Header parameter name:	Date