Validation Errors

Availability

Use of the production Forward API is subject to eligibility.

Contact your Account Manager for more information or submit an inquiry to our Business Development team.

Validation errors are returned in the response body to your application. The body is a JSON structure with a format resembling this example:

json

{
  "error": "Unknown HTTP Method",
  "message": {
    "validation_error?": true,
    "method": "An-Erroneously-Misnamed-HTTP-Method"
  },
  "request-uuid": "a-unique-identifier-for-the-request"
}

All validation errors include "validation_error?": true as part of the message, so it isn't listed below

Error	Explanation	Additional `message` fields
Config 'methods' must be an array	The `methods` parameter is required to be an array of supported HTTP methods.
Config must specify a valid URL regex	The URL specified in the configuration is not a valid regular expression.
Inline client certificates are not allowed in production	The `client_cert` parameter is sandbox-only.
Inline configurations are not allowed in production	The `config` parameter isn't allowed in production. All configs must be submitted and approved.
Invalid client certificate	The `client_cert` parameter is not a valid X.509 certificate.
Invalid client key	The `client_key` parameter is not a valid PEM-encoded PKCS 8 private key.
Invalid conditional predicates	One or more of the conditional transformations has an invalid if_defined condition.	`predicates`: The invalid conditions.
Invalid HTTP headers, multiple values were provided for the same key	Providing multiple values for a HTTP header should instead use a single key with a comma-separated list of values and HTTP header names are case-insensitive, per RFC 2616 4.2.	`headers`: The full set of headers.
Invalid HTTP headers, must provide map	The `header` parameter must be a JSON object.
Invalid HTTP headers, headers cannot contain newlines or carriage returns	Keys and values in header object cannot contain newlines or carriage returns
Invalid request_format	The supported request_formats are "json", "urlencode", and "xml"	`request_format`: The invalid request_formats.
JSON Schema validation error	The request did not pass our JSON Schema validations. See the schema here.	`detail`: A description of the error. `pointer`: A JSON Pointer to the errant data.
Missing required client cert parameter. client_cert and client_key are required.	It is necessary to specify both of the client_cert and client_key parameters for TLS mutual auth.
No config specified	Request JSON lacks either a `config` parameter (in Sandbox) or a config `name` parameter.
No config specified for payment type	The `config` does not include the specified payment method type.	`vault_type`: Type of payment method `supported_by_config`: Types supported by the config.
No url specified	Neither the `url` parameter nor the `urls` parameter are included.
No valid request_format specified	The `request_format` parameter isn't included.
Request URL does not match config URL regex	The URL or URLs parameter provided does not match the validating regex set in the `config`.
Request format must be JSON	The request isn't syntactically valid JSON.
Request method not allowed by config	The HTTP `method` parameter isn't included in the config's `methods` array.
Request must be a JSON dictionary	The request was not a valid JSON object.
Unknown HTTP Method	The HTTP `method` parameter is not one of `GET`, `POST`, `HEAD`, `PUT`, or `PATCH`.	`method`: The submitted HTTP method.
Unknown host	DNS lookup failed for the URL.	`url`: the URL of the attempted destination.
URL is invalid or resolves to private IP	Requests to a private network are unsupported.	`url`: The URL of the attempted destination.
URL is malformed	The `url` parameter was not a valid URL.	`url`: The URL of the attempted destination.
URL protocol must be http or https	The `url` parameter's protocol must either be HTTP or HTTPS.	`url`: The URL of the attempted destination.
debug_transformations is not allowed in production	The `debug_transformations` parameter isn't allowed in production since it might otherwise return PCI sensitive data.
merchant_id is required	The `merchant_id` parameter isn't included in the request.
override must be an object literal if provided	The `override` parameter must be a JSON object.
payment_method_nonce or payment_method_token(s) is required	At least one of the `payment_method_nonce`, `payment_method_token`, and `payment_method_tokens` parameters must be included in the request.
request_format does not match override	The `override` parameter could not be parsed in accordance with the `request_format`.	`content`: the text that caused a parsing error. `request_format`: the format unsuccessfully attempted for decoding of the content.
request override contained invalid keys	The `override` parameter contained top-level keys other than `body`, `header`, and `urlparam`.