Skip to main content

Function: useRequestIban()

useRequestIban(params?: { mutation: MutationOptions<ResponseStatus, Error, RequestIbanPayload>; }): MutationResult<"requestIban", ResponseStatus, Error, RequestIbanPayload>

Create an IBAN for a specified address and chain. All incoming EUR payments will automatically be routed to the linked address on that chain. Any linked address can use this IBAN for outgoing payments.

Parameters​

ParameterTypeDescription
params?{ mutation: MutationOptions<ResponseStatus, Error, RequestIbanPayload>; }No required parameters.
params.mutation?MutationOptions<ResponseStatus, Error, RequestIbanPayload>See Tanstack Query - useMutation options.

Returns​

MutationResult<"requestIban", ResponseStatus, Error, RequestIbanPayload>

Example​

const {
   requestIban, // useMutation's `mutateAsync` property
   isPending,
   isError,
   error,
   status,
   ...moreUseMutationResults
} = useRequestIban();

See​

API Documentation}