GET

Get details of an HPP session

https://api.kustom.co/hpp/v1/sessions/{session_id}

Use this API to read an HPP session content and it’s status. Read more on Read HPP session.

Parameters1 field

session_idstringrequiredin path
HPP session id

200

Response28 fields

Session found

authorization_tokenstringoptional
Authorization token (only for KP Sessions)
customerobjectoptional
5 fields in customer
- date_of_birthstringoptional
  Customer’s date of birth (YYYY-MM-dd)
- family_namestringoptional
  Customer’s family name
- given_namestringoptional
  Customer’s given name
- national_identification_numberstringoptional
  Customer’s national identity number
- titlestringoptional
  Customer’s title
expires_atstring · date-timeoptional
Session expiration time
klarna_referencestringoptional
Kustom reference provided by MoOD
manual_identificationobjectoptional
14 fields in manual_identification
- challengestringoptional
  Identification challenge
- customerobjectoptional
  5 fields in customer
  - date_of_birthstringoptional
    Customer’s date of birth (YYYY-MM-dd)
  - family_namestringoptional
    Customer’s family name
  - given_namestringoptional
    Customer’s given name
  - national_identification_numberstringoptional
    Customer’s national identity number
  - titlestringoptional
    Customer’s title
- customer_obfuscatedobjectoptional
  Same shape as customer — 5 fields, identical. Anchors under this path still resolve.
  5 fields in customer_obfuscated
  - date_of_birthstringoptional
    Customer’s date of birth (YYYY-MM-dd)
  - family_namestringoptional
    Customer’s family name
  - given_namestringoptional
    Customer’s given name
  - national_identification_numberstringoptional
    Customer’s national identity number
  - titlestringoptional
    Customer’s title
- expires_atstring · date-timeoptional
  Session identification expiry time (YYYY-MM-ddThh:mm:ss.fffZ)
order_idstringoptional
Order id of the payment session
session_idstringoptional
The id of the HPP Session
statusstringoptional
Current HPP Session status
- WAITING
- BACK
- IN_PROGRESS
- MANUAL_ID_CHECK
- COMPLETED
- CANCELLED
- FAILED
- DISABLED
- ERROR
updated_atstring · date-timeoptional
Latest status update time

401

Response0 fields

Unauthorized

No response body — this status returns headers only.

403

Response0 fields

You were not authorized to execute this operation.

No response body — this status returns headers only.

404

Response0 fields

HPP session has expired or could not be found by provided id.

No response body — this status returns headers only.

GET https://api.kustom.co/hpp/v1/sessions/{session_id}

Response 200· Session found

{
  "authorization_token": "70850a20-a2a0-5c70-810c-096fa6f850bb",
  "customer": {
    "date_of_birth": "1987-08-15",
    "family_name": "<string>",
    "given_name": "<string>",
    "national_identification_number": "19870815-84932",
    "title": "Mr"
  },
  "expires_at": "2038-01-19T03:14:07.000Z",
  "klarna_reference": "ffc25786",
  "manual_identification": {
    "challenge": "A78",
    "customer": {
      "date_of_birth": "1987-08-15",
      "family_name": "<string>",
      "given_name": "<string>",
      "national_identification_number": "19870815-84932",
      "title": "Mr"
    },
    "customer_obfuscated": {
      "date_of_birth": "1987-08-15",
      "family_name": "<string>",
      "given_name": "<string>",
      "national_identification_number": "19870815-84932",
      "title": "Mr"
    },
    "expires_at": "2038-01-19T03:14:07.000Z"
  },
  "order_id": "93d644a2-43f3-11e9-b210-d663bd873d93",
  "session_id": "a15b228c-02ad-11e9-8eb2-f2801f1b9fd1",
  "status": "COMPLETED",
  "updated_at": "2038-01-19T03:14:07.000Z"
}

34 lines

This page is also available as Markdown — append .md to its URL — and is indexed in llms.txt.