Netspend API Business Errors

Listing of possible business errors in the Netspend API, with description, context and possible remedies.

account_has_pending_transfer

The given subaccount has a pending transfer, and cannot be closed.

This error may occur when trying to close a subaccount.

Ensure all the transfers on the subaccount are completed before trying to close it.

account_inactive

The given account is inactive, which will block access to a number of features.

This error may occur when trying to use Payback Rewards, Overdraft or Statements endpoints.

Check the account status via the GET /accounts/{account_id} endpoint to determine what needs to be done to make the account active.

account_not_found

The account related to the endpoint call could not be found.

This error may occur with any endpoint that involves an account.

Double check the account id to make sure it is valid and belongs to a valid account.

account_transfer_not_found

The account level transfer (deposit or withdrawal) cannot be found.

This error may occur when using Partner Account Transfer or Subaccount transfer endpoints.

Double check your deposit or withdrawal id to make sure it is valid

address_canadian_not_allowed

The residential or shipping address was canadian.

This error may occur with any endpoint involving an address.

Use a non-Canadian address.

address_general_delivery_not_allowed

The residential or shipping address does not allow for general delivery.

This error may occur with any endpoint involving an address.

Double check the address and try to make the address more specific.

address_has_component_mismatch

The residential or shipping address has a component mismatch.

This error may occur with any endpoint involving an address.

Double check the components of the address and correct.

address_has_multiple_matches

The residential or shipping address has multiple matches.

This error may occur with any endpoint involving an address.

Double check the address and try to make the address more specific.

address_is_out_of_range

The residential or shipping address value or number is out of range.

This error may occur with any endpoint involving an address.

Double check the address for out of range values and correct.

address_is_undeliverable

The residential or shipping address could not be validated as a deliverable address.

This error may occur with any endpoint involving an address.

Double check the address and correct to be a deliverable address.

address_po_box_not_allowed

The residential or shipping address is a PO box.

This error may occur with any endpoint involving an address.

Double check the address and correct to be a street address instead of a PO box.

address_private_mail_box_not_allowed

The residential or shipping address refers to a private mailbox.

This error may occur with any endpoint involving an address.

Double check the address and correct with a non-private mail box address.

address_street_is_unknown

The residential or shipping address street could not be found or verified.

This error may occur with any endpoint involving an address.

Double check the street and correct with valid value.

address_verification_failed

The residential or shipping address had a general verification error.

This error may occur with any endpoint involving an address.

Double check the address for errors.

address_zip_code_is_invalid

The residential or shipping address has an invalid zip code.

This error may occur with any endpoint involving an address.

Double check the zip code and correct with valid value.

agreement_acceptance_not_found

No term acceptance found for card owner.

This error may occur with any endpoint involving an agreement acceptance.

The end user should be reminded of accepting any pending agreements.

agreement_not_found

The requested agreement was not found

This error may occur with an endpoint searching for the accepted agreements for a person.

Ensure that you provide the correct account in the request.

agreement_subscription_not_found

No term subscription found for account.

This error may occur with the endpoint involving an agreement.

The end user should be reminded of accepting any pending agreements.

already_enrolled

Account is already enrolled in a feature eg., savings.

This error may occur for an endpoint related to a feature enrollment where the user has already enrolled for the feature.

No enrollment is required.

amount_too_high

The transfer amount is greater than the maximum allowed amount.

This error may occur with the endpoints related to external transfer.

Ensure that you provide the transfer amount within the allowed range of amount.

amount_too_low

The transfer amount is less than the minimum allowed amount.

This error may occur with the endpoints related to external transfer.

Ensure that you provide withdrawal amount within the allowed range of amount.

authentication_factor_not_found

Invalid authentication factor provided for session creation request.

This error may occur with an endpoint while getting the session information.

Ensure the session is authenticated before sending the request.

bank_account_relinking_is_required

User should attempt to relink their account.

This error can occur with any endpoint related to the external bank transfer.

Relink the account and resend the request.

bank_transfer_request_limit_reached

The number of allowed bank transfers per 24-hour period have already occurred.

Occurs while initiating external bank transfer or withdrawal. Wait until the period has passed and try again.

Check and provide the correct account_id in the request. Wait for the period to expire and attempt the transfer again.

card_brand_not_found

Invalid card brand provided in the card order request.

This error may occur while using the endpoint to create a digital card.

