결제
엑심베이 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를 사용하려면 별도의 계약이 필요합니다.
: 결제창이 호출되면 Token Creation 을 통해 발급받은 token_id 를 통해
추가적인 카드 정보 입력 없이
간편하게 인증, 결제 승인 그리고 매입까지 자동으로 처리되는 모델입니다.
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*국내 결제 시 사용할 수 있는 파라미터입니다.
receipt_status string
현금영수증 발급 여부를 Y, N 중 선택할 수 있습니다. 실시간 계좌이체를 사용하는 경우 현금영수증 발급을 위해서 반드시 Y로 요청해야 현금영수증 발급이 가능합니다.
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 object
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 통화 코드에서 확인할 수 있습니다.
* 금액은 엑심베이 DCC Provider를 통해 조회한 실시간 환율이 적용된 금액입니다. 카드정보가 최종 입력된 후에는 카드발급 국가의 통화로 변경될 수 있습니다.
* 해외 결제 연동시 사용할 수 있습니다.
call_from_app string
-
Y
:앱(iOS, AOS) 환경에서 호출
-
N
: 웹 브라우저 환경에서 호출
-
*
앱 환경에서 결제창을 호출할 경우 웹뷰에서 외부 앱 열기의 연동 방법을 확인해주세요.
call_from_scheme string
-
*
앱 환경에서 결제창을 호출할 경우 웹뷰에서 외부 앱 열기의 연동 방법을 확인해주세요.
issuer_country string
ostype string
: PC 환경
: 모바일 환경
virtualaccount_expiry_datestring
tokenbilling object
token_creation string
: 토큰 생성 요청
* transaction_type 파라미터가 PAYMENT인 경우만 사용할 수 있습니다.
unique_token_id string
: 유일한 결제정보(card)로 토큰 생성만 가능, 기 동일한 결제정보(card)로 등록된 token_id 존재 시 거절됩니다.
: 결제정보(card)로 복수의 토큰 생성이 가능
* transaction_type 파라미터가 PAYMENT인 경우만 사용할 수 있습니다.
token_id string
* transaction_type 파라미터가 REBILL인 경우만 사용할 수 있습니다.
Note. 1 - 토큰 결제를 사용하려면 별도의 계약이 필요합니다.
recurring object * 자동결제 등록에 사용되는 파라미터입니다.
recurring_amount string
필수전체 자릿수는 10이고, 소수 자릿수는 2. (예시 - 10.50, 9.15)
금액 3자리 구분 ,는 사용하지 않습니다.
recurring_start_date string
필수자동 결제 시작일(다음 결제일)은 현재 일자 이후 이어야 하며, 이후로는 1달 후 자동 결제됩니다.
recurring_interval string
필수최대 반복 주기는 10(월)입니다. (예시 - 3달 주기 결제의 경우 3)
recurring_noti_url string
최대 길이는 255자입니다.
remind_email_interval string
최대 길이는 2자입니다. (예시 - '7'인 경우, 결제 7일전에 결제자에게 알림메일 발송)
fast_payment object
user_id string
필수user_ci string
필수* 가맹점에서 본인 인증 진행 후 받은 userCi를 파라미터로 세팅해 주시기 바랍니다.
* 가맹점에서 본인 인증을 진행하지 않는 경우 엑심베이와 사전 협의를 진행해야 하며, userCi 값은 공백으로 보내주시기 바랍니다.
phone_number string
필수* 가맹점에서 본인 인증을 진행하지 않는 경우 공백으로 보내주시기 바랍니다.
birthday string
필수* 가맹점에서 본인 인증을 진행하지 않는 경우 공백으로 보내주시기 바랍니다.
gender string
필수: 남성
: 여성
* 가맹점에서 본인 인증을 진행하지 않는 경우 공백으로 보내주시기 바랍니다.
foreigner string
필수: 외국인
: 내국인
* 가맹점에서 본인 인증을 진행하지 않는 경우 공백으로 보내주시기 바랍니다.
Note. 1 - 빠른 결제를 사용하려면 별도의 계약이 필요합니다.
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"
},
"tokenbilling" : {
"token_creation" : "Y",
"unique_token_id" : "Y"
},
"recurring" : {
"recurring_amount" : "1.15",
"recurring_start_date" : "20250210",
"recurring_interval" : "1",
"recurring_noti_url" : "https://가맹점url",
"remind_email_interval" : "5"
}
}'
rescode string
필수resmsg string
필수fgkey string
필수
{
"rescode": "0000",
"resmsg": "Success",
"fgkey": "0E9BE04BA239A519E68171F26B68604ADA0A85C8350DBF5C8C0FCCF98461DB09"
}
결제 승인
POST/v1/payments/confirm
인증 결제창으로 결제 인증 후 결제 승인 API를 호출해 결제를 마무리하세요.transaction_type string
필수자세한 내용은 준비하기 를 참고하세요.
: 결제 승인과 함께 매입까지 자동으로 처리되는 모델입니다.
: 결제 승인만 처리되는 모델입니다. 매입 처리를 위해서 수동 매입 API를 별도로 사용해야 합니다.
mid string
필수payment object
order_id string
필수currency string
필수amount string
필수payer_auth_id string
필수lang string
필수other_param object
param1 string
param2 string
curl --request POST 'https://api-test.eximbay.com/v1/payments/confirm' \
--header 'Authorization: Basic dGVzdF8xODQ5NzA1QzY0MkMyMTdFMEIyRDo=' \
--header 'Content-Type: application/json' \
--data '{
"transaction_type" : "PAYMENT_PA",
"mid" : "1849705C64",
"payment" : {
"order_id" : "20220902101716",
"currency" : "USD",
"amount" : "1",
"payer_auth_id" : "20220902101716",
"lang" : "EN"
}
}'
rescode string
필수resmsg string
필수mid string
필수payment object
order_id string
필수currency string
필수amount string
필수email string
필수transaction_id string
필수auth_code string
* 간편결제로 결제된 거래의 경우 승인번호가 존재하지 않습니다.
transaction_date string
필수access_country string
payment_method string
pay_to string
payment_url string
status string
: 접수 반드시 Sale을 수신한 경우에만 주문완료 처리를 해야합니다.
: 입금 완료 시 statusurl로만 전송됩니다.
base_currency string
* 일반적으로 currency 파라미터와 동일 값이 돌아오며, 자국통화기준 MCP의 경우 원화(KRW) 또는 달러(USD) 로 돌아옵니다.
* 직가맹점은 매입데이터로 사용할 수 있습니다.
* 해외 결제 연동시 사용할 수 있습니다.
base_amount string
* 일반적으로 amount 파라미터와 동일 값이 돌아오며, 자국통화기준 MCP의 경우 원화(KRW) 또는 달러(USD) 로 돌아옵니다.
* 직가맹점은 매입데이터로 사용할 수 있습니다.
* 해외 결제 연동시 사용할 수 있습니다.
base_rate string
* currency대비 base_currency에 대한 환율로, 동일한 경우 1 이 돌아옵니다.
* 직가맹점은 매입데이터로 사용할 수 있습니다.
* 해외 결제 연동시 사용할 수 있습니다.
dcc_rate string
* base_currency대비 foreign_currency에 대한 환율로, 동일한 경우 1 이 돌아옵니다.
* 해외 결제 연동시 사용할 수 있습니다.
terminal_id string
card_number string
expiry_date string
store_number string
foreign object
foreign_currency string
* DCC의 경우 고객이 선택한 통화 단위가 돌아옵니다.
* 해외 결제 연동시 사용할 수 있습니다.
foreign_amount string
* DCC의 경우 고객이 선택한 통화 단위가 돌아옵니다.
* 해외 결제 연동시 사용할 수 있습니다.
foreign_rate string
* currency 대비 foreign_currency 에 대한 환율로 동일한 경우 1 이 들어옵니다.
* 해외 결제 연동시 사용할 수 있습니다.
card_info object
card_holder string
card_number1 string
card_number4 string
cash_receipt object
use_flag string
*가상계좌, 네이버페이 포인트 결제 시 필요한 파라미터입니다.
cash_receipt_type string
*가상계좌, 네이버페이 포인트 결제 시 필요한 파라미터입니다.
customer_information_type string
*가상계좌, 네이버페이 포인트 결제 시 필요한 파라미터입니다.
customer_information string
*가상계좌, 네이버페이 포인트 결제 시 필요한 파라미터입니다.
ship_to object
city string
country string
first_name string
last_name string
phone_number string
postal_code string
state string
street1 string
dm object
dm_decision string
: DM Process 위험 검토 후 거래 승인
: DM Process 위험 검토 후 거래 실패
: DM Process 위험 검토 후 승인될 수 있으나, 위험 거래여부 확인이 필요한 상태
: DM Process 실패
dm_reject string
dm_review string
other_param object
param1 string
param2 string
{
"rescode": "0000",
"resmsg": "Success",
"mid": "1849705C64",
}
결제 검증
POST/v1/payments/verify
SDK로 결제창을 열고 받은 응답에 포함되어 있는 FGKey의 유효성 검증을 위해 필요합니다.결제 검증 API를 사용해 결제를 마무리하세요. 아래 주의사항을 꼭 참고해주세요.
엑심베이 서버에서 가맹점 status_url로 나간 응답 파라미터는 쿼리스트링 형식입니다.
쿼리스트링으로 응답받은 파라미터를 빠짐없이 결제 검증 API 요청 파라미터로 전송해주세요.
자세한 내용은 결제
준비에서 확인할 수 있습니다.
Note. 1 - SDK로 결제창을 열 때 선택한 transaction_type과 사용한 요청
파라미터에 따라
status_url로 받은 응답 값이 달라집니다.
Note. 2 - 국내/해외 결제 따라 SDK 호출 후 받는 응답 값이 달라질 수 있습니다.
version string
필수mid string
필수transaction_type string
필수fgkey string
필수order_id string
필수currency string
필수amount string
필수email string
필수param1 string
param2 string
param3 string
rescode string
필수resmsg string
필수transaction_id string
auth_code string
* 간편결제로 결제된 거래의 경우 승인번호가 존재하지 않습니다.
payer_auth_id string
transaction_date string
access_country string
payment_method string
payment_type string
*국내 간편결제를 사용했을 경우 필요한 파라미터입니다.
pay_to string
card_holder string
card_number1 string
card_number4 string
installment_months string
*국내 결제일 경우 사용할 수 있습니다.
status string
필수: 정상매출 (매출 확정)
: 승인거래 (매출 미확정, 수동 매입시 매출 확정)
: 주문등록 (매출 미확정, 입금통지시 매출 확정)
: 거래 없음
ship_to_city string
ship_to_country string
ship_to_first_name string
ship_to_last_name string
ship_to_phone_number string
ship_to_postal_code string
ship_to_state string
ship_to_street1 string
useFlag string
*가상계좌, 네이버페이 포인트 결제 시 필요한 파라미터입니다.
cash_receipt_type string
*가상계좌, 네이버페이 포인트 결제 시 필요한 파라미터입니다.
cash_receipt_deduction_detail string
*가상계좌, 네이버페이 포인트 결제 시 필요한 파라미터입니다.
cash_receipt_user_info string
*가상계좌, 네이버페이 포인트 결제 시 필요한 파라미터입니다.
virtual_account_number string
virtual_account_bank_name string
virtual_account_depositor string
virtual_account_due_date string
Note. 1 - 고객이 결제수단으로 가상계좌 또는 일본 편의점 결제를 선택했을 때 필요한 객체입니다.
Note. 2 - 가상계좌 또는 일본 편의점 결제의 경우 아래 두 단계로 결과가 전송됩니다.
• 주문등록: returnurl, statusurl • 입금통지: statusurl
Note. 3 - statusurl로 주문등록 결과를 받을지 여부는 선택할 수 있습니다.
payment_url string
dm_decision string
: DM Process 위험 검토 후 거래 승인
: DM Process 위험 검토 후 거래 실패
: DM Process 위험 검토 후 승인될 수 있으나, 위험 거래여부 확인이 필요한 상태
: DM Process 실패
dm_reject string
dm_review string
base_currency string
* 일반적으로 currency 파라미터와 동일 값이 돌아오며, 자국통화기준 MCP의 경우 원화(KRW) 또는 달러(USD) 로 돌아옵니다.
* 직가맹점은 매입데이터로 사용할 수 있습니다.
* 해외 결제 연동시 사용할 수 있습니다.
base_amount string
* 일반적으로 amount 파라미터와 동일 값이 돌아오며, 자국통화기준 MCP의 경우 원화(KRW) 또는 달러(USD) 로 돌아옵니다.
* 직가맹점은 매입데이터로 사용할 수 있습니다.
* 해외 결제 연동시 사용할 수 있습니다.
base_rate string
currency 대비 base_currency 에 대한 환율로, 동일한 경우 1 이 돌아옵니다.
* 직가맹점은 매입데이터로 사용할 수 있습니다.
* 해외 결제 연동시 사용할 수 있습니다.
foreign_currency string
* DCC의 경우 고객이 선택한 통화 단위가 돌아옵니다.
*해외 결제 연동시 사용할 수 있습니다.
foreign_amount string
* DCC의 경우 고객이 선택한 통화에 맞는 금액이 돌아옵니다.
*해외 결제 연동시 사용할 수 있습니다.
foreign_rate string
*currency 대비 foreign_currency 에 대한 환율로 동일한 경우 1 이 돌아옵니다.
*해외 결제 연동시 사용할 수 있습니다.
dcc_rate string
base_currency 대비 foreign_currency 에 대한 환율로, 동일한 경우 1 이 돌아옵니다.
* 해외 결제 연동시 사용할 수 있습니다.
terminal_id string
card_number string
expiry_date string
store_number string
cavv string
xid string
eci string
token_id string
* 토큰결제 연동시 사용할 수 있습니다.
token_creation string
* 토큰 생성 요청시 전달된 파라미터를 리턴합니다.
recurring_payment string
최대 길이는 1자입니다.
: 자동결제 등록
recurring_id string
최대 길이는 20자입니다.
recurring_next_date string
최대 길이는 8자입니다. (YYYYMMDD)
curl --request POST 'https://api-test.eximbay.com/v1/payments/verify' \
--header 'Authorization: Basic dGVzdF8xODQ5NzA1QzY0MkMyMTdFMEIyRDo=' \
--header 'Content-Type: application/json' \
--data '{
"data" : "currency=USD&card_number1=4111&transaction_date=20220927152250&card_number4=1111&mid=1849705C64&amount=100&access_country=KR&order_id=20220927152140&payment_method=P101&email=test@eximbay.com&ver=230&transaction_id=1849705C6420220927000016¶m3=TEST&resmsg=Success.&card_holder=TESTP&rescode=0000&auth_code=309812&fgkey=2AE38D785E05E6AF57977328908C7CD84A273B3FE6C042D537A800B0CBC783EA&transaction_type=PAYMENT&pay_to=EXIMBAY.COM"
}'
rescode string
필수resmsg string
필수
{
"rescode": "0000",
"resmsg": "Success",
}
결제 조회
POST/v1/payments/retrieve
승인 또는 취소된 결제를 조회할 수 있습니다.
결제 조회 API는 반드시 Server to Server로 구현하시기 바랍니다.
mid string
필수key_field string
필수: 승인 또는 환불된 최종 거래를 조회할 수 있습니다.
: 지정된 거래를 조회할 때 사용합니다.
payment object
order_id string
필수currency string
필수amount string
필수lang string
필수transaction_id string
other_param object
param1 string
param2 string
curl --request POST 'https://api-test.eximbay.com/v1/payments/retrieve' \
--header 'Authorization: Basic dGVzdF8xODQ5NzA1QzY0MkMyMTdFMEIyRDo=' \
--header 'Content-Type: application/json' \
--data '{
"mid" : "1849705C64",
"key_field" : "order_id",
"payment" : {
"order_id" : "20220902101716",
"currency" : "USD",
"amount" : "1",
"transaction_id" : "20220902101716",
"lang" : "EN"
}
}'
rescode string
필수resmsg string
필수mid string
필수payment object
status string
필수: 정상매출 (매출 확정)
: 승인거래 (매출 미확정, 수동 매입시 매출 확정)
: 주문등록 (매출 미확정, 입금통지시 매출 확정)
: 거래 없음
order_id string
필수currency string
필수amount string
필수transaction_id string
필수auth_code string
* 간편결제로 결제된 거래의 경우 승인번호가 존재하지 않습니다.
transaction_date string
필수balance string
payment_method string
card_info object
card_number1 string
card_number4 string
other_param object
param1 string
param2 string
{
"rescode": "0000",
"resmsg": "Success.",
"mid": "1849705C64",
"payment": {
"order_id": "20220902101716",
"currency": "USD",
"amount": "1",
"transaction_id": "1849705C6420220902000010",
"status": "AUTH",
"auth_code": "485760",
"transaction_date": "20220902101749",
"balance": "1.00"
},
"card_info": {
"cardno1": "4111",
"cardno4": "1111"
}
}
결제 취소
POST/v1/payments/{transaction_id}/cancel
승인된 결제를 transaction_id 로 취소합니다.
결제 취소 API는 반드시 Server to Server로 구현하시기 바랍니다.
mid string
필수엑심베이에서 가맹점을 구분하기 위해 발급한 고유 가맹점 ID입니다.
refund object
refund_type string
필수: 전체 취소
: 부분 취소
refund_amount string
필수요청한 취소 금액입니다. 원승인 거래 금액을 초과해 요청할 수 없습니다. refund_type이 F 일 때 금액을 보내지 않으면 원승인 거래 전체 금액이 취소됩니다.
refund_id string
필수취소하려는 거래를 구분하기 위해 가맹점에서 생성하는 고유한 취소 번호입니다. 취소 번호는 유일한 값을 가져야 합니다.
reason string
필수결제를 취소한 이유입니다.
payment object
order_id string
필수취소하려는 거래의 주문번호(odrer_id)입니다. 동일한 주문번호를 넣어야 취소가 정상적으로 처리됩니다.
currency string
필수결제에 사용한 통화 단위입니다 . 자세한 내용은 통화 코드를 참고하세요.
amount string
필수총 결제 금액입니다. , 는 사용할 수 없으며, 0보다 큰 숫자만 보낼 수 있습니다.
balance string
필수취소 가능 금액입니다. (승인 금액 - 환불 금액)
lang string
필수결제창에 지원되는 언어 코드입니다. 를 참고하세요.
other_param object
param1 string
가맹점이 필요한 경우 사용할 수 있는 예비 파라미터입니다. 최대 길이는 255자입니다.
param2 string
가맹점이 필요한 경우 사용할 수 있는 예비 파라미터입니다. 최대 길이는 255자입니다.
refund_account object*가상계좌 거래를 취소할 때 필요한 파라미터입니다.
user_name string
고객이 입력할 환불계좌 정보의 예금주명입니다.
bank_code string
고객이 입력할 환불계좌의 은행코드입니다.
account_number string
고객이 입력할 환불계좌의 계좌번호입니다.
tax object*가상계좌 또는 네이버페이로 결제한 거래를 취소할 때 필요한 파라미터입니다.
receipt_status string
현금영수증 발급 여부를 Y, N 중 선택할 수 있습니다. 실시간 계좌이체를 사용하는 경우 현금영수증 발급을 위해서 반드시 Y로 요청해야 현금영수증 발급이 가능합니다.
amount_tax_free string
amount_taxable string
amount_vat string
amount_service_fee string
curl --request POST 'https://api-test.eximbay.com/v1/payments/{transaction_id}/cancel' \
--header 'Authorization: Basic dGVzdF8xODQ5NzA1QzY0MkMyMTdFMEIyRDo=' \
--header 'Content-Type: application/json' \
--data '{
"mid" : "1849705C64",
"refund" : {
"refund_type" : "F",
"refund_amount" : "1",
"refund_id" : "1849705C64",
"reason" : "단순변심"
},
"payment" : {
"order_id" : "20220829170258",
"currency" : "USD",
"amount" : "1",
"balance" : "1",
"lang" : "EN"
}
}'
rescode string
필수응답 코드입니다.
resmsg string
필수응답 코드에 대한 설명입니다.
mid string
필수엑심베이에서 가맹점을 구분하기 위해 발급한 고유 가맹점 ID입니다.
refund object
refund_amount string
필수요청한 취소 금액입니다. 원승인 거래 금액을 초과해 요청할 수 없습니다. refund_type이 F 일 때 금액을 보내지 않으면 원승인 거래 전체 금액이 취소됩니다.
refund_id string
필수취소하려는 거래를 구분하기 위해 가맹점에서 생성하는 고유한 취소 번호입니다. 취소 번호는 유일한 값을 가져야 합니다.
refund_date string
필수결제가 취소된 일시입니다. YYYYMMDDHHMMSS 형식으로 돌아옵니다.
refund_transaction_id string
필수엑심베이에서 취소된 거래를 구분하기 위해 발급한 고유한 아이디입니다.
payment object
order_id string
필수취소하려는 거래의 주문번호(odrer_id)입니다. 동일한 주문번호를 넣어야 취소가 정상적으로 처리됩니다.
currency string
필수결제에 사용한 통화 단위입니다. 자세한 내용은 통화 코드를 참고하세요.
amount string
필수총 결제 금액입니다. , 는 사용할 수 없으며, 0보다 큰 숫자만 보낼 수 있습니다.
transaction_id string
필수엑심베이에서 결제 내역을 구분하기 위해 발급한 고유 ID입니다.
balance string
필수취소 가능 금액입니다. (승인 금액 - 환불 금액)
auth_code string
* 간편결제로 결제된 거래의 경우 승인번호가 존재하지 않습니다.
base_amount string
* 일반적으로 amount 파라미터와 동일 값이 돌아오며, 자국통화기준 MCP의 경우 원화(KRW) 또는 달러(USD) 로 돌아옵니다.
* 직가맹점은 매입데이터로 사용할 수 있습니다.
* 해외 결제 연동시 사용할 수 있습니다.
base_rate string
currency 대비 base_currency 에 대한 환율로, 동일한 경우 1 이 돌아옵니다.
* 직가맹점은 매입데이터로 사용할 수 있습니다.
* 해외 결제 연동시 사용할 수 있습니다.
dcc_rate string
base_currency 대비 foreign_currency 에 대한 환율로, 동일한 경우 1 이 돌아옵니다.
* 해외 결제 연동시 사용할 수 있습니다.
foreign objcet
foreign_currency string
* DCC의 경우 고객이 선택한 통화 단위가 돌아옵니다.
* 해외 결제 연동시 사용할 수 있습니다.
foreign_amount string
* DCC의 경우 고객이 선택한 통화에 맞는 금액이 돌아옵니다.
* 해외 결제 연동시 사용할 수 있습니다.
foreign_rate string
* currency 대비 foreign_currency 에 대한 환율로 동일한 경우 1 이 돌아옵니다.
* 해외 결제 연동시 사용할 수 있습니다.
other_param object
param1 string
param2 string
{
"rescode": "0000",
"resmsg": "Success.",
"mid": "1849705C64",
"refund": {
"refund_amount": "1.00",
"refund_id": "1849705C64",
"refund_date": "20220922113927",
"refund_transaction_id": "1849705C6420220922000014"
},
"payment": {
"order_id": "20220922113330",
"currency": "USD",
"amount": "1.00",
"transaction_id": "1849705C6420220922000013",
"balance": "0.00",
"base_amount": "1.00",
"base_rate": "1.000000",
"dcc_rate": "1.000000",
"payment_method" : "P101"
},
"foreign": {
"foregin_currency": "USD",
"foregin_amount": "1.00",
"foregin_rate": "0"
}
}