비 인증 결제(일회성) API

카드정보를 기입하여 1회성 결제를 요청할 수 있습니다.

Previous비 인증 결제(빌링키) API Next해외PG 관련 API

Last updated 1 year ago

Was this helpful?

비 인증 결제(일회성) API

카드정보를 기입하여 1회성 결제를 요청할 수 있습니다.

Deprecated

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

를 이용해주세요.

카드정보만으로 결제를 요청할 수 있습니다.

구매자로부터 별도의 인증과정을 거치지 않고 카드정보만으로 결제를 진행하는 API 입니다.

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

customer_uid

를 전달해주시면 결제 후 다음 번 결제를 위해 성공된 결제에 사용된 빌링키를 저장해두게되고 customer_uid가 없는 경우 저장되지 않습니다. 동일한

merchant_uid는 재사용이 불가

능하며 고유한 값을 전달해주셔야 합니다.

Request Body

Name

Type

Description

merchant_uid*

String

주문번호

currency

결제통화 구분코드

KRW, USD, VND ...

amount*

double

결제금액

tax_free

double

면세금액

vat_amount

integer

부가세 지정(기본값: null)

지원 PG사

-나이스페이먼츠

-이니시스

card_number*

String

카드번호

(dddd-dddd-dddd-dddd)

expiry*

String

카드 유효기간

(YYYY-MM)

birth*

String

생년월일 6자리** (yymmdd)**

(법인카드의 경우 사업자등록번호10자리)

pwd_2digit

String

카드비밀번호 앞 2자리

cvc

String

카드 인증번호

(카드 뒷면 3자리, AMEX의 경우 4자리). Paymentwall 에서만 사용

customer_uid

String

결제에 사용된 카드정보를 빌링키 형태로 저장해두고 재 결제에 사용하시려면 customer_uid를 지정해주세요

pg*

String

pg 구분코드

name

String

제품명

buyer_name

String

구매자명

buyer_email

String

주문자 E-mail주소

buyer_tel

String

주문자 전화번호

buyer_addr

String

주문자 주소

buyer_postcode

String

주문자 우편번호

card_quota

integer

카드할부개월수

interest_free_by_merchant

boolen

가맹점부담 무이자 할부여부

custom_data

String

에코항목

notice_url

String

결제성공 시 통지될 웹훅 URL

browser_ip

String

매자 브라우져(PC)의 IP

secure_3d_charge_id

String

(해외PG 전용) 3D secure 인증 후 재결제시 PG사에서 부여한 결제 ID

secure_3d_token

String

(해외PG 전용) 3D secure 인증 후 재결제시 PG사에서 부여한 토큰

code * integer

응답코드

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

message * string

응답메세지

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

response (PaymentAnnotation, optional)

code * integer

응답코드

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

message * string

응답메세지

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

imp_uid * string

포트원 결제 고유 UID

merchant_uid * string

주문번호

pay_method * string

결제수단 구분코드

channel * string

결제환경 구분코드

pc : (인증방식)PC결제
mobile:(인증방식)모바일결제
api:정기결제 또는 비인증 결제

pg_provider * string

PG사 구분코드

emb_pg_provider * string

허브형결제 PG사 구분코드

pg_tid * string

pg사 거래번호

pg_id * string

PG사 MID

escrow boolean

에스크로 결제여부

apply_num string

신용카드 승인번호

bank_code string

bank_name string

은행 명칭

card_code string

card_name string

카드사명

card_quota integer

할부개월 수(0이면 일시불)

card_number string

마스킹 카드번호

card_type string

카드 구분코드

0 : 신용카드
1 : 체크카드

vbank_code string

가상계좌 은행 표준코드(하단이미지 참고)

vbank_name string

입금받을 가상계좌 은행명

vbank_holder string

입금받을 가상계좌 예금주

vbank_date string

입금받을 가상계좌 마감기한 (UNIX timestamp)

vbank_issued_at string

가상계좌 생성 시각 (UNIX timestamp)

name string

제품명

amount * integer

주문(결제)금액

cancel_amount integer

결제취소금액

currency string

통화구분코드

buyer_name string

주문자명

buyer_email string

주문자 Email주소\

buyer_tel string

주문자 전화번호

buyer_addr string

주문자 주소

buyer_postcode string

주문자 우편번호

custom_data string

echo data

JSON string으로 전달

user_agent string

UserAgent

결제를 시작한 단말기 정

status * string

결제상태 구분코드

