트레져러 금/은 상품권

트레져러 금/은 상품권은 트레져러에 회원가입한 유저가 등록하게 되면 금/은 포인트로 전환되게 되며 해당 포인트로 트레져러의 금/은을 구매할 수 있습니다.

파트너사들은 [email protected] 로 연락을 주시면 API 키를 발급받을 수 있습니다. 해당 파트너사들은 발급받은 API를 통해 직접 유저들에게 지급하거나, 구매를 통해서 직접 유저들에게 지급할 수 있습니다.

유저 플로우

1

금/은 상품권 구매

파트너사에서 API를 활용하여 금/은 상품권을 구매 요청. 트레져러 측에서 카카오 알림톡 혹은 문자 메시지로 유저에게 상품권 PIN Code가 포함된 사용

2

금/은 상품권 등록

제공된 웹사이트에서 트레져러 금/은 상품권을 등록. 해당 유저가 트레져러 유저가 아닐 경우 회원가입 진행

3

트레져러 애플리케이션

어플리케이션 등록한 아이디로 로그인, 금/은 상품권을 활용하여 금/은 구매

상품권 구매

POST /v2/partner/metal/giftcard/buy

상품권 구매를 진행하게 됩니다. 호출과 동시에 상품권이 발급되며, 알림톡과 문자메세지로 해당 상품권의 사용방법 유효기간, 주의 사항 등이 전달되게 됩니다.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
phoneNumber	string	휴대폰 번호
amount	number	실제 유저에게 적립될 금액

Response

200

{
  "result": "success",
  "data": {
    "txId:" : "248cc545-efd4-43f0-952d-e3efb650ba5f",
    "giftId" : "248cc545-efd4-43f0-952d-e3efb650ba5f"
  }
}

400

구매 이력 조회

GET /v2/partner/metal/giftcard/buy/:giftUUID

txId를 이용하여 해당건의 처리내역을 확인 할 수 있습니다. 조회는 파트너사가 발급한 아이디만 요청할수 있으며, 해당 상품권의 상태를 표시하게 됩니다.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Query

Name	Type	Description
giftUUID	string	giftUUID

Response

200

{
  "result": "Success"
  "data" : {
     "giftId" : 132,
     "amount" : 1000,
     "used" : false,
     "expires" : "2024-10-11",
     "valid" : true
  }
}

400

총 사용량 조회

GET /v2/partner/usage

파트너사가 발행한 상품권의 총량을 조회할수 있는 API입니다. 해당 API를 통하여 해당 기간동안 발급된 상품권의 총액과 해당기간동안 사용된 상품권의 총액을 조회할 수 있습니다. 시작날부터 완료날을 포함하여 계산하게 됩니다.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Params

Name	Type	Description
startDate	string	시작 날짜
endDate	string	완료 날짜

Response

200

{
  "startDate" : "2024-12-1",
  "endDate": "2024-12-31",
  "totalIssued": 23422342,
  "totalUsed" : 234234,
  "totalUsedInIssued": 234234
}

400

totalIssued는 해당 기간동안 발행된 상품권 금액, totalUsed는 해당 기간동안 사용된 상품권 총액, totalUsedInIssued는 해당 기간동안 발행된 상품권 중에 사용된 상품권 총액을 나타냅니다.