API Reference

주문 취소 정산건 생성

post
https://public-api-service.dev.iamport.co/platform/transfers/order-cancel
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

취소 정산 등록을 위한 입력 정보

하나의 payment에 하나의 정산 건만 존재하는 경우에는 (partnerId, paymentId)로 취소 정산을 등록하실 수 있습니다.
하나의 payment에 여러 개의 정산 건이 존재하는 경우에는 transferId를 필수로 입력해야 합니다.
transferId를 입력한 경우 (partnerId, paymentId)는 생략 가능합니다.

string
string
string
string
required
string
orderDetail
object
discounts
array of objects
required
discounts*
string

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.

externalCancellationDetail
object
boolean
Responses

InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
  • PlatformOrderDetailMismatchedError
  • PlatformDiscountSharePolicyIdDuplicatedError
  • PlatformCancellableAmountExceededError
  • PlatformCancellableDiscountAmountExceededError
  • PlatformProductIdDuplicatedError
  • PlatformCancellableProductQuantityExceededError
  • PlatformOrderTransferAlreadyCancelledError
  • PlatformDiscountCancelExceededOrderCancelAmountError
  • PlatformCancellationAndPaymentTypeMismatchedError
  • PlatformSettlementCancelAmountExceededPortOneCancelError

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

    PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

    PlatformTransferNotFoundError
  • PlatformCancellationNotFoundError
  • PlatformPaymentNotFoundError
  • PlatformProductIdNotFoundError
  • PlatformTransferDiscountSharePolicyNotFoundError

    • PlatformTransferAlreadyExistsError

    Updated about 2 years ago

    Language
    Credentials
    URL
    LoadingLoading…
    Response
    Click Try It! to start a request and see the response here! Or choose an example:
    application/json

    Updated about 2 years ago