Skip to main content
GET
/
payment-profiles
/
sessions
/
{paymentProfileSessionId}
{
  "paymentProfileSessionId": "69321a62-f1fe-461f-8761-a19ae6587bb2",
  "orderId": "44567801-a504-4f09-8089-31ea78bc239b",
  "paymentProvider": "STRIPE",
  "status": "PENDING",
  "providers": {
    "stripe": {
      "clientSecret": "seti_1234_secret_abcd",
      "publishableKey": "pk_test_1234567890abcdef",
      "setupIntentId": "seti_1234567890abcdef"
    }
  },
  "metadata": {
    "source": "mobile_app",
    "campaign": "summer_2024"
  },
  "createdAt": "2024-09-29T10:00:00Z",
  "updatedAt": "2024-09-29T10:30:00Z"
}

Authorizations

​
X-API-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Path Parameters

​
paymentProfileSessionId
string
required

The unique identifier of the payment profile session to retrieve.

Response

Payment profile session retrieved successfully

A payment profile session that wraps the process of setting up and saving a payment method for future use.

​
paymentProfileSessionId
string
required

The unique identifier for this payment profile session.

Example:

"69321a62-f1fe-461f-8761-a19ae6587bb2"

​
orderId
string
required

The unique identifier of the order this payment profile session is associated with.

Example:

"44567801-a504-4f09-8089-31ea78bc239b"

​
paymentProvider
string
required

Payment service provider for processing transactions.

Example:

"STRIPE"

​
status
enum<string>
required

Current status of a payment profile session lifecycle.

Available options:
PENDING,
REQUIRES_ACTION,
COMPLETED,
FAILED
Example:

"PENDING"

​
providers
object
required

Payment provider-specific configurations for widget rendering.

​
metadata
object
required

Custom key-value pairs for additional payment profile session information.

Example:
{
  "source": "mobile_app",
  "campaign": "summer_2024"
}
​
createdAt
string<date-time>
required

When this payment profile session was created.

Example:

"2024-09-29T10:00:00Z"

​
updatedAt
string<date-time>
required

When this payment profile session was last updated.

Example:

"2024-09-29T10:30:00Z"

⌘I