⌨ī¸Paymentwall delivery API

Registers delivery information.

Registers delivery information required by Paymentwall for e-Commerce (physical goods) businesses.

Registers delivery information for physical products.

POST https://api.iamport.kr/paymentwall/delivery

If omitted, you cannot receive settlement from Paymentwall.

Request Body

NameTypeDescription

imp_uid*

String

i'mport transaction ID

merchant_uid*

String(40)

Order ID

type*

String(10)

Product code

physical

digital

status*

String(10)

Delivery status code

order_placed

order_shipped

delivering

delivered

carrier_tracking_id

String(64)

Tracking number

Required for physical order

carrier_type

String(64)

Courier name

Required for physical order

estimated_delivery_datetime

integer

Estimated delivery date/time

Unix timestamp

(May specify current time for digital order)

estimated_update_datetime

integer

Estimated status update date/time

Unix timestamp sec

(May specify current time for digital order)

reason

String(64)

Reason

refundable*

String

Refundable?

yes

no

details

String(400)

Details

shipping_address_email*

String(50)

Recipient's email

shipping_address_country

String(40)

Recipient's country

Required for physical order

shipping_address_city

String(40)

Recipient's city

Required for physical order

shipping_address_zip

String(40)

Recipient's zip code

Required for physical order

shipping_address_state

String(40)

Recipient's state

Set to 'N/A' if outside of USA

Required for physical order

shipping_address_street

String(40)

Recipient's street name

Required for physical order

shipping_address_phone

String(40)

Recipient's phone

Required for physical order

shipping_address_firstname

String(40)

Recipient's first name

Required for physical order

shipping_address_lastname

String(40)

Recipient's last name

Required for physical order

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

Includes multiple error messages or 'success: 1' message when successful.

error_codeinteger

Success if null. Otherwise, check notices for error message.

error string

Error message

notices Array[string]

Detailed error message

Response Model Schema
{
  "code": 0,
  "message": "string",
  "response": {
    "error_code": 0,
    "error": "string",
    "notices": [
      "string"
    ]
  }
}

Last updated