Create a hosted checkout session for a payment intent

POST

/v1/checkout-sessions

const session = await gp.checkoutSessions.create({ payment_intent_id: 'pi_…' });
// redirect the customer to session.url

• GRYPHEM PAY API

Honors Idempotency-Key (replays return the original response for 24 h).

Authorizations

• ApiKey
• Session

Parameters

Header Parameters

Gryphem-Organization

string

Active organization for dashboard sessions. Ignored for API keys (the key determines the organization).

Idempotency-Key

string

<= 255 characters

Unique key per logical create operation (max 255 chars). Replays return the original response; reuse with a different body returns idempotency_error.

Request Body^required

Media typeapplication/json

object

payment_intent_id

required

string

Example ^generated

{
  "payment_intent_id": "example"
}

Responses

201

New short-lived session for an open payment intent.

Media typeapplication/json

object

id

required

string

object

required

string

Allowed value: checkout_session

payment_intent_id

required

string

url

required

string format: uri

status

required

string

Allowed values: open complete expired

livemode

required

boolean

expires_at

required

string format: date-time

created_at

required

string format: date-time

Example

{
  "object": "checkout_session",
  "status": "open"
}

401

Missing or invalid credentials.

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

403

Authenticated but not permitted.

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

409

State conflict.

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

422

Validation failed.

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

429

Too many requests. See Retry-After.

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

Headers

Retry-After

integer