개발자센터
V1
V2

채널 관련 API

채널에 관련된 API 를 확인할 수 있습니다.

⌨ 채널 불러오기

GET https://api.portone.io/v2/channels

채널 불러오기

Parameters

Query

store_id
string

하위상점 ID (Merchant 유저가 store_id를 명시하지 않으면, Merchant 유저의 대표 상점 id가 입력됨)

Responses

200
채널 불러오기 성공

channels Array[Channel]

V2 결제를 지원하는 채널

Channel

channel_id * string

결제 채널 ID


channel_name * string

결제 채널 이름


pg_provider * PgProvider

V2 결제가 가능한 PG사

"TOSSPAYMENTS", "KSNET", "KAKAOPAY", "SMARTRO_V2", "NAVERPAY", "DANAL"


channel_type * ChannelType

기본값: "CHANNEL_TYPE_UNSPECIFIED"

"CHANNEL_TYPE_UNSPECIFIED", "CHANNEL_TYPE_LIVE", "CHANNEL_TYPE_MERCHANT_TEST", "CHANNEL_TYPE_SHARED_TEST"


pg_merchant_id * string

PG 상점 ID


is_for_payment * boolean

결제용 채널 여부


is_for_identification_verification * boolean

본인인증용 채널 여부


channel_key * string

채널 키


toss_payments_credential TossPaymentsCredential


ksnet_credential KsnetCredential


smartro_v2_credential SmartroV2Credential


naverpay_credential NaverpayCredential


danal_credential DanalCredential



401
인증되지 않음

code * string

UNAUTHORIZED: 인증되지 않은 요청입니다. 올바른 API Key를 헤더에 제공했는지 확인해주세요.\

"UNAUTHORIZED"


params object

에러 상세 정보를 담은 파라미터 모음

params

message string



403
하위상점에 접근할 권한이 없습니다.

code * string

PERMISSION_DENIED: 해당 하위상점에 접근할 권한이 없습니다.\

"PERMISSION_DENIED"


params object

에러 상세 정보를 담은 파라미터 모음

params

message string



404
채널을 찾을 수 없습니다.

code * string

CHANNEL_NOT_FOUND: 채널을 찾을 수 없습니다.\

"CHANNEL_NOT_FOUND"


params object

에러 상세 정보를 담은 파라미터 모음

params

message string



500
내부 서버 에러

code * string

"PORTONE_ERROR"


params object

에러 상세 정보를 담은 파라미터 모음

params

message string