> ## Documentation Index > Fetch the complete documentation index at: https://telnesstech-a0a16404.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Get payment profile > Retrieve details of a specific saved payment method by its identifier. ## OpenAPI ````yaml /api-reference/bundled_openapi.json get /payment-profiles/{paymentProfileId} openapi: 3.1.0 info: title: Telness Tech Connect version: 2.0.0-alpha description: > Telness Tech Connect API provides all you need to own your user's connectivity experience. Go back to [Telnesstech.com](https://telnesstech.com) servers: - url: https://apiv2.example.com description: Connect API URL for your domain security: - apiKey: [] - bearerAuth: [] apiKey: [] tags: - name: Auth description: Authenticate users and obtain access tokens. - name: Users description: Manage users. - name: Customers description: Manage customers. - name: Subscriptions description: Manage subscriptions and subscription. - name: Subscription Addons description: Manage subscription addons. - name: Subscription Usage description: Get subscription usage. - name: Subscribers description: Manage subscribers. - name: Licenses description: Manage licenses. - name: Product Offerings description: Browse product offerings. - name: Product Catalogs description: Browse product catalogs. - name: Product Discounts description: Discounts and promotions. - name: Orders description: Manage orders and line items. - name: Payment Intents description: >- Inspect payment intents, the money collected over card rails for orders and renewals. - name: Payment Links description: Create and manage payment links for orders and invoices. - name: Payment Sessions description: Create and manage payment sessions for orders. - name: Payment Profiles description: Manage customer payment profiles and methods. - name: Payment Profile Sessions description: Create sessions for setting up payment profiles. - name: Signing sessions description: Handle contract signing sessions for postpaid orders. - name: Porting description: Manage number porting for subscriptions. - name: Taxes description: Calculate taxes for products and line items. - name: Invoices description: Manage invoices and invoice items. - name: Tools description: >- Tools for address validation, number porting, device info, and network coverage. - name: Inventory description: Manage phone number inventory, SIM cards, and reservations. - name: Workflows description: Dynamic processing of customer journeys and events. paths: /payment-profiles/{paymentProfileId}: get: tags: - Payment Profiles summary: Get payment profile description: Retrieve details of a specific saved payment method by its identifier. operationId: getPaymentProfile parameters: - name: paymentProfileId in: path required: true schema: type: string description: The unique identifier of the payment profile to retrieve. example: e1f2a3b4-c5d6-7890-1234-f01234567890 responses: '200': description: Payment profile retrieved successfully content: application/json: schema: $ref: '#/components/schemas/PaymentProfile' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' components: schemas: PaymentProfile: type: object description: A saved payment method or mandate for future use. required: - paymentProfileId - type - status - customerId - createdAt additionalProperties: false properties: paymentProfileId: type: string description: Unique identifier for this payment profile. example: d9f0b83a-8b0d-44a6-af7c-54b6b91b6040 paymentProvider: $ref: '#/components/schemas/PaymentProvider' description: The payment provider for this payment profile. example: STRIPE type: $ref: '#/components/schemas/PaymentMethodType' description: Type of payment method. example: CARD status: $ref: '#/components/schemas/PaymentProfileStatus' description: Current status of the payment profile. example: ACTIVE customerId: type: string description: Customer who owns this payment profile. example: a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d displayName: type: string description: Human-readable name for this payment method. example: My credit card expiresAt: type: string format: date x-ogen-type: telnesstech.com/apiv2/apiv2types.Date description: When this payment profile expires (for cards). example: '2025-12-31' billingDetails: type: object description: Billing details associated with this payment method. additionalProperties: false properties: name: type: string description: Billing name. example: John Doe email: type: string format: email description: Billing email. example: john.doe@example.com address: $ref: '#/components/schemas/Address' createdAt: type: string format: date-time description: When this payment profile was created. example: '2024-01-15T10:00:00Z' metadata: $ref: '#/components/schemas/Metadata' PaymentProvider: type: string description: Payment service provider that processes the transaction. enum: - STRIPE - BILLOGRAM example: STRIPE PaymentMethodType: type: string description: > The kind of payment method, as reported by the payment provider. This is an open set of provider-defined values (for example "CARD", "SEPA_DEBIT", "SWISH", "VIPPS", "KLARNA", "PAYPAL") rather than a fixed enumeration, so new method types can appear without an API change. example: CARD PaymentProfileStatus: type: string description: Status of a saved payment profile. enum: - ACTIVE - INACTIVE - EXPIRED - REQUIRES_ACTION Address: type: object required: - street1 - city - zip - country properties: street1: type: string description: The first line of the address, typically street and house number. example: 500 S Main St street2: type: string description: >- The second line of the address, typically apartment, suite, unit, building, floor, etc. example: Apt 1 city: type: string description: The city or municipality of the address. example: Natick zip: type: string description: > 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'). example: '01701' country: type: string description: >- The two-letter country abbreviation (e.g., 'US' for United States, 'SE' for Sweden). pattern: ^[A-Z]{2}$ example: US state: type: string description: >- For countries that use states or regions, the state or administrative area code (e.g., 'CA' for California in the United States). example: CA region: type: string description: >- A province, region, or territory name, applicable in certain countries (e.g., 'Ontario' in Canada, 'Sindh' in Pakistan). attention: type: string description: >- An optional line for specifying a person, department, or attention to a specific entity within an address. Metadata: type: object additionalProperties: type: string description: > A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format. Error: type: object required: - message - code properties: message: type: string description: A human-readable message providing more details about the error. code: type: string description: A machine-readable code for the error. details: type: array description: Additional details about the error. items: type: object required: - message - code properties: message: type: string description: >- A human-readable message providing more details about the error. code: type: string description: A machine-readable code for the specific detail. property: type: string description: The property or field related to the error. suggestion: $ref: '#/components/schemas/Any' description: > A suggested value for the particular property. For example, this may be set when validating an address with an alias, suggesting the expected value by the operator. hint: type: string description: A hint to help resolve the error. Any: oneOf: - type: string - type: number - type: boolean - type: object additionalProperties: true - type: array responses: BadRequest: description: The request was malformed or invalid. content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: Authentication is required to access this resource. content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: Access to this resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: The requested resource was not found. content: application/json: schema: $ref: '#/components/schemas/Error' InternalServerError: description: An unexpected error occurred on the server. content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: apiKey: type: apiKey in: header name: X-Api-Key description: > An API key that grants access to the Connect API. You can create and manage API keys in the portal. bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Bearer authentication with JWT tokens is used to authenticate users. Do note that a valid API keys is also required to access the Connect API to prove that requests are made by a trusted party. Requests with a JWT token is scoped to the permissions of the user the token belongs to, regardless of the API key used. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.