PortOne REST API - V2

type이(가)"INVALID_REQUEST"일 때의 타입

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

401 Error

type이(가)"UNAUTHORIZED"일 때의 타입

인증 정보가 올바르지 않은 경우

403 Error

VirtualAccountIssuedPayment

type이(가)"FORBIDDEN"일 때의 타입

요청이 거절된 경우

409 Error

AlreadyPaidError

type이(가)"ALREADY_PAID"일 때의 타입

결제가 이미 완료된 경우

try

Request

Request Sample

N/A

get/payments/{paymentId}

결제 단건 조회

주어진 아이디에 대응되는 결제 건을 조회합니다.

Request

Path

paymentId: string

조회할 결제 아이디

조회할 결제 아이디

Query

storeId?: string

상점 아이디

상점 아이디

Response

200 Ok

CancelledPayment

status이(가)"CANCELLED"일 때의 타입

결제 취소 상태 건

FailedPayment

status이(가)"FAILED"일 때의 타입

결제 실패 상태 건

PaidPayment

status이(가)"PAID"일 때의 타입

결제 완료 상태 건

PartialCancelledPayment

status이(가)"PARTIAL_CANCELLED"일 때의 타입

결제 부분 취소 상태 건

PayPendingPayment

status이(가)"PAY_PENDING"일 때의 타입

결제 완료 대기 상태 건

ReadyPayment

status이(가)"READY"일 때의 타입

준비 상태 건

status이(가)"VIRTUAL_ACCOUNT_ISSUED"일 때의 타입

가상계좌 발급 완료 상태 건

400 Error

type이(가)"INVALID_REQUEST"일 때의 타입

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

401 Error

type이(가)"UNAUTHORIZED"일 때의 타입

인증 정보가 올바르지 않은 경우

403 Error

type이(가)"FORBIDDEN"일 때의 타입

요청이 거절된 경우

404 Error

type이(가)"PAYMENT_NOT_FOUND"일 때의 타입

결제 건이 존재하지 않는 경우

try

Request

Request Sample

N/A

get/payments/{paymentId}/transactions

결제 시도 내역 조회unstable

주어진 아이디에 대응되는 결제 건의 결제 시도 내역을 조회합니다.

Request

Path

paymentId: string

조회할 결제 아이디

조회할 결제 아이디

Query

storeId?: string

상점 아이디

상점 아이디

Response

200 Ok

items: Array<PaymentTransaction>

결제 시도 내역

400 Error

type이(가)"INVALID_REQUEST"일 때의 타입

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

401 Error

type이(가)"UNAUTHORIZED"일 때의 타입

인증 정보가 올바르지 않은 경우

403 Error

type이(가)"FORBIDDEN"일 때의 타입

요청이 거절된 경우

404 Error

type이(가)"PAYMENT_NOT_FOUND"일 때의 타입

결제 건이 존재하지 않는 경우

try

Request

Request Sample

N/A

get/payments

결제 다건 조회(페이지 기반)

주어진 조건에 맞는 결제 건들을 페이지 기반으로 조회합니다.

Request

body를 쿼리 문자열에 포함시켜 보낼 수 있습니다. 자세히 보기

Body

page?: PageInput

다건 조회 API 에 사용되는 페이지 입력 정보

다건 조회 API 에 사용되는 페이지 입력 정보

filter?: PaymentFilterInput

결제 건 다건 조회를 위한 입력 정보

결제 건 다건 조회를 위한 입력 정보

Response

200 Ok

items: Array<Payment>

조회된 결제 건 리스트

page: PageInfo

반환된 페이지 결과 정보

반환된 페이지 결과 정보

400 Error

type이(가)"INVALID_REQUEST"일 때의 타입

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

401 Error

type이(가)"UNAUTHORIZED"일 때의 타입

인증 정보가 올바르지 않은 경우

403 Error

type이(가)"FORBIDDEN"일 때의 타입

요청이 거절된 경우

try

Request

Request Sample

N/A

get/payments-by-cursor

결제 대용량 다건 조회(커서 기반)unstable

기간 내 모든 결제 건을 커서 기반으로 조회합니다. 결제 건의 생성일시를 기준으로 주어진 기간 내 존재하는 모든 결제 건이 조회됩니다.

Request

