Consumer API
>
API Reference
>
v0
>
Transfers
>
Transfer Frequencies
openapi: 3.0.0
info:
title: Transfer Frequencies
version: "0.0"
servers:
- url: "https://{API_ENVIRONMENT}"
variables:
API_ENVIRONMENT:
default: digital.garden-fi.com
description: FI specific hostname
tags:
- name: Transfer Frequencies
paths:
"/a/consumer/api/v0/institutions/transfers/frequencies":
get:
tags:
- Transfer Frequencies
description: |
Returns the scheduled transfer frequencies available to the user.
security:
- OpenIDConsumer:
- openid
- OpenIDEnterprise: []
responses:
"200":
description: >-
The transfer frequencies available to the user. The array is empty
when the user's core provider does not offer any, or when the user
is not connected to a core.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/TransferFrequencyType"
examples:
allFrequencies:
summary: A core that supports all frequencies
value:
- Interval
- Once
- SemiMonthly
limitedFrequencies:
summary: A core that supports a subset of the frequencies
value:
- Interval
- Once
noFrequencies:
summary: A core that offers no frequencies, or a user who is not connected to a core
value: []
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: The Access Token does not identify a consumer user. The response has no body.
"500":
description: Internal Server Error
components:
securitySchemes:
OpenIDConsumer:
$ref: "https://jackhenry.dev/authentication-framework/security-schemes.swagger.yaml#/components/securitySchemes/OpenIDConsumer"
OpenIDEnterprise:
$ref: "https://jackhenry.dev/authentication-framework/security-schemes.swagger.yaml#/components/securitySchemes/OpenIDEnterprise"
schemas:
TransferFrequencyType:
type: string
description: |
The kind of recurrence a scheduled transfer can use.
- `Once` - The transfer happens a single time.
- `Interval` - The transfer repeats every given number of days, weeks, months, or years.
- `SemiMonthly` - The transfer repeats twice a month, on two given days of the month.
enum:
- Once
- Interval
- SemiMonthly
About Transfer Frequencies
A transfer frequency is a kind of recurrence for a scheduled transfer. Not every core provider supports every frequency, so use this endpoint to find out which ones to offer the user.
Frequency Values
Once - The transfer happens a single time.
Interval - The transfer repeats every given number of days, weeks, months, or years.
SemiMonthly - The transfer repeats twice a month, on two given days of the month.