get/v1/checkout-return

Resolve a Stripe checkout return

Operation: resolveCheckoutReturn
Authentication: API key

Returns a minimal payment receipt for the session and application pair. It never returns applicant answers or contact details.

Request

Parameters

application_idqueryrequiredstring

session_idqueryrequiredstring

Responses

200Receipt summary and payment status.

Free-form JSON object.

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

403`projects:write` is required. No partner key is ever issued this scope.

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

503Stripe checkout is unavailable.

Example

curl

curl -X GET https://api.haavisa.com/v1/checkout-return \
  -H "Authorization: Bearer $HAAVISA_API_KEY"?application_id=<application_id>&session_id=<session_id>

More in Admin

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