リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET、POST	/discount/getCreditHistoryList

リクエストヘッダ

NAVERクラウドプラットフォームで共通して使用されるヘッダの詳細は、Ncloud APIの共通ヘッダをご参照ください。

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	Optional	ページ番号
`pageSize`	Integer	Optional	ページサイズ 1,000以下(デフォルト: 1,000)
`discountNoList.N`	List<String>	Optional	照会対象のクレジット番号未入力時、全クレジット使用履歴を返すクレジット番号はgetDiscountListアクションを通じて確認
`isOrganization`	Boolean	Optional	Organizationサービスアカウントの統合照会かどうかマスターのみ使用可能 `isOrganization`、`isPartner`のいずれも`true`の場合、エラーを返す
`isPartner`	Boolean	Optional	パートナーアカウントの照会かどうかパートナー代表のみ使用可能 `isOrganization`、`isPartner`のいずれも`true`の場合、エラーを返す
`memberNoList`	List<String>	Optional	会員番号リストマスターまたはパートナー代表のみ使用可能
`startMonth`	String	Optional	照会開始月(yyyyMM) <例> 202401
`endMonth`	String	Optional	照会最終月(yyyyMM) <例> 202403
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location  --request GET 'https://billingapi.apigw.ntruss.com/billing/v1/discount/getCreditHistoryList?discountNoList.1=793&discountNoList.2=68' \
--header 'x-ncp-apigw-timestamp: {timestamp}' \
--header 'x-ncp-iam-access-key: {access key}' \
--header 'x-ncp-apigw-signature-v2: {signature}' \

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、CreditHistoryListをご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

<?xml version="1.0" encoding="UTF-8"?>
<getCreditHistoryList>
  <requestId>a78f6d1b-****-****-****-50966324f793</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <creditHistoryList>
    <creditHistory>
      <memberNo>1***9</memberNo>
      <credit>
        <discountNo>6383</discountNo>
        <creditName>credit-discount-test</creditName>
        <receivedCredit>30000</receivedCredit>
        <remainingCredit>0</remainingCredit>
        <validityStartMonth>202212</validityStartMonth>
        <validityEndMonth>202212</validityEndMonth>
        <creditType>
          <code>FCHG</code>
          <codeName>Fee-Charging</codeName>
        </creditType>
        <eligibleProductDemandTypeList>
          <productDemandType>
            <code>SCMTR</code>
            <codeName>Security Monitoring</codeName>
            <regionCode>KR</regionCode>
          </productDemandType>
          <productDemandType>
            <code>GDNS</code>
            <codeName>Global DNS</codeName>
            <regionCode>COM</regionCode>
          </productDemandType>
        </eligibleProductDemandTypeList>
        <payCurrency>
          <code>KRW</code>
          <codeName>South Korea Won</codeName>
        </payCurrency>
      </credit>
      <creditUseHistory>
        <creditUseHistory>
          <useMonth>202212</useMonth>
          <productDemandTypeCode>SCMTR</productDemandTypeCode>
          <productDemandType>
            <code>SCMTR</code>
            <codeName>Security Monitoring</codeName>
            <regionCode>KR</regionCode>
          </productDemandType>
          <unusedCredit>30000</unusedCredit>
          <usedCredit>30000</usedCredit>
          <remainingCredit>0</remainingCredit>
        </creditUseHistory>
      </creditUseHistory>
    </creditHistory>
  </creditHistoryList>
</getCreditHistoryList>

この記事は役に立ちましたか?

リクエスト
レスポンス

タグ

Discount