body를 쿼리 문자열에 포함시켜 보낼 수 있습니다. 자세히 보기

Body

storeId?: string

상점 아이디

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

from?: string (RFC 3339 date-time)

결제 건 생성시점 범위 조건의 시작

값을 입력하지 않으면 end의 90일 전으로 설정됩니다.

until?: string (RFC 3339 date-time)

결제 건 생성시점 범위 조건의 끝

값을 입력하지 않으면 현재 시점으로 설정됩니다.

cursor?: string

커서

결제 건 리스트 중 어디서부터 읽어야 할지 가리키는 값입니다. 최초 요청일 경우 값을 입력하지 마시되, 두번째 요청 부터는 이전 요청 응답값의 cursor를 입력해주시면 됩니다.

size?: integer (32 bit)

페이지 크기

미입력 시 기본값은 10 이며 최대 1000까지 허용

Response

200 Ok

items: Array<PaymentWithCursor>

조회된 결제 건 및 커서 정보 리스트

400 Error

type이(가)"INVALID_REQUEST"일 때의 타입

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

401 Error

type이(가)"UNAUTHORIZED"일 때의 타입

인증 정보가 올바르지 않은 경우

403 Error

type이(가)"FORBIDDEN"일 때의 타입

요청이 거절된 경우

try

Request

Request Sample

N/A

post/payments/{paymentId}/cancel

결제 취소

결제 취소를 요청합니다.

Request

Path

paymentId: string

결제 건 아이디

결제 건 아이디

Body

storeId?: string

상점 아이디

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

amount?: integer (64 bit)

취소 총 금액

값을 입력하지 않으면 전액 취소됩니다.

taxFreeAmount?: integer (64 bit)

취소 금액 중 면세 금액

값을 입력하지 않으면 전액 과세 취소됩니다.

vatAmount?: integer (64 bit)

취소 금액 중 부가세액

값을 입력하지 않으면 자동 계산됩니다.

reason: string

취소 사유

requester?: CancelRequester

CancelRequester

promotionDiscountRetainOption?: PromotionDiscountRetainOption

PromotionDiscountRetainOption

currentCancellableAmount?: integer (64 bit)

결제 건의 취소 가능 잔액

본 취소 요청 이전의 취소 가능 잔액으로써, 값을 입력하면 잔액이 일치하는 경우에만 취소가 진행됩니다. 값을 입력하지 않으면 별도의 검증 처리를 수행하지 않습니다.

refundAccount?: CancelPaymentBodyRefundAccount

고객 정보 입력 형식

고객 정보 입력 형식

Response

200 Ok

cancellation: PaymentCancellation

결제 취소 내역

결제 취소 내역

400 Error

NegativePromotionAdjustedCancelAmountError

type이(가)"INVALID_REQUEST"일 때의 타입

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

type이(가)"NEGATIVE_PROMOTION_ADJUSTED_CANCEL_AMOUNT"일 때의 타입

프로모션에 의해 조정된 취소 금액이 음수인 경우

PromotionDiscountRetainOptionShouldNotBeChangedError

type이(가)"PROMOTION_DISCOUNT_RETAIN_OPTION_SHOULD_NOT_BE_CHANGED"일 때의 타입

프로모션 혜택 유지 옵션을 이전 부분 취소와 다른 것으로 입력한 경우

401 Error

type이(가)"UNAUTHORIZED"일 때의 타입

인증 정보가 올바르지 않은 경우

403 Error

type이(가)"FORBIDDEN"일 때의 타입

요청이 거절된 경우

404 Error

CancellableAmountConsistencyBrokenError

type이(가)"PAYMENT_NOT_FOUND"일 때의 타입

결제 건이 존재하지 않는 경우

409 Error

type이(가)"CANCELLABLE_AMOUNT_CONSISTENCY_BROKEN"일 때의 타입

취소 가능 잔액 검증에 실패한 경우

CancelAmountExceedsCancellableAmountError

type이(가)"CANCEL_AMOUNT_EXCEEDS_CANCELLABLE_AMOUNT"일 때의 타입

결제 취소 금액이 취소 가능 금액을 초과한 경우

CancelTaxAmountExceedsCancellableTaxAmountError

type이(가)"CANCEL_TAX_AMOUNT_EXCEEDS_CANCELLABLE_TAX_AMOUNT"일 때의 타입

