Skip to content
Proxy Developer Docs

/proxy_sessions/{id}

GET
/proxy_sessions/{id}
curl --request GET \
  --url https://example.com/proxy_sessions/example

Retrieves a payer-safe Proxy session using a publishable key.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
string
/^psess_/

Query Parameters

Section titled “ Query Parameters ”
pk
string

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Default Response

Media typeapplication/json
object
actionable_next_step
required
string
Allowed values: prepare_provider continue_payment already_paid merchant_action_required unavailable
amount_minor
required
integer
<= 2147483647
completed_acquisition_attempt_id
required
null | string
currency
required
string
/^[a-z]{3}$/
current_acquisition_attempt
required
object
attempt_number
required
integer
>= 1
checkout_ui_mode
required
null | string
id
required
string
/^pspacq_/
integration_path
required
string
status
required
string
status_reason
required
null | string
expires_at
required
string
final
required
object
amount_minor
required
integer
<= 2147483647
currency
required
string
/^[a-z]{3}$/
finalized_at
required
string
id
required
string
/^psess_/
integration_mode
required
string
latest_quote
required
object
amount_minor
required
integer
<= 2147483647
currency
required
string
/^[a-z]{3}$/
observed_at
required
string
merchant
required
object
name
required
string
presentation_state
required
string
Allowed values: checkout_available already_paid action_required unavailable
pricing_mode
required
string
Allowed values: fixed provider_finalized
status
required
string
requested
required
object
amount_minor
required
integer
<= 2147483647
currency
required
string
/^[a-z]{3}$/
Example
{
  "actionable_next_step": "prepare_provider",
  "presentation_state": "checkout_available",
  "pricing_mode": "fixed"
}

400

Section titled “ 400 ”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
request_id
required
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}

401

Section titled “ 401 ”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
request_id
required
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}

404

Section titled “ 404 ”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
request_id
required
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}

500

Section titled “ 500 ”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
request_id
required
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}