API 목록
version 1.0
- version 1.0
엑심베이 API
엑심베이 API를 이용하면 다양한 결제 수단의 결제 연동・승인・취소・조회・인증을 구현할 수 있습니다.
API를 사용하기 위해 필요한 키 정보와 인증 방식, 보안에 대한 정보는 API 준비하기에서 자세히 알아보세요.
결제 준비
POST/v1/payments/ready
FGKey는 결제의 위변조 방지를 위해 가맹점과 엑심베이 사이에 요청, 응답되는 파라미터의 유효성을 검증할 때 사용하고 있습니다.결제 준비 API를 사용해 결제창 호출에 필요한 FGKey를 생성해보세요.
결제 준비 API로 생성한 fgkey는 JavaScript SDK로 결제창을 호출할 때 반드시 필요합니다.
생성한 fgkey를 그대로 넣어서 결제창을 호출해주세요. 자세한 내용은 javascript SDK 에서 확인할 수 있습니다.
payment object
transaction_type string
필수자세한 내용은 준비하기를 참고하세요.
: 결제창이 호출되고 인증, 결제 승인 그리고 매입까지 자동으로 처리되는 모델입니다.
: 결제창이 호출되면 인증만 처리되며, 승인과 매입이 자동으로 처리되는 API 또는, 승인만 이루어지는
승인 API 호출이 독립적으로 필요한 모델입니다.
: 결제창이 호출되면 인증과 승인까지 자동으로 처리되며, 매입(정산)은 가맹점에서 수동 매입 API를
호출해 요청해야 합니다
* 수동 매입 API를 사용하려면 별도의 계약이 필요합니다.
order_id string
필수currency string
필수amount string
필수lang string
필수payment_method string
multi_payment_method string
merchant object
mid string
필수shop string
partner_code string
url object
return_url string
필수return_url은 고객 브라우저 기반으로 동작하므로, 브라우저 강제 종료 시, 호출되지 않을 수 있습니다.
status_url string
필수브라우저에서 호출되지 않으므로, 스크립트, 쿠키, 세션은 사용할 수 없습니다.
* DB 작업 및 결제 프로세스 처리는 status_url에서 해야 합니다.
* 고객이 결제창을 강제 종료하면 return_url이 호출되지 않을 수 있습니다.
* 중복 호출이 가능하므로, 결제가 중복 처리되지 않게 주의가 필요합니다.
buyer object
name string
필수phone_number string
email string
필수tax object*국내 결제 시 사용할 수 있는 파라미터입니다.
amount_tax_free string
amount_taxable string
amount_vat string
amount_service_fee string
Note. 1 - 네이버페이 포인트로 결제를 진행하는 경우 tax 객체 내 파라미터 모두를 필수로 보내야 합니다.
Note. 2 - 국내/해외 결제 따라 SDK 호출 후 받는 응답 값이 달라질 수 있습니다.
other_param object
param1 string
param2 string
product array 배열의 길이는 최대 3입니다.
name string
필수quantity string
필수unit_price string
필수link string
필수surcharge array 배열의 길이는 최대 3입니다.
name string
quantity string
unit_price string
ship_to
city string
country string
first_name string
last_name string
phone_number string
postal_code string
state string
street1 string
bill_to object
city string
country string
first_name string
last_name string
phone_number string
postal_code string
state string
street1 string
settings object
display_type string
: 팝업 형태로 결제창 생성
: 가맹점 화면에서 결제창 화면으로 이동
autoclose string
중 하나입니다. 보내지 않으면 N 이 기본으로 보내집니다.
: 가맹점 화면으로 이동
: 결제창의 완료 화면으로 이동(기본)
site_foreign_currency string
* payment_method 파라미터를 사용한 경우 P000(신용카드)만 보낼 수 있습니다.
* 가맹점에서 DCC를 사용할 경우, DCC 지원통화만 결제창에서 보여줄 수 있습니다. DCC 지원 통화는 에서 확인할 수 있습니다.
* 금액은 엑심베이 DCC Provider를 통해 조회한 실시간 환율이 적용된 금액입니다. 카드정보가 최종 입력된 후에는 카드발급 국가의 통화로 변경될 수 있습니다.
* 해외 결제 연동시 사용할 수 있습니다.
call_from_app string
-
Y
:앱(iOS, AOS) 환경에서 호출
-
N
: 웹 브라우저 환경에서 호출
-
*
앱 환경에서 결제창을 호출할 경우 웹뷰에서 외부 앱 열기의 연동 방법을 확인해주세요.
call_from_scheme string
-
*
앱 환경에서 결제창을 호출할 경우 웹뷰에서 외부 앱 열기의 연동 방법을 확인해주세요.
issuer_country string
ostype string
: PC 환경
: 모바일 환경
curl --request POST 'https://api-test.eximbay.com/v1/payments/ready' \
--header 'Authorization: Basic dGVzdF8xODQ5NzA1QzY0MkMyMTdFMEIyRDo=' \
--header 'Content-Type: application/json' \
--data '{
"payment" : {
"transaction_type" : "PAYMENT",
"order_id" : "20220819105102",
"currency" : "USD",
"amount" : "1",
"lang" : "EN"
},
"merchant" : {
"mid" : "1849705C64"
},
"buyer" : {
"name" : "eximbay",
"email" : "test@eximbay.com"
},
"url" : {
"return_url" : "eximbay.com",
"status_url" : "eximbay.com"
}
}'
rescode string
필수resmsg string
필수fgkey string
필수
{
"rescode": "0000",
"resmsg": "Success",
"fgkey": "0E9BE04BA239A519E68171F26B68604ADA0A85C8350DBF5C8C0FCCF98461DB09"
}
