코드가 복사되었습니다.

인보이스

인보이스 생성

POST/api/v1/partner/merchants/{merchantId}/invoices

템플릿을 기반으로 새로운 인보이스(결제 링크)를 생성하고 발송합니다.
요청 파라미터
Path Parameters

merchantId string

필수
가맹점 ID입니다.
Request Body

templateId string

필수
사용할 템플릿 ID입니다.

currency string

필수
통화 코드(KRW, USD 등)입니다.

invoiceNumber string

인보이스 번호입니다. 기본값은 자동 생성됩니다.

expiryDays int

유효 기간(일)입니다. 기본값은 템플릿 설정값입니다.

options object* 옵션 설정입니다.

themeColor string

테마 색상입니다. 기본 값은 템플릿 설정값입니다. (DARK 또는 LIGHT)

isDomestic boolean

국내 결제 여부입니다. 기본 값은 true입니다.

includeTax boolean

세금 포함 여부입니다. 기본 값은 false입니다.

items array* 상품 목록입니다.

name string

필수
상품명입니다.

quantity int

필수
수량입니다. 최소 값은 1입니다.

unitPrice string

필수
단가입니다.

description string

상품 설명입니다.

recipient object* 수신자 정보입니다.

email object* 이메일 수신자입니다.

address string

필수
이메일 주소입니다.

name string

필수
수신자명입니다.

send boolean

발송 여부입니다. 기본 값은 true입니다.

sms object* SMS 수신자입니다.

address string

필수
전화번호입니다.

name string

필수
수신자명입니다.

countryCode string

필수
국가 코드입니다.

send boolean

발송 여부입니다. 기본 값은 false입니다.
요청 
                            
{
  "templateId": "ptmp_abc123",
  "currency": "KRW",
  "invoiceNumber": "INV-20240204-001",
  "items": [
    {
      "name": "프리미엄 서비스 구독",
      "quantity": 1,
      "unitPrice": "15000",
      "description": "1개월 이용권"
    }
  ],
  "recipient": {
    "email": {
      "address": "customer@example.com",
      "name": "홍길동",
      "send": true
    },
    "sms": {
      "address": "01012345678",
      "name": "홍길동",
      "countryCode": "82",
      "send": true
    }
  }
}
응답 파라미터

invoiceId string

필수
인보이스 ID입니다.

invoiceNumber string

필수
인보이스 번호입니다. 기본 값은 자동 생성됩니다.

status string

필수
인보이스 상태입니다. (PENDING)

paymentUrl string

필수
결제 링크 URL입니다.

totalAmount string

필수
총 결제 금액입니다.

currency string

필수
통화 코드(KRW, USD 등)입니다.

expiresAt string (ISO 8601)

필수
만료 일시입니다.

createdAt string (ISO 8601)

필수
생성 일시입니다.

delivery object* 발송 결과입니다.

email object* 이메일 발송 결과입니다.

recipient string

필수
수신 주소입니다.

status string

필수
발송 상태입니다.

sms array* SMS 발송 결과입니다.

recipient string

필수
수신 번호입니다.

status string

필수
발송 상태입니다.
응답 
                            
{
  "code": "CMN_0000",
  "data": {
    "invoiceId": "pinv_987654",
    "invoiceNumber": "INV-20240204-001",
    "status": "PENDING",
    "paymentUrl": "https://linkpay.eximbay.com/pay/...",
    "totalAmount": "15000",
    "currency": "KRW",
    "expiresAt": "2024-02-11T23:59:59",
    "createdAt": "2024-02-04T10:00:00",
    "delivery": {
      "email": [{"recipient": "customer@...", "status": "SENT"}],
      "sms": [{"recipient": "0101234...", "status": "SENT"}]
    }
  }
}

인보이스 상세 조회

GET/api/v1/partner/merchants/{merchantId}/invoices/{invoiceId}

생성된 인보이스의 상세 정보를 조회합니다.
요청 파라미터
Path Parameters

merchantId string

필수
가맹점 ID입니다.

invoiceId string

필수
인보이스 ID입니다.
요청 
                            
curl -X GET https://link.eximbay.com/api/v1/partner/merchants/{merchantId}/invoices/{invoiceId} \
-H "Authorization: Bearer eyJhbGciOi..."
응답 파라미터

invoiceId string

필수
인보이스 ID입니다.

invoiceNumber string

필수
인보이스 번호입니다. 기본 값은 자동 생성됩니다.

templateId string

필수
템플릿 ID입니다.

status string

필수
인보이스 상태입니다. (PENDING)

paymentUrl string

필수
결제 링크 URL입니다.

totalAmount string

필수
총 결제 금액입니다.

currency string

필수
통화 코드(KRW, USD 등)입니다.

expiresAt string (ISO 8601)

필수
만료 일시입니다.

createdAt string (ISO 8601)

필수
생성 일시입니다.

items array* 상품 목록입니다.

name string

필수
상품명입니다.

quantity int

필수
수량입니다.

unitPrice string

필수
단가입니다.

amount string

필수
소계 금액입니다.

delivery object* 발송 결과입니다.

email object* 이메일 발송 결과입니다.

recipient string

필수
수신 주소입니다.

status string

필수
발송 상태입니다.

sms array* SMS 발송 결과입니다.

recipient string

필수
수신 번호입니다.

status string

필수
발송 상태입니다.
응답 
                            
{
  "code": "CMN_0000",
  "data": {
    "invoiceId": "pinv_987654",
    "invoiceNumber": "INV-20240204-001",
    "templateId": "ptmp_abc123",
    "status": "COMPLETED",
    "paymentUrl": "https://linkpay.eximbay.com/pay/...",
    "totalAmount": "15000",
    "currency": "KRW",
    "expiresAt": "2026-02-11T23:59:59",
    "createdAt": "2026-02-04T10:00:00",
    "items": [
      {
        "name": "프리미엄 서비스 구독",
        "description": "1개월 이용권",
        "quantity": 1,
        "unitPrice": "15000",
        "amount": "15000"
      }
    ],
    "delivery": {
      "email": [{ "recipient": "customer@example.com", "status": "SENT" }],
      "sms": []
    }
  }
}