Payoff Errors

Request Errors

The request to the /accounts/{acc_id}/payoffs endpoint failed. These are the sub_type that can be returned.

`INVALID_REQUEST`

The request body failed basic validation for the specific API endpoint.

`NOT_FOUND`

The requested resource does not exist.

`PRODUCT_UNAVAILABLE`

This Account does not support Payoffs. This could be due to the Account’s status, the Account’s liability type or Method currently doesn’t support Payoffs for the Account’s Financial Institution.

`PRODUCT_UNAVAILABLE_ACCOUNT_NOT_ACTIVE`

The Account is not active, so a Payoff cannot be retrieved.

`PRODUCT_UNAVAILABLE_INVALID_LIABILITY_TYPE`

Payoffs are not supported for this liability type.

`TEAM_CAPABILITY_RESTRICTED`

Your organization does not have access to Payoff endpoint.

`PRODUCT_VERIFICATION_MISSING`

Account must be verified before it can access /accounts/{acc_id}/payoffs endpoint.

Resource Errors

Errors set on a Payoff’s error property for processes that are unsuccessful.

`18001 – PAYOFF_TEMPORARILY_UNAVAILABLE`

There was an issue with connecting with the Account’s Financial Institution and the request could not be completed.

{
  "type": "PAYOFF_FAILED",
  "code": 18001,
  "sub_type": "PAYOFF_TEMPORARILY_UNAVAILABLE",
  "message": "Payoff is temporarily unavailable for this account."
}

⌘I

API Reference

Entities

Accounts

Wallet

Payments

Files

Opal

Elements

Events

Supporting Endpoints

Request Errors

`INVALID_REQUEST`

`NOT_FOUND`

`PRODUCT_UNAVAILABLE`

`PRODUCT_UNAVAILABLE_ACCOUNT_NOT_ACTIVE`

`PRODUCT_UNAVAILABLE_INVALID_LIABILITY_TYPE`

`TEAM_CAPABILITY_RESTRICTED`

`PRODUCT_VERIFICATION_MISSING`

Resource Errors

`18001 – PAYOFF_TEMPORARILY_UNAVAILABLE`

​Request Errors

​INVALID_REQUEST

​NOT_FOUND

​PRODUCT_UNAVAILABLE

​PRODUCT_UNAVAILABLE_ACCOUNT_NOT_ACTIVE

​PRODUCT_UNAVAILABLE_INVALID_LIABILITY_TYPE

​TEAM_CAPABILITY_RESTRICTED

​PRODUCT_VERIFICATION_MISSING

​Resource Errors

​18001 – PAYOFF_TEMPORARILY_UNAVAILABLE

Request Errors

`INVALID_REQUEST`

`NOT_FOUND`

`PRODUCT_UNAVAILABLE`

`PRODUCT_UNAVAILABLE_ACCOUNT_NOT_ACTIVE`

`PRODUCT_UNAVAILABLE_INVALID_LIABILITY_TYPE`

`TEAM_CAPABILITY_RESTRICTED`

`PRODUCT_VERIFICATION_MISSING`

Resource Errors

`18001 – PAYOFF_TEMPORARILY_UNAVAILABLE`