Promises
Account Services
>
API Reference
>
v1
>
Promises
openapi: 3.0.3
info:
title: Account Services APIs - Promises
version: v1
description: APIs for Account Services
contact:
name: Digital Core @ Jack Henry and Associates, inc.
url: https://www.jackhenry.com/
email: DC-Operations@jackhenry.com
servers:
- url: https://{API_ENDPOINT}
variables:
API_ENDPOINT:
default: digital.garden-fi.com
security:
- bearerAuth: []
tags:
- name: Promises
description: APIs for Promise Functions
paths:
/a/api/acct-svcs/v1/{InstitutionUniversalId}/accounts/{AccountId}/promises:
get:
operationId: GetAccountPromises
tags:
- Promises
summary: API to get Account Promises by AccountId
description: Method to get Account Promises by AccountId
parameters:
- name: InstitutionUniversalId
in: path
description: A unique identifier to establish the identity of an Institution/Environment/Brand combination
required: true
schema:
type: string
- name: AccountId
in: path
description: A unique identifier which identifies the Account record for which the message is intended
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
holds:
type: array
items:
type: object
properties:
id:
description: A unique identifier which identifies the Promise record for which the message is intended
type: string
format: uuid
nullable: false
operationalPeriod:
type: string
format: date
description: This attribute defines the operational period for the request. (Formatted as RFC3339)
nullable: false
system:
type: string
description: This is the journal producer for the journal entry.
nullable: false
journal:
type: string
description: This is the journal type of the journal entry.
nullable: false
journalId:
description: This attribute defines the identifier of the JournalEntry record for which the message is intended.
type: string
format: uuid
nullable: false
lineItemId:
description: This attribute defines the identifier of the LineItem record for which the message is intended.
type: string
format: uuid
nullable: false
accountId:
description: This attribute defines the identifier of the Account.
type: string
format: uuid
nullable: false
amount:
type: object
properties:
value:
type: string
description: This defines the amount value.
nullable: false
currencyType:
type: string
description: The ISO 4217 three character currency type. USD is the default value.
nullable: true
default: usd
additionalProperties: false
description:
type: string
maxLength: 50
description: This attribute defines the description of why this promise was added to the account.
postedDate:
type: string
format: date
description: This attribute defines the UTC date time stamp that the promise was added to the account.
expirationDate:
type: string
format: date
description: This attribute defines the UTC datetime stamp that the promise expires and will be released.
paging:
type: object
properties:
nextOffset:
description: 'The next offset is the start position of the read pointer for pagination '
type: string
results:
description: The number of records sent for pagination
type: integer
total:
description: The total number of records requested for pagination
type: integer
'400':
description: The server could not process the request due to an invalid request.
content:
application/problem+json:
schema:
type: object
required:
- type
- title
- details
properties:
type:
description: A string path which uniquely classifies the domain of the error.
type: string
nullable: false
example: jackhenry/operation-failed
title:
description: A end-user readable string title of the error type.
nullable: false
type: string
details:
description: An array of end-user readable strings which provide additional details for the error message.
type: array
nullable: false
items:
type: string
fieldDetails:
type: array
description: An array of objects which provide additional details to specific fields in the request that caused the error.
items:
type: object
properties:
field:
type: string
description: The name or path of the field in the request that caused the error.
detail:
type: string
description: A end-user readable message describing the error related to the field.
data:
type: object
description: |
Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined.
nullable: true
examples:
badRequest:
summary: Bad request
value:
type: acct-svcs/bad-request
title: Rule violation
details:
- exampleField is invalid or malformed.
fieldDetails:
- field: exampleField
detail: Provide a valid value for this field.
'401':
description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
'403':
description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.
'404':
description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.
'500':
description: An unexpected internal server error occurred while processing the request.
content:
application/problem+json:
schema:
type: object
required:
- type
- title
- details
properties:
type:
description: A string path which uniquely classifies the domain of the error.
type: string
nullable: false
example: jackhenry/operation-failed
title:
description: A end-user readable string title of the error type.
nullable: false
type: string
details:
description: An array of end-user readable strings which provide additional details for the error message.
type: array
nullable: false
items:
type: string
data:
type: object
description: |
Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined.
nullable: true
examples:
internalServerError:
summary: Internal server error
value:
type: acct-svcs/internal-server-error
title: Unexpected error
details:
- An unexpected error occurred. Please contact your service provider and/or try again later.
/a/api/acct-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/accounts/{AccountId}/promises:
get:
operationId: GetAccountPromisesWithEnterpriseUserId
tags:
- Promises
summary: API to get Account Promises by AccountId
description: Method to get Account Promises by AccountId
parameters:
- name: InstitutionUniversalId
in: path
description: A unique identifier to establish the identity of an Institution/Environment/Brand combination
required: true
schema:
type: string
- in: path
name: EnterpriseUserId
required: true
schema:
type: string
format: uuid
description: The ID of the enterprise user.
- name: AccountId
in: path
description: A unique identifier which identifies the Account record for which the message is intended
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
holds:
type: array
items:
type: object
properties:
id:
description: A unique identifier which identifies the Promise record for which the message is intended
type: string
format: uuid
nullable: false
operationalPeriod:
type: string
format: date
description: This attribute defines the operational period for the request. (Formatted as RFC3339)
nullable: false
system:
type: string
description: This is the journal producer for the journal entry.
nullable: false
journal:
type: string
description: This is the journal type of the journal entry.
nullable: false
journalId:
description: This attribute defines the identifier of the JournalEntry record for which the message is intended.
type: string
format: uuid
nullable: false
lineItemId:
description: This attribute defines the identifier of the LineItem record for which the message is intended.
type: string
format: uuid
nullable: false
accountId:
description: This attribute defines the identifier of the Account.
type: string
format: uuid
nullable: false
amount:
type: object
properties:
value:
type: string
description: This defines the amount value.
nullable: false
currencyType:
type: string
description: The ISO 4217 three character currency type. USD is the default value.
nullable: true
default: usd
additionalProperties: false
description:
type: string
maxLength: 50
description: This attribute defines the description of why this promise was added to the account.
postedDate:
type: string
format: date
description: This attribute defines the UTC date time stamp that the promise was added to the account.
expirationDate:
type: string
format: date
description: This attribute defines the UTC datetime stamp that the promise expires and will be released.
paging:
type: object
properties:
nextOffset:
description: 'The next offset is the start position of the read pointer for pagination '
type: string
results:
description: The number of records sent for pagination
type: integer
total:
description: The total number of records requested for pagination
type: integer
'400':
description: The server could not process the request due to an invalid request.
content:
application/problem+json:
schema:
type: object
required:
- type
- title
- details
properties:
type:
description: A string path which uniquely classifies the domain of the error.
type: string
nullable: false
example: jackhenry/operation-failed
title:
description: A end-user readable string title of the error type.
nullable: false
type: string
details:
description: An array of end-user readable strings which provide additional details for the error message.
type: array
nullable: false
items:
type: string
fieldDetails:
type: array
description: An array of objects which provide additional details to specific fields in the request that caused the error.
items:
type: object
properties:
field:
type: string
description: The name or path of the field in the request that caused the error.
detail:
type: string
description: A end-user readable message describing the error related to the field.
data:
type: object
description: |
Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined.
nullable: true
examples:
badRequest:
summary: Bad request
value:
type: acct-svcs/bad-request
title: Rule violation
details:
- exampleField is invalid or malformed.
fieldDetails:
- field: exampleField
detail: Provide a valid value for this field.
'401':
description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
'403':
description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.
'404':
description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.
'500':
description: An unexpected internal server error occurred while processing the request.
content:
application/problem+json:
schema:
type: object
required:
- type
- title
- details
properties:
type:
description: A string path which uniquely classifies the domain of the error.
type: string
nullable: false
example: jackhenry/operation-failed
title:
description: A end-user readable string title of the error type.
nullable: false
type: string
details:
description: An array of end-user readable strings which provide additional details for the error message.
type: array
nullable: false
items:
type: string
data:
type: object
description: |
Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined.
nullable: true
examples:
internalServerError:
summary: Internal server error
value:
type: acct-svcs/internal-server-error
title: Unexpected error
details:
- An unexpected error occurred. Please contact your service provider and/or try again later.
/a/api/acct-svcs/v1/{InstitutionUniversalId}/promises/release:
post:
operationId: ReleasePromise
tags:
- Promises
summary: API to release a hold record on an account.
description: API to release a hold record on and account
parameters:
- name: InstitutionUniversalId
in: path
description: A unique identifier to establish the identity of an Institution/Environment/Brand combination
required: true
schema:
type: string
requestBody:
description: The hold record to be released.
content:
application/json:
schema:
type: object
required:
- system
- journal
- journalId
- lineItemId
- accountId
properties:
system:
type: string
description: This is the journal producer for the journal entry.
nullable: false
journal:
type: string
description: This is the journal type of the journal entry.
nullable: false
journalId:
description: This attribute defines the identifier of the JournalEntry record for which the message is intended.
type: string
format: uuid
nullable: false
lineItemId:
description: This attribute defines the identifier of the LineItem record for which the message is intended.
type: string
format: uuid
nullable: false
accountId:
description: This attribute defines the identifier of the Account.
type: string
format: uuid
nullable: false
responses:
'204':
description: Success - No Content
'400':
description: The server could not process the request due to an invalid request.
content:
application/problem+json:
schema:
type: object
required:
- type
- title
- details
properties:
type:
description: A string path which uniquely classifies the domain of the error.
type: string
nullable: false
example: jackhenry/operation-failed
title:
description: A end-user readable string title of the error type.
nullable: false
type: string
details:
description: An array of end-user readable strings which provide additional details for the error message.
type: array
nullable: false
items:
type: string
fieldDetails:
type: array
description: An array of objects which provide additional details to specific fields in the request that caused the error.
items:
type: object
properties:
field:
type: string
description: The name or path of the field in the request that caused the error.
detail:
type: string
description: A end-user readable message describing the error related to the field.
data:
type: object
description: |
Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined.
nullable: true
examples:
badRequest:
summary: Bad request
value:
type: acct-svcs/bad-request
title: Rule violation
details:
- exampleField is invalid or malformed.
fieldDetails:
- field: exampleField
detail: Provide a valid value for this field.
'401':
description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
'403':
description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.
'404':
description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.
'500':
description: An unexpected internal server error occurred while processing the request.
content:
application/problem+json:
schema:
type: object
required:
- type
- title
- details
properties:
type:
description: A string path which uniquely classifies the domain of the error.
type: string
nullable: false
example: jackhenry/operation-failed
title:
description: A end-user readable string title of the error type.
nullable: false
type: string
details:
description: An array of end-user readable strings which provide additional details for the error message.
type: array
nullable: false
items:
type: string
data:
type: object
description: |
Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined.
nullable: true
examples:
internalServerError:
summary: Internal server error
value:
type: acct-svcs/internal-server-error
title: Unexpected error
details:
- An unexpected error occurred. Please contact your service provider and/or try again later.
/a/api/acct-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/promises/release:
post:
operationId: ReleasePromiseWithEnterpriseUserId
tags:
- Promises
summary: API to release a hold record on an account.
description: API to release a hold record on and account
parameters:
- name: InstitutionUniversalId
in: path
description: A unique identifier to establish the identity of an Institution/Environment/Brand combination
required: true
schema:
type: string
- in: path
name: EnterpriseUserId
required: true
schema:
type: string
format: uuid
description: The ID of the enterprise user.
requestBody:
description: The hold record to be released.
content:
application/json:
schema:
type: object
required:
- system
- journal
- journalId
- lineItemId
- accountId
properties:
system:
type: string
description: This is the journal producer for the journal entry.
nullable: false
journal:
type: string
description: This is the journal type of the journal entry.
nullable: false
journalId:
description: This attribute defines the identifier of the JournalEntry record for which the message is intended.
type: string
format: uuid
nullable: false
lineItemId:
description: This attribute defines the identifier of the LineItem record for which the message is intended.
type: string
format: uuid
nullable: false
accountId:
description: This attribute defines the identifier of the Account.
type: string
format: uuid
nullable: false
responses:
'204':
description: Success - No Content
'400':
description: The server could not process the request due to an invalid request.
content:
application/problem+json:
schema:
type: object
required:
- type
- title
- details
properties:
type:
description: A string path which uniquely classifies the domain of the error.
type: string
nullable: false
example: jackhenry/operation-failed
title:
description: A end-user readable string title of the error type.
nullable: false
type: string
details:
description: An array of end-user readable strings which provide additional details for the error message.
type: array
nullable: false
items:
type: string
fieldDetails:
type: array
description: An array of objects which provide additional details to specific fields in the request that caused the error.
items:
type: object
properties:
field:
type: string
description: The name or path of the field in the request that caused the error.
detail:
type: string
description: A end-user readable message describing the error related to the field.
data:
type: object
description: |
Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined.
nullable: true
examples:
badRequest:
summary: Bad request
value:
type: acct-svcs/bad-request
title: Rule violation
details:
- exampleField is invalid or malformed.
fieldDetails:
- field: exampleField
detail: Provide a valid value for this field.
'401':
description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
'403':
description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.
'404':
description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.
'500':
description: An unexpected internal server error occurred while processing the request.
content:
application/problem+json:
schema:
type: object
required:
- type
- title
- details
properties:
type:
description: A string path which uniquely classifies the domain of the error.
type: string
nullable: false
example: jackhenry/operation-failed
title:
description: A end-user readable string title of the error type.
nullable: false
type: string
details:
description: An array of end-user readable strings which provide additional details for the error message.
type: array
nullable: false
items:
type: string
data:
type: object
description: |
Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined.
nullable: true
examples:
internalServerError:
summary: Internal server error
value:
type: acct-svcs/internal-server-error
title: Unexpected error
details:
- An unexpected error occurred. Please contact your service provider and/or try again later.
Did this page help you?
Why was this page helpful?
Why wasn't this page helpful?
Thank you for your feedback!
Last updated Wed Apr 29 2026