API reference / Products

get/v1/products

List visa products

Operation
listProducts
Authentication
API key

The catalogue. Government fee and service fee are always returned separately — a single blended price is how a refund becomes impossible to explain.

Request

Parameters

destination_iso3querystring
visa_typequerystring
activequerybooleannull
limitqueryinteger
cursorquerystring

Responses

200Products matching the filter.
productsobject[]required
next_cursorstringnullrequired
400The request body or query failed validation.
errorobjectrequired
401No key, an unknown key, a revoked key, or a key whose tenant is not active. All four return an identical body on purpose: distinguishing them would let a caller discover which partners we have.
errorobjectrequired
403The key is valid but does not hold the scope this route requires.
errorobjectrequired
404Not found, or not yours. A resource belonging to another tenant answers 404 rather than 403, because 403 would confirm the record exists.
errorobjectrequired

Example

curl
curl -X GET https://api.haavisa.com/v1/products \
  -H "Authorization: Bearer $HAAVISA_API_KEY"

More in Products

Something unclear? The eligibility guide explains the model behind the answers; the errors guide covers the envelope.