@bootpay/backend-js/dist/lib/response.d.ts

Bootpay Server Side Package for Node.js

export interface AccessTokenResponseParameters {
    expire_in: number;
    access_token: string;
}
export interface ReceiptResponseParameters {
    receipt_id: string;
    order_id: string;
    price: number;
    tax_free: number;
    cancelled_price: number;
    cancelled_tax_free: number;
    order_name: string;
    company_name: string;
    gateway_url: string;
    metadata: string;
    sandbox: boolean;
    pg: string;
    method: string;
    method_symbol: string;
    method_origin: string;
    method_origin_symbol: string;
    purchased_at?: Date;
    requested_at: Date;
    cancelled_at?: Date;
    status: number;
    status_locale: string;
    receipt_url?: string;
    card_data?: CardData;
    phone_data?: PhoneData;
    bank_data?: BankData;
    vbank_data?: BankData;
    escrow_data?: EscrowData;
    cash_receipt_data?: CashReceiptData;
    naver_point_data?: NaverPointData;
    kakao_moneny_data?: KakaoMoneyData;
    payco_point_data?: PaycoPointData;
    toss_point_data?: TossPointData;
    currency?: string;
}
export interface ExtraModel {
    subscribe_test_payment: boolean;
}
export interface UserModel {
    id?: string;
    username?: string;
    phone?: string;
    email?: string;
}
export interface CompanyModel {
    name?: string;
    phone?: string;
    zipcode?: string;
    addr1?: string;
    addr2?: string;
}
export interface ItemModel {
    id?: string;
    name?: string;
    qty?: number;
    price?: number;
}
export interface BillingData {
    card_no: string;
    card_company: string;
    card_company_code: string;
    card_type: number;
    card_hash?: string;
    rtn_key_info?: string;
}
export interface CardData {
    tid: string;
    card_approve_no: string;
    card_no: string;
    card_quota: string;
    card_company_code: string;
    card_company: string;
    card_interest: string;
    receipt_url?: string;
    card_type?: string;
    card_owner_type?: string;
    point?: number;
}
export interface PhoneData {
    tid: string;
    auth_no?: string;
    phone?: string;
    receipt_url?: string;
}
export interface BankData {
    tid: string;
    bank_code: string;
    bank_name: string;
    bank_username: string;
    bank_account?: string;
    sender_name?: string;
    expired_at?: Date;
    cash_receipt_tid?: string;
    cash_receipt_type?: string;
    cash_receipt_no?: string;
    receipt_url?: string;
}
export interface EscrowData {
    status: number;
    status_locale: string;
    shipping_started_at: Date;
    receipt_confirmed_at: Date | null;
}
export interface CashReceiptData {
    tid?: string;
    cash_receipt_type?: number;
    cash_receipt_no?: string;
    receipt_url?: string;
}
export interface KakaoMoneyData {
    tid?: string;
}
export interface NaverPointData {
    tid?: string;
}
export interface PaycoPointData {
    tid?: string;
}
export interface TossPointData {
    tid?: string;
}
export interface CancelPaymentParameters {
    receipt_id: string;
    cancel_price?: number;
    cancel_tax_free?: number;
    cancel_id?: string;
    cancel_username?: string;
    cancel_message?: string;
    refund?: Refund;
}
export interface Refund {
    bank_account: string;
    bank_username: string;
    bank_code: string;
}
export interface CertificateResponseParameters {
    receipt_id: string;
    authenticate_id: string;
    pg: string;
    method: string;
    method_origin: string;
    method_origin_symbol: string;
    authenticated_at: Date;
    requested_at: Date;
    status: number;
    status_locale: string;
    authenticate_data: AuthenticateData;
}
export interface AuthenticateData {
    name?: string;
    phone?: string;
    unique?: string;
    birth?: Date;
    gender?: number;
    foreigner?: number;
    carrier?: string;
    number_of_realarms?: number;
    tid: string;
}
export interface SubscriptionBillingRequestParameters {
    pg: string;
    method?: string;
    order_name: string;
    subscription_id: string;
    card_no: string;
    card_pw: string;
    card_identity_no: string;
    card_expire_year: string;
    card_expire_month: string;
    price?: number;
    tax_free?: number;
    extra: ExtraModel;
    user: UserModel;
    metadata?: object;
}
export interface SubscriptionBillingTransferRequestParameters {
    pg: string;
    method?: string;
    order_name: string;
    subscription_id: string;
    auth_type: 'ARS' | '간편인증';
    username: string;
    bank_name: string;
    bank_account: string;
    identity_no: string;
    cash_receipt_type?: '소득공제' | '지출증빙';
    cash_receipt_identity_no?: string;
    phone?: string;
    price?: number;
    tax_free?: number;
    extra: ExtraModel;
    user: UserModel;
    metadata?: object;
}
export interface SubscriptionBillingResponseParameters {
    billing_key: string;
    billing_data: BillingData;
    receipt_id: string;
    subscription_id: string;
    gateway_url?: string;
    metadata: object;
    pg: string;
    method: string;
    method_origin?: string;
    method_origin_symbol?: string;
    method_symbol?: string;
    published_at: Date;
    requested_at: Date;
    receipt_data: ReceiptResponseParameters;
    billing_expire_at: Date;
    status: number;
    status_locale?: string;
}
export interface SubscriptionCardPaymentRequestParameters {
    billing_key: string;
    order_name: string;
    price: number;
    tax_free?: number;
    card_quota?: string;
    card_interest?: string;
    order_id: string;
    feedback_url?: string;
    content_type?: string;
    metadata?: any;
    items?: Array<ItemModel>;
    user?: UserModel;
    extra?: ExtraModel;
}
export interface SubscriptionPaymentRequestParameters {
    billing_key: string;
    order_name: string;
    price: number;
    tax_free?: number;
    card_quota?: string;
    card_interest?: string;
    order_id: string;
    feedback_url?: string;
    content_type?: string;
    metadata?: any;
    items?: Array<ItemModel>;
    user?: UserModel;
    extra?: ExtraModel;
}
export interface DestroySubscribeResponseParameters {
    billing_key: string;
}
export interface UserTokenRequestParameters {
    user_id: string;
    email?: string;
    username?: string;
    gender?: number;
    birth?: string;
    phone?: string;
}
export interface UserTokenResponseParameters {
    user_token: string;
    expired_at: Date;
}
export interface SubscribePaymentReserveParameters {
    billing_key: string;
    order_name: string;
    price: number;
    tax_free?: number;
    order_id: string;
    reserve_execute_at: Date;
    user?: UserModel;
    items?: ItemModel;
    metadata?: any;
    feedback_url?: string;
    content_type?: 'application/json' | 'application/x-www-form-urlencoded';
}
export interface ShippingRequestParameters {
    receipt_id: string;
    receipt_url: string;
    tracking_number: string;
    delivery_corp: string;
    shipping_prepayment?: boolean;
    shipping_day?: number;
    user?: UserModel;
    company?: CompanyModel;
}
export interface SubscribePaymentReserveResponse {
    reserve_id: string;
    reserve_execute_at: Date;
}
export interface CancelSubscribeReserveResponse {
    reserve_id: string;
    success: boolean;
}
export interface CashReceiptPublishOnReceiptParameters {
    receipt_id: string;
    username?: string;
    email?: string;
    phone?: string;
    identity_no: string;
    cash_receipt_type: '소득공제' | '지출증빙';
    currency?: string;
}
export interface CashReceiptCancelOnReceiptParameters {
    receipt_id: string;
    cancel_username?: string;
    cancel_message?: string;
}
export interface RequestCashReceiptParameters {
    pg: string;
    price: number;
    tax_free?: number;
    order_name: string;
    cash_receipt_type: '소득공제' | '지출증빙';
    identity_no: string;
    purchased_at?: Date;
    order_id: string;
    user?: UserModel;
    extra?: ExtraModel;
}
export interface CancelCashReceiptParameters {
    receipt_id: string;
    cancel_username?: string;
    cancel_message?: string;
}
export interface RequestAuthenticateParameters {
    authentication_id: string;
    pg: string;
    method: string;
    username: string;
    identity_no: string;
    carrier: string;
    phone: string;
    client_ip: string;
    site_url?: string;
    authenticate_type?: 'sms' | 'pass';
    order_name: string;
    extra?: ExtraModel;
    user?: UserModel;
    metadata?: object;
}
export interface SubscribePaymentLookupResponse {
    reserve_id: string;
    receipt_id?: string;
    order_id: string;
    price: number;
    tax_free: number;
    order_name: string;
    user: UserModel;
    feedback_url: string;
    metadata?: any;
    content_type: 'application/json' | 'application/x-www-form-urlencoded';
    version: number;
    extra: ExtraModel;
    reserve_requested_at: string;
    reserve_execute_at: string;
    reserve_started_at: string;
    reserve_finished_at: string;
    reserve_revoked_at: string;
    status: number;
}
export interface WalletRequestParameters {
    user_id: string;
    order_name: string;
    price: number;
    tax_free?: number;
    order_id: string;
    webhook_url?: string;
    content_type?: 'application/json' | 'application/x-www-form-urlencoded';
    items?: ItemModel;
    user?: UserModel;
    extra?: ExtraModel;
    metadata?: object;
    sandbox: boolean;
}
export interface WalletPaymentResponseParameters {
    cancelled_price: number;
    wallet_data: WalletData;
    metadata: Record<string, any>;
    cancelled_tax_free: number;
    method: string;
    card_data: CardData;
    sandbox: boolean;
    receipt_id: string;
    method_origin: string;
    order_name: string;
    method_origin_symbol: string;
    receipt_url: string;
    method_symbol: string;
    purchased_at: string;
    tax_free: number;
    price: number;
    company_name: string;
    pg: string;
    status_locale: string;
    currency: string;
    http_status: number;
    order_id: string;
    requested_at: string;
    status: number;
}
export interface WalletData {
    success: WalletDataPart;
    failure: any[];
}
export interface WalletDataPart {
    wallet_id: string;
    type: number;
    sandbox: number;
    order: number;
    payment_status: number;
    batch_data: BatchData;
    card_code: string;
    expired_at: string;
    latest_purchased_at: string;
}
export interface BatchData {
    card_no: string;
    card_company: string;
    card_company_code: string;
    card_type: number;
    card_hash: string;
}
export interface CardData {
    tid: string;
    card_approve_no: string;
    card_no: string;
    card_quota: string;
    card_company_code: string;
    card_company: string;
    card_type?: string;
}