getCoinHistoryList

Available in Classic and VPC

View the status and usage history of coins granted to an account.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
GET, POST	/discount/getCoinHistoryList

Request headers

For headers common to NAVER Cloud Platform, see Common Ncloud API headers.

Request query parameters

The following describes the parameters.

Field	Type	Required	Description
`pageNo`	Integer	Optional	Page number
`pageSize`	Integer	Optional	Page size 1000 or less (default: 1000)
`discountNoList.N`	List<String>	Optional	Coin number to view Full coin usage history response if not entered Check the coin number through the getDiscountList action
`isOrganization`	Boolean	Optional	Whether to view consolidated usage for organization service accounts Available to masters only An error is returned if both `isOrganization` and `isPartner` are `true`
`isPartner`	Boolean	Optional	Whether to view partner accounts Available to partner representatives only An error is returned if both `isOrganization` and `isPartner` are `true`
`memberNoList.N`	List<String>	Optional	Member ID list Only available to master or partner representatives
`responseFormatType`	String	Optional	Response result format type `xml` (default) \| `json`

Request example

The following is a sample request.

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}' \

Response

The following describes the response format.

Response body

See CoinHistoryList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The following is a sample response.

<?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>Bank transer (Nonghyup)</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>Bank transer (Nonghyup)</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>