API Error Types
Below is a list of the RFC 7807 application/problem+json error types that may be returned in 4xx error responses from Apiture Digital Banking APIs. See Error Responses for more details.
addendaDisallowedInImport
Error type url: https://api.apiture.com/errors/addendaDisallowedInImport/v1.0.0
Version: 1.0.0
Description: Addenda are not allowed for this type of batch.
Remediation: Addenda values found in the file have been skipped.
Error objects of this addendaDisallowedInImport type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
recordNumbers | array | An array of record (line) numbers containing invalid data. |
more | boolean | If |
ambiguousOriginatorAddress
Error type url: https://api.apiture.com/errors/ambiguousOriginatorAddress/v1.0.0
Version: 1.0.0
Description: A wire transfer originator may not have both a US and international address.
Remediation: Set the unneeded originator address to null when patching the wire transfer payment batch.
antiMalwareRequired
Error type url: https://api.apiture.com/errors/antiMalwareRequired/v1.0.0
Version: 1.0.0
Description: The financial institution requires the customer to have anti-malware software installed.
Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
appendDisallowedForCtxImport
Error type url: https://api.apiture.com/errors/appendDisallowedForCtxImport/v1.0.0
Version: 1.0.0
Description: When importing CTX payment instructions, only the replace option is allowed.
Remediation: Change the request strategy from append to replace.
badRequest
Error type url: https://api.apiture.com/errors/badRequest/v1.0.0
Version: 1.0.0
Description: The request body and/or parameters was not well-formed.
Remediation: Correct any syntax or schema errors in the request body or parameters.
balancedNachaAchFileNotAllowed
Error type url: https://api.apiture.com/errors/balancedNachaAchFileNotAllowed/v1.0.0
Version: 1.0.0
Description: The user attempted to upload a balanced NACHA file but is only allowed to upload unbalanced files.
Remediation: Upload only unbalanced NACHA files.
cannotDeleteProcessedTransfers
Error type url: https://api.apiture.com/errors/cannotDeleteProcessedTransfers/v1.0.0
Version: 1.0.0
Description: The delete operation is only allowed for transfers which have not begun processing.
Remediation: Select a pending or scheduled transfer.
cannotTransferFrom
Error type url: https://api.apiture.com/errors/cannotTransferFrom/v1.0.0
Version: 1.0.0
Description: The customer does not have transferFrom entitlement on the source account.
Remediation: Choose a source account that allows transfers from it.
cannotTransferTo
Error type url: https://api.apiture.com/errors/cannotTransferTo/v1.0.0
Version: 1.0.0
Description: The customer does not have transferTo entitlement on the target account.
Remediation: Choose a target account that allows transfers to it.
cdMaturityTransferAccountAndProductAreMutuallyExclusive
Error type url: https://api.apiture.com/errors/cdMaturityTransferAccountAndProductAreMutuallyExclusive/v1.0.0
Version: 1.0.0
Description: CD maturity may only specify a transfer account or a transfer product, not both
Remediation: Set only one of a transfer account or a transfer product
challengeBlocked
Error type url: https://api.apiture.com/errors/challengeBlocked/v1.0.0
Version: 1.0.0
Description: The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication.
Remediation: Have the user end their login session and login again.
challengeRequired
Error type url: https://api.apiture.com/errors/challengeRequired/v1.0.0
Version: 1.0.0
Description: The operation requires the customer to complete an identity challenge.
Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call.
conflict
Error type url: https://api.apiture.com/errors/conflict/v1.0.0
Version: 1.0.0
Description: The request could not be completed due to a conflict with the current state of the target resource.
Remediation: Try another operation that is allowed.
customerDisabled
Error type url: https://api.apiture.com/errors/customerDisabled/v1.0.0
Version: 1.0.0
Description: The customer is disabled.
Remediation: Have the customer contact the financial institution for support.
duplicateNachaFile
Error type url: https://api.apiture.com/errors/duplicateNachaFile/v1.0.0
Version: 1.0.0
Description: There is already another NACHA pass-through file with the same content.
Remediation: Do not upload previously uploaded NACHA files, or have the bank customer confirm the duplicate is intentional and retry with ?allowDuplicates=true.
duplicateOverdraftAccounts
Error type url: https://api.apiture.com/errors/duplicateOverdraftAccounts/v1.0.0
Version: 1.0.0
Description: The items in the request list the same account id more than once.
Remediation: Use eligible unique accounts only.
duplicatePaymentInstruction
Error type url: https://api.apiture.com/errors/duplicatePaymentInstruction/v1.0.0
Version: 1.0.0
Description: There is already another payment instruction that matches the request.
Remediation: Enter unique data for this payment instruction.
duplicatePaymentMethod
Error type url: https://api.apiture.com/errors/duplicatePaymentMethod/v1.0.0
Version: 1.0.0
Description: There is already another payment method that matches the request.
Remediation: Enter unique data for this payment method.
duplicateTemplateName
Error type url: https://api.apiture.com/errors/duplicateTemplateName/v1.0.0
Version: 1.0.0
Description: The given template name already exists.
Remediation: Choose a different name for the template.
emptyFileForImport
Error type url: https://api.apiture.com/errors/emptyFileForImport/v1.0.0
Version: 1.0.0
Description: The provided values file is empty.
Remediation: Supply the values for import in Base64 encoding of a well-formed values file.
exceedsEffectiveDateLimits
Error type url: https://api.apiture.com/errors/exceedsEffectiveDateLimits/v1.0.0
Version: 1.0.0
Description: The time span between the earliest and latest effective dates exceeds the limit.
Remediation: Submit a NACHA file whose effective date range is within the financial institution’s limit.
exceedsLimits
Error type url: https://api.apiture.com/errors/exceedsLimits/v1.0.0
Version: 1.0.0
Description: The payment total exceeds the allowed limits.
Remediation: Check for and remove excessive payments, or split the payment batch into multiple batches.
exceedsRisks
Error type url: https://api.apiture.com/errors/exceedsRisks/v1.0.0
Version: 1.0.0
Description: The payment batch exceeds the risk limits.
Remediation: Address the risk limit.
externalToExternalTransferNotAllowed
Error type url: https://api.apiture.com/errors/externalToExternalTransferNotAllowed/v1.0.0
Version: 1.0.0
Description: Transfers from an external account to another external is not allowed.
Remediation: At least one of the source or target accounts must be an internal account held at the financial institution.
extraColumnsIgnoredInImport
Error type url: https://api.apiture.com/errors/extraColumnsIgnoredInImport/v1.0.0
Version: 1.0.0
Description: One or more records had extra columns which were ignored.
Remediation: Remove extra columns before importing to prevent this warning.
Error objects of this extraColumnsIgnoredInImport type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
recordNumbers | array | An array of record (line) numbers containing extra columns. |
more | boolean | If |
forbidden
Error type url: https://api.apiture.com/errors/forbidden/v1.0.0
Version: 1.0.0
Description: The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access.
Remediation: Check the user’s permissions and entitlements before attempting the operation.
gatewayTimeout
Error type url: https://api.apiture.com/errors/gatewayTimeout/v1.0.0
Version: 1.0.0
Description: The server did not receive a timely response from an upstream server it needed to access in order to complete the request.
Remediation: Wait a few minutes and try again, or gracefully fail the client request.
immutablePaymentBatchState
Error type url: https://api.apiture.com/errors/immutablePaymentBatchState/v1.0.0
Version: 1.0.0
Description: The payment batch is not mutable.
Remediation: To update a scheduled batch, unlock the batch via the unlockPaymentBatch operation.
insufficientFundsForTransfer
Error type url: https://api.apiture.com/errors/insufficientFundsForTransfer/v1.0.0
Version: 1.0.0
Description: The source account has insufficient funds.
Remediation: Reduce the transfer amount to less than the available balance.
invalidAccountId
Error type url: https://api.apiture.com/errors/invalidAccountId/v1.0.0
Version: 1.0.0
Description: The named accountId does not exist or the user is not entitled to access the account.
Remediation: Pass the id of an existing account the caller has access to.
invalidAccountIds
Error type url: https://api.apiture.com/errors/invalidAccountIds/v1.0.0
Version: 1.0.0
Description: One or more account IDs are invalid and do not correspond to accounts.
Remediation: Remove the invalid account IDs from the request and try again.
Error objects of this invalidAccountIds type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
accountIds | array | The list of invalid account IDs. |
invalidAccountNumberInImport
Error type url: https://api.apiture.com/errors/invalidAccountNumberInImport/v1.0.0
Version: 1.0.0
Description: One or more ACH account numbers are invalid.
Remediation: Correct the invalid records and retry the operation.
Error objects of this invalidAccountNumberInImport type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
recordNumbers | array | An array of record (line) numbers containing invalid data. |
more | boolean | If |
invalidAccountTypeInImport
Error type url: https://api.apiture.com/errors/invalidAccountTypeInImport/v1.0.0
Version: 1.0.0
Description: One or more ACH account type values are invalid
Remediation: Correct the invalid records and retry the operation. Valid values are checking, check, D, DDA for checking accounts, loan, L, LN, LON, for loan accounts, and savings, S, SAV, SSA for savings accounts.
Error objects of this invalidAccountTypeInImport type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
recordNumbers | array | An array of record (line) numbers containing invalid data. |
more | boolean | If |
invalidAchInstructionAccountNumber
Error type url: https://api.apiture.com/errors/invalidAchInstructionAccountNumber/v1.0.0
Version: 1.0.0
Description: The ach.accountNumber is not a valid bank account number.
Remediation: Enter a valid 9 digit account number, fully padded.
invalidAchInstructionRoutingNumber
Error type url: https://api.apiture.com/errors/invalidAchInstructionRoutingNumber/v1.0.0
Version: 1.0.0
Description: The ach.routingNumber is not a valid bank routing number.
Remediation: Enter a valid 9 digit financial institution routing number.
invalidAchPaymentBatchDetails
Error type url: https://api.apiture.com/errors/invalidAchPaymentBatchDetails/v1.0.0
Version: 1.0.0
Description: The batch type was ach but the request did not include the ach property.
Remediation: Include a valid ach object in the new payment batch request.
invalidApprover
Error type url: https://api.apiture.com/errors/invalidApprover/v1.0.0
Version: 1.0.0
Description: The requested approver is not eligible for approving this payment batch.
Remediation: Pass only eligible approvers from the listPaymentBatchEligibleApprovers operation.
Error objects of this invalidApprover type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
id | string | The ineligible customer ID. |
name | string | The ineligible customer name. |
identification | string | The ineligible customer's identification string. |
invalidCdMaturityTransferAccount
Error type url: https://api.apiture.com/errors/invalidCdMaturityTransferAccount/v1.0.0
Version: 1.0.0
Description: The selected transfer account ID does not match an existing account.
Remediation: Select a deposit account that is eligible for debit transfers for the current user.
invalidChallengeFactor
Error type url: https://api.apiture.com/errors/invalidChallengeFactor/v1.0.0
Version: 1.0.0
Description: The factor in the request does not match available factors.
Remediation: Use a factor that corresponds to the challengeId from the corresponding challenge.
invalidChallengeFactorState
Error type url: https://api.apiture.com/errors/invalidChallengeFactorState/v1.0.0
Version: 1.0.0
Description: The selected challenge factor is not active.
Remediation: Start the challenge factor to set it as active before verifying a user response.
invalidChallengeId
Error type url: https://api.apiture.com/errors/invalidChallengeId/v1.0.0
Version: 1.0.0
Description: The provided challengeId is invalid, expired, already claimed, or does not match the factor or context.
Remediation: Provide the corresponding operationId, factor and id from the challenge.
invalidChallengeOperationId
Error type url: https://api.apiture.com/errors/invalidChallengeOperationId/v1.0.0
Version: 1.0.0
Description: The operationId is invalid.
Remediation: Use the operationId from the corresponding challenge.
invalidCompanyId
Error type url: https://api.apiture.com/errors/invalidCompanyId/v1.0.0
Version: 1.0.0
Description: Company ID contains invalid characters or is blank.
Remediation: Remove invalid characters from company ID.
invalidCompanyName
Error type url: https://api.apiture.com/errors/invalidCompanyName/v1.0.0
Version: 1.0.0
Description: Company name contains invalid characters or is blank.
Remediation: Remove invalid characters from company name.
invalidDirectionForWireTransfer
Error type url: https://api.apiture.com/errors/invalidDirectionForWireTransfer/v1.0.0
Version: 1.0.0
Description: If a payment batch is a wire transfer, the direction must be credit.
Remediation: Set the direction to credit in the request.
invalidHoldValueInImport
Error type url: https://api.apiture.com/errors/invalidHoldValueInImport/v1.0.0
Version: 1.0.0
Description: One or more Hold column values are invalid.
Remediation: Correct the invalid records and retry the operation.
Error objects of this invalidHoldValueInImport type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
recordNumbers | array | An array of record (line) numbers containing invalid data. |
more | boolean | If |
invalidIdentityChallengeHeader
Error type url: https://api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
Version: 1.0.0
Description: The additional on-time Challenge header in this request is expired, already used, or otherwise invalid.
Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.
invalidImportFormat
Error type url: https://api.apiture.com/errors/invalidImportFormat/v1.0.0
Version: 1.0.0
Description: The format of the content for importing values is invalid.
Remediation: Supply the Base64 encoding of a well-formed comma-separated values file or tab-separated values file.
invalidInstitutionLocator
Error type url: https://api.apiture.com/errors/invalidInstitutionLocator/v1.0.0
Version: 1.0.0
Description: The locator value for the financial institution is invalid.
Remediation: Use a valid financial institution locator.
Error objects of this invalidInstitutionLocator type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
institutionName | string | The name of the financial institution. |
locatorType | undefined | The type of the locator. |
locator | string | The American Bankers Association routing number, SWIFT Business Identifier Code (BIC) code, or IBAN account number of the institution. |
invalidInstructionForBatch
Error type url: https://api.apiture.com/errors/invalidInstructionForBatch/v1.0.0
Version: 1.0.0
Description: The payment instruction type does not match the payment batch type.
Remediation: Add only matching instructions to a patch (i.e. ach instructions to an ach batch, wireTransfer instructions to a wireTransfer batch).
invalidInstructions
Error type url: https://api.apiture.com/errors/invalidInstructions/v1.0.0
Version: 1.0.0
Description: One or more payment instructions have problems.
Remediation: Address the problems in the individual payment instructions.
invalidLocator
Error type url: https://api.apiture.com/errors/invalidLocator/v1.0.0
Version: 1.0.0
Description: The locator value is invalid for the given locatorType.
Remediation: Pass a valid ABA routing number, IBAN number, or SWIFT/BIC code, as per the given locatorType.
invalidLocatorTypeForInstitution
Error type url: https://api.apiture.com/errors/invalidLocatorTypeForInstitution/v1.0.0
Version: 1.0.0
Description: The provided locatorType is invalid for the institution.
Remediation: Pass a valid locator type.
Error objects of this invalidLocatorTypeForInstitution type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
locatorTypes | array | Valid locator types for the institution. |
invalidNachaAchFile
Error type url: https://api.apiture.com/errors/invalidNachaAchFile/v1.0.0
Version: 1.0.0
Description: The supplied NACHA ACH file contents is invalid.
Remediation: Send a properly formatted and Base64-encoded NACHA ACH file.
invalidOccurredAtRange
Error type url: https://api.apiture.com/errors/invalidOccurredAtRange/v1.0.0
Version: 1.0.0
Description: The ocurredAt parameter is not a valid range of dates/time values.
Remediation: Use valid YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.ssZ values and proper delimiters.
invalidPaymentBatchForCopy
Error type url: https://api.apiture.com/errors/invalidPaymentBatchForCopy/v1.0.0
Version: 1.0.0
Description: The payment batch referenced by the paymentBatchId is not eligible for copying, or the customer does not have the copy permission.
Remediation: Pass an eligible payment batch ID.
invalidPaymentBatchIds
Error type url: https://api.apiture.com/errors/invalidPaymentBatchIds/v1.0.0
Version: 1.0.0
Description: One or more payment batch IDs are invalid or do not refer to an existing payment batch.
Remediation: Specify the ID of a payment batch for the operation that the user requested.
Error objects of this invalidPaymentBatchIds type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
invalidPaymentBatchIds | array | The list of invalid payment batch IDs |
invalidPaymentContactIds
Error type url: https://api.apiture.com/errors/invalidPaymentContactIds/v1.0.0
Version: 1.0.0
Description: One or more payment contact IDs are invalid or do not refer to an existing payment contact.
Remediation: Specify the ID of an existing contact for which the user has read access.
Error objects of this invalidPaymentContactIds type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
invalidPaymentContactIds | array | The list of invalid payment contact IDs |
invalidPaymentContactImportRow
Error type url: https://api.apiture.com/errors/invalidPaymentContactImportRow/v1.0.0
Version: 1.0.0
Description: One or more values are invalid for the import row.
Remediation: Supply valid values for the specified columns.
Error objects of this invalidPaymentContactImportRow type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
lineNumber | integer | The line number containing invalid data. |
columnName | string | The name of the column containing invalid data. |
invalidPaymentDirectionInImport
Error type url: https://api.apiture.com/errors/invalidPaymentDirectionInImport/v1.0.0
Version: 1.0.0
Description: Payment direction for items must match the payment batch direction.
Remediation: Invalid items found in the file have been skipped.
Error objects of this invalidPaymentDirectionInImport type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
recordNumbers | array | An array of record (line) numbers containing invalid data. |
more | boolean | If |
invalidPaymentInstructionIds
Error type url: https://api.apiture.com/errors/invalidPaymentInstructionIds/v1.0.0
Version: 1.0.0
Description: One or more payment instructions IDs are invalid or do not refer to an existing payment instruction in the payment batch.
Remediation: Specify the ID of a payment instruction for the operation that the user requested.
Error objects of this invalidPaymentInstructionIds type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
invalidPaymentInstructionIds | array | The list of invalid payment instruction IDs. |
invalidPaymentMethod
Error type url: https://api.apiture.com/errors/invalidPaymentMethod/v1.0.0
Version: 1.0.0
Description: The payment method contains invalid data.
Remediation: Supply the correct value for the payment method field.
Error objects of this invalidPaymentMethod type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
index | integer | The index of the payment method with invalid data. |
fieldName | string | The name of the field containing invalid data. |
invalidRestrictionDateRange
Error type url: https://api.apiture.com/errors/invalidRestrictionDateRange/v1.0.0
Version: 1.0.0
Description: The startOn date should be no earlier than a week before the start of the current month, and the endOn date must fall after the startOn date
Remediation: Pass valid values for startOn and endOn
invalidRolloverProduct
Error type url: https://api.apiture.com/errors/invalidRolloverProduct/v1.0.0
Version: 1.0.0
Description: The selected rollover product is not eligible for CD rollover.
Remediation: Select an active CD rollover product that meets the balance and other requirements.
invalidRoutingNumberInImport
Error type url: https://api.apiture.com/errors/invalidRoutingNumberInImport/v1.0.0
Version: 1.0.0
Description: One or more ACH routing and transit numbers are invalid.
Remediation: Correct the invalid records and retry the operation
Error objects of this invalidRoutingNumberInImport type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
recordNumbers | array | An array of record (line) numbers containing invalid data. |
more | boolean | If |
invalidScheduledDate
Error type url: https://api.apiture.com/errors/invalidScheduledDate/v1.0.0
Version: 1.0.0
Description: The payment scheduled start date for this payment batch is invalid.
Remediation: Set a different scheduled date.
Error objects of this invalidScheduledDate type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
earliestScheduledDate | undefined | The earliest available scheduled date, based on financial institution banking holidays and customer risk, in |
minimumApprovalDays | integer | The minimum number of business days required for approving the payment batch. |
cutoffDate | undefined | The next available cutoff date for payment batch processing in |
invalidSettlementAccount
Error type url: https://api.apiture.com/errors/invalidSettlementAccount/v1.0.0
Version: 1.0.0
Description: The chosen settlement account does not exist, is not accessible, or is not entitled for the chosen money movement direction.
Remediation: Choose an available account that supports debit or credits that match the batch’s money movement direction.
invalidSourceAccountId
Error type url: https://api.apiture.com/errors/invalidSourceAccountId/v1.0.0
Version: 1.0.0
Description: The named sourceAccountId does not exist or the user is not entitled to access the account.
Remediation: Pass the id of an existing account the caller has access to.
invalidStateForAddApprovers
Error type url: https://api.apiture.com/errors/invalidStateForAddApprovers/v1.0.0
Version: 1.0.0
Description: The payment batch cannot have approvers added when in the current state.
Remediation: The payment batch state must be pendingApprovals or remove existing approvals.
Error objects of this invalidStateForAddApprovers type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
invalidPaymentBatchIds | array | The list of payment batch IDs which are in an invalid state. |
invalidStateForApprove
Error type url: https://api.apiture.com/errors/invalidStateForApprove/v1.0.0
Version: 1.0.0
Description: The payment batch cannot be approved when in the current state.
Remediation: The payment batch state must be one of pendingApprovals or rejected and have no problems.
Error objects of this invalidStateForApprove type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
invalidPaymentBatchIds | array | The list of payment batch IDs which are in an invalid state. |
invalidStateForDelete
Error type url: https://api.apiture.com/errors/invalidStateForDelete/v1.0.0
Version: 1.0.0
Description: The payment batch cannot be deleted when in the current state.
Remediation: The payment batch state must be one of pending, pendingApprovals or rejected.
Error objects of this invalidStateForDelete type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
invalidPaymentBatchIds | array | The list of payment batch IDs which are in an invalid state. |
invalidStateForHold
Error type url: https://api.apiture.com/errors/invalidStateForHold/v1.0.0
Version: 1.0.0
Description: The payment instruction hold value cannot be changed when the payment batch is in the current state.
Remediation: The payment batch containing the payment instruction must be in an editable state.
invalidStateForPaymentInstructionDelete
Error type url: https://api.apiture.com/errors/invalidStateForPaymentInstructionDelete/v1.0.0
Version: 1.0.0
Description: The payment instruction cannot be deleted when the payment batch is in the current state
Remediation: The payment batch containing the payment instruction must be in an editable state.
invalidStateForReject
Error type url: https://api.apiture.com/errors/invalidStateForReject/v1.0.0
Version: 1.0.0
Description: The payment batch cannot be rejected when in the current state.
Remediation: The payment batch state must be pendingApprovals.
Error objects of this invalidStateForReject type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
invalidPaymentBatchIds | array | The list of payment batch IDs which are in an invalid state. |
invalidStateForReverse
Error type url: https://api.apiture.com/errors/invalidStateForReverse/v1.0.0
Version: 1.0.0
Description: The payment batch cannot be reversed when in the current state.
Remediation: The payment batch state must be processing.
Error objects of this invalidStateForReverse type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
invalidPaymentBatchIds | array | The list of payment batch IDs which are in an invalid state. |
invalidStateForSubmit
Error type url: https://api.apiture.com/errors/invalidStateForSubmit/v1.0.0
Version: 1.0.0
Description: The submit operation is not allowed if the payment batch allows.submit is true.
Remediation: Resolve any problems in the batch and/or its payment instructions so that the payment batch allows.submit is true.
invalidTabSeparatedValues
Error type url: https://api.apiture.com/errors/invalidTabSeparatedValues/v1.0.0
Version: 1.0.0
Description: The tab-separated values file is not well formed and parsing failed.
Remediation: Supply the Base64 encoding of a well-formed tab-separated values file.
invalidTargetAccountId
Error type url: https://api.apiture.com/errors/invalidTargetAccountId/v1.0.0
Version: 1.0.0
Description: The named targetAccountId does not exist or the user is not entitled to access the account.
Remediation: Pass the id of an existing account the caller has access to.
invalidTransferSchedule
Error type url: https://api.apiture.com/errors/invalidTransferSchedule/v1.0.0
Version: 1.0.0
Description: The transfer schedule is invalid.
Remediation: Choose a date that is not in the past or past the cutoff time.
invalidWatermark
Error type url: https://api.apiture.com/errors/invalidWatermark/v1.0.0
Version: 1.0.0
Description: The watermark parameter is invalid.
Remediation: Use only watermark values returned from a previous call’s response.
invalidWireTransferTemplateIds
Error type url: https://api.apiture.com/errors/invalidWireTransferTemplateIds/v1.0.0
Version: 1.0.0
Description: One or more wire transfer template IDs are invalid or do not refer to an existing wire transfer template.
Remediation: Specify the ID of an existing template for which the user has access.
Error objects of this invalidWireTransferTemplateIds type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
invalidWireTransferTemplateIds | array | The list of invalid wire transfer template IDs |
missingPaymentInstructionAmount
Error type url: https://api.apiture.com/errors/missingPaymentInstructionAmount/v1.0.0
Version: 1.0.0
Description: The payment amount for this instruction is missing.
Remediation: Set a valid, non-zero payment amount.
modificationForbidden
Error type url: https://api.apiture.com/errors/modificationForbidden/v1.0.0
Version: 1.0.0
Description: The customer is properly authenticated but not authorized to create, modify, or delete resources.
Remediation: Avoid modification operation for customers with read-only authorization.
mustRemovePaymentBatchApprovals
Error type url: https://api.apiture.com/errors/mustRemovePaymentBatchApprovals/v1.0.0
Version: 1.0.0
Description: The payment batch has at least one approval.
Remediation: Remove the existing approvals.
Error objects of this mustRemovePaymentBatchApprovals type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
invalidPaymentBatchIds | array | The list of invalid payment batch IDs. |
noIdentityChallengeFactors
Error type url: https://api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
Version: 1.0.0
Description: This operation requires an identity challenge, but the user does not have the necessary registered authentication factors.
Remediation: Have the user register one or more challenge security code delivery factors.
noSuchAccount
Error type url: https://api.apiture.com/errors/noSuchAccount/v1.0.0
Version: 1.0.0
Description: There is no such account at the given accountId
Remediation: Use the accountId of an account the user is entitled to view.
noSuchCdMaturityTransferAccount
Error type url: https://api.apiture.com/errors/noSuchCdMaturityTransferAccount/v1.0.0
Version: 1.0.0
Description: The selected transfer account ID does not match an existing account.
Remediation: Select a deposit account that is eligible for debit transfers for the current user.
noSuchCdMaturityTransferProduct
Error type url: https://api.apiture.com/errors/noSuchCdMaturityTransferProduct/v1.0.0
Version: 1.0.0
Description: The selected transfer product ID does not match an existing product.
Remediation: Select a deposit product that is eligible for new account creation and funding transfer.
noSuchCompanyId
Error type url: https://api.apiture.com/errors/noSuchCompanyId/v1.0.0
Version: 1.0.0
Description: There is no such company for the provided customer ID query parameter.
Remediation: Supply the ID of a company the customer is entitled to manage.
noSuchConfidentialCustomer
Error type url: https://api.apiture.com/errors/noSuchConfidentialCustomer/v1.0.0
Version: 1.0.0
Description: There is no such customer for the given confidentialCustomers[i].id.
Remediation: Pass a valid customer ID.
noSuchContact
Error type url: https://api.apiture.com/errors/noSuchContact/v1.0.0
Version: 1.0.0
Description: There is no such contact resource for the given contactId.
Remediation: Pass a valid contact ID or omit the contactId from the request.
noSuchInstruction
Error type url: https://api.apiture.com/errors/noSuchInstruction/v1.0.0
Version: 1.0.0
Description: There is no such payment instruction for the given paymentInstructionId.
Remediation: Pass a valid payment instruction ID.
noSuchPaymentBatch
Error type url: https://api.apiture.com/errors/noSuchPaymentBatch/v1.0.0
Version: 1.0.0
Description: There is no such payment batch for the given paymentBatchId.
Remediation: Pass a valid payment batch ID.
noSuchPaymentBatchCompany
Error type url: https://api.apiture.com/errors/noSuchPaymentBatchCompany/v1.0.0
Version: 1.0.0
Description: No such company was found or accessible for the given company id and type.
Remediation: Supply the correct company id and type that the user is entitled to use for payment batches.
noSuchPaymentBatchCustomerId
Error type url: https://api.apiture.com/errors/noSuchPaymentBatchCustomerId/v1.0.0
Version: 1.0.0
Description: No such customer was found or accessible for the given customerId.
Remediation: Supply the resource ID (not username/access ID) of a valid customer in the customerId property.
noSuchPaymentInstruction
Error type url: https://api.apiture.com/errors/noSuchPaymentInstruction/v1.0.0
Version: 1.0.0
Description: There is no such payment instruction on this batch for one or more of the given paymentInstructionIds,
Remediation: Pass valid payment instruction IDs from this batch’s list of instructions.
Error objects of this noSuchPaymentInstruction type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
paymentInstructionIds | array | The invalid payment instruction IDs. |
noSuchPaymentMethod
Error type url: https://api.apiture.com/errors/noSuchPaymentMethod/v1.0.0
Version: 1.0.0
Description: There is no such contact resource for the given paymentMethodId.
Remediation: Pass a valid payment method ID or omit the paymentMethodId from the request.
noSuchRolloverProduct
Error type url: https://api.apiture.com/errors/noSuchRolloverProduct/v1.0.0
Version: 1.0.0
Description: The rollover product does not exist
Remediation: Select an active CD rollover product that meets the balance and other requirements.
noSuchTransaction
Error type url: https://api.apiture.com/errors/noSuchTransaction/v1.0.0
Version: 1.0.0
Description: There is no such transaction at the given transactionId
Remediation: Use the transactionId of a transaction from the list of transaction items.
noTransactionImages
Error type url: https://api.apiture.com/errors/noTransactionImages/v1.0.0
Version: 1.0.0
Description: There are no transaction images associated with this transaction.
Remediation: Invoke this operation only when a transaction has images.
nonAchPaymentBatch
Error type url: https://api.apiture.com/errors/nonAchPaymentBatch/v1.0.0
Version: 1.0.0
Description: The selected payment batch is not a type: ach batch.
Remediation: Select only ACH batches when exporting payment batches.
Error objects of this nonAchPaymentBatch type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
invalidPaymentBatchIds | array | The list of invalid payment batch IDs. |
nonPositiveAmount
Error type url: https://api.apiture.com/errors/nonPositiveAmount/v1.0.0
Version: 1.0.0
Description: The transfer amount may not be 0.00.
Remediation: Set the transfer amount to a positive number.
notFound
Error type url: https://api.apiture.com/errors/notFound/v1.0.0
Version: 1.0.0
Description: The resource at the requested URL does not exist.
Remediation: Use the URL of an existing resource.
overdraftAccountNotEligible
Error type url: https://api.apiture.com/errors/overdraftAccountNotEligible/v1.0.0
Version: 1.0.0
Description: The named account is not eligible as an overdraft protection account.
Remediation: Use an account from the listEligibleOverdraftAccounts response for the protected account.
pastCutoffTime
Error type url: https://api.apiture.com/errors/pastCutoffTime/v1.0.0
Version: 1.0.0
Description: The cutoff time for payment processing has passed.
Remediation: Update the scheduled date for a future date.
paymentInstructionsNotAvailable
Error type url: https://api.apiture.com/errors/paymentInstructionsNotAvailable/v1.0.0
Version: 1.0.0
Description: Payment instructions are not available for NACHA pass-through payments.
Remediation: Do not access payment instructions for NACHA pass-through payments.
propertiesIneligibleForLocking
Error type url: https://api.apiture.com/errors/propertiesIneligibleForLocking/v1.0.0
Version: 1.0.0
Description: The property cannot be locked due to an incompatible value.
Remediation: Assign a different value for the property before locking.
Error objects of this propertiesIneligibleForLocking type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
properties | array | Properties that are unable to be locked due to having an incompatible value. |
propertiesLockedInTemplate
Error type url: https://api.apiture.com/errors/propertiesLockedInTemplate/v1.0.0
Version: 1.0.0
Description: One of more properties have been locked for modification in the template.
Remediation: Unlock the properties in the template to modify them in this payment batch.
Error objects of this propertiesLockedInTemplate type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
properties | array | Requested properties that are unable to be modified due to being locked. |
restrictionDateRangeTooLarge
Error type url: https://api.apiture.com/errors/restrictionDateRangeTooLarge/v1.0.0
Version: 1.0.0
Description: The endOn is limited to four years after the startOn date
Remediation: Limit the endOn date to no more than four years after the startOn date
sameSourceAndTargetTransferAccounts
Error type url: https://api.apiture.com/errors/sameSourceAndTargetTransferAccounts/v1.0.0
Version: 1.0.0
Description: The source and target account are the same.
Remediation: Choose different source and target accounts.
tooFewColumnsInImport
Error type url: https://api.apiture.com/errors/tooFewColumnsInImport/v1.0.0
Version: 1.0.0
Description: The values file is not well formed and parsing failed.
Remediation: Supply the Base64 encoding of a well-formed values file.
tooFewColumnsInTabSeparatedValues
Error type url: https://api.apiture.com/errors/tooFewColumnsInTabSeparatedValues/v1.0.0
Version: 1.0.0
Description: The tab-separated values file is not well formed and parsing failed.
Remediation: Supply the Base64 encoding of a well-formed tab-separated values file.
tooManyAddendaInImport
Error type url: https://api.apiture.com/errors/tooManyAddendaInImport/v1.0.0
Version: 1.0.0
Description: Only one addenda allowed for this type of batch.
Remediation: Addenda values found in the file have been skipped.
Error objects of this tooManyAddendaInImport type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
recordNumbers | array | An array of record (line) numbers containing invalid data. |
more | boolean | If |
tooManyInstructionsForCtxImport
Error type url: https://api.apiture.com/errors/tooManyInstructionsForCtxImport/v1.0.0
Version: 1.0.0
Description: When importing CTX payment instructions, only one payment instruction allowed.
Remediation: Adjust the file to include only one payment instruction.
tooManyOverdraftAccounts
Error type url: https://api.apiture.com/errors/tooManyOverdraftAccounts/v1.0.0
Version: 1.0.0
Description: The items in the request contains more than maximumOverdraftAccounts items.
Remediation: Specify at most maximumOverdraftAccounts items in the request.
tooManyPaymentBatchIds
Error type url: https://api.apiture.com/errors/tooManyPaymentBatchIds/v1.0.0
Version: 1.0.0
Description: Only one payment batch is allowed when exporting a tab-separated values file.
Remediation: Reduce the number of payment batch IDs to 1.
tooManyRecordsInImport
Error type url: https://api.apiture.com/errors/tooManyRecordsInImport/v1.0.0
Version: 1.0.0
Description: Only one record is allowed for this type of batch.
Remediation: Additional records found in the file have been skipped.
Error objects of this tooManyRecordsInImport type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
recordNumbers | array | An array of record (line) numbers containing invalid data. |
more | boolean | If |
tooManyRequests
Error type url: https://api.apiture.com/errors/tooManyRequests/v1.0.0
Version: 1.0.0
Description: The client has sent too many requests in a given amount of time, exceeding rate limiting.
Remediation: Slow down the rate of API calls.
transactionsForInternalAccountOnly
Error type url: https://api.apiture.com/errors/transactionsForInternalAccountOnly/v1.0.0
Version: 1.0.0
Description: Transactions are not available for external accounts.
Remediation: Request transactions only for internal accounts.
unauthorized
Error type url: https://api.apiture.com/errors/unauthorized/v1.0.0
Version: 1.0.0
Description: The request lacks valid authentication credentials for the target resource or operation.
Remediation: Authenticate the user and pass the required authorization with the request.
unbalancedNachaAchFileNotAllowed
Error type url: https://api.apiture.com/errors/unbalancedNachaAchFileNotAllowed/v1.0.0
Version: 1.0.0
Description: The user attempted to upload an unbalanced NACHA file but is only allowed to upload balanced files.
Remediation: Upload only balanced NACHA files.
unprivilegedAchOperation
Error type url: https://api.apiture.com/errors/unprivilegedAchOperation/v1.0.0
Version: 1.0.0
Description: Responsible customer does not have ACH privilege(s) over customer.
Remediation: Give the customer privileges, or let a customer with the correct privileges perform the operation.
Error objects of this unprivilegedAchOperation type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
responsibleCustomerName | string | The name of the customer attempting the operation. |
responsibleCustomerUsername | string | The login username of the customer attempting the operation. |
customerName | string | The name of the customer the user is attempting to act on behalf of. |
customerUsername | string | The login username of the customer the user is attempting to act on behalf of. |
unprocessableEntity
Error type url: https://api.apiture.com/errors/unprocessableEntity/v1.0.0
Version: 1.0.0
Description: The syntax of the request entity is correct but was unable to process the contained instructions.
Remediation: Provide a semantically correct request.
unsupportedSecCode
Error type url: https://api.apiture.com/errors/unsupportedSecCode/v1.0.0
Version: 1.0.0
Description: The SEC code is not supported
Remediation: Use a supported SEC code.
Error objects of this unsupportedSecCode type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
secCodes | array | Unsupported SEC codes. |
wrongNumberOfResponses
Error type url: https://api.apiture.com/errors/wrongNumberOfResponses/v1.0.0
Version: 1.0.0
Description: The challenge verification sent the wrong number of response strings.
Remediation: Send only one response for one-time passcode challenges, or send exactly one response for each security question.