Currency Alliance API
49
AI ReadinessFoundational (D+)49/100
Community OpenAPI document · agent-readyE CommerceOrder ManagementapiKey60 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For 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.
Use for: I want to issue 200 loyalty points to a member for completing a survey, Simulate exchanging 5000 points for a partner programme's currency, Execute a redemption of points against a partner offer, Issue a gift card to a member in EUR
Not supported: 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.
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.
Install Jentic One Beta
Connect the Currency Alliance API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Currency Alliance API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fcurrencyalliance.com%2Fcurrencyalliance" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fcurrencyalliance.com%2Fcurrencyalliance" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Currency Alliance API.
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
Patterns agents use Currency Alliance API for, with concrete tasks.
★ 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.
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.
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.
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.
Use Jentic search for 'simulate a loyalty currency exchange' and execute the matching POST /exchanges/simulate operation.
Key Endpoints
60 endpoints — the currency alliance api connects loyalty programmes so partners can issue, transfer, redeem, or exchange loyalty currency units across brands and into gift cards.
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
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
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
C
Currency Alliance API Documentation
- Foundational (D+)49/100
47
Foundational Compliance70
Developer Experience & Jentic Compatibility24
AI-Readiness & Agent Experience92
Agent Usability100
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
47
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: D+Signals: 4
89%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
0%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
70
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B+Signals: 4
44%
Example Density
How richly the API is illustrated with examples.
94%
Example Validity
Percentage of examples that conform to their schemas.
42%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
24
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
43%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
0%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
52%
Summary Coverage
Coverage of summaries across operations/tags/info.
92
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
92%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
100
Security
Trust, risk posture, and security compliance.
Grade: A+Signals: 1
100%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
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 isolation
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.
Intent-based discovery
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
Alternatives and complements available in the Jentic catalogue.
Complementary
Stripe API
Stripe handles fiat payments alongside Currency Alliance's loyalty currency operations.
Use Stripe to take a card payment for the cash portion of a checkout; use Currency Alliance to redeem points for the rest.
FAQs
Specific to using Currency Alliance API through Jentic.
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=<public-key>, Signature=<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.
GET STARTED