채널 관련 API

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

PreviousV2 API 시작하기 Next인증 관련 API

Last updated 2 years ago

Was this helpful?

채널 불러오기

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

Query Parameters

Name

Type

Description

store_id

string

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

channels Array[Channel]

V2 결제를 지원하는 채널

Channel

channel_id * string

결제 채널 ID

channel_name * string

결제 채널 이름

pg_provider * PgProvider

V2 결제가 가능한 PG사

기본값: "PG_PROVIDER_UNSPECIFIED"

"PG_PROVIDER_UNSPECIFIED", "PG_PROVIDER_TOSSPAYMENTS", "PG_PROVIDER_KSNET", "PG_PROVIDER_KAKAOPAY", "PG_PROVIDER_SMARTRO_V2", "PG_PROVIDER_NAVERPAY"

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_certification boolean

본인인증용 채널 여부

toss_payments_credential TossPaymentsCredential

ksnet_credential KsnetCredential

smartro_v2_credential SmartroV2Credential

naverpay_credential NaverpayCredential

api_key string

client_id string

client_secret string

chain_id string

merchant_key string

cancel_password string

ssp_mall_id string

api_key string

secret_key string

client_key string

code * string

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

"UNAUTHORIZED"

params object

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

params

message string

code * string

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

"PERMISSION_DENIED"

params object

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

params

message string

code * string

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

"CHANNEL_NOT_FOUND"

params object

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

params

message string

code * string

"PORTONE_ERROR"

params object

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

params

message string

채널 불러오기

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

Query Parameters

Name

Type

Description

store_id

string

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

channels Array[Channel]

V2 결제를 지원하는 채널

Channel

channel_id * string

결제 채널 ID

channel_name * string

결제 채널 이름

pg_provider * PgProvider

V2 결제가 가능한 PG사

기본값: "PG_PROVIDER_UNSPECIFIED"

"PG_PROVIDER_UNSPECIFIED", "PG_PROVIDER_TOSSPAYMENTS", "PG_PROVIDER_KSNET", "PG_PROVIDER_KAKAOPAY", "PG_PROVIDER_SMARTRO_V2", "PG_PROVIDER_NAVERPAY"

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_certification boolean

본인인증용 채널 여부

toss_payments_credential TossPaymentsCredential

ksnet_credential KsnetCredential

smartro_v2_credential SmartroV2Credential

naverpay_credential NaverpayCredential

api_key string

client_id string

client_secret string

chain_id string

merchant_key string

cancel_password string

ssp_mall_id string

api_key string

secret_key string

client_key string

code * string

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

"UNAUTHORIZED"

params object

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

params

message string

code * string

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

"PERMISSION_DENIED"

params object

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

params

message string

code * string

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

"CHANNEL_NOT_FOUND"

params object

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

params

message string

code * string

"PORTONE_ERROR"

params object

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

params

message string

채널 관련 API

채널 관련 API

⌨ 채널 불러오기

채널 불러오기

Query Parameters

⌨ 채널 불러오기

채널 불러오기

Query Parameters