Documentation

CANARY_INVALID

400invalid_request

The canary payload is invalid.

Cause

The CanaryState aggregate refused the fields: a missing biller_id/candidate_hash, or an unsupported decision.

How to fix it

Fix the field named in error_message and resend.

Example response

400 CANARY_INVALID
JSON
{
  "error_code": "CANARY_INVALID",
  "error_type": "invalid_request",
  "error_message": "The canary payload is invalid.",
  "hint": "Fix the field named in error_message and resend.",
  "docs_url": "https://docs.billerapi.com/errors/CANARY_INVALID",
  "request_id": "d94f5e2a-8c3b-4f1e-9a7d-6b2c1e0f8a34"
}

Related

Canonical docs URL: https://docs.billerapi.com/errors/CANARY_INVALID

Was this page helpful?