getCoinHistoryList

Prev Next

Classic/VPC環境で利用できます。

アカウントに付与されたコインの状況と使用履歴を照会します。

リクエスト

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

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

リクエストヘッダ

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.N List<String> Optional 会員番号リスト
  • マスターまたはパートナー代表のみ使用可能
responseFormatType String Optional レスポンス結果の形式タイプ
  • xml(デフォルト) | json

リクエスト例

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

curl --location  --request GET 'https://billingapi.apigw.ntruss.com/billing/v1/discount/getCoinHistoryList' \
--header 'x-ncp-apigw-timestamp: {timestamp}' \
--header 'x-ncp-iam-access-key: {access key}' \
--header 'x-ncp-apigw-signature-v2: {signature}' \

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

<?xml version="1.0" encoding="UTF-8"?>
<getCoinHistoryList>
<requestId>103****-****-****-****-****6563ca0b</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>2</totalRows>
<coinHistoryList>
<coinHistory>
<memberNo>******</memberNo>
<coin>
<discountNo>54</discountNo>
<coinChagedNo>42</coinChagedNo>
<coinName>銀行振込(農協)</coinName>
<coinType>
<code>COIN</code>
<codeName>Common Coin</codeName>
</coinType>
<chargedCoin>100000</chargedCoin>
<remainingCoin>100000</remainingCoin>
<coinStatus>
<code>NOML</code>
<codeName>Normal</codeName>
</coinStatus>
<isShareCoin>false</isShareCoin>
        <validityStartMonth>202007</validityStartMonth>
<validityEndMonth>202307</validityEndMonth>
        <shareCoinSnapshotList/>  
</coin>
<coinUseHistory/>
</coinHistory>
<coinHistory>
<memberNo>******</memberNo>
<coin>
<discountNo>55</discountNo>
<coinChagedNo>42</coinChagedNo>
<coinName>銀行振込(農協)</coinName>
<coinType>
<code>BONUS</code>
<codeName>Bonus Coing</codeName>
</coinType>
<chargedCoin>1500</chargedCoin>
<remainingCoin>1500</remainingCoin>
<coinStatus>
<code>RFNDSS</code>
<codeName>Refund Success</codeName>
</coinStatus>
<isShareCoin>false</isShareCoin>  
        <validityStartMonth>202007</validityStartMonth>
<validityEndMonth>202107</validityEndMonth>
        <shareCoinSnapshotList/> 
</coin>
<coinUseHistory/>
</coinHistory>
</coinHistoryList>
</getCoinHistoryList>