취소 과세 금액이 취소 가능한 과세 금액을 초과한 경우

CancelTaxFreeAmountExceedsCancellableTaxFreeAmountError

type이(가)"CANCEL_TAX_FREE_AMOUNT_EXCEEDS_CANCELLABLE_TAX_FREE_AMOUNT"일 때의 타입

취소 면세 금액이 취소 가능한 면세 금액을 초과한 경우

PaymentAlreadyCancelledError

type이(가)"PAYMENT_ALREADY_CANCELLED"일 때의 타입

결제가 이미 취소된 경우

SumOfPartsExceedsCancelAmountError

type이(가)"PAYMENT_NOT_PAID"일 때의 타입

결제가 완료되지 않은 경우

type이(가)"SUM_OF_PARTS_EXCEEDS_CANCEL_AMOUNT"일 때의 타입

면세 금액 등 하위 항목들의 합이 전체 취소 금액을 초과한 경우

502 Error

DiscountAmountExceedsTotalAmountError

type이(가)"PG_PROVIDER"일 때의 타입

PG사에서 오류를 전달한 경우

try

Request

Request Sample

N/A

post/payments/{paymentId}/billing-key

빌링키 결제

빌링키로 결제를 진행합니다.

Request

Path

paymentId: string

결제 건 아이디

결제 건 아이디

Body

storeId?: string

상점 아이디

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

billingKey: string

빌링키 결제에 사용할 빌링키

channelKey?: string

채널 키

다수 채널에 대해 발급된 빌링키에 대해, 결제 채널을 특정하고 싶을 때 명시

orderName: string

주문명

customer?: CustomerInput

고객 정보 입력 정보

고객 정보 입력 정보

customData?: string

사용자 지정 데이터

amount: PaymentAmountInput

금액 세부 입력 정보

금액 세부 입력 정보

currency: Currency

통화 단위

통화 단위

installmentMonth?: integer (32 bit)

할부 개월 수

useFreeInterestFromMerchant?: boolean

무이자 할부 이자를 고객사가 부담할지 여부

useCardPoint?: boolean

카드 포인트 사용 여부

cashReceipt?: CashReceiptInput

현금영수증 입력 정보

현금영수증 입력 정보

country?: Country

국가

noticeUrls?: Array<string>

웹훅 주소

결제 승인/실패 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다. 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.

products?: Array<PaymentProduct>

상품 정보

입력된 값이 없을 경우에는 빈 배열로 해석됩니다.

productCount?: integer (32 bit)

상품 개수

productType?: PaymentProductType

상품 유형

상품 유형

shippingAddress?: SeparatedAddressInput

분리 형식 주소 입력 정보

분리 형식 주소 입력 정보

promotionId?: string

해당 결제에 적용할 프로모션 아이디

bypass?: { }

PG사별 추가 파라미터 ("PG사별 연동 가이드" 참고)

Response

200 Ok

payment: BillingKeyPaymentSummary

빌링키 결제 완료된 결제 건 요약 정보

빌링키 결제 완료된 결제 건 요약 정보

400 Error

type이(가)"DISCOUNT_AMOUNT_EXCEEDS_TOTAL_AMOUNT"일 때의 타입

프로모션 할인 금액이 결제 시도 금액 이상인 경우

MaxTransactionCountReachedError

type이(가)"INVALID_REQUEST"일 때의 타입

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

type이(가)"MAX_TRANSACTION_COUNT_REACHED"일 때의 타입

결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우

PromotionPayMethodDoesNotMatchError

type이(가)"PROMOTION_PAY_METHOD_DOES_NOT_MATCH"일 때의 타입

결제수단이 프로모션에 지정된 것과 일치하지 않는 경우

401 Error

type이(가)"UNAUTHORIZED"일 때의 타입

인증 정보가 올바르지 않은 경우

403 Error

BillingKeyAlreadyDeletedError

type이(가)"FORBIDDEN"일 때의 타입

요청이 거절된 경우

404 Error

BillingKeyNotFoundError

type이(가)"BILLING_KEY_NOT_FOUND"일 때의 타입

빌링키가 존재하지 않는 경우

ChannelNotFoundError

type이(가)"CHANNEL_NOT_FOUND"일 때의 타입

