@coin-voyage/paykit
Version:
Seamless crypto payments. Onboard users from any chain, any coin into your app with one click.
18 lines (17 loc) • 754 B
TypeScript
import type { PaymentStatus } from "../types";
/** Returns the current payment, or undefined if there is none.
*
* Status values:
* - `payment_pending` - the user has not paid yet
* - `payment_started` - the user has paid & payment is in progress. This status
* typically lasts a few seconds.
* - `payment_completed` - the final call or transfer succeeded
* - `payment_bounced` - the final call or transfer reverted. Funds were sent
* - `payment_expired` - the payment expired before the user paid
* - `payment_failed` - the payment failed for some reason
* to the payment's configured refund address on the destination chain.
*/
export declare function usePayStatus(): {
paymentId: string;
status: PaymentStatus;
} | undefined;