Interface HostedcheckoutsClient

interface HostedcheckoutsClient {
    create(
        merchantId: string,
        postData: CreateHostedCheckoutRequest,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<CreateHostedCheckoutResponse, ErrorResponse>>;
    get(
        merchantId: string,
        hostedCheckoutId: string,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<GetHostedCheckoutResponse, ErrorResponse>>;
    remove(
        merchantId: string,
        hostedCheckoutId: string,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<void, ErrorResponse>>;
}

Index

Methods

create get remove

Methods

create

create(
    merchantId: string,
    postData: CreateHostedCheckoutRequest,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<CreateHostedCheckoutResponse, ErrorResponse>>
Resource /{merchantId}/hostedcheckouts - Create hosted checkout
Parameters
- merchantId: string
- postData: CreateHostedCheckoutRequest
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<CreateHostedCheckoutResponse, ErrorResponse>>

get

get(
    merchantId: string,
    hostedCheckoutId: string,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<GetHostedCheckoutResponse, ErrorResponse>>
Resource /{merchantId}/hostedcheckouts/{hostedCheckoutId} - Get hosted checkout status
Parameters
- merchantId: string
- hostedCheckoutId: string
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<GetHostedCheckoutResponse, ErrorResponse>>

remove

remove(
    merchantId: string,
    hostedCheckoutId: string,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<void, ErrorResponse>>
Resource /{merchantId}/hostedcheckouts/{hostedCheckoutId} - Delete hosted checkout
Parameters
- merchantId: string
- hostedCheckoutId: string
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<void, ErrorResponse>>