# Retrieve Hosted Payment Page Status
This endpoint allows merchants to inquire about the status of the hosted payment page session. The endpoint can return the following valid session states:
| State | Description |
|---|---|
| Pending | The session state is set to pending immediately after the HPP session is created |
| Processing | The session state changes to processing when the customer inputs their card details on the HPP and selects 'pay' |
| Used | Upon completion of the payment process by the customer, the session state is updated to used |
| Expired | If the HPP session is created, but not used (within 1hour), the session state is updated to expired |
# Retrieving a Hosted Payment Page session
Live
Sandbox
POST: https://api.openacquiring.com/v1/merchants/YOUR_MERCHANT_ID/hosted-payment/session/HOSTED_PAGE_SESSION_ID
Request example
- Shell
- JavaScript
curl -X GET \
https://api.openacquiring.com/v1/merchants/w3z8dfhkzvfq0j9n/hosted-payment/session/469d9a8b7f414d05939636f9e5dc5121 \
-H 'authorization: Basic ODZidWQ0Y2JremlxOXZmYzoweHI1ZDkwOHo2bmo4a2h6' \
-H 'content-type: application/json'
Response example
{
"session_id": "469d9a8b7f414d05939636f9e5dc5121",
"session_state": "pending"
}
# HTTP Status Codes
status 200
status 400
status 404
{
"session_id": "469d9a8b7f414d05939636f9e5dc5121",
"session_state": "pending"
}
# Session State example
Pending
Processing
Used
Expired
{
"session_id": "469d9a8b7f414d05939636f9e5dc5121",
"session_state": "pending"
}