Skip to content

ErrorCode

Gatepost\Postcode\Client\ErrorCode

Why a client call failed. spec/client.md maps each HTTP status to one of these codes. Each value is the wire value that every Gatepost SDK uses.

  • InvalidInput = 'invalid_input': The client’s own check of the input failed, or the gateway rejected the request.
  • Unauthorized = 'unauthorized': The gateway refused the API key, or the client sent none (HTTP 401).
  • InsufficientCredits = 'insufficient_credits': The account has no credits for the lookup level (HTTP 402).
  • OriginNotAllowed = 'origin_not_allowed': The gateway refused the origin of the request for a publishable key (HTTP 403).
  • Forbidden = 'forbidden': The key lacks the scope or the lookup level for the request (HTTP 403).
  • RateLimited = 'rate_limited': The gateway refused the request because the key sent too many (HTTP 429).
  • ServerError = 'server_error': The gateway failed (HTTP 502, 503, 504 or another status that is not 200).
  • UnexpectedResponse = 'unexpected_response': The gateway sent status 200, but the body lacks a part that the client needs.
  • NetworkError = 'network_error': No response arrived, because the connection failed.
  • Timeout = 'timeout': No response arrived within the timeout.

Unofficial. Not made or endorsed by NIPOST.