canonical: https://jentic.com/apis/currencyalliance.com/currencyalliance # Currency Alliance API The Currency Alliance API connects loyalty programmes so partners can issue, transfer, redeem, or exchange loyalty currency units across brands and into gift cards. Endpoints cover accruals (direct issue, purchase rules, and activity rules), currency exchanges between partner programmes, standard redemptions with simulate, execute, adjust, and cancel actions, gift card issuance, member lookup, transactions, and partner discovery. Authentication uses a public credential plus a HMAC-SHA256 signature derived from the request body or query string, sent in the Authorization header. The API is designed for server-to-server use only. ## For AI agents Issue, exchange, and redeem loyalty currency units across partner programmes through the Currency Alliance loyalty commerce network. Useful for AI agents that automate redemptions, simulations, and member lookups. ## Scope Does not handle fiat payment processing, customer identity verification, or front-end loyalty UIs - use for Currency Alliance loyalty accruals, exchanges, redemptions, and gift cards only. ## Capabilities - Issue loyalty currency to a member directly via `/accruals/standard` - Trigger purchase-rule and activity-rule accruals via the `/accruals/purchase-rules` and `/accruals/activity-rules` endpoints - Simulate or execute currency exchanges between partner programmes via `/exchanges/simulate` and `/exchanges/execute` - Run standard redemptions with simulate, execute, adjust, and cancel actions - Issue gift cards in partner currencies via the gift-card endpoints - Look up members and pull transaction history for reconciliation ## Use cases ### Cross-Brand Loyalty Exchange An airline or hotel agent can offer members the ability to exchange loyalty currency into a partner's programme. The agent calls `/exchanges/simulate` first to show the projected balance, then `/exchanges/execute` on confirmation. Currency Alliance handles the partner-side reconciliation, so the brand only deals with one API instead of integrating dozens of partner programmes individually. Example prompt: POST `/exchanges/simulate` with the source and target programmes, present the result, then POST `/exchanges/execute` on user confirmation. ### Activity-Triggered Loyalty Rewards A marketing team can reward members for behavioural events such as referrals, reviews, or birthdays. The agent calls `/accruals/activity-rules/trigger` with the rule ID and member, and Currency Alliance applies the configured number of points without the marketing team needing to recalculate amounts in their own systems. Example prompt: POST `/accruals/activity-rules/trigger` with the activity rule ID and the member identifier when a referral event fires. ### Pay With Points Checkout An e-commerce checkout can offer customers the option to pay with partner loyalty points using the Standard Redemptions endpoints. The agent simulates the redemption to show the price in points, executes it on confirmation, and uses adjust or cancel if the order changes. The simulate-then-execute pattern protects the customer from balance surprises. Example prompt: POST `/redemptions/simulate`, present points cost, then POST `/redemptions/execute` on confirmation, and POST `/redemptions/cancel` if the order is voided. ### AI Agent Integration via Jentic A loyalty operations agent can use Jentic to discover Currency Alliance operations rather than wiring 60 endpoints directly. The agent searches Jentic for an intent like 'simulate a loyalty currency exchange', loads the schema, and runs the call with credentials Jentic holds, including the HMAC signature step. Example prompt: Use Jentic search for 'simulate a loyalty currency exchange' and execute the matching POST `/exchanges/simulate` operation. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/accruals/standard` | Execute a direct accrual | | POST | `/accruals/purchase-rules/trigger` | Trigger a purchase-rule accrual | | POST | `/accruals/activity-rules/trigger` | Trigger an activity-rule accrual | | POST | `/exchanges/simulate` | Simulate a currency exchange | | POST | `/exchanges/execute` | Execute a currency exchange | ## Key resources - **Accruals** — Issue loyalty currency units via direct, purchase-rule, or activity-rule endpoints. - **Exchanges** — Simulate and execute loyalty currency exchanges between partner programmes. - **Standard Redemptions** — Simulate, execute, adjust, and cancel redemptions of points for goods and services. - **Gift Cards** — Issue gift cards in fiat currencies in exchange for points. - **Members** — Look up member details and balances. - **Partners** — Discover partner loyalty programmes and required member fields. - **Transactions** — Pull transaction history for reconciliation. ## Why Jentic - **Setup:** Wiring the Currency Alliance API by hand means computing an HMAC-SHA256 signature over each request with your private key, building the Authorization Credential and Signature header, and handling retries across dozens of loyalty endpoints yourself. Through Jentic you install once, import the Currency Alliance API from the API Directory, store the public and private keys once, and your agent calls it. - **Permission scoping:** Currency Alliance takes accrual, exchange, and redemption targets in the request body rather than an id in the URL path, so limit the agent to the operations it needs, such as simulating an exchange. You choose which operations are in scope, so ones that execute an exchange or trigger an accrual are not included unless you add them. - **Credential handling:** Your Currency Alliance public and private keys are stored once, encrypted, by your own Jentic One instance, which computes the request signature at execution time. The private key never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'simulate a loyalty currency exchange', and Jentic returns the matching Currency Alliance operation with its input schema so the agent calls the right endpoint without browsing the integration guide. ## Related APIs - **LoyaltyLion API** — LoyaltyLion is a stand-alone loyalty programme platform alternative for direct-to-consumer brands. - **Stripe API** — Stripe handles fiat payments alongside Currency Alliance's loyalty currency operations. - **RewardLoyalty API** — RewardLoyalty is another loyalty platform overlapping with Currency Alliance's accrual and redemption flows. ## FAQ ### What authentication does the Currency Alliance API use? Currency Alliance uses a public credential plus an HMAC-SHA256 signature of the request body (or query string for GET) using your private key. Both are sent in the Authorization header as Credential=, Signature=. Through Jentic the public and private keys are held in your Jentic One instance and Jentic computes the signature per call so the agent never handles the secret. ### Can I exchange loyalty points between partner programmes with the Currency Alliance API? Yes. POST `/exchanges/simulate` first to preview the partner balance, then POST `/exchanges/execute` to complete the exchange. Use the partners endpoints to discover which programmes are available and what member-validation fields they require. ### What are the rate limits for the Currency Alliance API? Currency Alliance does not publish a fixed rate limit in the spec, but the API is designed for server-to-server traffic and supports idempotency via the Idempotency-Key header on POST and PATCH requests. Use idempotency keys to safely retry on transient errors. ### How do I issue a gift card with the Currency Alliance API through Jentic? Run pip install jentic, search Jentic for 'issue a gift card with Currency Alliance', load the schema for the gift-card issuance operation, and execute it with the member ID and amount. Jentic computes the HMAC signature and injects the credentials, so the integration code stays clean. ### How do I cancel a redemption with the Currency Alliance API? Use the cancel endpoint under standard redemptions with the redemption identifier. The system refunds the points to the member if the partner allows cancellation. ### Is the Currency Alliance API free? Currency Alliance is a partnership platform, so commercial terms are negotiated per partner rather than published as a self-serve price list. Contact Currency Alliance to onboard a brand and obtain credentials. ### Can I limit what my agent is allowed to do with the Currency Alliance API? Yes. Because you run Jentic One yourself, you decide which Currency Alliance operations the agent may call, and only the ones you add are in scope. For example, you can allow the agent to simulate an exchange or accrual while leaving the operations that execute an exchange, trigger an accrual, or execute a redemption out of scope. Since the accrual, exchange, and redemption targets are passed in the request body rather than a path id, scoping happens at the operation level, and your public and private keys stay held by your own instance so the agent never handles the secret.