⌨️결제 상세내역 조회 API

복합결제거래 상세정보를 조회합니다.

Deprecated

이 문서는 더 이상 관리되지 않습니다.

PortOne 개발자센터를 이용해주세요.

복합결제거래 상세정보를 조회합니다.

복수의 결제수단으로 거래가 발생된 거래의 상세 금액정보를 확인합니다.

GET https://api.iamport.kr/payments/{imp_uid}/balance

현재 PAYCO 결제수단에 한해 제공되고 있습니다

Path Parameters

Name	Type	Description
imp_uid*	String	포트원 거래번호

200: OK 성공

PaymentBalanceResponse

code * integer

응답코드

0이면 정상적인 조회, 0 이 아닌 값이면 message를 확인해봐야 합니다

message * string

응답메세지

code 값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

response (PaymentBalanceResponseAnnotation, optional)

PaymentBalanceResponseAnnotation

amount Integer

총 결제금액

cash_receipt (PaymentBalanceAnnotation):

현금영수증 발급된 금액 상세

primary (PaymentBalanceAnnotation):

1차 결제수단(신용카드, 계좌이체, 가상계좌, 휴대폰소액결제) 금액 상세

secondary (PaymentBalanceAnnotation):

2차 결제수단(PG사포인트, 카드사포인트) 금액 상세

discount (PaymentBalanceAnnotation):

PG사/카드사 자체 할인 금액 상세

histories (Array[PaymentBalanceBaseAnnotation], optional)

PaymentBalance 이력

PaymentBalanceAnnotation

tax_free integer

면세 공급가액 (환불시 마이너스 차감된 최종 금액 반환)

supply integer

과세 공급가액 (환불시 마이너스 차감된 최종 금액 반환)

vat integer

부가세액 (환불시 마이너스 차감된 최종 금액 반환)

service integer

봉사료 (환불시 마이너스 차감된 최종 금액 반환)

PaymentBalanceBaseAnnotation

cash_receipt (PaymentBalanceAnnotation):

현금영수증 발급된 금액 상세

primary (PaymentBalanceAnnotation)

1차 결제수단(신용카드, 계좌이체, 가상계좌, 휴대폰소액결제) 금액 상세

secondary (PaymentBalanceAnnotation):

2차 결제수단(PG사포인트, 카드사포인트) 금액 상세

discount (PaymentBalanceAnnotation)

PG사/카드사 자체 할인 금액 상세

created integer

Balance정보가 등록된 시각 UNIX timestamp

401: Unauthorized 인증 Token이 전달되지 않았거나 유효하지 않은 경우

{
    // Response
}

404: Not Found 유효하지 않은 imp_uid

{
    // Response
}

Response Model Schema

{
  "code": 0,
  "message": "string",
  "response": {
    "amount": 0,
    "cash_receipt": {
      "tax_free": 0,
      "supply": 0,
      "vat": 0,
      "service": 0
    },
    "primary": {
      "tax_free": 0,
      "supply": 0,
      "vat": 0,
      "service": 0
    },
    "secondary": {
      "tax_free": 0,
      "supply": 0,
      "vat": 0,
      "service": 0
    },
    "discount": {
      "tax_free": 0,
      "supply": 0,
      "vat": 0,
      "service": 0
    },
    "histories": [
      {
        "cash_receipt": {
          "tax_free": 0,
          "supply": 0,
          "vat": 0,
          "service": 0
        },
        "primary": {
          "tax_free": 0,
          "supply": 0,
          "vat": 0,
          "service": 0
        },
        "secondary": {
          "tax_free": 0,
          "supply": 0,
          "vat": 0,
          "service": 0
        },
        "discount": {
          "tax_free": 0,
          "supply": 0,
          "vat": 0,
          "service": 0
        },
        "created": 0
      }
    ]
  }
}

Swagger Test Link

https://api.iamport.kr/#!/payments/balanceByImpUid