링크페이 목록

발행한 링크페이 목록을 조회해요. product_type 을 빼면 비어요.

생성된 링크페이 목록을 조건에 맞게 검색하고 조회해요. 생성일, 결제 상태, 고객 정보 등 다양한 조건으로 필터링이 가능해요.

API 엔드포인트

GEThttps://api.bootapi.com/v1/invoicesBasic Auth

요청 파라미터

파라미터	타입	필수	설명
`keyword`	String	선택	검색어 — 청구서명·청구서 ID·고객 이름·전화번호·이메일에서 중간 글자로도 찾아요
`user_id`	String	선택	특정 고객의 링크페이만 조회
`product_type`	Integer	선택	상품 유형 필터 (기본 0) — `1` 금액만 청구 · `2` 단일 상품 · `3` 여러 상품·금액 항목
`cs_type`	String	선택	검색 일 유형 (`c_at` 생성일 · `s_at` 발송일 · `p_at` 결제일). 생략하면 날짜로 거르지 않아요
`css_at`	String	선택	검색 시작일 (YYYY-MM-DD)
`cse_at`	String	선택	검색 종료일 (YYYY-MM-DD)
`page`	Integer	선택	페이지 번호 (기본값: 1)
`limit`	Integer	선택	페이지당 데이터 수 (기본값: 24)

지금은 product_type 을 생략하면 기본값 0 으로 거르는데, 0 인 링크페이가 없어서 항상 빈 목록이 와요. API 로 만든 링크페이는 1 이니, 당장은 product_type=1 을 넣어 조회하고 필요하면 2·3 도 따로 불러요.

코드 예제

const { BootpayCommerce } = require('@bootpay/backend-js');

const commerce = new BootpayCommerce({
    client_key: '{client_key}',
    secret_key: '{secret_key}'
});

const response = await commerce.invoice.list({
    page: 1,
    limit: 20
});
console.log(response);javascript

from bootpay_backend.commerce import BootpayCommerce

commerce = BootpayCommerce('{client_key}', '{secret_key}')
response = commerce.invoice_list({
    'page': 1,
    'limit': 20
})
print(response)python

use Bootpay\ServerPhp\BootpayCommerceApi;

$commerce = new BootpayCommerceApi("{client_key}", "{secret_key}");
$response = $commerce->invoice->list([
    'page' => 1,
    'limit' => 20
]);
print_r($response);php

import kr.co.bootpay.store.BootpayStore;
import kr.co.bootpay.store.model.request.TokenPayload;
import kr.co.bootpay.store.model.request.invoice.InvoiceListParams;
import kr.co.bootpay.store.model.response.BootpayStoreResponse;

TokenPayload tokenPayload = new TokenPayload("{client_key}", "{secret_key}");
BootpayStore commerce = new BootpayStore(tokenPayload).withToken();

InvoiceListParams params = new InvoiceListParams();
params.page = 1;
params.limit = 20;

BootpayStoreResponse response = commerce.invoice.list(params);
System.out.println(response.getData());java

require 'bootpay'

commerce = BootpayStore::RestClient.new(client_key: '{client_key}', secret_key: '{secret_key}')
response = commerce.invoice_list(
  page: 1,
  limit: 20
)
puts responseruby

commerce := bootpay.NewCommerceApi("{client_key}", "{secret_key}")
response, err := commerce.Invoice.List(map[string]interface{}{
    "page": 1,
    "limit": 20,
})
fmt.Println(response)go

using Bootpay.Commerce;

var commerce = new BootpayCommerceApi("{client_key}", "{secret_key}");
var response = await commerce.Invoice.List(new {
    page = 1,
    limit = 20
});
Console.WriteLine(response);csharp

링크페이 상태 (`status`)

목록 응답의 status 는 아래 값(숫자)으로 와요. 링크페이 상세는 키(문자열)로 와요.

키	값	설명
`invoice_available`	`1`	결제 가능 (링크 생성 후 결제 대기)
`invoice_order_completed`	`2`	주문 완료
`invoice_order_cancelled`	`3`	주문 취소
`invoice_deleted`	`-1`	판매자가 삭제
`invoice_expired`	`-2`	유효기간이 지난 링크
`invoice_product_unavailable`	`-3`	판매 불가 상품이 포함됨
`invoice_abandoned`	`-10`	고객이 결제하지 않고 이탈

응답

성공 응답

{
  "count": 45,
  "status_counts": {
    "waiting": 12,
    "paid": 30,
    "unpaid": 3
  },
  "list": [
    {
      "invoice_id": "687a1b2c3d4e5f6789012345",
      "name": "프리미엄 서비스 결제",
      "price": 50000,
      "status": 1,
      "invoice_url": "https://i.bootpay.co.kr/i/{client_key}/687a1b2c3d4e5f6789012345",
      "expired_at": "2025-07-18 00:00:00",
      "c_at": "2025-07-11T11:52:09+09:00"
    }
  ]
}json

status_counts 는 상태별 건수예요 — waiting 결제 가능, paid 주문 완료, unpaid 기간 만료+이탈. user_id 로 조회하면 user 에 그 고객 정보가 함께 와요.

API 엔드포인트

요청 파라미터

코드 예제

링크페이 상태 (status)

응답

성공 응답

링크페이 상태 (`status`)