요청된 채널이 존재하지 않는 경우

409 Error

AlreadyPaidError

type이(가)"ALREADY_PAID"일 때의 타입

결제가 이미 완료된 경우

type이(가)"BILLING_KEY_ALREADY_DELETED"일 때의 타입

빌링키가 이미 삭제된 경우

PaymentScheduleAlreadyExistsError

type이(가)"PAYMENT_SCHEDULE_ALREADY_EXISTS"일 때의 타입

결제 예약건이 이미 존재하는 경우

SumOfPartsExceedsTotalAmountError

type이(가)"SUM_OF_PARTS_EXCEEDS_TOTAL_AMOUNT"일 때의 타입

면세 금액 등 하위 항목들의 합이 전체 결제 금액을 초과한 경우

502 Error

DiscountAmountExceedsTotalAmountError

type이(가)"PG_PROVIDER"일 때의 타입

PG사에서 오류를 전달한 경우

try

Request

Request Sample

N/A

post/payments/{paymentId}/instant

수기 결제

수기 결제를 진행합니다.

Request

Path

paymentId: string

결제 건 아이디

결제 건 아이디

Body

storeId?: string

상점 아이디

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

channelKey?: string

채널 키

채널 키 또는 채널 그룹 ID 필수

channelGroupId?: string

채널 그룹 ID

채널 키 또는 채널 그룹 ID 필수

method: InstantPaymentMethodInput

수기 결제 수단 입력 정보

하나의 필드만 입력합니다.

orderName: string

주문명

isCulturalExpense?: boolean

문화비 지출 여부

기본값은 false 입니다.

isEscrow?: boolean

에스크로 결제 여부

기본값은 false 입니다.

customer?: CustomerInput

고객 정보 입력 정보

고객 정보 입력 정보

customData?: string

사용자 지정 데이터

amount: PaymentAmountInput

금액 세부 입력 정보

금액 세부 입력 정보

currency: Currency

통화 단위

통화 단위

country?: Country

국가

noticeUrls?: Array<string>

웹훅 주소

products?: Array<PaymentProduct>

상품 정보

입력된 값이 없을 경우에는 빈 배열로 해석됩니다.

productCount?: integer (32 bit)

상품 개수

productType?: PaymentProductType

상품 유형

상품 유형

shippingAddress?: SeparatedAddressInput

분리 형식 주소 입력 정보

분리 형식 주소 입력 정보

promotionId?: string

해당 결제에 적용할 프로모션 아이디

Response

200 Ok

payment: InstantPaymentSummary

수기 결제가 완료된 결제 건 요약 정보

수기 결제가 완료된 결제 건 요약 정보

400 Error

type이(가)"DISCOUNT_AMOUNT_EXCEEDS_TOTAL_AMOUNT"일 때의 타입

프로모션 할인 금액이 결제 시도 금액 이상인 경우

MaxTransactionCountReachedError

type이(가)"INVALID_REQUEST"일 때의 타입

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

type이(가)"MAX_TRANSACTION_COUNT_REACHED"일 때의 타입

결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우

PromotionPayMethodDoesNotMatchError

type이(가)"PROMOTION_PAY_METHOD_DOES_NOT_MATCH"일 때의 타입

결제수단이 프로모션에 지정된 것과 일치하지 않는 경우

401 Error

type이(가)"UNAUTHORIZED"일 때의 타입

인증 정보가 올바르지 않은 경우

403 Error

PaymentScheduleAlreadyExistsError

type이(가)"FORBIDDEN"일 때의 타입

요청이 거절된 경우

404 Error

ChannelNotFoundError

type이(가)"CHANNEL_NOT_FOUND"일 때의 타입

요청된 채널이 존재하지 않는 경우

409 Error

AlreadyPaidError

type이(가)"ALREADY_PAID"일 때의 타입

결제가 이미 완료된 경우

type이(가)"PAYMENT_SCHEDULE_ALREADY_EXISTS"일 때의 타입

결제 예약건이 이미 존재하는 경우

SumOfPartsExceedsTotalAmountError

type이(가)"SUM_OF_PARTS_EXCEEDS_TOTAL_AMOUNT"일 때의 타입

면세 금액 등 하위 항목들의 합이 전체 결제 금액을 초과한 경우

