API Errors

Pinwheel API error messages are returned in JSON format inside an error object. The type field contains a higher level category of the error and the code field is more specific. The message field contains a human-readable description of the error and is subject to change. For example, an error response to POST /link_tokens could look like:

{
  "error": {
    "type": "INVALID_REQUEST_PARAMETERS",
    "code": "INVALID_ROUTING_NUMBER",
    "message": "Validation error.",
    "status_code": 400,
    "fields": [{
      "message": "Provided value doesn't match valid format.",
      "name": "routing_number"
    }]
  }
}

There are four different API error types:

The optional fields attribute holds an array of validation errors. It is human-facing and shouldn't be programatically processed since its structure and content may change arbitrarily. Use type and code as stable fields for programmatic handling.

Link Errors

An onError event will fire for every error. Errors may be retryable (e.g., an incorrect credential was entered) or may be terminal (e.g., the 3rd party integration is currently down). If an error occurred before closing the modal, Link's onExit callback is called with an error object as well.

Link error codes and types are safe for developer use, whereas error messages are liable to change.

There are eight different Link error types:

Specific error codes include:

Please contact [email protected] for access to our Developer Dashboard.