Path parameters

• paymentMethodId string(uuid) Required

  The unique identifier of the payment method to retrieve.

Query parameters

• userId string(uuid)

  The unique identifier of the user to retrieve the payment method for.

Responses

• 200 application/json

  The payment method was successfully retrieved.

  Hide response attribute Show response attribute object

  • data object Required

    The user payment method that was retrieved.

    Hide data attributes Show data attributes object

    • createdAt string(date-time) Required

      The date and time when the payment method was created.

    • expiresAt string(date-time) | null Required

      The date and time when the payment method will expire.

    • icons object Required

      The icons to use for this payment method.

      Hide icons attributes Show icons attributes object

      • dark string(uri) | null Required

        An optional URL of the dark theme icon for the payment method.

      • default string(uri) Required

        The URL of the default icon for the payment method.

    • id string(uuid) Required

      The unique identifier for the payment method.

    • implicit boolean Required

      A boolean indicating whether the payment method is implicit. Implicit payment methods are not onboarded by the user but rather the system during authorization.

    • kind string Required

      The kind of the payment method.

    • label string Required

      The localized label of the payment method kind.

    • lastUsedAt string(date-time) | null Required

      The date and time when the payment method was last used to capture a payment transaction.

    • metadata object | null Required

      An optional object containing additional metadata for the payment method.

      Additional properties are allowed.

    • name string Required

      A human-readable name for the payment method.

    • onboardingId string(uuid) | null Required

      The unique identifier of the onboarding through which the payment method was created. This is null if the payment method was not created through an onboarding process.

    • proxy boolean Required

      A boolean indicating whether the payment method is a proxy payment method.

    • shareCount integer Required

      The number of shares for the payment method with other users.

      Minimum value is 0.

    • shared boolean Required

      A boolean indicating whether the payment method is shared by other user.

    • updatedAt string(date-time) Required

      The date and time when the payment method was last updated.

    • userId string(uuid) Required

      The unique identifier of the user associated with the payment method.

• 401

  Client authentication failed.

• 403

  Missing one or more required scopes.

• 404

  The payment method was not found.

• 500

  An internal server error occurred.