502 Error

type이(가)"PG_PROVIDER"일 때의 타입

PG사에서 오류를 전달한 경우

try

Request

Request Sample

N/A

post/payments/{paymentId}/virtual-account/close

가상계좌 말소

발급된 가상계좌를 말소합니다.

Request

Path

paymentId: string

결제 건 아이디

결제 건 아이디

Query

storeId?: string

상점 아이디

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

Response

200 Ok

closedAt: string (RFC 3339 date-time)

가상계좌 말소 시점

400 Error

type이(가)"INVALID_REQUEST"일 때의 타입

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

401 Error

type이(가)"UNAUTHORIZED"일 때의 타입

인증 정보가 올바르지 않은 경우

403 Error

type이(가)"FORBIDDEN"일 때의 타입

요청이 거절된 경우

404 Error

PaymentNotWaitingForDepositError

type이(가)"PAYMENT_NOT_FOUND"일 때의 타입

결제 건이 존재하지 않는 경우

409 Error

type이(가)"PAYMENT_NOT_WAITING_FOR_DEPOSIT"일 때의 타입

결제 건이 입금 대기 상태가 아닌 경우

502 Error

type이(가)"PG_PROVIDER"일 때의 타입

PG사에서 오류를 전달한 경우

try

Request

Request Sample

N/A

post/payments/{paymentId}/escrow/logistics

에스크로 배송 정보 등록

에스크로 배송 정보를 등록합니다.

Request

Path

paymentId: string

결제 건 아이디

결제 건 아이디

Body

storeId?: string

상점 아이디

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

sender?: PaymentEscrowSenderInput

에스크로 발송자 정보

에스크로 발송자 정보

receiver?: PaymentEscrowReceiverInput

에스크로 수취인 정보

에스크로 수취인 정보

logistics: PaymentLogistics

배송정보

배송정보

sendEmail?: boolean

이메일 알림 전송 여부

에스크로 구매 확정 시 이메일로 알림을 보낼지 여부입니다.

products?: Array<PaymentProduct>

상품 정보

Response

200 Ok

invoiceNumber: string

송장 번호

sentAt: string (RFC 3339 date-time)

발송 시점

appliedAt: string (RFC 3339 date-time)

에스크로 정보 등록 시점

400 Error

type이(가)"INVALID_REQUEST"일 때의 타입

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

401 Error

type이(가)"UNAUTHORIZED"일 때의 타입

인증 정보가 올바르지 않은 경우

403 Error

type이(가)"FORBIDDEN"일 때의 타입

요청이 거절된 경우

404 Error

type이(가)"PAYMENT_NOT_FOUND"일 때의 타입

결제 건이 존재하지 않는 경우

409 Error

type이(가)"PAYMENT_NOT_PAID"일 때의 타입

결제가 완료되지 않은 경우

502 Error

type이(가)"PG_PROVIDER"일 때의 타입

PG사에서 오류를 전달한 경우

try

Request

Request Sample

N/A

patch/payments/{paymentId}/escrow/logistics

에스크로 배송 정보 수정

에스크로 배송 정보를 수정합니다.

Request

Path

paymentId: string

결제 건 아이디

결제 건 아이디

Body

storeId?: string

상점 아이디

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

sender?: PaymentEscrowSenderInput

에스크로 발송자 정보

에스크로 발송자 정보

receiver?: PaymentEscrowReceiverInput

에스크로 수취인 정보

에스크로 수취인 정보

logistics: PaymentLogistics

배송정보

배송정보

sendEmail?: boolean

이메일 알림 전송 여부

에스크로 구매 확정 시 이메일로 알림을 보낼지 여부입니다.

products?: Array<PaymentProduct>

상품 정보

Response

200 Ok

invoiceNumber: string

송장 번호

sentAt: string (RFC 3339 date-time)

발송 시점

modifiedAt: string (RFC 3339 date-time)

에스크로 정보 수정 시점

400 Error

type이(가)"INVALID_REQUEST"일 때의 타입

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

401 Error

type이(가)"UNAUTHORIZED"일 때의 타입

인증 정보가 올바르지 않은 경우

403 Error

type이(가)"FORBIDDEN"일 때의 타입

요청이 거절된 경우

404 Error

type이(가)"PAYMENT_NOT_FOUND"일 때의 타입

