Skip to main content
GET
/
payment-profiles
/
{paymentProfileId}
{
  "paymentProfileId": "d9f0b83a-8b0d-44a6-af7c-54b6b91b6040",
  "provider": "STRIPE",
  "type": "CARD",
  "status": "ACTIVE",
  "customerId": "cust-123",
  "displayName": "My credit card",
  "expiresAt": "2025-12-31",
  "billingDetails": {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "address": {
      "street1": "500 S Main St",
      "street2": "Apt 1",
      "city": "Natick",
      "zip": "01701",
      "country": "US",
      "state": "CA",
      "region": "<string>",
      "attention": "<string>"
    }
  },
  "createdAt": "2024-01-15T10:00:00Z",
  "metadata": {}
}

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

​
paymentProfileId
string
required

The unique identifier of the payment profile to retrieve.

Response

Payment profile retrieved successfully

A saved payment method or mandate for future use.

​
paymentProfileId
string
required

Unique identifier for this payment profile.

Example:

"d9f0b83a-8b0d-44a6-af7c-54b6b91b6040"

​
type
string
required

Type of payment method.

Example:

"CARD"

​
status
enum<string>
required

Current status of the payment profile.

Available options:
ACTIVE,
INACTIVE,
EXPIRED,
REQUIRES_ACTION
​
customerId
string
required

Customer who owns this payment profile.

Example:

"cust-123"

​
createdAt
string<date-time>
required

When this payment profile was created.

Example:

"2024-01-15T10:00:00Z"

​
provider
string

The payment provider for this payment profile.

Example:

"STRIPE"

​
displayName
string

Human-readable name for this payment method.

Example:

"My credit card"

​
expiresAt
string<date>

When this payment profile expires (for cards).

Example:

"2025-12-31"

​
billingDetails
object

Billing details associated with this payment method.

​
metadata
object

A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.

⌘I