결제 예약취소 API

예약된 결제내역을 취소할 수 있는 API 입니다.

Deprecated

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

를 이용해주세요.

예약된 결제가 실행되기전에 해당 예약을 취소할 수 있는 API 입니다.

예약된 결제를 취소합니다.

POST https://api.iamport.kr/subscribe/payments/unschedule

Request Body

Name

Type

Description

customer_uid*

String

빌링키

merchant_uid

Array

주문번호

누락되면 customer_uid에 대한 결제 예약정보 일괄취소

code integer

응답코드

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

message string

응답메세지

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

response (Array[ScheduleResultAnnotation], optional

code integer

응답코드

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

message string

응답메세지

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

customer_uid string

빌링키

merchant_uid string

주문번호

imp_uid * string

포트원 결제 고유 UID

schedule_at UNIX timestamp

예약결제 실행 예정 시각

executed_at UNIX timestamp

예약결제가 실행된 시각

revoked_at UNIX timestamp

예약결제 실행을 철회한 시각

amount integer

주문(결제)금액

name string

제품명

buyer_name string

주문자명

buyer_email string

주문자 Email주소\

buyer_tel string

주문자 전화번호

buyer_addr string

주문자 주소

buyer_postcode string

주문자 우편번호

custom_data string

echo data JSON string으로 전달

schedule_status string

예약상태

scheduled: 예약됨(실행되기 전)
executed: 예약된 결제실행완료
revoked: 예약철회

payment_status string

실행된 결제의 승인 상태

null: 아직 예약결제가 실행되지 않음(null 이라는 값의 문자열이 아닌 실제 null 입니다)
paid: 예약결제가 결제승인됨
failed: 예약결제가 승인실패됨
cancelled: 예약결제가 결제승인 후 환불됨

fail_reason string

실패사유

{
    // Response
}

Response Model Schema

{
  "code": 0,
  "message": "string",
  "response": [
    {
      "customer_uid": "string",
      "merchant_uid": "string",
      "imp_uid": "string",
      "schedule_at": "0",
      "executed_at": "0",
      "revoked_at": "0",
      "amount": 0,
      "name": "string",
      "buyer_name": "string",
      "buyer_email": "string",
      "buyer_tel": "string",
      "buyer_addr": "string",
      "buyer_postcode": "string",
      "custom_data": "string",
      "schedule_status": "scheduled",
      "payment_status": "paid",
      "fail_reason": "string"
    }
  ]
}

Swagger Test Link

Previous결제 예약 API Next결제예약 복수조회 API

Last updated 2 years ago

Was this helpful?

예약된 결제를 취소합니다.

POST https://api.iamport.kr/subscribe/payments/unschedule

Request Body

Name

Type

Description

customer_uid*

String

빌링키

merchant_uid

Array

주문번호

누락되면 customer_uid에 대한 결제 예약정보 일괄취소

code integer

응답코드

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

message string

응답메세지

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

response (Array[ScheduleResultAnnotation], optional

code integer

응답코드

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

message string

응답메세지

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

customer_uid string

빌링키

merchant_uid string

주문번호

imp_uid * string

포트원 결제 고유 UID

schedule_at UNIX timestamp

예약결제 실행 예정 시각

executed_at UNIX timestamp

예약결제가 실행된 시각

revoked_at UNIX timestamp

예약결제 실행을 철회한 시각

amount integer

주문(결제)금액

name string

제품명

buyer_name string

주문자명

buyer_email string

주문자 Email주소\

buyer_tel string

주문자 전화번호

buyer_addr string

주문자 주소

buyer_postcode string

주문자 우편번호

custom_data string

echo data JSON string으로 전달

schedule_status string

예약상태

scheduled: 예약됨(실행되기 전)
executed: 예약된 결제실행완료
revoked: 예약철회

payment_status string

실행된 결제의 승인 상태

null: 아직 예약결제가 실행되지 않음(null 이라는 값의 문자열이 아닌 실제 null 입니다)
paid: 예약결제가 결제승인됨
failed: 예약결제가 승인실패됨
cancelled: 예약결제가 결제승인 후 환불됨

fail_reason string

실패사유

{
    // Response
}

Response Model Schema

{
  "code": 0,
  "message": "string",
  "response": [
    {
      "customer_uid": "string",
      "merchant_uid": "string",
      "imp_uid": "string",
      "schedule_at": "0",
      "executed_at": "0",
      "revoked_at": "0",
      "amount": 0,
      "name": "string",
      "buyer_name": "string",
      "buyer_email": "string",
      "buyer_tel": "string",
      "buyer_addr": "string",
      "buyer_postcode": "string",
      "custom_data": "string",
      "schedule_status": "scheduled",
      "payment_status": "paid",
      "fail_reason": "string"
    }
  ]
}

Swagger Test Link