결제 건이 존재하지 않는 경우

409 Error

type이(가)"PAYMENT_NOT_PAID"일 때의 타입

결제가 완료되지 않은 경우

502 Error

type이(가)"PG_PROVIDER"일 때의 타입

PG사에서 오류를 전달한 경우

try

Request

Request Sample

N/A

post/payments/{paymentId}/escrow/complete

에스크로 구매 확정

에스크로 결제를 구매 확정 처리합니다

Request

Path

paymentId: string

결제 건 아이디

결제 건 아이디

Body

storeId?: string

상점 아이디

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

fromStore?: boolean

확인 주체가 상점인지 여부

구매확정요청 주체가 고객사 관리자인지 구매자인지 구분하기 위한 필드입니다. 네이버페이 전용 파라미터이며, 구분이 모호한 경우 고객사 관리자(true)로 입력합니다.

Response

200 Ok

completedAt: string (RFC 3339 date-time)

에스크로 구매 확정 시점

400 Error

type이(가)"INVALID_REQUEST"일 때의 타입

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

401 Error

type이(가)"UNAUTHORIZED"일 때의 타입

인증 정보가 올바르지 않은 경우

403 Error

type이(가)"FORBIDDEN"일 때의 타입

요청이 거절된 경우

404 Error

type이(가)"PAYMENT_NOT_FOUND"일 때의 타입

결제 건이 존재하지 않는 경우

409 Error

type이(가)"PAYMENT_NOT_PAID"일 때의 타입

결제가 완료되지 않은 경우

502 Error

type이(가)"PG_PROVIDER"일 때의 타입

PG사에서 오류를 전달한 경우

try

Request

Request Sample

N/A

post/payments/{paymentId}/resend-webhook

웹훅 재발송

웹훅을 재발송합니다.

Request

Path

paymentId: string

결제 건 아이디

결제 건 아이디

Body

storeId?: string

상점 아이디

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

webhookId?: string

웹훅 아이디

입력하지 않으면 결제 건의 가장 최근 웹훅 아이디가 기본 적용됩니다

Response

200 Ok

webhook: PaymentWebhook

성공 웹훅 내역

성공 웹훅 내역

400 Error

MaxWebhookRetryCountReachedError

type이(가)"INVALID_REQUEST"일 때의 타입

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

type이(가)"MAX_WEBHOOK_RETRY_COUNT_REACHED"일 때의 타입

동일한 webhook id에 대한 수동 재시도 횟수가 최대에 도달한 경우

401 Error

type이(가)"UNAUTHORIZED"일 때의 타입

인증 정보가 올바르지 않은 경우

403 Error

type이(가)"FORBIDDEN"일 때의 타입

요청이 거절된 경우

404 Error

type이(가)"PAYMENT_NOT_FOUND"일 때의 타입

결제 건이 존재하지 않는 경우

WebhookNotFoundError

type이(가)"WEBHOOK_NOT_FOUND"일 때의 타입

웹훅 내역이 존재하지 않는 경우

try

Request

Request Sample

N/A

post/payments/{paymentId}/register-store-receipt

영수증 내 하위 상점 거래 등록

결제 내역 매출전표에 하위 상점의 거래를 등록합니다. 지원되는 PG사: KG이니시스(이용 전 콘솔 -> 결제연동 탭에서 INIApi Key 등록 필요)

Request

Path

paymentId: string

등록할 하위 상점 결제 건 아이디

등록할 하위 상점 결제 건 아이디

Body

items: Array<RegisterStoreReceiptBodyItem>

하위 상점 거래 목록

storeId?: string

상점 아이디

Response

200 Ok

receiptUrl?: string

결제 영수증 URL

400 Error

type이(가)"INVALID_REQUEST"일 때의 타입

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

401 Error

type이(가)"UNAUTHORIZED"일 때의 타입

인증 정보가 올바르지 않은 경우

403 Error

type이(가)"FORBIDDEN"일 때의 타입

요청이 거절된 경우

404 Error

type이(가)"PAYMENT_NOT_FOUND"일 때의 타입

결제 건이 존재하지 않는 경우

409 Error

type이(가)"PAYMENT_NOT_PAID"일 때의 타입

결제가 완료되지 않은 경우

502 Error