ready
paid
cancelled
failed

started_at * string

결제시작시점 (UNIX timestamp)

paid_at * string

결제완료시점 (UNIX timestamp)\

failed_at * string

결제실패시점 (UNIX timestamp)

cancelled_at * string

결제취소시점 (UNIX timestamp)

fail_reason string

결제실패 사유

cancel_reason string

결제취소 사유

receipt_url string

신용카드 매출전표 확인 URL

cash_receipt_issued boolean

현금영수증 자동발급 여부

customer_uid string

해당 결제처리에 사용된 customer_uid

customer_uid_usage string

customer_uid 사용 구분코드

issue : 빌링키 발급
payment : 결제
payment.scheduled : 예약결제

cancel_history (Array[PaymentCancelAnnotation], optional):

취소/부분취소 내역

cancel_history array []

pg_tid * string

PG사 승인취소번호

amount * integer

취소 금액

cancelled_at * string

결제취소된 시각 UNIX timestamp

reason * string

결제취소 사유

receipt_url * string

취소에 대한 매출전표 확인 URL. PG사에 따라 제공되지 않는 경우도 있음

{
    // Response
}

주요 요청 파라미터 상세 설명

merchant_uid * string
주문번호
매 결제요청 시 고유값으로 요청해야 합니다.

card_numb * string
카드번호
카드번호 기재 양식의 유의하세요 (DDDD-DDDD-DDDD-DDDD)

expiry * string
카드 유효기간
유효기간 기입 양식을 유의하세요 (YYYY-MM)

birth * string
생년월일
생년월일 기재 양식 유의**(YYMMDD)** 및 법인카드의 경우 사업자 번호 10자리 기재
(생년월이 기재가 필요 없는 해외PG사 결제 요청의 경우 000000 으로 고정 기재해도 무방)

pg * string
pg 구분코드
관리자콘솔 API 방식 비인증 PG설정이 2개 이상인 경우 필수적으로 기재해야 하는 항목입니다.
동일 PG사에 두개의 MID 를 설정한 경우 아래 양식으로 기재 합니다.
{PG사}.{PG상점아이디}
나이스페이먼츠, JTNet 2가지 PG설정이 되어있다면, pg 파라미터로 nice 또는 jtnet로 구분 가능
나이스페이먼츠로부터 2개 이상의 상점아이디를 발급받았다면, nice.MID1 또는 nice.MID2로 구분 가능

buyer_name * string
**주문자명 **
페이먼트월 PG를 이용하는 경우 구매자명은 first name 과 last name이 한칸 띄어쓰기 형태로 구분되서 유입되어야 합니다.
예시)** Michael Jackson**

customer_uid * string
고객 빌링키
해당 값이 설정되는 경우 빌링키가 해당 값에 맵핑되며 추후 customer_uid 값으로만 결제를 발생시킬 수 있습니다.

Response Model Schema

{
  "code": 0,
  "message": "string",
  "response": {
    "imp_uid": "string",
    "merchant_uid": "string",
    "pay_method": "string",
    "channel": "pc",
    "pg_provider": "string",
    "emb_pg_provider": "string",
    "pg_tid": "string",
    "pg_id": "string",
    "escrow": true,
    "apply_num": "string",
    "bank_code": "string",
    "bank_name": "string",
    "card_code": "string",
    "card_name": "string",
    "card_quota": 0,
    "card_number": "string",
    "card_type": "null",
    "vbank_code": "string",
    "vbank_name": "string",
    "vbank_num": "string",
    "vbank_holder": "string",
    "vbank_date": 0,
    "vbank_issued_at": 0,
    "name": "string",
    "amount": 0,
    "cancel_amount": 0,
    "currency": "string",
    "buyer_name": "string",
    "buyer_email": "string",
    "buyer_tel": "string",
    "buyer_addr": "string",
    "buyer_postcode": "string",
    "custom_data": "string",
    "user_agent": "string",
    "status": "ready",
    "started_at": 0,
    "paid_at": 0,
    "failed_at": 0,
    "cancelled_at": 0,
    "fail_reason": "string",
    "cancel_reason": "string",
    "receipt_url": "string",
    "cancel_history": [
      {
        "pg_tid": "string",
        "amount": 0,
        "cancelled_at": 0,
        "reason": "string",
        "receipt_url": "string"
      }
    ],
    "cancel_receipt_urls": [
      "string"
    ],
    "cash_receipt_issued": true,
    "customer_uid": "string",
    "customer_uid_usage": "issue"
  }
}

