Banyan Systems History API
The History API from Banyan Systems — 1 operation(s) for history.
The History API from Banyan Systems — 1 operation(s) for history.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/banyan-systems:banyan-systems-history-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
description: REST API for communicating with Banyan's systems
title: Banyan REST History API
version: 1.0.3
servers:
- url: https://api.banyan.com
security:
- bearerToken: []
tags:
- name: History
paths:
/v1/history:
post:
description: Get the history of data associated with a finx consumer token. The default time range is from the beginning of time to now and the start and/or end of the range can be overridden. This request is a POST because the time of request is a component in generating the response and the HTTP spec disallows caching POSTs so any caching proxies or clever HTTP request libraries should behave correctly. The response is limited to 1000 items. If more are expected request again with the start date advanced to after the last item returned.
operationId: retrieve-history
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HistoryParametersJSON'
description: The consumer token and optional data range for history.
required: true
responses:
'200':
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/HistoryItemJSON'
minItems: 1
type: array
errors:
items:
$ref: '#/components/schemas/ErrorJSON'
type: array
request_id:
format: uuid
type: string
required:
- data
- errors
type: object
description: The history items.
'400':
content:
application/json:
schema:
properties:
data:
items: {}
maxItems: 0
type: array
errors:
items:
$ref: '#/components/schemas/ErrorJSON'
minItems: 1
type: array
request_id:
format: uuid
type: string
required:
- data
- errors
type: object
description: The request was malformed.
'401':
content:
application/json:
schema:
properties:
data:
items: {}
maxItems: 0
type: array
errors:
items:
$ref: '#/components/schemas/ErrorJSON'
minItems: 1
type: array
request_id:
format: uuid
type: string
required:
- data
- errors
type: object
description: Bearer token expired or not correct.
'403':
content:
application/json:
schema:
properties:
data:
items: {}
maxItems: 0
type: array
errors:
items:
$ref: '#/components/schemas/ErrorJSON'
minItems: 1
type: array
request_id:
format: uuid
type: string
required:
- data
- errors
type: object
description: Partner does not have permissions for resource
'404':
content:
application/json:
schema:
properties:
data:
items: {}
maxItems: 0
type: array
errors:
items:
$ref: '#/components/schemas/ErrorJSON'
minItems: 1
type: array
request_id:
format: uuid
type: string
required:
- data
- errors
type: object
description: The consumer token was not found.
'408':
content:
application/json:
schema:
properties:
data:
items: {}
maxItems: 0
type: array
errors:
items:
$ref: '#/components/schemas/ErrorJSON'
minItems: 1
type: array
request_id:
format: uuid
type: string
required:
- data
- errors
type: object
description: Request timeout
'413':
content:
application/json:
schema:
properties:
data:
items: {}
maxItems: 0
type: array
errors:
items:
$ref: '#/components/schemas/ErrorJSON'
minItems: 1
type: array
request_id:
format: uuid
type: string
required:
- data
- errors
type: object
description: Request body is too large (4MiB limit)
'500':
content:
application/json:
schema:
properties:
data:
items: {}
maxItems: 0
type: array
errors:
items:
$ref: '#/components/schemas/ErrorJSON'
minItems: 1
type: array
request_id:
format: uuid
type: string
required:
- data
- errors
type: object
description: Internal server error
summary: Retrieve consumer history
tags:
- History
components:
schemas:
ValidationJSON:
properties:
field:
description: The field that failed validation.
type: string
message:
description: A human readable message describing the validation error.
type: string
value:
$ref: '#/components/schemas/FieldTypesJSON'
required:
- field
- message
type: object
HistoryParametersJSON:
properties:
end_ts:
format: date-time
type: string
finx_consumer_token:
type: string
start_ts:
format: date-time
type: string
required:
- finx_consumer_token
type: object
HistoryItemJSON:
properties:
created_ts:
format: date-time
type: string
entity_id:
type: string
entity_type:
type: string
required:
- entity_type
- entity_id
- created_ts
type: object
ErrorJSON:
properties:
key:
additionalProperties:
description: A map of id field to id identifying the object the error is about.
type: string
type: object
message:
description: A human readable message describing the error.
type: string
validations:
items:
$ref: '#/components/schemas/ValidationJSON'
type: array
required:
- message
title: Error
type: object
FieldTypesJSON:
anyOf:
- format: binary
title: Binary Field
type: string
- title: Boolean Field
type: boolean
- format: binary
maxLength: 1
minLength: 1
title: Byte Field
type: string
- title: Integer Field
type: integer
- format: int32
title: Integer32 Field
type: integer
- format: int64
title: Integer64 Field
type: integer
- format: double
title: Double Field
type: number
- format: uuid
title: Banyan ID
type: string
- format: uri
title: URI
type: string
- format: date-time
title: Timestamp
type: string
- format: decimal
minLength: 1
title: Amount
type: string
securitySchemes:
basic:
scheme: basic
type: http
bearerToken:
flows:
clientCredentials:
refreshUrl: /oauth/refresh
scopes: {}
tokenUrl: /oauth/token
type: oauth2
x-provenance:
method: searched
source: https://developers.banyan.com/reference
harvested: '2026-10-14'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://developers.banyan.com/reference/create-webhook-application.md
- https://developers.banyan.com/reference/create-webhook-endpoint.md
- https://developers.banyan.com/reference/delete-webhook-application.md
- https://developers.banyan.com/reference/delete-webhook-endpoint.md
- https://developers.banyan.com/reference/execute-tag-counter-query.md
- https://developers.banyan.com/reference/fetch-a-transaction.md
- https://developers.banyan.com/reference/get-webhook-endpoints-all.md
- https://developers.banyan.com/reference/get-webhook-event-types.md
- https://developers.banyan.com/reference/oauth-token.md
- https://developers.banyan.com/reference/receipt-search.md
- https://developers.banyan.com/reference/retrieve-a-campaign.md
- https://developers.banyan.com/reference/retrieve-a-receipt.md
- https://developers.banyan.com/reference/retrieve-all-campaigns.md
- https://developers.banyan.com/reference/retrieve-all-offers-under-a-campaign.md
- https://developers.banyan.com/reference/retrieve-an-offer-activation.md
- https://developers.banyan.com/reference/retrieve-an-offer.md
- https://developers.banyan.com/reference/retrieve-history.md
- https://developers.banyan.com/reference/retrieve-match-merchant-service-provider.md
- https://developers.banyan.com/reference/retrieve-match.md
- https://developers.banyan.com/reference/retrieve-offer-activations-for-offer-id.md
- https://developers.banyan.com/reference/retrieve-offer-redemption-history.md
- https://developers.banyan.com/reference/retrieve-offer-redemption.md
- https://developers.banyan.com/reference/retrieve-webhook-application.md
- https://developers.banyan.com/reference/retrieve-webhook-endpoint.md
- https://developers.banyan.com/reference/search-offer-activations.md
- https://developers.banyan.com/reference/search-offer.md
- https://developers.banyan.com/reference/submit-a-campaign.md
- https://developers.banyan.com/reference/submit-an-offer-activation.md
- https://developers.banyan.com/reference/submit-an-offer.md
- https://developers.banyan.com/reference/submit-hotel-receipts.md
- https://developers.banyan.com/reference/submit-one-or-more-transactions.md
- https://developers.banyan.com/reference/submit-retail-receipts.md
- https://developers.banyan.com/reference/update-a-campaign.md
- https://developers.banyan.com/reference/update-an-offer-activation.md
- https://developers.banyan.com/reference/update-an-offer.md
- https://developers.banyan.com/reference/update-webhook-endpoint.md
- https://developers.banyan.com/reference/version.md
merge:
pages: 37
deduped: 288
conflicts_kept_first: 0