Check if the brand details are correctly entered OR select from the brands that are available.

card_encryption_error

Encryption error occurred during card tokenization for mobile wallets.

This error may occur while using any endpoint involving creating a pay token.

xxx

card_not_eligible

Card is not eligible for reset PIN and activation.

This error may occur either during setting a PIN or creating a pay token.

Ensure that the card is active, not expired, and there are no blocks on the card or account.

card_not_found

Invalid card id either in the path or in the request body.

This error may occur when trying any card related endpoints except for saring brand or creating and ordering a new card.

Check if you provided the correct card details in the request.

card_inactive

Card is inactive because it is expired, lost, or stolen.

This error may occur when enrolling an account in the overdraft program and the account owner's card is invalid.

xxx

card_order_not_allowed

Card order is not allowed.

This error may occur while running an endpoint to create a new card - physical, digital or virtual.

Ensure that the primary owner holds a card before ordering a card for the secondary owner OR ensure details for program_id and account_create_context match.

card_verification_expired

Card verification has expired.

This error occurs while setting a card PIN.

Make another call to POST /cards/{card_id}/verify, obtain the new card_verification_result_id, and attempt to set the card PIN again.

card_verification_failed

Card verification cannot be completed. Card might be closed or invalid card.

This error may occur while trying to verify a physical card.

Enter details for a card that is not closed.

contact_customer_service

The issue requires the user to contact customer service.

This error may occur when trying to creade or update a person.

Ensure that the SSN is not already associated with another active account.

data_encryption_is_invalid

Cannot deserialize the provided encrypted data.

This error may occur while trying to answer any identity question, verifying people using personal information, or while creating a new session.

Verify the encryption algorithm and re-encrypt the data.

dependency_unresolved

Unable to enroll in savings due to incomplete workflow steps.

This error may occur when trying to enroll an acocunt in the Savings program.

Attempt the work flow steps again.

document_request_not_found

Invalid document request id either in the path or request body.

This error may occur when invoking any endpoints related to the document requests.

xxx

document_upload_not_allowed

Document upload is not allowed. Either KYC is already approved or documents have already been uploaded.

This error may occur when trying to upload any documents that are requested.

No action is required.

encrypted_data.verification_value_invalid

The verification PIN does not match the actual PIN.

This error may occur when verifying a physical card.

Verify and correct the card_id and encrypted_data in the request.

external_bank_account_already_linked

The external bank account is already linked to the user or another Netspend account.

This error may occur when trying to link an external bank account.

No action is needed as the bank account is already linked.

external_bank_account_daily_success_link_limit_reached

The ACH Transfer account has already made the maximum number of successful external bank links in 24 hrs.

This error may occur when trying to execute external bank transfer.

Execute the transfer after the limit period is over.

external_bank_account_link_failed

Cannot link the external bank account

This error may occur when linking to an external bank.

Check and provide the correct inputs in the request.

external_bank_account_link_limit_reached

The ACH Transfer account already has maximum number of external bank linked

xxx

xxx

external_bank_account_is_blocked

Due to previous ACH return(s) on this account, request cannot be processed.

This error may occur when trying to use any endpoints for external bank deposits or withdrawals.

xxx

Due to previous ach return(s) on this account, we cannot process your new request

external_bank_account_name_check_failed

Bank owner name does not match with netspend account owner name.

This error occurs while using external bank transfer endpoints.

xxx

external_bank_account_not_linked_by_this_person

Only the linker of the external account can perform this action.

This error may occur when trying external bank withdrawal endpoints.

Ensure the person details in the request are the details of the linker.

external_bank_account_person_permission_not_allowed

Person does not have permission to perform this action

This error occurs when trying the external bank deposit/withdrawal endpoints.

Ensure the details of the person in the request are of the person with permission to perform the required action.

external_bank_transfer_deposit_not_found

Deposit with specified id is not found

This error may occur when trying to execute external bank deposit.

Check the deposit id provided in the request.

external_bank_transfer_server_error

This error indicates that ACH Transfer has failed.

This error may occur while getting or executing external bank deposit/withdrawal.

xxx

external_bank_transfer_withdrawal_not_found

This error indicates that specific withdrawal id is not found.

This error may occur when trying to execute external bank withdrawal.

Check and provide correct id in the request.

feature_not_enrolled

An account or person is not actively enrolled in the External Bank or Remote Deposit Capture features.

