@adyen/kyc-components
Version:
This guide assumes that you have already an account with Adyen. A legalEntity needs to be created, and you need to have a `legalEntityId` to instatiate a Component.
15 lines (14 loc) • 775 B
TypeScript
import { skipToken } from '@tanstack/preact-query';
import type { ExistingTransferInstrument } from '../../core/models/api/transfer-instrument';
import type { QueryOptions } from '../types';
/**
* Variables:
* * `transferInstrumentId`
*/
export type QueryKeyTransferInstrument = ['transferInstrument', string];
/**
* Gets a single transfer instrument associated with a legal entity
* @param transferInstrumentId ID of transfer instrument
* @param options additional options passed to Tanstack Query, eg; refetchInterval for polling
*/
export declare const useTransferInstrument: (transferInstrumentId: string | typeof skipToken, options?: QueryOptions<ExistingTransferInstrument>) => import("@tanstack/preact-query").UseQueryResult<ExistingTransferInstrument, Error>;