타입 별칭 PaymentFilterInput

PaymentFilterInput: {
    merchantId?: string;
    storeId?: string;
    timestampType?: PaymentTimestampType;
    from?: string;
    until?: string;
    status?: PaymentStatus[];
    methods?: PaymentMethodType[];
    pgProvider?: PgProvider[];
    isTest?: boolean;
    isScheduled?: boolean;
    sortBy?: PaymentSortBy;
    sortOrder?: SortOrder;
    version?: PortOneVersion;
    webhookStatus?: PaymentWebhookStatus;
    platformType?: PaymentClientType;
    currency?: Currency;
    isEscrow?: boolean;
    escrowStatus?: PaymentFilterInputEscrowStatus;
    cardBrand?: CardBrand;
    cardType?: CardType;
    cardOwnerType?: CardOwnerType;
    giftCertificateType?: PaymentMethodGiftCertificateType;
    cashReceiptType?: CashReceiptInputType;
    cashReceiptStatus?: PaymentCashReceiptStatus;
    cashReceiptIssuedAtRange?: DateTimeRange;
    cashReceiptCancelledAtRange?: DateTimeRange;
    textSearch?: PaymentTextSearch[];
}

결제 건 다건 조회를 위한 입력 정보

타입 선언

  • OptionalmerchantId?: string

    고객사 아이디

  • OptionalstoreId?: string

    상점 아이디

    Merchant 사용자만 사용가능하며, 지정되지 않은 경우 고객사 전체 결제 건을 조회합니다.

  • OptionaltimestampType?: PaymentTimestampType

    조회 기준 시점 유형

  • Optionalfrom?: string

    결제 요청/상태 승인 시점 범위의 시작

    값을 입력하지 않으면 end의 90일 전으로 설정됩니다.

  • Optionaluntil?: string

    결제 요청/상태 승인 시점 범위의 끝

    값을 입력하지 않으면 현재 시점으로 설정됩니다.

  • Optionalstatus?: PaymentStatus[]

    결제 상태 리스트

    값을 입력하지 않으면 결제상태 필터링이 적용되지 않습니다.

  • Optionalmethods?: PaymentMethodType[]

    결제수단 리스트

    값을 입력하지 않으면 결제수단 필터링이 적용되지 않습니다.

  • OptionalpgProvider?: PgProvider[]

    PG사 리스트

    값을 입력하지 않으면 결제대행사 필터링이 적용되지 않습니다.

  • OptionalisTest?: boolean

    테스트 결제 필터링

  • OptionalisScheduled?: boolean

    결제 예약 건 필터링

  • OptionalsortBy?: PaymentSortBy

    결제 건 정렬 기준

  • OptionalsortOrder?: SortOrder

    결제 건 정렬 방식

  • Optionalversion?: PortOneVersion

    포트원 버전

  • OptionalwebhookStatus?: PaymentWebhookStatus

    웹훅 상태

  • OptionalplatformType?: PaymentClientType

    플랫폼 유형

  • Optionalcurrency?: Currency

    통화

  • OptionalisEscrow?: boolean

    에스크로 결제 여부

  • OptionalescrowStatus?: PaymentFilterInputEscrowStatus

    에스크로 결제의 배송 정보 상태

  • OptionalcardBrand?: CardBrand

    카드 브랜드

  • OptionalcardType?: CardType

    카드 유형

  • OptionalcardOwnerType?: CardOwnerType

    카드 소유주 유형

  • OptionalgiftCertificateType?: PaymentMethodGiftCertificateType

    상품권 종류

  • OptionalcashReceiptType?: CashReceiptInputType

    현금영수증 유형

  • OptionalcashReceiptStatus?: PaymentCashReceiptStatus

    현금영수증 상태

  • OptionalcashReceiptIssuedAtRange?: DateTimeRange

    현금영수증 발급 시간 범위

  • OptionalcashReceiptCancelledAtRange?: DateTimeRange

    현금영수증 취소 시간 범위

  • OptionaltextSearch?: PaymentTextSearch[]

    통합 검색 리스트 필터

설정

필터