⌨️Get balance API (for split payment transaction)

Gets the balance of a transaction paid for using multiple payment methods.

Gets the balance of a transaction paid for using multiple payment methods.

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

This is currently supported only by PAYCO.

Path Parameters

Name	Type	Description
imp_uid*	String	i'mport order ID

200: OK Success

PaymentBalanceResponse

code * integer

Response code

0: success, Not 0: check the message

message * string

Response message

A non-zero code includes a message like 'Invalid payment info'.

response (PaymentBalanceResponseAnnotation, optional)

PaymentBalanceResponseAnnotation

amount Integer

Total amount

cash_receipt (PaymentBalanceAnnotation):

Cash receipt amount

primary (PaymentBalanceAnnotation):

Payment method 1(credit card, account transfer, virtual account, mobile micropayment) amount

secondary (PaymentBalanceAnnotation):

Payment method 2 PG/credit card points amount

discount (PaymentBalanceAnnotation):

PG/credit card discount amount

histories (Array[PaymentBalanceBaseAnnotation], optional)

PaymentBalance history

PaymentBalanceAnnotation

tax_free Integer

Tax free amount (excludes any refunded amount)

supply Integer

Taxed amount (excludes any refunded amount)

vat Integer

Tax (excludes any refunded amount)

service Integer

Fee (excludes any refunded amount)

PaymentBalanceBaseAnnotation

cash_receipt (PaymentBalanceAnnotation):

Cash receipt amount

primary (PaymentBalanceAnnotation):

Payment method 1(credit card, account transfer, virtual account, mobile micropayment) amount

secondary (PaymentBalanceAnnotation):

Payment method 2 PG/credit card points amount

discount (PaymentBalanceAnnotation):

PG/credit card discount amount

created * integer

Balance created at (UNIX timestamp)

401: Unauthorized Missing or invalid access token

{
    // Response
}

404: Not Found Invalid 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