웹훅
페이플 웹훅을 이용하면 결제결과 누락을 방지할 수 있습니다. 정산지급대행은 이체실행 결과를 웹훅으로 받습니다.
서비스별 웹훅
| 서비스 | 종류 | 라이브 등록 위치 |
|---|---|---|
| 국내 카드/계좌 결제 | 결제 완료, 취소 완료, 결제수단 등록, 결제수단 해지 | 파트너 관리자 〉 기본정보 |
| 해외 카드 결제 | 결제 완료, 취소 완료 | 파트너 관리자 〉 기본정보 |
| 정산지급대행 | 이체실행 완료 | 파트너 관리자 〉 정산지급대행 〉 정산지급대행 이용정보 |
참고
테스트 계정은 계약 심사가 완료되면 자동으로 발급됩니다.
참고
라이브 환경에서 웹훅 등록은 파트너 관리자 〉 기본정보 메뉴에서 가능합니다.
결제 완료PAYMENT
참고
정기결제에서 중복결제를 방지하려면
PCD_PAY_YEAR,PCD_PAY_MONTH 를 추가해주세요.국내 카드결제
| 파라미터 | 설명 | 값 예시 |
|---|---|---|
| PCD_WEBHOOK_TYPE | 웹훅 종류 구분값 (값은 위 표 참고) | PAYMENT |
| PCD_PAY_RST | 결과 | success |
| PCD_PAY_CODE | 응답 코드 | 0000 |
| PCD_PAY_MSG | 응답 메시지 | 카드승인완료 |
| PCD_PAY_TYPE | 결제수단 | card |
| PCD_CARD_VER | 결제수단 상세(앱카드/정기) | 01 |
| PCD_PAY_WORK | 결제요청 방식 | CERT |
| PCD_AUTH_KEY | 파트너 인증 토큰 값 | K0VnWlZ5TWZSaG... |
| PCD_PAY_REQKEY | 최종 결제요청 승인키 | VnfReitkgcREx... |
| PCD_PAY_HOST | 파트너 인증 후 본 요청시 필요한 페이플 도메인 주소 | https://democpay.payple.kr |
| PCD_PAY_URL | 파트너 인증 후 본 요청시 필요한 페이플 도메인 주소 | "" |
| PCD_PAY_COFURL | 최종 결제요청 URL | https://demopcpay.payple.kr... |
| PCD_PAYER_ID | 카드등록 후 리턴받은 빌링키 | OVA3UUdZSFNiSG... |
| PCD_PAYER_NO | 회원번호 | 2335 |
| PCD_PAYER_NAME | 결제자 이름 | 홍길동 |
| PCD_PAYER_HP | 휴대전화번호 | 01012345678 |
| PCD_PAYER_EMAIL | 이메일주소 | test@payple.kr |
| PCD_PAY_YEAR | 월 중복결제 년 | 2022 |
| PCD_PAY_MONTH | 월 중복결제 월 | 06 |
| PCD_PAY_OID | 주문번호 | test06881335001623242176279 |
| PCD_PAY_GOODS | 상품명 | 테스트상품 |
| PCD_PAY_AMOUNT | 결제 요청금액 | 1000 |
| PCD_PAY_DISCOUNT | 페이플 이벤트 할인금액(이용불가) | "" |
| PCD_PAY_AMOUNT_REAL | 실 결제금액 | 1000 |
| PCD_PAY_TOTAL | 결제금액의 총합계 | 1000 |
| PCD_PAY_TAXTOTAL | 과세금액 | 0 |
| PCD_PAY_ISTAX | 과세여부 | Y |
| PCD_PAY_CARDNAME | 카드사 | 삼성카드 |
| PCD_PAY_CARDNUM | 카드번호 | 1234-****-****-5678 |
| PCD_PAY_CARDQUOTA | 할부 개월 수 | 00 |
| PCD_PAY_CARDTRADENUM | 승인거래 키 | 298416639827 |
| PCD_PAY_CARDAUTHNO | 승인번호 | 85324231 |
| PCD_PAY_CARDRECEIPT | 매출전표 출력 링크 | https://cpay.payple.kr/receipt/card.php?token=... |
| PCD_PAY_TIME | 결제완료 시간 | 20220624114407 |
| PCD_REGULER_FLAG | 월 중복결제 방지 사용여부 | N |
| PCD_SIMPLE_FLAG | 비밀번호 간편결제 방식 선택 | N |
| PCD_RST_URL | 결과 리턴 URL / 결제창 호출방식 | /order_result.html |
| PCD_LINK_ADD_PARAM | 링크결제 생성시 추가로 지정한 사용자 정의 파라미터 | {"params1":"val1","params2":"val2"} |
JSON 예시
{ "PCD_WEBHOOK_TYPE" : "PAYMENT", "PCD_PAY_RST" : "success", "PCD_PAY_CODE" : "0000", "PCD_PAY_MSG" : "카드승인완료", "PCD_PAY_TYPE" : "card", "PCD_CARD_VER" : "01", "PCD_PAY_WORK" : "CERT", "PCD_AUTH_KEY" : "K0VnWlZ5TWZSaG...", "PCD_PAY_REQKEY" : "VnfReitkgcREx...", "PCD_PAY_HOST" : "https://democpay.payple.kr", "PCD_PAY_URL" : "", "PCD_PAY_COFURL" : "https://demopcpay.payple.kr...", "PCD_PAYER_ID" : "OVA3UUdZSFNiSG...", "PCD_PAYER_NO" : "2335", "PCD_PAYER_NAME" : "홍길동", "PCD_PAYER_HP" : "01012345678", "PCD_PAYER_EMAIL" : "test@payple.kr", "PCD_PAY_YEAR" : "2022", "PCD_PAY_MONTH" : "06" , "PCD_PAY_OID" : "test06881335001623242176279", "PCD_PAY_GOODS" : "테스트상품", "PCD_PAY_AMOUNT" : "1000", "PCD_PAY_DISCOUNT" : "", "PCD_PAY_AMOUNT_REAL" : "1000", "PCD_PAY_TOTAL" : "1000", "PCD_PAY_TAXTOTAL" : "0", "PCD_PAY_ISTAX" : "Y", "PCD_PAY_CARDNAME" : "삼성카드", "PCD_PAY_CARDNUM" : "1234-****-****-5678", "PCD_PAY_CARDQUOTA" : "00", "PCD_PAY_CARDTRADENUM" : "298416639827", "PCD_PAY_CARDAUTHNO" : "85324231", "PCD_PAY_CARDRECEIPT" : "https://cpay.payple.kr/receipt/card.php?token=...", "PCD_PAY_TIME" : "20220624114407", "PCD_REGULER_FLAG" : "N", "PCD_SIMPLE_FLAG" : "N", "PCD_RST_URL" : "/order_result.html", "PCD_LINK_ADD_PARAM": {"params1":"val1","params2":"val2"}}
국내 계좌결제
| 파라미터 | 설명 | 값 예시 |
|---|---|---|
| PCD_WEBHOOK_TYPE | 웹훅 종류 구분값 (값은 위 표 참고) | PAYMENT |
| PCD_PAY_RST | 결과 | success |
| PCD_PAY_CODE | 응답 코드 | BILL0000 |
| PCD_PAY_MSG | 응답 메시지 | 출금이체완료 |
| PCD_PAY_TYPE | 결제수단 | transfer |
| PCD_PAY_WORK | 결제요청 방식 | CERT |
| PCD_AUTH_KEY | 파트너 인증 토큰 값 | K0VnWlZ5TWZSaGNla1V... |
| PCD_PAY_REQKEY | 최종 결제요청 승인키 | VnfReitkgcREx... |
| PCD_PAY_HOST | 파트너 인증 후 본 요청시 필요한 페이플 도메인 주소 | https://democpay.payple.kr |
| PCD_PAY_URL | 파트너 인증 후 본 요청시 필요한 페이플 도메인 주소 | "" |
| PCD_PAY_COFURL | 최종 결제요청 URL | https://demopcpay.payple.kr... |
| PCD_PAYER_ID | 계좌등록 후 리턴받은 빌링키 | bitvTm11bEN... |
| PCD_PAYER_NO | 회원번호 | 2335 |
| PCD_PAYER_NAME | 결제자 이름 | 홍길동 |
| PCD_PAYER_HP | 휴대전화번호 | 01012345678 |
| PCD_PAYER_EMAIL | 이메일주소 | test@payple.kr |
| PCD_PAY_BANKACCTYPE | 개인, 법인 구분 | personal |
| PCD_PAY_YEAR | 월 중복결제 년 | 2022 |
| PCD_PAY_MONTH | 월 중복결제 월 | 06 |
| PCD_PAY_OID | 주문번호 | test0803729001656045847 |
| PCD_PAY_GOODS | 상품명 | 테스트상품 |
| PCD_PAY_AMOUNT | 결제 요청금액 | 1000 |
| PCD_PAY_DISCOUNT | 페이플 이벤트 할인금액(이용불가) | "" |
| PCD_PAY_AMOUNT_REAL | 실 결제금액 | 1000 |
| PCD_PAY_TOTAL | 결제금액의 총합계 | 1000 |
| PCD_PAY_TAXTOTAL | 과세금액 | 0 |
| PCD_PAY_BANK | 은행 코드 | 011 |
| PCD_PAY_BANKNAME | 은행명 | NH농협은행 |
| PCD_PAY_BANKNUM | 계좌번호 | 456-*******-123 |
| PCD_PAY_ISTAX | 과세여부 | 과세여부 |
| PCD_PAY_TIME | 결제완료 시간 | 20220624134514 |
| PCD_REGULER_FLAG | 월 중복결제 방지 사용여부 | N |
| PCD_TAXSAVE_FLAG | 현금영수증 발행창 사용여부 | N |
| PCD_TAXSAVE_RST | 현금영수증 발행결과 | N |
| PCD_TAXSAVE_MGTNUM | 현금영수증 국세청 발행번호 | "" |
| PCD_SIMPLE_FLAG | 비밀번호 간편결제 방식 선택 | "" |
| PCD_RST_URL | 결과 리턴 URL / 결제창 호출방식 | /order_result.html |
| PCD_LINK_ADD_PARAM | 링크결제 생성시 추가로 지정한 사용자 정의 파라미터 | {"params1":"val1","params2":"val2"} |
JSON 예시
{ "PCD_WEBHOOK_TYPE" : "PAYMENT", "PCD_PAY_RST" : "success", "PCD_PAY_CODE" : "BILL0000", "PCD_PAY_MSG" : "출금이체완료", "PCD_PAY_TYPE" : "transfer", "PCD_PAY_WORK" : "CERT", "PCD_AUTH_KEY" : "K0VnWlZ5TWZSaGNla1V...", "PCD_PAY_REQKEY" : "VnfReitkgcREx...", "PCD_PAY_HOST" : "https://democpay.payple.kr", "PCD_PAY_URL" : "", "PCD_PAY_COFURL" : "https://demopcpay.payple.kr...", "PCD_PAYER_ID" : "bitvTm11bEN...", "PCD_PAYER_NO" : "2335", "PCD_PAYER_NAME" : "홍길동", "PCD_PAYER_HP" : "01012345678", "PCD_PAYER_EMAIL" : "test@payple.kr", "PCD_PAY_BANKACCTYPE" : "personal", "PCD_PAY_YEAR" : "2022", "PCD_PAY_MONTH" : "06", "PCD_PAY_OID" : "test0803729001656045847", "PCD_PAY_GOODS" : "테스트상품", "PCD_PAY_AMOUNT" : "1000", "PCD_PAY_DISCOUNT" : "", "PCD_PAY_AMOUNT_REAL" : "1000", "PCD_PAY_TOTAL" : "1000", "PCD_PAY_TAXTOTAL" : "0", "PCD_PAY_BANK" : "011", "PCD_PAY_BANKNAME" : "NH농협은행", "PCD_PAY_BANKNUM" : "456-*******-123", "PCD_PAY_ISTAX" : "과세여부", "PCD_PAY_TIME" : "20220624134514", "PCD_REGULER_FLAG" : "N", "PCD_TAXSAVE_FLAG" : "N", "PCD_TAXSAVE_RST" : "N", "PCD_TAXSAVE_MGTNUM" : "" , "PCD_SIMPLE_FLAG" : "", "PCD_RST_URL" : "/order_result.html", "PCD_LINK_ADD_PARAM": {"params1":"val1","params2":"val2"}}
취소 완료REFUND
국내 카드/계좌결제
| 파라미터 | 설명 | 값 예시 |
|---|---|---|
| PCD_WEBHOOK_TYPE | 웹훅 종류 구분값 (값은 위 표 참고) | REFUND |
| PCD_PAY_RST | 결과 | success |
| PCD_PAY_CODE | 응답 코드 | PAYC0000 |
| PCD_PAY_MSG | 응답 메시지 | 승인취소성공 |
| PCD_PAY_OID | 주문번호 | test06881335001623242176279 |
| PCD_PAY_TYPE | 결제수단 | card |
| PCD_PAYER_ID | 카드(계좌) 등록시 리턴받은 빌링키 | d0to... |
| PCD_PAY_GOODS | 상품명 | 테스트상품 |
| PCD_REFUND_TOTAL | 취소 요청금액 | 1000 |
| PCD_REFUND_TAXTOTAL | 취소 요청금액의 부가세 | 10 |
| PCD_PAY_CARDTRADENUM | 취소거래 키 | 202206241312548965783400 |
| PCD_PAY_CARDRECEIPT | 매출전표 출력 링크 | https://cpay.payple.kr/receipt/card.php?token=... |
JSON 예시
{ "PCD_WEBHOOK_TYPE" : "REFUND", "PCD_PAY_RST" : "success", "PCD_PAY_CODE" : "PAYC0000", "PCD_PAY_MSG" : "승인취소성공", "PCD_PAY_OID" : "test06881335001623242176279", "PCD_PAY_TYPE" : "card", "PCD_PAYER_ID" : "d0to...", "PCD_PAY_GOODS" : "테스트상품", "PCD_REFUND_TOTAL" : "1000", "PCD_REFUND_TAXTOTAL" : "10", "PCD_PAY_CARDTRADENUM" : "202206241312548965783400", "PCD_PAY_CARDRECEIPT" : "https://cpay.payple.kr/receipt/card.php?token=..."}
결제수단 등록REGISTER
국내 카드결제
| 파라미터 | 설명 | 값 예시 |
|---|---|---|
| PCD_WEBHOOK_TYPE | 웹훅 종류 구분값 (값은 위 표 참고) | REGISTER |
| PCD_PAY_RST | 결과 | success |
| PCD_PAY_CODE | 응답 코드 | 0000 |
| PCD_PAY_MSG | 응답 메시지 | 카드등록이 완료되었습니다. |
| PCD_PAY_WORK | 등록방식 | AUTH |
| PCD_AUTH_KEY | 파트너 인증 토큰 값 | K0VnWlZ5TWZSaGNla... |
| PCD_PAY_TYPE | 등록한 결제수단 | card |
| PCD_PAYER_AUTHTYPE | 비밀번호 간편결제 인증방식 | pwd |
| PCD_PAYER_NO | 회원번호 | 2335 |
| PCD_PAYER_ID | 카드 등록 후 리턴받은 빌링키 | ekNWNW... |
| PCD_PAYER_NAME | 결제자 이름 | 홍길동 |
| PCD_PAYER_EMAIL | 이메일 | test@payple.kr |
| PCD_PAYER_HP | 휴대전화번호 | 01012345678 |
| PCD_PAY_CARDNAME | 카드사 | NH |
| PCD_PAY_CARDNUM | 카드번호 | 1234-****-****-7894 |
| PCD_RST_URL | 결과 리턴 URL / 결제창 호출방식 | /order_result.html |
JSON 예시
{ "PCD_WEBHOOK_TYPE": "REGISTER", "PCD_PAY_RST": "success", "PCD_PAY_CODE": "0000", "PCD_PAY_MSG": "카드등록이 완료되었습니다.", "PCD_PAY_WORK": "AUTH", "PCD_AUTH_KEY": "K0VnWlZ5TWZSaGNla...", "PCD_PAY_TYPE": "card", "PCD_PAYER_AUTHTYPE": "pwd", "PCD_PAYER_NO": "2335", "PCD_PAYER_ID": "ekNWNW...", "PCD_PAYER_NAME": "홍길동", "PCD_PAYER_EMAIL": "test@payple.kr", "PCD_PAYER_HP": "01012345678", "PCD_PAY_CARDNAME": "NH", "PCD_PAY_CARDNUM": "1234-****-****-7894", "PCD_RST_URL": "/order_result.html"}
국내 계좌결제 - ARS 인증 성공
| 파라미터 | 설명 | 값 예시 |
|---|---|---|
| PCD_WEBHOOK_TYPE | 웹훅 종류 구분값 (값은 위 표 참고) | REGISTER |
| PCD_PAY_RST | 결과 | success |
| PCD_PAY_CODE | 응답 코드 | 0000 |
| PCD_PAY_MSG | 응답 메시지 | 계좌등록이 완료되었습니다. |
| PCD_PAY_WORK | 등록방식 | AUTH |
| PCD_AUTH_KEY | 파트너 인증 토큰 값 | K0VnWlZ5TWZ... |
| PCD_PAY_TYPE | 등록한 결제수단 | transfer |
| PCD_PAYER_AUTHTYPE | 비밀번호 간편결제 인증방식 | sms |
| PCD_PAYER_NO | 회원번호 | 2335 |
| PCD_PAYER_ID | 계좌 등록 후 리턴받은 빌링키 | YzZFc3h... |
| PCD_PAY_BANKACCTYPE | 개인, 법인 구분 | personal |
| PCD_PAYER_NAME | 결제자 이름 | 홍길동 |
| PCD_PAYER_HP | 휴대전화번호 | 01012345678 |
| PCD_PAY_BANK | 은행 코드 | 011 |
| PCD_PAY_BANKNAME | 은행명 | NH농협은행 |
| PCD_PAY_BANKOWNER | 예금주명 | 홍길동 |
| PCD_PAY_BANKNUM | 계좌번호 | 456-*******-123 |
| PCD_RST_URL | 결과 리턴 URL / 결제창 호출방식 | /order_result.html |
JSON 예시
{ "PCD_WEBHOOK_TYPE":"REGISTER", "PCD_PAY_RST":"success", "PCD_PAY_CODE":"0000", "PCD_PAY_MSG":"계좌등록이 완료되었습니다.", "PCD_PAY_WORK":"AUTH", "PCD_AUTH_KEY":"K0VnWlZ5TWZ...", "PCD_PAY_TYPE":"transfer", "PCD_PAYER_AUTHTYPE":"sms", "PCD_PAYER_NO":"2335", "PCD_PAYER_ID":"YzZFc3h...", "PCD_PAY_BANKACCTYPE":"personal", "PCD_PAYER_NAME":"홍길동", "PCD_PAYER_HP":"01012345678", "PCD_PAY_BANK":"011", "PCD_PAY_BANKNAME":"NH농협은행", "PCD_PAY_BANKOWNER":"홍길동", "PCD_PAY_BANKNUM":"456-*******-123", "PCD_RST_URL":"/order_result.html"}
국내 계좌결제 - 계좌 등록 완료
| 파라미터 | 설명 | 값 예시 |
|---|---|---|
| PCD_WEBHOOK_TYPE | 웹훅 종류 구분값 (값은 위 표 참고) | REGISTER |
| PCD_PAY_RST | 결과 | success |
| PCD_PAY_CODE | 응답 코드 | PBER0000 |
| PCD_PAY_MSG | 응답 메시지 | 계좌등록이 완료되었습니다. |
| PCD_PAY_WORK | 등록방식 | AUTH |
| PCD_AUTH_KEY | 파트너 인증 토큰 값 | K0VnWlZ5TWZ... |
| PCD_PAY_TYPE | 등록한 결제수단 | transfer |
| PCD_PAYER_NO | 회원번호 | 2335 |
| PCD_PAYER_ID | 계좌 등록 후 리턴받은 빌링키 | YzZFc3h... |
| PCD_PAYER_NAME | 결제자 이름 | 홍길동 |
| PCD_PAYER_EMAIL | 이메일 | test@payple.kr |
| PCD_PAYER_HP | 결제자 휴대전화번호 | 01012345678 |
| PCD_RST_URL | 결과 리턴 URL / 결제창 호출방식 | /order_result.html |
| PCD_PAY_BANKACCTYPE | 개인, 법인 구분 | personal |
| PCD_PAY_BANK | 은행 코드 | 011 |
| PCD_PAY_BANKNAME | 은행명 | NH농협은행 |
| PCD_PAY_BANKNUM | 계좌번호 | 456-*******-123 |
JSON 예시
{ "PCD_WEBHOOK_TYPE": "REGISTER", "PCD_PAY_RST": "success", "PCD_PAY_CODE": "PBER0000", "PCD_PAY_MSG": "계좌등록이 완료되었습니다.", "PCD_PAY_WORK": "AUTH", "PCD_AUTH_KEY": "K0VnWlZ5TWZ...", "PCD_PAY_TYPE": "transfer", "PCD_PAYER_NO": "2335", "PCD_PAYER_ID": "YzZFc3h...", "PCD_PAYER_NAME": "홍길동", "PCD_PAYER_EMAIL": "test@payple.kr", "PCD_PAYER_HP": "01012345678", "PCD_RST_URL": "/order_result.html", "PCD_PAY_BANKACCTYPE": "personal", "PCD_PAY_BANK" : "011", "PCD_PAY_BANKNAME" : "NH농협은행", "PCD_PAY_BANKNUM" : "456-*******-123"}
결제수단 해지TERMINATE
국내 카드결제
| 파라미터 | 설명 | 값 예시 |
|---|---|---|
| PCD_WEBHOOK_TYPE | 웹훅 종류 구분값 (값은 위 표 참고) | TERMINATE |
| PCD_PAY_RST | 결과 | success |
| PCD_PAY_CODE | 응답 코드 | PUSER0000 |
| PCD_PAY_MSG | 응답 메시지 | 카드해지완료 |
| PCD_PAY_WORK | API 요청 종류 | PUSERDEL |
| PCD_PAY_TYPE | 해지한 결제수단 | card |
| PCD_PAYER_ID | 카드 등록 후 리턴받은 빌링키 | ekNWNW... |
| PCD_PAYER_NO | 회원번호 | 1234 |
JSON 예시
{ "PCD_WEBHOOK_TYPE" : "TERMINATE", "PCD_PAY_RST" : "success", "PCD_PAY_CODE" : "PUSER0000", "PCD_PAY_MSG" : "카드해지완료", "PCD_PAY_TYPE" : "card", "PCD_PAY_WORK" : "PUSERDEL", "PCD_PAYER_ID" : "ekNWNW...", "PCD_PAYER_NO" : "1234"}
국내 계좌결제
| 파라미터 | 설명 | 값 예시 |
|---|---|---|
| PCD_WEBHOOK_TYPE | 웹훅 종류 구분값 (값은 위 표 참고) | TERMINATE |
| PCD_PAY_RST | 결과 | success |
| PCD_PAY_CODE | 응답 코드 | PUER0000 |
| PCD_PAY_MSG | 응답 메시지 | 계좌해지 완료 |
| PCD_PAY_WORK | API 요청 종류 | PUSERDEL |
| PCD_PAY_TYPE | 해지한 결제수단 | transfer |
| PCD_PAYER_ID | 계좌 등록 후 리턴받은 빌링키 | YzZFc3h... |
| PCD_PAYER_NO | 회원번호 | 2335 |
JSON 예시
{ "PCD_WEBHOOK_TYPE": "TERMINATE", "PCD_PAY_RST": "success", "PCD_PAY_CODE": "PUER0000", "PCD_PAY_MSG": "계좌해지 완료", "PCD_PAY_TYPE": "transfer", "PCD_PAY_WORK": "PUSERDEL", "PCD_PAYER_ID": "YzZFc3h...", "PCD_PAYER_NO": "2335"}
참고
라이브 환경에서 웹훅 등록은 파트너 관리자 〉 기본정보 메뉴에서 가능합니다.
결제 완료
해외 카드결제
| 파라미터 | 설명 | 값 예시 |
|---|---|---|
| type | 요청 종류 | PAYMENT |
| result | 응답 코드 | A0000 |
| message | 응답 메시지 | Processing Success |
| resultUrl | 결제결과 반환(Return) URL | http://test.shop.com |
| org_pay_id | 원거래 결제 고유키 | "" |
| api_id | 결제 요청 고유키 | 6548264741426583803027 |
| api_date | 대한민국(UTC+9) 기준 결제시간 | 2022-06-10 11:01:17 |
| receiptUrl | 매출전표(거래 내역서) 조회 URL | https://api.payple.kr/gpay/receipt?token=abc123... |
| info.service_oid | 주문번호 | test120220608512351 |
| info.comments | 상품명 | 테스트상품명 |
| info.pay_type | 결제수단 | card |
| info.card_number | 카드번호 | 1234-****-****-7890 |
| info.totalAmount | 결제 요청금액 | 0.10 |
| info.currency | 통화 | USD |
| info.firstName | 카드회원 이름 | Gildong |
| info.lastName | 카드회원 성 | Hong |
| info.email | 이메일 | test@payple.kr |
| info.phoneNumber | 휴대전화번호 | 01012345678 |
| info.billing_key | 빌링키 | MlNCQ0pHMn... |
| info.score_result | Decision Manager 점수 | 0 |
| info.submitTimeUtc | 국제표준시(UTC) 기준 결제시간 | 2022-06-10 02:01:16 |
| serviceDefine | 사용자 정의 파라미터 | Service Define Test |
JSON 예시
{ "type": "PAYMENT", "result": "A0000", "message": "Processing Success", "resultUrl": "http://test.shop.com", "org_pay_id": "", "api_id": "6548264741426583803027", "api_date": "2022-06-10 11:01:17", "receiptUrl": "https://api.payple.kr/gpay/receipt?token=abc123...", "info": { "service_oid": "test120220608512351", "comments": "테스트상품명", "pay_type": "card", "card_number": "1234-****-****-7890", "totalAmount": "0.10", "currency": "USD", "firstName": "Gildong", "lastName": "Hong", "email": "test@payple.kr", "phoneNumber": "01012345678", "billing_key": "MlNCQ0pHMn...", "score_result": "0", "submitTimeUtc": "2022-06-10 02:01:16" }, "serviceDefine": "Service Define Test"}
취소 완료
해외 카드결제
| 파라미터 | 설명 | 값 예시 |
|---|---|---|
| type | 요청 종류 | CANCEL |
| result | 응답 코드 | A0000 |
| message | 응답 메시지 | Processing Success |
| resultUrl | 취소 요청시 보낸 값 그대로 반환되는 URL | http://test.shop.com |
| org_pay_id | 원거래 결제 고유키 | 6548264741426583803027 |
| api_id | 취소 고유키 | 676273618072602 |
| api_date | 대한민국(UTC+9) 기준 취소시간 | 2022-06-10 16:09:22 |
| receiptUrl | 매출전표(거래 내역서) 조회 URL | https://api.payple.kr/gpay/receipt?token=abc123... |
| info.orgTotalAmount | 원거래 결제금액 | 0.10 |
| info.totalAmount | 취소 요청 금액 | 0.10 |
| info.remainAmount | 취소 후 잔여 금액 | 0.00 |
| info.currency | 취소 통화 | USD |
| info.service_oid | 원거래 주문번호 | OID_22072217525616584799763773750 |
| info.submitTimeUtc | 국제표준시(UTC) 기준 취소시간 | 2022-06-10 07:09:22 |
| serviceDefine | 사용자 정의 파라미터 | Service Define Test |
JSON 예시
{ "type": "CANCEL", "result": "A0000", "message": "Processing Success", "resultUrl": "http://test.shop.com", "org_pay_id": "6548264741426583803027", "api_id": "676273618072602", "api_date": "2022-06-10 16:09:22", "receiptUrl": "https://api.payple.kr/gpay/receipt?token=abc123...", "info": { "orgTotalAmount": "0.10", "totalAmount": "0.10", "remainAmount": "0.00", "currency": "USD", "service_oid": "OID_22072217525616584799763773750", "submitTimeUtc": "2022-06-10 07:09:22" }, "serviceDefine": "Service Define Test"}
정산지급대행
| 종류 | 설명 |
|---|---|
| 이체실행 완료 | 이체가 처리되면 결과(성공/실패)를 보냅니다. 금융기관 처리가 지연되면 처리 중(A0001 등) 결과를 먼저 보내고, 결과가 확정되면 최종 결과를 한 번 더 보냅니다. |
참고
라이브 환경에서 웹훅 등록은 파트너 관리자 〉 정산지급대행 〉 정산지급대행 이용정보 메뉴에서 가능합니다.
이체실행 완료
정산지급대행 이체실행 완료
| 파라미터 | 설명 | 값 예시 |
|---|---|---|
| result | 결과 | A0000 |
| message | 응답 메시지 | 처리 성공 |
| cst_id | 파트너 ID | 발급받은 cst_id |
| sub_id | 파트너 하위고객 ID | test12385610 |
| group_key | 실행 그룹 키 | Q0RSSkYzWUI3... |
| distinct_key | 중복 이체 방지 키 | uo3h1708394911737306031340821 |
| billing_tran_id | 빌링키 | 6fen3g2m-j9hb-... |
| api_tran_id | 거래고유번호 | ohr8ps3m-j5x... |
| api_tran_dtm | 이체일시 | 20211025142315647 |
| bank_tran_id | 은행 거래고유번호 | M202112389U142315646 |
| bank_tran_date | 이체일자 | 20211025 |
| bank_rsp_code | 기관 응답코드 | 000 |
| bank_code_std | 기관 표준코드 | 020 |
| bank_code_sub | 기관 점별코드 | 0000000 |
| bank_name | 기관명 | 우리은행 |
| account_num | 계좌번호 | 1234567890123456 |
| account_num_masked | 가림 처리된 계좌번호 | 1234567890123*** |
| account_holder_name | 예금주 | 홍길동 |
| print_content | 입금계좌인자내역 | 정산테스트 |
| tran_amt | 이체금액 | 1000 |
JSON 예시
{ "result":"A0000", "message":"처리 성공", "cst_id":"발급받은 cst_id", "sub_id":"test12385610", "group_key":"Q0RSSkYzWUI3...", "distinct_key":"uo3h1708394911737306031340821", "billing_tran_id":"6fen3g2m-j9hb-...", "api_tran_id":"ohr8ps3m-j5x...", "api_tran_dtm":"20211025142315647", "bank_tran_id":"M202112389U142315646", "bank_tran_date":"20211025", "bank_rsp_code":"000", "bank_code_std":"020", "bank_code_sub":"0000000", "bank_name":"우리은행", "account_num":"1234567890123456", "account_num_masked":"1234567890123***", "account_holder_name":"홍길동", "print_content":"정산테스트", "tran_amt":"1000"}