A valid request URL is required to generate request examples{
"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": {}
}
]
}List payment profiles for customer
List saved payment profiles for the customer.
A valid request URL is required to generate request examples{
"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
An API key that grants access to the Connect API. You can create and manage API keys in the portal.
Query Parameters
Filter profiles for a specific customer.
Response
Payment profiles retrieved successfully.
List of saved payment profiles.
Show child attributes
Show child attributes
Unique identifier for this payment profile.
"d9f0b83a-8b0d-44a6-af7c-54b6b91b6040"
Type of payment method.
"CARD"
Current status of the payment profile.
ACTIVE, INACTIVE, EXPIRED, REQUIRES_ACTION "ACTIVE"
Customer who owns this payment profile.
"cust-123"
When this payment profile was created.
"2024-01-15T10:00:00Z"
The payment provider for this payment profile.
"STRIPE"
Human-readable name for this payment method.
"My credit card"
When this payment profile expires (for cards).
"2025-12-31"
Billing details associated with this payment method.
Show child attributes
Show child attributes
Billing name.
"John Doe"
Billing email.
Show child attributes
Show child attributes
The first line of the address, typically street and house number.
"500 S Main St"
The city or municipality of the address.
"Natick"
The zip code of the address.
Depending on the country, this may be referred to as a postal code or postcode.
Specifically for US addresses, the zip can include the optional four-digit extension (e.g., '27604-5121').
"01701"
The two-letter country abbreviation (e.g., 'US' for United States, 'SE' for Sweden).
"US"
The second line of the address, typically apartment, suite, unit, building, floor, etc.
"Apt 1"
For countries that use states or regions, the state or administrative area code (e.g., 'CA' for California in the United States).
"CA"
A province, region, or territory name, applicable in certain countries (e.g., 'Ontario' in Canada, 'Sindh' in Pakistan).
An optional line for specifying a person, department, or attention to a specific entity within an address.