GMP OPEN API

Base URL: https://api.gmpay.kr
v0.0.1

회원

GET /oapi/p/member/checkMemberId 회원 아이디 중복 체크
Parameters
Name Type Required Description
memberId String Y 중복 체크할 회원 아이디
Success 200
Name Type Description
val1 String E : 존재 하는 아이디, N : 존재 하지 않는 아이디
Success Response 
{
  "message": "OK",
  "success": true,
  "val1": "E/N"
}
Error Response 
{
  "message": "Error Message",
  "success": false
}
POST /oapi/p/member/preAgree 사전 동의 신청
Headers
Name Description
devID 파트너사 아이디 (부여받은 아이디)
devToken 파트너사 토큰 (부여받은 토큰)
Parameters
Name Type Required Description
storeName String Y 상점명
ceoName String Y 대표자명
ceoMobile String Y 대표자 핸드폰 번호
email String Y E-mail
bizNo String Y 사업자 등록 번호
Request Example
{
  "bizNo": "1231212345",
  "ceoMobile": "01012341234",
  "ceoName": "\ub300\ud45c\uc790",
  "email": "test@gmpay.kr",
  "storeName": "\uc0c1\uc810\uba85"
}
Success Response 
{
  "message": "OK",
  "success": true
}
Error Response 
{
  "message": "Error Message",
  "success": false
}
POST /oapi/p/member/register 회원 가입
Headers
Name Description
devID 파트너사 아이디 (부여받은 아이디)
devToken 파트너사 토큰 (부여받은 토큰)
Parameters
Name Type Required Description
memberId String Y 회원 아이디
ceo String Y 대표자
passwd String Y 패스워드
bizNo String Y 사업자 등록 번호
stlDayCd String Y 기본 정산일 - DU01 : 익일1일, DU001 : D+1 정산, DU005 : D+5 정산
name String Y 가맹점명
mobile String Y 핸드폰 번호
email String Y E-mail
addr String Y 주소1
addr2 String Y 상세 주소
type1 String Y 업종
type2 String Y 업태
storePhone String Y 매장 전화번호
zipCode String Y 우편번호
productName String Y 주요 제품명
bizType String Y 사업자 타입 - PERSONAL : 개인사업자, CORPORATION : 법인사업자
corpNo String Y 법인 등록번호
taxType String Y 과세 타입 - TAX : 과세, TAX_FREE : 면세
homepage String N 홈페이지
ceoBirth String Y 대표자 생년월일 (yyyyMMdd)
taxEmail String Y 세금계산서 담당자 - E-mail
taxPhone String Y 세금계산서 담당자 - 전화번호
taxManager String Y 세금계산서 담당자 - 이름
saleMan String N 영업사원
Success Response 
{
  "message": "OK",
  "success": true
}
Error Response 
{
  "message": "Error Message",
  "success": false
}
GET /oapi/p/member/token 회원 토큰 정보 리턴
Headers
Name Description
devID 파트너사 아이디 (부여받은 아이디)
devToken 파트너사 토큰 (부여받은 토큰)
Parameters
Name Type Required Description
memberId String Y 취소 토큰을 조회할 회원 아이디
Success 200
Name Type Description
val1 String 취소 토큰
Success Response 
{
  "message": "OK",
  "success": true,
  "val1": "\ucde8\uc18c \ud1a0\ud070"
}
Error Response 
{
  "message": "Error Message",
  "success": false
}

결제

POST /oapi/payment/request 결제 요청
Parameters
Name Type Required Description
memberId String Y 판매점 아이디
totalPrice Number Y 결제 금액
goodName String Y 상품명
mobile String Y 구매자 핸드폰 번호
email String N 구매자 E-mail
comment String N 결제에 관련된 간략한 설명
feedbackUrl String N 결제 완료, 취소시 결과 값을 통지 받을 URL
returnUrl String N 결제 완료 후 돌아가기 URL
var1 String N 통지 시 함께 적용 수신 받을 값 1
var2 String N 통지 시 함께 적용 수신 받을 값 2
Request Example
{
  "goodName": "\ud14c\uc2a4\ud2b8 \uc0c1\ud488",
  "memberId": "testid",
  "mobile": "010-0000-0000",
  "totalPrice": 1004
}
Success 200
Name Type Description
payUrl String 결제 페이지 URL
orderNo String 주문번호 - 취소 호출시 필요
Feedback 통지 항목

feedbackUrl 설정시 결제 완료, 취소시 전송 되는 파라미터 입니다.

Name Type Description
memberId String 가맹점 아이디
feedbackToken String 피드백 토큰 (설정된 피드백 토큰, 확인 용으로 사용합니다.)
goodName String 상품명
price Number 결제 금액
customerPhone String 고객 연락처 (선택)
paymentState String 결제 상태 - COMPLETE : 결제 완료, CANCEL : 결제 취소
orderNo String 주문번호
payMethod String 결제 수단 - CARD : 카드
cardName String 카드사명
cardNum String 일부 마스킹된 카드 번호
cardQuota String 할부개월
approvalNo String 승인번호
var1 String 추가 필드 1 (선택)
var2 String 추가 필드 2 (선택)
cstUrl String 영수증 URL
Success Response 
{
  "message": "OK",
  "orderNo": "\uc8fc\ubb38\ubc88\ud638 - \ucde8\uc18c \ud638\ucd9c\uc2dc \ud544\uc694",
  "payUrl": "\uacb0\uc81c \ud398\uc774\uc9c0 URL",
  "success": true
}
Error Response 
{
  "message": "Error Message",
  "success": false
}
POST /oapi/payment/cancel 결제 취소
Parameters
Name Type Required Description
memberId String Y 판매점 아이디
orderNo String Y 주문 번호 (결제 완료시 리턴)
cancelToken String Y 판매자마다 부여된 취소 토큰
Request Example
{
  "cancelToken": "\ud310\ub9e4\uc790 \ub9c8\ub2e4 \ubd80\uc5ec\ub41c \ucde8\uc18c \ud1a0\ud070",
  "memberId": "testid",
  "orderNo": "\uc8fc\ubb38\ubc88\ud638"
}
Success Response 
{
  "message": "OK",
  "success": true
}
Error Response 
{
  "message": "Error Message",
  "success": false
}