This section provides the complete technical reference for all AxeTip API endpoints. All endpoints run globally on edge infrastructure with sub-20ms latency and zero database I/O at runtime.

OpenAPI specifications:

  • OpenAPI 3.1.1 (default, compatible with code generators, Postman, and API clients)
  • OpenAPI 3.2.0 (includes hierarchical tags and $self document URIs)

To test endpoints interactively in your browser, visit the API Explorer.


Endpoints

EndpointMethodsDescriptionReference
/api/cardsGET, POSTCard terms, CFPB margin schedules, and APRs calculated from live Fed Prime.Cards Reference →
/api/mccGET, POSTISO 18245 merchant category codes, network citations (Visa, Mastercard, Amex), and top-earning cards.MCC Reference →
/api/merchantGET, POSTMerchant database, alias resolution, primary/secondary MCCs, network rules, and co-brand cards.Merchant Reference →
/api/benchmarkGETFederal Reserve H.15 rates (Prime, SOFR, EFFR), FOMC meeting calendar, and credit card rate spreads.Benchmark Reference →
/api/optimizeGET, POSTTransaction routing and spend basket optimization. Checks register acceptance rules and compares card returns.Optimize Reference →

Base URL & Protocol

All requests are served over HTTPS:

https://www.axetip.com/api/
  • HTTP Methods: GET (query string parameters) and POST (JSON request body with Content-Type: application/json).
  • Response Format: application/json; charset=utf-8.
  • CORS: Enabled by default (Access-Control-Allow-Origin: *) for browser-based applications and frontend widgets.
  • Edge Caching: Responses to GET requests are cached globally for 7 days (Cache-Control: public, s-maxage=604800, max-age=3600).

Data Types: Structured Value Objects

To eliminate floating-point rounding errors across client runtimes, currency amounts, interest rates, and reward multipliers are serialized as structured objects with integer minor units (cents) and basis points (bps):

1. Currency Amounts (MoneyAmount)

{
  "value": 325.0,
  "cents": 32500,
  "formatted": "$325.00",
  "currency": "USD"
}
  • value (number): Floating-point decimal representation for display.
  • cents (integer): Integer minor units (cents) for exact ledger calculations.
  • formatted (string): Localized currency string.
  • currency (string): ISO 4217 three-letter currency code (e.g. USD).

2. Interest Rates (InterestRate)

{
  "value": 7.0,
  "bps": 700,
  "formatted": "7.00%"
}
  • value (number): Percentage value (e.g. 7.0 for 7.00%).
  • bps (integer): Integer basis points ($1\text{ bp} = 0.01% = 0.0001$).
  • formatted (string): Formatted percentage string.

3. Reward Yields (RewardYield)

{
  "value": 4.0,
  "unit": "%",
  "formatted": "4.0%",
  "basis_points": 400
}
  • value (number): Multiplier or cash back percentage.
  • unit (string): Reward unit (% for cash back, x for points or miles).
  • formatted (string): Formatted reward string (e.g. 4.0% or 4.0x).
  • basis_points (integer): Basis points equivalent ($4.0% = 400\text{ bps}$).

HTTP Status Codes

The API returns standard HTTP status codes:

CodeStatusMeaning
200OKRequest succeeded. Response body contains requested data.
400Bad RequestMissing required parameters, invalid format, or malformed JSON body.
404Not FoundRequested card, merchant, or MCC could not be resolved.
405Method Not AllowedUnsupported HTTP method for the endpoint.
429Too Many RequestsRate limit exceeded (more than 60 requests/minute on preview tier).
500Internal ErrorUnexpected server error.

Error Response Schema

When an error occurs, the API returns a JSON error response:

{
  "status": "error",
  "error": "Missing required parameter 'cards'",
  "code": "MISSING_PARAMETER"
}