get-payment-amount-api.mdx

title	description
Get payment amount API

import Details from "/components/gitbook/Details.astro"; import Swagger from "/components/gitbook/swagger/Swagger.astro"; import SwaggerDescription from "/components/gitbook/swagger/SwaggerDescription.astro"; import SwaggerParameter from "/components/gitbook/swagger/SwaggerParameter.astro"; import SwaggerResponse from "/components/gitbook/swagger/SwaggerResponse.astro"; import Tab from "/components/gitbook/tabs/Tab.astro"; import Tabs from "/components/gitbook/tabs/Tabs.astro"; import Hint from "/components/Hint.astro";

Gets the amount saved via save payment amount API.

Parameters

Body

**Merchant order ID**

Responses

**`code`** **\*** **integer**

    **Response code**

    0: success, Not 0: check the message

    **`message`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

    **Response message**

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

    <mark style="color:red;">
      **`response (PaymentPrepareAnnotation, optional)`**
    </mark>
  </Tab>
</Tabs>

<Tabs>
  <Tab title="PaymentPrepareAnnotation">
    **`merchant_uid`` `**<mark style="color:red;">**`*`**</mark>**` `**<mark style="color:green;">**`string`**</mark>

    **`Merchant order ID`**

    **`amount`**<mark style="color:red;">**`*`**</mark><mark style="color:orange;">**`number`**</mark>

    **`Payment amount`**
  </Tab>
</Tabs>

```ts { // Response } ```

Response Model Schema

{
  "code": 0,
  "message": "string",
  "response": {
    "merchant_uid": "string",
    "amount": 0
  }
}

**Swagger Test Link**

https://api.iamport.kr/#!/payments.validation/getPaymentPrepareByMerchantUid