Swagger Test Link

Previous비 인증 결제(빌링키) API Next해외PG 관련 API

Last updated 1 year ago

Was this helpful?

Deprecated

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

를 이용해주세요.

카드정보만으로 결제를 요청할 수 있습니다.

구매자로부터 별도의 인증과정을 거치지 않고 카드정보만으로 결제를 진행하는 API 입니다.

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

customer_uid

를 전달해주시면 결제 후 다음 번 결제를 위해 성공된 결제에 사용된 빌링키를 저장해두게되고 customer_uid가 없는 경우 저장되지 않습니다. 동일한

merchant_uid는 재사용이 불가

능하며 고유한 값을 전달해주셔야 합니다.

Request Body

Name

Type

Description

merchant_uid*

String

주문번호

currency

결제통화 구분코드

KRW, USD, VND ...

amount*

double

결제금액

tax_free

double

면세금액

vat_amount

integer

부가세 지정(기본값: null)

지원 PG사

-나이스페이먼츠

-이니시스

card_number*

String

카드번호

(dddd-dddd-dddd-dddd)

expiry*

String

카드 유효기간

(YYYY-MM)

birth*

String

생년월일 6자리** (yymmdd)**

(법인카드의 경우 사업자등록번호10자리)

pwd_2digit

String

카드비밀번호 앞 2자리

cvc

String

카드 인증번호

(카드 뒷면 3자리, AMEX의 경우 4자리). Paymentwall 에서만 사용

customer_uid

String

결제에 사용된 카드정보를 빌링키 형태로 저장해두고 재 결제에 사용하시려면 customer_uid를 지정해주세요

pg*

String

pg 구분코드

name

String

제품명

buyer_name

String

구매자명

buyer_email

String

주문자 E-mail주소

buyer_tel

String

주문자 전화번호

buyer_addr

String

주문자 주소

buyer_postcode

String

주문자 우편번호

card_quota

integer

카드할부개월수

interest_free_by_merchant

boolen

가맹점부담 무이자 할부여부

custom_data

String

에코항목

notice_url

String

결제성공 시 통지될 웹훅 URL

browser_ip

String

매자 브라우져(PC)의 IP

secure_3d_charge_id

String

(해외PG 전용) 3D secure 인증 후 재결제시 PG사에서 부여한 결제 ID

secure_3d_token

String

(해외PG 전용) 3D secure 인증 후 재결제시 PG사에서 부여한 토큰

code * integer

응답코드

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

message * string

응답메세지

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

response (PaymentAnnotation, optional)

code * integer

응답코드

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

message * string

응답메세지

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

imp_uid * string

포트원 결제 고유 UID

merchant_uid * string

주문번호

pay_method * string

결제수단 구분코드

channel * string

결제환경 구분코드

pc : (인증방식)PC결제
mobile:(인증방식)모바일결제
api:정기결제 또는 비인증 결제

pg_provider * string

PG사 구분코드

emb_pg_provider * string

허브형결제 PG사 구분코드

pg_tid * string

pg사 거래번호

pg_id * string

PG사 MID

escrow boolean

에스크로 결제여부

apply_num string

신용카드 승인번호

bank_code string

은행 표준코드

bank_name string

은행 명칭

card_code string

카드사 코드번호(금융결제원 표준코드번호 : )

card_name string

카드사명

card_quota integer

할부개월 수(0이면 일시불)

card_number string

마스킹 카드번호

card_type string

카드 구분코드

0 : 신용카드
1 : 체크카드

vbank_code string

가상계좌 은행 표준코드(하단이미지 참고)

vbank_name string

입금받을 가상계좌 은행명

vbank_holder string

입금받을 가상계좌 예금주

vbank_date string

입금받을 가상계좌 마감기한 (UNIX timestamp)

vbank_issued_at string

가상계좌 생성 시각 (UNIX timestamp)

name string

제품명

amount * integer

주문(결제)금액

cancel_amount integer

결제취소금액

currency string

통화구분코드

buyer_name string

주문자명

buyer_email string

주문자 Email주소\

buyer_tel string

주문자 전화번호

buyer_addr string

주문자 주소

buyer_postcode string

주문자 우편번호

custom_data string

echo data

JSON string으로 전달

user_agent string

UserAgent

결제를 시작한 단말기 정

status * string

결제상태 구분코드

ready
paid
cancelled
failed

started_at * string

결제시작시점 (UNIX timestamp)

