Skip to main content
GET
/
payment-profiles
List payment profiles for customer
curl --request GET \
  --url https://apiv2.example.com/payment-profiles \
  --header 'X-Api-Key: <api-key>'
{
  "items": [
    {
      "paymentProfileId": "d9f0b83a-8b0d-44a6-af7c-54b6b91b6040",
      "type": "CARD",
      "status": "ACTIVE",
      "customerId": "cust-123",
      "createdAt": "2024-01-15T10:00:00Z",
      "provider": "STRIPE",
      "displayName": "My credit card",
      "expiresAt": "2025-12-31",
      "billingDetails": {
        "name": "John Doe",
        "email": "[email protected]",
        "address": {
          "street1": "500 S Main St",
          "city": "Natick",
          "zip": "01701",
          "country": "US",
          "street2": "Apt 1",
          "state": "CA",
          "region": "<string>",
          "attention": "<string>"
        }
      },
      "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.

Query Parameters

​
customerId
string
required

Filter profiles for a specific customer.

Response

Payment profiles retrieved successfully.

​
items
object[]
required

List of saved payment profiles.