This error may occur when working with External Bank Transfers or Remote Deposit Capture.

Check and provide correct IDs in the request.

  • External Bank Transfers: Provide the correct external_bank_id
  • Remote Deposit Capture: Provide the correct account_id, connect_id, or person_id.

feature_not_allowed

Issues trying to exercise the feature.

This error may occur while validating the account while activating a card, creating an account, as well as performing various transfer activities.

Check if there is any block on the account like closed, compliance, pin_failure, and so on.

identity_scan_already_uploaded

The ID scan document has already been uploaded.

This error occurs while uploading an identity scan document.

Check and provide correct encypted data in the request.

identity_scan_expired

The time window for performing the ID scan upload has expired.

This error occurs while uploading an ID scan document.

Upload the ID scan document again. Check network latency.

identity_scan_not_found

The ID scan is not available or the most recent ID scan transaction is already complete.

This error may occur when trying to upload and identity scan image.

Check the status of the ID scan. Wait and try the ID scan upload again.

identity_scan_request_is_invalid

The ID scan request was invalid, for example, due to a corrupt file.

This error may occur when trying to upload an identity scan file.

Check and provide a non-corrupt file in the upload request.

identity_verification_answer_not_found

The answer to an Identity verification question was not found.

This error occurs when submitting answers to an Identity verification question.

Check and provide the correct question ID in the request.

identity_verification_answers_already_submitted

The person has already answered identity questions.

This error may occur when submitting answers to identity questions.

Check and provide correct person_id and encrypted data in the request.

identity_verification_question_not_found

Identity verification question was not found for the provided ID.

This error may occur when requesting identity questions or submitting answers.

xxx

identity_verification_questions_not_available

Identity verification questions are not configured for the partner, no questions available for the user, or the question set has expired.

This error may occur when requesting identity questions or submitting answers.

xxx

insufficient_funds

General error for insufficient funds

This error may occur when using any endpoints for transferring funds, making deposits and withdrawals, and so on.

Check available funds before submitting a request.

invalid_status

General error for an invalid status.

This error may occur anytime an entity (such as an account) is inactive, a feature is not offered, and so on.

Check the `status` and `status_reason` fields in the response.

kyc_approval_required

KYC approval is required for the given operation.

This error may occur when working with accounts, subaccounts, document requests, people, and cards.

Process the needed KYC workflows.

kyc_updates_not_permitted_when_approved_or_conditional

Updates to a person's KYC status are not allowed when the person's KYC status is "approved" or "conditional"

This error may occur when trying to update a person.

Ensure that you are not updating KYC details for a person with KYC status as “approved” or “conditional”. If yes, you won’t be able to update the KYC details.

linked_bank_account_not_found

Bank account for provided ID could not be found.

This error may occur when trying to retrieve the external bank permissions.

Ensure that the correct linked bank account details are added in the request.

linked_debit_card_not_found

Debit card for provided ID could not be found.

This error may occur when trying to unlink an external card, initiate or execute an external card withdrawal request.

Check the debit card details added in the request.

linked_debit_card_transaction_not_found

Debit card transaction for provided ID could not be found.

xxx

Check the transaction id provided.

max_active_account_owners_exceeded

Maximum number of owners for a given account has been reached.

This error may occur when trying to create new person against an existing account.

You cannot add more active account owners.

max_active_cards_exceeded

Maximum number of active cards for the account or person has been reached.

This error may occur when trying to create a new digital card.

You cannot add more active digital cards.

max_card_verifications_exceeded

Maximum number of verification attempts has been reached.

This error may occur when you try verifying a physical card multiple times.

xxx

overdraft_program_not_allowed

Overdraft is not allowed for the partner or account.

This error may occur when trying to enroll the account with enroll overdraft.

Check the partner/account details provided.

overdraft_program_not_found

Overdraft program not available or configured for the partner.

This error may occur when trying to run any overdraft endpoints.

If you have this program available, check the configuration.

partial_amount_transferred

Only part of the funds in a debit card funding were transferred.

This error may occur while initiating or executing.

Check the account balance.

partner_not_found

Partner cannot be found for given id.

This error may occur when trying any Partern Account Transfer endpoints or while authenticating the user in Ingo.

Ensure correct partner id is provided.

payback_reward_not_opted_in

Account has not opted into the payback rewards program.

This error may occur when trying to get payback rewards offers information.

