Stop Payments

openapi: 3.0.3 info: title: Account Services APIs - Stop Payments 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: http://jx-r.jhacorp.com description: Corporate Test Server security: [] components: securitySchemes: OpenIDEnterprise: type: openIdConnect openIdConnectUrl: https://login.jackhenry.com/.well-known/openid-configuration description: "Jack Henry Enterprise Authentication. \n\n ### Supported Flows\n \n #### 1. Authorization Code Flow\n * **Use Case:** Person-at-keyboard logins (FI or JH Employees).\n * **Security:** Supports/recommends PKCE (S256). Supports Pushed Authorization Requests (PAR), and DPoP token binding.\n * **Client Auth:** Supports/recommends `client_assertion` (Private Key JWT), also supports `client_secret`.\n \n #### 2. Client Credentials Flow\n * **Use Case:** System services and machine-to-machine integrations.\n * **Security:** Supports DPoP token binding.\n * **Client Auth:** **Requires** `client_assertion` (Private Key JWT).\n" tags: - name: Stop Payments description: APIs for Stop Payments to Accounts paths: /a/api/acct-svcs/v1/{InstitutionUniversalId}/stop-payments: post: operationId: CreateStopPayment security: - OpenIDEnterprise: - https://jackhenry.com/acct-svcs/stoppayments.write tags: - Stop Payments summary: API to add a stop payment record on the account description: Add a stop payment on an account with stop payment details for an institution 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: API to add a new stop payment record. content: application/json: schema: type: object required: - accountId - stopType - reason properties: accountId: description: This attribute defines the account id generated by the system for the account. type: string format: uuid amount: description: This optional attribute defines the transaction amount for the stop payment. Either amount or payee is required. nullable: true 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 effectiveDate: type: string format: date description: This attribute defines the effective date of the transaction in the stop payment request. nullable: true expirationDate: type: string format: date description: This attribute defines the date when the stop payment is no longer active; if left blank, expirationDate is effectiveDate plus Stop Payment settings months based on the stopType (OneTimeAchStopPaymentExpirationMonths for one-time, RecurringAchStopPaymentExpirationMonths for recurring). originatorId: type: string description: This attribute defines the originator identifier used to identify the originator of the transaction; for ACH, this is typically a 10-digit unique identifier. example: '1234567890' nullable: true originatorSecCode: type: string description: This attribute defines the type of ACH transaction a stop payment is being place on. This can include PPD (personal payment/debit), CCD (commercial cash concentration/disbursement), etc. example: PPD maxLength: 3 nullable: true payee: type: string description: This optional attribute defines the payee of the transaction for the stop payment. Either amount or payee is required. minLength: 1 maxLength: 25 nullable: true reason: type: string description: This attribute defines the reason for the stop payment request. maxLength: 50 stopType: type: string description: This enum attribute defines the type of transaction to stop. enum: - one_time - recurring additionalProperties: false responses: '201': description: Success - Created content: application/json: schema: type: object required: - id properties: id: type: string format: uuid description: This attribute defines the Id generated by the system for the stop payment. additionalProperties: false '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}/stop-payments: post: operationId: CreateStopPaymentWithEnterpriseUserId security: - OpenIDEnterprise: - https://jackhenry.com/acct-svcs/stoppayments.write tags: - Stop Payments summary: API to add a stop payment record on the account description: Add a stop payment on an account with stop payment details for an enterprise user in an institution 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: API to add a new stop payment record. content: application/json: schema: type: object required: - accountId - stopType - reason properties: accountId: description: This attribute defines the account id generated by the system for the account. type: string format: uuid amount: description: This optional attribute defines the transaction amount for the stop payment. Either amount or payee is required. nullable: true 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 effectiveDate: type: string format: date description: This attribute defines the effective date of the transaction in the stop payment request. nullable: true expirationDate: type: string format: date description: This attribute defines the date when the stop payment is no longer active; if left blank, expirationDate is effectiveDate plus Stop Payment settings months based on the stopType (OneTimeAchStopPaymentExpirationMonths for one-time, RecurringAchStopPaymentExpirationMonths for recurring). originatorId: type: string description: This attribute defines the originator identifier used to identify the originator of the transaction; for ACH, this is typically a 10-digit unique identifier. example: '1234567890' nullable: true originatorSecCode: type: string description: This attribute defines the type of ACH transaction a stop payment is being place on. This can include PPD (personal payment/debit), CCD (commercial cash concentration/disbursement), etc. example: PPD maxLength: 3 nullable: true payee: type: string description: This optional attribute defines the payee of the transaction for the stop payment. Either amount or payee is required. minLength: 1 maxLength: 25 nullable: true reason: type: string description: This attribute defines the reason for the stop payment request. maxLength: 50 stopType: type: string description: This enum attribute defines the type of transaction to stop. enum: - one_time - recurring additionalProperties: false responses: '201': description: Success - Created content: application/json: schema: type: object required: - id properties: id: type: string format: uuid description: This attribute defines the Id generated by the system for the stop payment. additionalProperties: false '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}/stop-payments/{Id}: get: operationId: GetStopPayment security: - OpenIDEnterprise: - https://jackhenry.com/acct-svcs/stoppayments.read tags: - Stop Payments summary: API to retrieve a stop payment record description: Retrieve stop payment information with stop payment identifier for an institution 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: Id in: path description: The Stop Payment Identifier. required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object required: - accountId - accountNumber - accountType properties: id: type: string format: uuid description: This attribute defines the Id generated by the system for the stop payment. accountId: description: This attribute defines the account id generated by the system for the account. type: string format: uuid accountNumber: description: This attribute defines the account number on which stop payment exists. type: string nullable: false maxLength: 34 accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false amount: nullable: true 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 effectiveDate: type: string format: date description: This attribute defines the effective date of the transaction in the stop payment request. nullable: true expirationDate: type: string format: date description: This attribute defines the date when the stop payment is no longer active. If the expiration date is left blank, a default expiration date is used. originatorId: type: string description: This attribute defines the originator identifier used to identify the originator of the transaction; for ACH, this is typically a 10-digit unique identifier. example: '1234567890' nullable: true originatorSecCode: type: string description: This attribute defines the type of ACH transaction a stop payment is being place on. example: PPD maxLength: 3 nullable: true payee: type: string description: This attribute defines the payee of the transaction. minLength: 1 maxLength: 25 nullable: true reason: type: string description: This attribute defines the reason for the stop payment request. maxLength: 50 stopType: type: string description: This enum attribute defines the type of transaction to stop. enum: - one_time - recurring stopTypeDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false additionalProperties: false '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. put: operationId: UpdateStopPayment security: - OpenIDEnterprise: - https://jackhenry.com/acct-svcs/stoppayments.write tags: - Stop Payments summary: API to update a stop payment record description: Update a stop payment record with stop payment identifier and details for an institution 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: Id in: path description: The Stop Payment Identifier. required: true schema: type: string format: uuid requestBody: description: The stop payment to be updated content: application/json: schema: type: object required: - stopType - reason properties: amount: description: This optional attribute defines the transaction amount for the stop payment. A nil value will clear the amount on the stop payment. An error will be returned if attempting to clear both the amount and payee. nullable: true 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 effectiveDate: type: string format: date description: This attribute defines the effective date of the transaction in the stop payment request. nullable: true expirationDate: type: string format: date description: This attribute defines the date when the stop payment is no longer active; if left blank, expirationDate is effectiveDate plus Stop Payment settings months based on the stopType (OneTimeAchStopPaymentExpirationMonths for one-time, RecurringAchStopPaymentExpirationMonths for recurring). originatorId: type: string description: This attribute defines the originator identifier used to identify the originator of the transaction; for ACH, this is typically a 10-digit unique identifier. example: '1234567890' nullable: true originatorSecCode: type: string description: This attribute defines the type of ACH transaction a stop payment is being place on. example: PPD maxLength: 3 nullable: true payee: type: string description: This optional attribute defines the payee of the transaction for the stop payment. A nil value will clear the payee on the stop payment. An error will be returned if attempting to clear both the amount and payee. minLength: 1 maxLength: 25 nullable: true reason: type: string description: This attribute defines the reason for the stop payment request. maxLength: 50 stopType: type: string description: This enum attribute defines the type of transaction to stop. enum: - one_time - recurring additionalProperties: 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. delete: operationId: DeleteStopPayment security: - OpenIDEnterprise: - https://jackhenry.com/acct-svcs/stoppayments.write tags: - Stop Payments summary: API to delete a stop payment record description: Delete a stop payment record with stop payment identifier for an institution 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: Id in: path description: The Stop Payment Identifier. required: true schema: type: string format: uuid 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}/stop-payments/{Id}: get: operationId: GetStopPaymentWithEnterpriseUserId security: - OpenIDEnterprise: - https://jackhenry.com/acct-svcs/stoppayments.read tags: - Stop Payments summary: API to retrieve a stop payment record description: Retrieve stop payment information with stop payment identifier for an institution 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: Id in: path description: The Stop Payment Identifier. required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object required: - accountId - accountNumber - accountType properties: id: type: string format: uuid description: This attribute defines the Id generated by the system for the stop payment. accountId: description: This attribute defines the account id generated by the system for the account. type: string format: uuid accountNumber: description: This attribute defines the account number on which stop payment exists. type: string nullable: false maxLength: 34 accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false amount: nullable: true 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 effectiveDate: type: string format: date description: This attribute defines the effective date of the transaction in the stop payment request. nullable: true expirationDate: type: string format: date description: This attribute defines the date when the stop payment is no longer active. If the expiration date is left blank, a default expiration date is used. originatorId: type: string description: This attribute defines the originator identifier used to identify the originator of the transaction; for ACH, this is typically a 10-digit unique identifier. example: '1234567890' nullable: true originatorSecCode: type: string description: This attribute defines the type of ACH transaction a stop payment is being place on. example: PPD maxLength: 3 nullable: true payee: type: string description: This attribute defines the payee of the transaction. minLength: 1 maxLength: 25 nullable: true reason: type: string description: This attribute defines the reason for the stop payment request. maxLength: 50 stopType: type: string description: This enum attribute defines the type of transaction to stop. enum: - one_time - recurring stopTypeDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false additionalProperties: false '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. put: operationId: UpdateStopPaymentWithEnterpriseUserId security: - OpenIDEnterprise: - https://jackhenry.com/acct-svcs/stoppayments.write tags: - Stop Payments summary: API to update a stop payment record description: Update a stop payment record with stop payment identifier and details for an institution 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: Id in: path description: The Stop Payment Identifier. required: true schema: type: string format: uuid requestBody: description: The stop payment to be updated content: application/json: schema: type: object required: - stopType - reason properties: amount: description: This optional attribute defines the transaction amount for the stop payment. A nil value will clear the amount on the stop payment. An error will be returned if attempting to clear both the amount and payee. nullable: true 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 effectiveDate: type: string format: date description: This attribute defines the effective date of the transaction in the stop payment request. nullable: true expirationDate: type: string format: date description: This attribute defines the date when the stop payment is no longer active; if left blank, expirationDate is effectiveDate plus Stop Payment settings months based on the stopType (OneTimeAchStopPaymentExpirationMonths for one-time, RecurringAchStopPaymentExpirationMonths for recurring). originatorId: type: string description: This attribute defines the originator identifier used to identify the originator of the transaction; for ACH, this is typically a 10-digit unique identifier. example: '1234567890' nullable: true originatorSecCode: type: string description: This attribute defines the type of ACH transaction a stop payment is being place on. example: PPD maxLength: 3 nullable: true payee: type: string description: This optional attribute defines the payee of the transaction for the stop payment. A nil value will clear the payee on the stop payment. An error will be returned if attempting to clear both the amount and payee. minLength: 1 maxLength: 25 nullable: true reason: type: string description: This attribute defines the reason for the stop payment request. maxLength: 50 stopType: type: string description: This enum attribute defines the type of transaction to stop. enum: - one_time - recurring additionalProperties: 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. delete: operationId: DeleteStopPaymentWithEnterpriseUserId security: - OpenIDEnterprise: - https://jackhenry.com/acct-svcs/stoppayments.write tags: - Stop Payments summary: API to delete a stop payment record description: Delete a stop payment record with stop payment identifier for an institution 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: Id in: path description: The Stop Payment Identifier. required: true schema: type: string format: uuid 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}/stop-payments/search: post: operationId: SearchStopPayment security: - OpenIDEnterprise: - https://jackhenry.com/acct-svcs/stoppayments.read tags: - Stop Payments summary: API to search for stop payments description: Search for stop payments with search parameters and optional pagination parameters for an institution parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - schema: type: string default: '0' name: Offset in: query required: false description: | When returning a list of results, the offset determines the number of records to skip before returning the result. If the offset is not provided, the server will return the first set of records. Example: `.../resource?Offset=50` - schema: type: string default: '10' name: Count in: query required: false description: | The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. Example: `.../resource?Count=100`' requestBody: description: Request parameters content: application/json: schema: type: object properties: stopType: type: string description: This enum attribute defines the type of transaction to stop. enum: - one_time - recurring accountId: description: This attribute defines the account id generated by the system for the account. type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object properties: stopPayments: type: array items: type: object required: - accountId - accountNumber - accountType properties: id: type: string format: uuid description: This attribute defines the Id generated by the system for the stop payment. accountId: description: This attribute defines the account id generated by the system for the account. type: string format: uuid accountNumber: description: This attribute defines the account number on which stop payment exists. type: string nullable: false maxLength: 34 accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false amount: nullable: true 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 effectiveDate: type: string format: date description: This attribute defines the effective date of the transaction in the stop payment request. nullable: true expirationDate: type: string format: date description: This attribute defines the date when the stop payment is no longer active. If the expiration date is left blank, a default expiration date is used. originatorId: type: string description: This attribute defines the originator identifier used to identify the originator of the transaction; for ACH, this is typically a 10-digit unique identifier. example: '1234567890' nullable: true originatorSecCode: type: string description: This attribute defines the type of ACH transaction a stop payment is being place on. example: PPD maxLength: 3 nullable: true payee: type: string description: This attribute defines the payee of the transaction. minLength: 1 maxLength: 25 nullable: true reason: type: string description: This attribute defines the reason for the stop payment request. maxLength: 50 stopType: type: string description: This enum attribute defines the type of transaction to stop. enum: - one_time - recurring stopTypeDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false additionalProperties: false 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}/stop-payments/search: post: operationId: SearchStopPaymentWithEnterpriseUserId security: - OpenIDEnterprise: - https://jackhenry.com/acct-svcs/stoppayments.read tags: - Stop Payments summary: API to search for stop payments description: Search for stop payments with search parameters and optional pagination parameters for an enterprise user in an institution 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. - schema: type: string default: '0' name: Offset in: query required: false description: | When returning a list of results, the offset determines the number of records to skip before returning the result. If the offset is not provided, the server will return the first set of records. Example: `.../resource?Offset=50` - schema: type: string default: '10' name: Count in: query required: false description: | The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. Example: `.../resource?Count=100`' requestBody: description: Request parameters content: application/json: schema: type: object properties: stopType: type: string description: This enum attribute defines the type of transaction to stop. enum: - one_time - recurring accountId: description: This attribute defines the account id generated by the system for the account. type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object properties: stopPayments: type: array items: type: object required: - accountId - accountNumber - accountType properties: id: type: string format: uuid description: This attribute defines the Id generated by the system for the stop payment. accountId: description: This attribute defines the account id generated by the system for the account. type: string format: uuid accountNumber: description: This attribute defines the account number on which stop payment exists. type: string nullable: false maxLength: 34 accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false amount: nullable: true 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 effectiveDate: type: string format: date description: This attribute defines the effective date of the transaction in the stop payment request. nullable: true expirationDate: type: string format: date description: This attribute defines the date when the stop payment is no longer active. If the expiration date is left blank, a default expiration date is used. originatorId: type: string description: This attribute defines the originator identifier used to identify the originator of the transaction; for ACH, this is typically a 10-digit unique identifier. example: '1234567890' nullable: true originatorSecCode: type: string description: This attribute defines the type of ACH transaction a stop payment is being place on. example: PPD maxLength: 3 nullable: true payee: type: string description: This attribute defines the payee of the transaction. minLength: 1 maxLength: 25 nullable: true reason: type: string description: This attribute defines the reason for the stop payment request. maxLength: 50 stopType: type: string description: This enum attribute defines the type of transaction to stop. enum: - one_time - recurring stopTypeDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false additionalProperties: false 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.

Please ignore this field