⌨️Save payment amount API

Saves the payment amount before calling the payment window to block the payment process in case of forgery or falsification of the payment amount when making an authenticated payment.

Saves the payment amount before calling the payment window.

POST https://api.iamport.kr/payments/prepare

If the payment amount of the order saved on the merchant-side is different from the amount passed to IMP.requestpay() for the same merchant_uid, the PG payment window call is blocked.

Request Body

Name	Type	Description
merchant_uid*	String	Merchant order ID
amount*	double	Payment amount

200: OK Success

PaymentPrepareResponse

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 (PaymentPrepareAnnotation, optional)

PaymentPrepareAnnotation

merchant_uid * string

Merchant order ID

amount*number

Payment amount

401: Unauthorized Missing or invalid access token

Response Model Schema

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

Swagger Test Link

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