paid_at * string

결제완료시점 (UNIX timestamp)\

failed_at * string

결제실패시점 (UNIX timestamp)

cancelled_at * string

결제취소시점 (UNIX timestamp)

fail_reason string

결제실패 사유

cancel_reason string

결제취소 사유

receipt_url string

신용카드 매출전표 확인 URL

cash_receipt_issued boolean

현금영수증 자동발급 여부

customer_uid string

해당 결제처리에 사용된 customer_uid

customer_uid_usage string

customer_uid 사용 구분코드

issue : 빌링키 발급
payment : 결제
payment.scheduled : 예약결제

cancel_history (Array[PaymentCancelAnnotation], optional):

취소/부분취소 내역

cancel_history array []

pg_tid * string

PG사 승인취소번호

amount * integer

취소 금액

cancelled_at * string

결제취소된 시각 UNIX timestamp

reason * string

결제취소 사유

receipt_url * string

취소에 대한 매출전표 확인 URL. PG사에 따라 제공되지 않는 경우도 있음

{
    // Response
}

주요 요청 파라미터 상세 설명

merchant_uid * string
주문번호
매 결제요청 시 고유값으로 요청해야 합니다.

card_numb * string
카드번호
카드번호 기재 양식의 유의하세요 (DDDD-DDDD-DDDD-DDDD)

expiry * string
카드 유효기간
유효기간 기입 양식을 유의하세요 (YYYY-MM)

birth * string
생년월일
생년월일 기재 양식 유의**(YYMMDD)** 및 법인카드의 경우 사업자 번호 10자리 기재
(생년월이 기재가 필요 없는 해외PG사 결제 요청의 경우 000000 으로 고정 기재해도 무방)

pg * string
pg 구분코드
관리자콘솔 API 방식 비인증 PG설정이 2개 이상인 경우 필수적으로 기재해야 하는 항목입니다.
동일 PG사에 두개의 MID 를 설정한 경우 아래 양식으로 기재 합니다.
{PG사}.{PG상점아이디}
나이스페이먼츠, JTNet 2가지 PG설정이 되어있다면, pg 파라미터로 nice 또는 jtnet로 구분 가능
나이스페이먼츠로부터 2개 이상의 상점아이디를 발급받았다면, nice.MID1 또는 nice.MID2로 구분 가능

buyer_name * string
**주문자명 **
페이먼트월 PG를 이용하는 경우 구매자명은 first name 과 last name이 한칸 띄어쓰기 형태로 구분되서 유입되어야 합니다.
예시)** Michael Jackson**

customer_uid * string
고객 빌링키
해당 값이 설정되는 경우 빌링키가 해당 값에 맵핑되며 추후 customer_uid 값으로만 결제를 발생시킬 수 있습니다.

Response Model Schema

{
  "code": 0,
  "message": "string",
  "response": {
    "imp_uid": "string",
    "merchant_uid": "string",
    "pay_method": "string",
    "channel": "pc",
    "pg_provider": "string",
    "emb_pg_provider": "string",
    "pg_tid": "string",
    "pg_id": "string",
    "escrow": true,
    "apply_num": "string",
    "bank_code": "string",
    "bank_name": "string",
    "card_code": "string",
    "card_name": "string",
    "card_quota": 0,
    "card_number": "string",
    "card_type": "null",
    "vbank_code": "string",
    "vbank_name": "string",
    "vbank_num": "string",
    "vbank_holder": "string",
    "vbank_date": 0,
    "vbank_issued_at": 0,
    "name": "string",
    "amount": 0,
    "cancel_amount": 0,
    "currency": "string",
    "buyer_name": "string",
    "buyer_email": "string",
    "buyer_tel": "string",
    "buyer_addr": "string",
    "buyer_postcode": "string",
    "custom_data": "string",
    "user_agent": "string",
    "status": "ready",
    "started_at": 0,
    "paid_at": 0,
    "failed_at": 0,
    "cancelled_at": 0,
    "fail_reason": "string",
    "cancel_reason": "string",
    "receipt_url": "string",
    "cancel_history": [
      {
        "pg_tid": "string",
        "amount": 0,
        "cancelled_at": 0,
        "reason": "string",
        "receipt_url": "string"
      }
    ],
    "cancel_receipt_urls": [
      "string"
    ],
    "cash_receipt_issued": true,
    "customer_uid": "string",
    "customer_uid_usage": "issue"
  }
}

Swagger Test Link