Function useCustomerPaymentInstrument

useCustomerPaymentInstrument(apiOptions, queryOptions?): UseQueryResult<CustomerPaymentInstrument, unknown>
Retrieves a customer's payment instrument by its ID.

Parameter
apiOptions - Options to pass through to commerce-sdk-isomorphic, with null accepted for unset API parameters.

Parameter
queryOptions - TanStack Query query options, with enabled by default set to check that all required API parameters have been set.

See
- Salesforce Developer Center for more information about the API endpoint.
- commerce-sdk-isomorphic documentation for more information on the parameters and returned data type.
- TanStack Query useQuery reference for more information about the return value.
Parameters
- apiOptions: NullableParameters<{
      headers?: {
          [key: string]: string;
      };
      parameters: { customerId: string; paymentInstrumentId: string; organizationId?: string | undefined; siteId?: string | undefined; };
  }>
- queryOptions: ApiQueryOptions<{
      (options?): Promise<CustomerPaymentInstrument>;
      <T>(options?, rawResponse?): Promise<T extends true
          ? Response
          : CustomerPaymentInstrument>;
  }> = {}
Returns UseQueryResult<CustomerPaymentInstrument, unknown>
A TanStack Query query hook with data from the Shopper Customers getCustomerPaymentInstrument endpoint.
- Defined in src/hooks/ShopperCustomers/query.ts:215