Ensure the account has opted in to payback rewards program.

payback_reward_offer_not_found

Payback reward offer not found for provided ID

xxx

Check the id provided.

permission_change_not_allowed

The person in the session is not allowed to change the requested permission; for example, a secondary person cannot change their own permissions.

This error may occur when managing external bank permissions.

Check and provide the correct ns-session-id, external_bank_id, or person_id.

person_not_allowed

This is a generic error for a person not being allowed to perform an operation.
It could be for any of the following reasons:

  • Person has not completed expected use
  • Person has not completed eSign
  • Person has not accepted terms & conditions
  • Person has KYC unchecked, rejected or conditional

This error may occur when trying to check the eligibility or create a digital card or create a new person.

xxx

person_not_found

General error for not being able to find a person for a provided ID or related to an operation.

This error may occur when trying multiple endpoints such as agreements endpoints, various card endpoints, document request endpoints.

xxx

person_session_is_required

Person is required to be identified in the session for the given operation.

This error may occur when trying to get list of or unlink external bank or manage external bank permissions.

Ensure that the person session is established at the time of sending the request body.

primary_person_kyc_approval_required

KYC approval for the primary person (first joint account owner) is required for the given operation.

This error may occur when trying to create a new person for an account.

Ensure KTC is approved for the primary person.

primary_person_required

Cannot create a secondary person on an account where a primary does not already exist.

This error may occur when trying to create a new person for an account.

Ensure you have added a primary person on the account first.

provided_id_not_found

Provided ID not found; currently applies to agreements operations.

This error may occur when trying to search for agreements.

Ensure correct id is provided in the request.

provided_id_not_valid

Provided ID not valid; currently applies to agreements operations.

This error may occur when trying to search for agreements.

Ensure the correct id is provided.

receiver_amount_limit_reached

The daily, weekly, or monthly monetary amount limit for the receiver of the transfer has been reached.

This error may occur when trying P2P transfer.

xxx

receiver_feature_not_allowed

Transfer feature is not allowed for the receiver.

This error may occur when trying a P2P transfer.

Check if the receiver is inactive or blocked.

receiver_not_found

Transfer receiver was not found.

This error may occur when trying to initate or update a P2P transfer.

Ensure the correct receiver details are provided.

receiver_transfer_limit_reached

The daily, weekly, or monthly transfer count limit for the receiver of the transfer has been reached.

This error may occur when trying to initiate deposit as part of partner account transfer.

Cancel current transfer request, check when the receiver can again receive the funds, and accordingly reinitiate the transfer.

residence_state_is_not_allowed

Provided state of residence is not allowed.

This error may occur when trying to create and order a new physical card.

If the state of residence entered is incorrect, provide the correct one.

restriction_not_found

Restriction with the provided id is not found.

This error may occur when trying to retrieve a specific account restriction.

Check if correct. Alternatively, if the restriction is not added, add the appropriate restriction.

savings_account_not_found

Savings account not found for provided ID.

This error may occur when trying to retrieve an automatic savings transfer preference.

Check if savings account for the primary account exists and if found, provide the correct details.

savings_program_not_found

Savings program not found or configured for the partner.

This error may occur when working with savings, accounts, and transactions endpoints

Check if the savings program is configured and if so, verify all inputs to requests.

savings_transfer_not_found

Savings transfer details not present for the provided withdrawal_id or deposit_id.

This error may occur when executing a savings withdrawal or deposit.

Check and provide the correct ID in the request. Also check and provide the correct account_id.

savings_transfer_preference_already_exists

Savings account transfer preference already exists for provided automatic transfer ID.

This error may occur when adding an automatic savings transfer enrollment.

Check and provide the correct automatic transfer ID in the request. Also check and provide the correct account_id.

savings_transfer_preference_not_found

The provided savings account transfer preference ID was not found.

This error may occur when retrieving, adding, or deleting an automatic savings account transfer.

Check and provide the correct automatic transfer ID in the request. Also check and provide the correct account_id.

secondary_person_already_exists

Secondary person already exists for the account.

This error may occur when attempting to create a secondary person and a secondary person already exists on the account.

Check and provide the correct account_id in the identity_context object in the request. Also check and provide the correct relationship

sender_amount_limit_reached

The daily, weekly, or monthly monetary amount limit for the sender of the transfer has been reached.

This error may occur when initiating a P2P transfer.

