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.


additionalAuthenticationRequired

Error type url: https://api.apiture.com/errors/additionalAuthenticationRequired/v1.0.0
Version: 1.0.0
Description: Additional authentication, such as multi-factor authentication, required
Remediation: Complete the additional factors as per the WWW-Authenticate response header and add an additional Authorization to the call


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.


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


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 destination account
Remediation: Choose a destination account that allows transfers to


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


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.


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.


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

PropertyTypeDescription
recordNumbersarray

An array of record (line) numbers containing extra columns.

moreboolean

If true, recordNumbers contains only the first n warnings and there are more warnings If false, the recordNumbers lists all values.


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


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.


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

PropertyTypeDescription
recordNumbersarray

An array of record (line) numbers containing invalid data.

moreboolean

If true, recordNumbers contains only the first n errors and there are more errors. If false, the recordNumbers lists all values.


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

PropertyTypeDescription
recordNumbersarray

An array of record (line) numbers containing invalid data.

moreboolean

If true, recordNumbers contains only the first n errors and there are more errors. If false, the recordNumbers lists all values.


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.


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


invalidCsrfToken

Error type url: https://api.apiture.com/errors/invalidCsrfToken/v1.0.0
Version: 1.0.0
Description: The CSRF token is invalid
Remediation: The client application is not correctly configured to send CSRF


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

PropertyTypeDescription
recordNumbersarray

An array of record (line) numbers containing invalid data.

moreboolean

If true, recordNumbers contains only the first n errors and there are more errors. If false, the recordNumbers lists all values.


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 SWICT/BIC code, as per the given locatorType.


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.


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 an existing batch for which the user has read access.
Error objects of this invalidPaymentBatchIds type may have the following attributes as defined by this JSON schema

PropertyTypeDescription
invalidPaymentBatchIdsarray

The list of invalid payment batch IDs


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

PropertyTypeDescription
recordNumbersarray

An array of record (line) numbers containing invalid data.

moreboolean

If true, recordNumbers contains only the first n errors and there are more errors. If false the recordNumbers lists all values.


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.


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 Base-64 encoding of a well-formed tab-separated values file.


loginIncomplete

Error type url: https://api.apiture.com/errors/loginIncomplete/v1.0.0
Version: 1.0.0
Description: The user is correctly authenticated but additional actions are required for activating their login session
Remediation: Instruct the user to complete the additional actions to activate their login session


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 crete, modify, or delete resources
Remediation: Avoid modification operation for customers with read-only authorization


noSuchAccount

Error type url: https://api.apiture.com/errors/noSuchAccount/v1.0.0
Version: 1.0.0
Description: No such account was found or accessible for the given {accountId}.
Remediation: Specify the ID of an available account.


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.


noSuchCustomerSession

Error type url: https://api.apiture.com/errors/noSuchCustomerSession/v1.0.0
Version: 1.0.0
Description: The customer session is invalid or does not exist.
Remediation: Initiate a new customer session.


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: Enter the correct company ID and type that the user is entitled to use for payment batches.


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

PropertyTypeDescription
paymentInstructionIdsarray

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.


noSuchTransaction

Error type url: https://api.apiture.com/errors/noSuchTransaction/v1.0.0
Version: 1.0.0
Description: No such transaction was found or accessible for the given {transactionId}.
Remediation: Specify the ID of a valid transaction for the account.


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

PropertyTypeDescription
invalidPaymentBatchIdsarray

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: Transfer amount may not be 0.00
Remediation: Set the transfer amount to a positive number


passwordChangeRequired

Error type url: https://api.apiture.com/errors/passwordChangeRequired/v1.0.0
Version: 1.0.0
Description: The user must change their password
Remediation: Instruct the user to change their password or other login credentials


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.


sameSourceAndDestinationTransferAccounts

Error type url: https://api.apiture.com/errors/sameSourceAndDestinationTransferAccounts/v1.0.0
Version: 1.0.0
Description: Source and destination account are the same
Remediation: Choose different source and destination accounts


sessionExpired

Error type url: https://api.apiture.com/errors/sessionExpired/v1.0.0
Version: 1.0.0
Description: The user’s session has expired
Remediation: Re-authenticate the user to get a new access token or other authorization


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 Base-64 encoding of a well-formed tab-separated values file.


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.


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.


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


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

PropertyTypeDescription
responsibleCustomerNamestring

The name of the customer attempting the operation.

responsibleCustomerUsernamestring

The login username of the customer attempting the operation.

customerNamestring

The name of the customer the user is attempting to act on behalf of.

customerUsernamestring

The login username of the customer the user is attempting to act on behalf of.


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

PropertyTypeDescription
secCodesarray

Unsupported SEC codes.