개발하기

1. 프로모션 리워드 지급 키 생성하기

프로모션 지급을 위한 KEY를 발급합니다.

TIP

KEY 유효시간은 1시간이에요

요청 헤더

이름	타입	필수값 여부	설명
x-toss-user-key	string	Y	토스 로그인을 통해 획득한 userKey 값

응답 파라미터

이름	타입	설명
key	String	프로모션 지급을 위한 key 값 base64 인코딩된 값

json

{
  "resultType": "SUCCESS",
  "success": {
    "key": "3oBpxjUgl5r66edcVi7ynHGIjhzr9KOka6FfEKikev0="
  }
}

프로모션 지급을 실행해요.
프로모션 예산에서 차감되며, 지급 요청 이후 실제 지급까지 약간의 시간이 소요될 수 있어요.

요청 헤더

이름	타입	필수값 여부	설명
x-toss-user-key	string	Y	토스 로그인을 통해 획득한 userKey 값

요청 파라미터

json

{
  "promotionCode": "01JPPJ6SB66BQXXDAKRQZ6SZD7",
	"key": "3oBpxjUgl5r66edcVi7ynHGIjhzr9KOka6FfEKikev0=",
  "amount": 10
}

응답

이름	타입	설명
key	String	프로모션 지급을 위해 발급받은 KEY값

json

{
  "resultType": "SUCCESS",
  "success": {
    "key": "3oBpxjUgl5r66edcVi7ynHGIjhzr9KOka6FfEKikev0="
  }
}

프로모션 지급 결과를 확인해요.

요청 헤더

이름	타입	필수값 여부	설명
x-toss-user-key	string	Y	토스 로그인을 통해 획득한 userKey 값

요청 파라미터

이름	타입	필수	설명
promotionCode	String	Y	콘솔에서 생성한 프로모션 코드ID
key	String	Y	프로모션 지급을 위해 발급받은 KEY값

json

{
  "promotionCode": "01JPPJ6SB66BQXXDAKRQZ6SZD7",
	"key": "3oBpxjUgl5r66edcVi7ynHGIjhzr9KOka6FfEKikev0="
}

응답

이름	타입	설명
success	String	프로모션 지급 결과 - SUCCESS - PENDING - FAILED

json

{
  "resultType": "SUCCESS",
  "success": "PENDING"
}

프로모션 API를 사용할 때 발생할 수 있는 에러 코드 목록이에요.
응답 코드 또는 에러 메시지를 참고해서 적절히 처리해 주세요.