Check and provide the correct sender_person_id and amount in the request.

sender_feature_not_allowed

Transfer feature is not allowed for the sender.

This error may occur when initiating a P2P transfer.

Check and provide the correct sender_person_id in the request.

sender_transfer_limit_reached

The daily, weekly, or monthly transfer count limit for the sender of the transfer has been reached.

This error may occur when initiating a P2P transfer.

Check and provide the correct sender_person_id in the request.

service_level_not_offered

The selected service level (the selected timeliness of completion) is not offered.

This error may occur when initiating an external bank withdrawal.

Check and provide the correct service_level value (`same_day` or `standard`) in the request.

source_change_not_valid

Requested change to the source of the session is not allowed; for example from person to account.

This error may occur when changing a session's `source_id`. You can only change from: (1) anonymous to account or persion or (2) from account to person.

Check and provide the correct new `source_id` depending on the current source.

ssn_not_allowed

Social security number not allowed when creating or patching the person on a subaccount.

This error may occur when creating or updating a person and:

  • The account_id you passed represents a subaccount
  • The encrypted data includes a government ID

  • Verify that you want to attach the person to a subaccount. If so, pass encrypted data with other than a government ID.
  • Otherwise, check the account_id and change it to a non-subaccount.

statement_not_found

No statements available.

This error may occur when getting an account's available statements or the account's generated statement URL and either of the following:

  • The account does not have statements available (if it was recently opened)
  • The requested statement period is outside the range of available statements.

xxx

subaccount_transfer_deposit_not_found

Sub account transfer deposit not found for the provided account_id and deposit_id.

This error may occur when retrieving, executing, or cancelling a subaccount deposit request.

Check and provide a correct account_id and deposit_id

subaccount_transfer_withdrawal_not_found

Sub account transfer withdrawal not found for the provided IDs.

This error may occur when creating, retrieving, executing, or cancelling a subaccount withdrawal request.

Check and provide a correct ID depending on the operation:

Provide account_id and subaccount_id

Provide account_id and withdrawal_id

survey_already_answered

Survey question was already answered.

Survey was already answered.

Check to see if answering surveys multiple times is supported.

survey_answer_not_found

Survey answer not found.

This error may occur when trying to answer a survey question.

Check and provide correct answer to the survey question.

survey_not_found

Survey not found.

This error may occur when trying account onboarding.

xxx

survey_question_not_found

Survey question was not found.

This error may occur when trying account onboarding.

Very low probability of getting this error. If occured, check the survey question id.

third_party_auth_error

Authorization to a third party service used by Netspend failed.

This error may occur when trying to authenticate user with third party service, for example Ingo.

xxx

token_not_found

Authorization token was not found.

This error may occur when trying to redeem a token.

Check if you are providing the right token.

transaction_declined

The transaction was declined pending further verification.

This error may occur when trying to executing external bank deposit or withdrawal or when trying to initiate or execute extrnal card withdrawal.

xxx

transaction_not_found

The specified transaction was not found.

This error may occur when retrieving transaction details or searching for transactions.

  • If retrieving transaction details, verify and provide the correct transaction_id in the request.
  • If searching for a transaction, verify and provide the correct transaction_id as the starting_after value during pagination.

transfer_already_completed

Transfer has already completed.

This error may occur when trying to cancel a completed or failed transfer request.

No remedy is possible. The transaction is either failed or already completed.

transfer_expired

Initiated transfer has expired and cannot be executed.

This error may occur when executing an initiated transfer where the transfer is either expired or has been already executed.

Check if a fresh transfer is required in case the initiated transfer is expired.

transfer_not_allowed

Transfer is not allowed.

This error may occur when trying to initiate a subaccount deposit request.

xxx

transfer_not_found

Transfer cannot be found.

This error may occur when trying to endpoints related to P2P transfer.

xxx

transfer_update_not_allowed

Update to the transfer (initiated, pending or otherwise) is not allowed.

This error may occur when using any P2P transfer actions.

xxx

user_session_not_found

Could not find active session for the user where required.

Generic error and may occur when trying multiple activities such as verifying physical card or person, external bank actions, or session information.

Ensure you have an active session before sending a request.

velocity_exceeded

Number of attempts allowed per day, week or month exceeded.

This error may occur when trying to initiate or execute external card withdrawal request.

Wait for the next permissible transaction period.