본문으로 건너뛰기
페이싱크 개발자센터
Esc
↑↓이동↵열기⌘J미리보기
이 페이지에서

주문 목록 조회

GET /v1/invoices 로 내 계정의 주문 목록을 페이지 단위로 조회해요.

GET /v1/invoices

API 키가 속한 워크스페이스의 주문을 최신순으로 조회해요. 취소된 주문은 나오지 않아요. 결제 여부, 만료 여부, 만든 날짜로 거를 수 있어요. 계좌를 제한한 API 키로는 허용된 계좌의 주문만 나와요.

쿼리 파라미터

파라미터 타입 필수 설명
offset integer 예 건너뛸 항목 수예요. 0 이상이에요.
limit integer 예 가져올 항목 수예요. 1~100이에요.
search string 주문 ID나 주문번호(1043, #1043)가 같거나, 입금자명이나 이메일에 검색어가 들어간 주문을 찾아요. 대소문자를 구분하지 않아요. 숫자가 3자리 이상이면 전화번호에서도 찾고, 하이픈은 무시해요.
paid boolean true면 결제 완료된 주문, false면 결제 대기 주문만 조회해요.
expired boolean true면 만료된 주문, false면 만료 기간이 없거나 아직 만료되지 않은 주문만 조회해요.
dateAfter string 이 날짜(KST) 이후에 만든 주문만 조회해요. 그날도 포함해요. YYYY-MM-DD
dateBefore string 이 날짜(KST) 이전에 만든 주문만 조회해요. 그날도 포함해요. YYYY-MM-DD

결제 대기 중이고 아직 입금받을 수 있는 주문만 보려면 paid=false&expired=false를 함께 쓰세요.

요청 예시

curl "https://api.paysync.kr/v1/invoices?offset=0&limit=20&paid=true&dateAfter=2026-04-01" \
  -H "Authorization: Bearer $PAYSYNC_API_KEY"
const params = new URLSearchParams({ offset: "0", limit: "20", paid: "true", dateAfter: "2026-04-01" });
const res = await fetch(`https://api.paysync.kr/v1/invoices?${params}`, {
  headers: { Authorization: `Bearer ${process.env.PAYSYNC_API_KEY}` },
});
const { totalItems, data } = await res.json();
import os
import requests

res = requests.get(
    "https://api.paysync.kr/v1/invoices",
    headers={"Authorization": f"Bearer {os.environ['PAYSYNC_API_KEY']}"},
    params={"offset": 0, "limit": 20, "paid": "true", "dateAfter": "2026-04-01"},
)
print(res.json())

응답

data는 주문 객체 배열이고, totalItems는 조건에 맞는 전체 주문 수예요.

{
  "code": "OK",
  "totalItems": 57,
  "data": [
    {
      "id": "ivc_a1b2c3d4e5f6g7h8i9j0k1l2",
      "issuerId": "acc_x9y8z7w6v5u4t3s2r1q0p9o8",
      "bankAccountIds": [],
      "customer": {
        "name": "홍길동",
        "email": "hong@example.com",
        "phoneNumber": "01012345678"
      },
      "cashReceipt": null,
      "amount": 50000,
      "paid": true,
      "metadata": { "orderId": "ORDER-2026-0001" },
      "issuedAt": "2026-04-28T03:14:15.000+00:00",
      "expiresAt": "2026-04-29T03:14:15.000+00:00",
      "deletedAt": null
    }
  ]
}

오류

HTTP code 발생 조건
400 BAD_REQUEST 불리언이나 열거형 쿼리 값이 올바르지 않아요.
401 NOT_AUTHORIZED API 키가 없거나 올바르지 않아요.
403 LIMIT_EXCEEDS_MAXIMUM limit이 100을 넘어요.
422 INVALID_OFFSET offset이 없거나 0보다 작아요.
422 INVALID_LIMIT limit이 없거나 0 이하예요.
422 INVALID_DATE_RANGE_FORMAT dateAfter나 dateBefore가 YYYY-MM-DD 형식이 아니에요.

이 페이지가 도움이 되었나요?