Skip to content

Suggestion

Gatepost\Postcode\Client\Suggestion

One way to complete the segment that the user types. The gateway sends the value of that segment only. The client adds the segments that the user typed before it.

  • string $code: The value of the segment, as the gateway sent it, such as Z99.
  • ?string $label: The gateway’s label, or null. The gateway has sent none so far.
  • ?Postcode $postcode: The typed segments before this one and then code, or null when that is no postcode.

Unofficial. Not made or endorsed by NIPOST.