Search

파라미터 정의

메시지 포맷JSON(JavaScript Object Notation)입니다. 요청 후 받는 응답 파라미터는 JSON 표준대로 받아서 처리해주세요.

전체 파라미터 정의

전체 파라미터를 요청(Request)와 응답(Response)으로 구분하여 정리하였습니다.
전체 Parameter 하단에서 API별 요청 및 응답 파라미터도 확인해보세요.
※ 표 우측 상단에 있는 검색기능을 사용하여 빠르고 쉽게 파라미터를 검색해보세요!
Search
Parameter
Parameter
Request Value
Request Type (Length)
필수여부
Reference
Response Value
Response Type
더 알아보기
"abcd1234567890"
aN(255)
Y
파트너 인증키
"abcd1234567890"
aN(255)
"as12345678"
aN(10)
Y
파트너용 토큰 확인 코드
"as12345678"
aN(10)
-
-
응답 코드
"T0000"
-
-
-
응답 메시지
"처리 성공"
-
-
-
발행된 Access Token
"eyJhlNDlj..."
-
-
-
Access Token 유형
"Bearer" (고정값)
-
-
-
Access Token 만료 기간(초)
"60"
-
"test12385610"
aN(64)
N
파트너사 하위고객 ID
"test12385610"
aN(64)
"1234567890123456"
AN(16)
Y
계좌번호
"1234567890123456"
AN(16)
["0" | "6"]
N(1)
Y
예금주 실명번호 구분코드
-
-
["880212" | "1234567890"]
AN(13)
Y
예금주 실명번호
-
-
“c9z116521650283...”
aN(64)
N
파트너사 중복방지키
“c9z116521650283...”
aN(64)
[ "6fen3g2m-j9hb-..." | "ALL" ]
aNS(40)
Y
(실명 인증된) 계좌 빌링키 ※ 지급이체 실행(execute)시 실행범위 구분값
[ "6fen3g2m-j9hb-..." | "ALL" ]
aNS(40)
-
-
지급이체 거래고유번호
"9wm5a36z-5hj..."
aNS(40)
-
-
지급이체일시(밀리세컨드)
"20211022152040289"
N(17)
-
-
은행 거래고유번호
"M202112389U152040289"
AN(20)
"20211022"
N(8)
Y
지급이체일자
"20211022"
N(8)
-
-
지급이체기관 응답코드
"000"
AN(3)
"020"
AN(3)
Y
지급이체기관 표준코드
"020"
AN(3)
-
-
지급이체기관 점별코드
"1234567"
AN(7)
-
-
지급이체기관명
"우리은행"
AH(20)
-
-
계좌예금주명
"홍길동"
AH(20)
"1000"
N(12)
Y
지급이체금액
"1000"
N(12)
"정산테스트"
AH(6자) print_content의 Length단위는 자릿수 - 바이트(Byte)단위 아님
N
입금계좌인자내역
"정산테스트"
AH(6자)
"Q0RSSkYzWUI3..."
aN(64)
Y
실행 그룹 키
"Q0RSSkYzWUI3..."
aN(64)
["NOW" | "CANCEL"]
A
Y
실행 구분
["NOW" | "CANCEL"]
A
-
-
총 정산금액(HUB)
"10000000"
N(12)
-
-
총 지급이체 요청 누적금액
"56000"
N(12)
-
-
지급이체 한도잔여금액
"9944000"
N(12)
-
-
총 지급이체금액
"5000"
N(12)
"http://test.payple.kr/webhook"
테스트시 Y
테스트시 지급이체결과를 받을 웹훅 URL
-
-
-
-
지급이체요청(request)시간
"2021-10-26 10:55:03"
COUNT33

API별 파라미터 정의

요청, 응답 파라미터를 API별로 나누어서 설명합니다.
필수 요청 파라미터 보는 방법
상황별 Request 표에서 필수 여부를 보고 각 상황마다 필수 요청 파라미터를 확인합니다.
필수 : 해당 파라미터의 필수 값 여부
각 상황별 더욱 자세한 설명은 페이플 연동가이드 문서로 확인해주세요

토큰발급 파라미터

Search
Parameter
Request Value
Type (Length)
필수
Reference
더 알아보기
"test"
aN(8)
Y
파트너 ID
"abcd1234567890"
aN(255)
Y
파트너 인증키
"as12345678"
aN(10)
Y
파트너용 토큰 확인 코드
토큰발급 Request 예시
{ "cst_id":"test", "custKey":"abcd1234567890", "code":"as12345678" }
JSON
복사
Search
Parameter
Response Value
Type
Reference
더 알아보기
"T0000"
AN(10)
응답 코드
"처리 성공"
-
응답 메시지
"as12345678"
aN(10)
파트너용 토큰 확인 코드
"eyJhlNDlj..."
-
발행된 Access Token
"Bearer" (고정값)
-
Access Token 유형
"60"
-
Access Token 만료 기간(초)
COUNT6
토큰발급 Response 예시
{ "result":"T0000", "message":"처리 성공", "code":"as12345678", "access_token":"eyJhlNDlj...", "token_type":"Bearer", "expires_in":"60" }
JSON
복사

실명인증 파라미터

Search
Parameter
Request Value
Type (Length)
필수
Reference
더 알아보기
"test"
aN(8)
Y
파트너 ID
"abcd1234567890"
aN(255)
Y
파트너 인증키
"test12385610"
aN(64)
N
파트너사 하위고객 ID
"020"
AN(3)
Y
지급이체기관(은행) 표준코드
"1234567890123456"
AN(16)
Y
계좌번호
["0" | "6"]
N(1)
Y
예금주 실명번호 구분코드
["880212" | "1234567890"]
AN(13)
Y
예금주 실명번호
실명인증 요청 필수 파라미터 확인 예시
sub_id: 실명인증 요청시 선택 파라미터입니다.
cst_id , custKey : 실명인증 요청시 필수 파라미터입니다.
실명인증 Request 예시
{ "cst_id":"test", "custKey":"abcd1234567890", "sub_id":"test12385610", "bank_code_std":"020", "account_num":"1234567890123456", "account_holder_info_type":"0", "account_holder_info":"880212" }
JSON
복사
Search
Parameter
Response Value
Type
Reference
더 알아보기
"A0000"
응답 코드
"처리 성공"
응답 메시지
"test"
aN(8)
파트너 ID
"test12385610"
aN(64)
파트너사 하위고객 ID
"6fen3g2m-j9hb-..."
aNS(40)
(실명 인증된) 계좌 빌링키
"20211022152040289"
N(17)
지급이체일시(밀리세컨드)
"M202112389U152040289"
AN(20)
은행 거래고유번호
"20211022"
N(8)
지급이체일자
"000"
AN(3)
지급이체기관 응답코드
"020"
AN(3)
지급이체기관 표준코드
"1234567"
AN(7)
지급이체기관 점별코드
"우리은행"
AH(20)
지급이체기관명
"1234567890123456"
AN(16)
계좌번호
"홍길동"
AH(20)
계좌예금주명
COUNT14
실명인증 Response 예시
{ "result":"A0000", "message":"처리 성공", "cst_id":"test", "sub_id":"test12385610", "billing_tran_id":"6fen3g2m-j9hb-...c", "api_tran_dtm":"20211022152040289", "bank_tran_id":"M202112389U152040289", "bank_tran_date":"20211022", "bank_rsp_code":"000", "bank_code_std":"020", "bank_code_sub":"1234567", "bank_name":"우리은행", "account_num":"1234567890123456", "account_holder_name":"홍길동" }
JSON
복사

지급이체 요청(request) 파라미터

Search
Parameter
Request Value
Type (Length)
필수
Reference
더 알아보기
"test"
aN(8)
Y
파트너 ID
"abcd1234567890"
aN(255)
Y
파트너 인증키
"test12385610"
aN(64)
N
파트너사 하위고객 ID
"6fen3g2m-j9hb-..."
aNS(40)
Y
(실명 인증된) 계좌 빌링키
"1000"
N(12)
Y
지급이체금액
"정산테스트"
AH(20)
Y
입금계좌인자내역
지급이체 요청 Request 예시
{ "cst_id":"test", "custKey":"abcd1234567890", "sub_id":"test12385610", "billing_tran_id":"6fen3g2m-j9hb-...", "tran_amt":"1000", "print_content":"정산테스트" }
JSON
복사
Search
Parameter
Response Value
Type
Reference
더 알아보기
"A0000"
-
응답 코드
"처리 성공"
-
응답 메시지
"test"
aN(8)
파트너 ID
"test12385610"
aN(64)
파트너사 하위고객 ID
"Q0RSSkYzWUI3..."
aN(64)
실행 그룹 키
"6fen3g2m-j9hb-..."
aNS(40)
(실명 인증된) 계좌 빌링키
"1000"
N(12)
지급이체금액
"9995000"
N(12)
지급이체 한도 잔여금액
"정산테스트"
AH(20)
입금계좌인자내역
"20211022152040289"
N(17)
지급이체일시(밀리세컨드)
COUNT10
지급이체 요청 Response 예시
{ "result":"A0000", "message":"처리 성공", "cst_id":"test", "sub_id":"test12385610", "group_key":"Q0RSSkYzWUI3...", "billing_tran_id":"6fen3g2m-j9hb-...", "tran_amt":"1000", "remain_amt":"9995000", "print_content":"정산테스트", "api_tran_dtm":"20211022152040289" }
JSON
복사

지급이체 실행(execute) 파라미터

Search
Parameter
Request Value
Type (Length)
필수
Reference
더 알아보기
"test"
aN(8)
Y
파트너 ID
"abcd1234567890"
aN(255)
Y
파트너 인증키
"Q0RSSkYzWUI3..."
aN(64)
Y
실행 그룹 키
"6fen3g2m-j9hb-..."
aNS(40)
Y
(실명 인증된) 계좌 빌링키
["NOW" | "CANCEL"]
A
Y
실행 구분
지급이체 실행 Request 예시
{ "cst_id":"test", "custKey":"abcd1234567890", "group_key":"6fen3g2m-j9hb-...", "billing_tran_id":"ALL", "execute_type":"NOW" }
JSON
복사
Search
Parameter
Response Value
Type
Reference
더 알아보기
"A0000"
-
응답 코드
"처리 성공"
-
응답 메시지
"test"
aN(8)
파트너 ID
"Q0RSSkYzWUI3..."
aN(64)
실행 그룹 키
[ "6fen3g2m-j9hb-..." | "ALL" ]
aNS(40)
(실명 인증된) 계좌 빌링키
"5000"
N(12)
총 지급이체금액
"9995000"
N(12)
지급이체 한도 잔여금액
["NOW" | "CANCEL"]
A
실행 구분
"20211022152040289"
N(17)
지급이체일시(밀리세컨드)
COUNT9
지급이체 실행 Response 예시
{ "result":"A0000", "message":"처리 성공", "cst_id":"test", "group_key":"6fen3g2m-j9hb-...", "billing_tran_id":"ALL", "tot_tran_amt":"5000", "remain_amt":"9995000", "execute_type":"NOW", "api_tran_dtm":"20211022152040289" }
JSON
복사

지급이체 결과조회 파라미터

Search
Parameter
Request Value
Type (Length)
필수
Reference
더 알아보기
"test"
aN(8)
Y
파트너 ID
"abcd1234567890"
aN(255)
Y
파트너 인증키
"9wm5a36z-5hj..."
aNS(40)
Y
지급이체 거래고유번호
지급이체 결과조회 Request 예시
{ "cst_id":"test", "custKey":"abcd1234567890", "api_tran_id":"9wm5a36z-5hj..." }
JSON
복사
Search
Parameter
Response Value
Type
Reference
더 알아보기
"A0000"
aN(8)
응답 코드
"처리 성공"
aN(255)
응답 메시지
"test"
aN(8)
파트너 ID
"test12385610"
aN(64)
파트너사 하위고객 ID
"9wm5a36z-5hj..."
aNS(40)
지급이체 거래고유번호
"20211022152040289"
N(17)
지급이체일시(밀리세컨드)
"M202112389U152040289"
AN(20)
은행 거래고유번호
"20211022"
N(8)
지급이체일자
"000"
AN(3)
지급이체기관 응답코드
"020"
AN(3)
지급이체기관 표준코드
"1234567"
AN(7)
지급이체기관 점별코드
"우리은행"
AH(20)
지급이체기관명
"1234567890123456"
AN(16)
계좌번호
"1234567890123***"
계좌번호(마스킹처리)
"홍길동"
AH(20)
계좌예금주명
"정산테스트"
AH(20)
입금계좌인자내역
"1000"
N(12)
지급이체금액
COUNT17
지급이체 결과조회 Response 예시
{ "result":"A0000", "message":"처리 성공", "cst_id":"test", "sub_id":"test12385610", "api_tran_id":"9wm5a36z-5hj...", "api_tran_dtm":"20211022152040289", "bank_tran_id":"M202112389U152040289", "bank_tran_date":"20211022", "bank_rsp_code":"000", "bank_code_std":"020", "bank_code_sub":"1234567", "bank_name":"우리은행", "account_num":"1234567890123456", "account_num_masked":"1234567890123***", "account_holder_name":"홍길동", "print_content":"정산테스트", "tran_amt":"1000" }
JSON
복사

지급이체 잔여한도 조회 파라미터

Search
Parameter
Request Value
Type (Length)
필수
Reference
더 알아보기
"test"
aN(8)
Y
파트너 ID
"abcd1234567890"
aN(255)
Y
파트너 인증키
지급이체 잔여한도 조회 Request 예시
{ "cst_id":"test", "custKey":"abcd1234567890" }
JSON
복사
Search
Parameter
Response Value
Type
Reference
더 알아보기
"A0000"
-
응답 코드
"처리 성공"
-
응답 메시지
"test"
aN(8)
파트너 ID
"10000000"
N(12)
총 지급이체 가능금액
"56000"
N(12)
총 지급이체 누적금액
"9944000"
N(12)
지급이체 한도잔여금액
"20211103090426239"
N(17)
지급이체일시(밀리세컨드)
COUNT7
지급이체 잔여한도 조회 Response 예시
{ "result": "A0000", "message": "처리 성공", "cst_id": "test", "total_account_amt": "10000000", "total_transfer_amt": "56000", "remain_amt": "9944000", "api_tran_dtm": "20211103090426239" }
JSON
복사

일별 지급이체결과 조회 파라미터

Search
Parameter
Request Value
Type (Length)
필수
Reference
더 알아보기
"test"
aN(8)
Y
파트너 ID
"abcd1234567890"
aN(255)
Y
파트너 인증키
"20211022"
N(8)
Y
지급이체일자
일별 지급이체결과 조회 Request 예시
{ "cst_id":"test", "custKey":"abcd1234567890", "bank_tran_date": "20211022" }
JSON
복사
Search
Parameter
Response Value
Type
Reference
더 알아보기
"A0000"
aN(8)
응답 코드
"처리 성공"
aN(255)
응답 메시지
"3000"
N
해당 일자의 총 지급이체 완료금액
"3"
N
해당 일자의 총 지급이체 완료건수
"test"
aN(8)
파트너 ID
"test12385610"
aN(64)
파트너사 하위고객 ID
"Q0RSSkYzWUI3..."
aN(64)
실행 그룹 키
"6fen3g2m-j9hb-..."
aNS(40)
(실명 인증된) 계좌 빌링키
"9wm5a36z-5hj..."
aNS(40)
지급이체 거래고유번호
"20211022152040289"
N(17)
지급이체일시(밀리세컨드)
"M202112389U152040289"
AN(20)
은행 거래고유번호
"20211022"
N(8)
지급이체일자
"000"
AN(3)
지급이체기관 응답코드
"020"
AN(3)
지급이체기관 표준코드
"1234567"
AN(7)
지급이체기관 점별코드
"우리은행"
AH(20)
지급이체기관명
"1234567890123456"
AN(16)
계좌번호
"1234567890123***"
계좌번호(마스킹처리)
"홍길동"
AH(20)
계좌예금주명
"정산테스트"
AH(20)
입금계좌인자내역
"1000"
N(12)
지급이체금액
COUNT21
일별 지급이체결과 조회 Response 예시
{ "result": "A0000", "message": "처리 성공", "list": [ { "cst_id": "test", "sub_id": "test1238510", "group_key": "YWs1ZE83Q...", "billing_tran_id": "l94mc4kl-...", "api_tran_id": "trdjk6n8-pn6x-...", "api_tran_dtm": "20211029115948614", "bank_tran_id": "M202112389U115948612", "bank_tran_date": "20211029", "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": "정산테스트1", "tran_amt": "1000" }, { "cst_id": "test", "sub_id": "test1238510", "group_key": "YWs1ZE83Q...", "billing_tran_id": "l94mc4kl-...", "api_tran_id": "dy9j4neq-zurk-...", "api_tran_dtm": "20211029115948644", "bank_tran_id": "M202112389U115948643", "bank_tran_date": "20211029", "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": "정산테스트1", "tran_amt": "1000" }, { "cst_id": "test", "sub_id": "test1238510", "group_key": "S1VvbjNvSEd0bH...", "billing_tran_id": "l94mc4kl-...", "api_tran_id": "cyn61kif-022q-...", "api_tran_dtm": "20211029115948676", "bank_tran_id": "M202112389U115948675", "bank_tran_date": "20211029", "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
복사

그룹별 지급이체결과 조회 파라미터

Search
Parameter
Request Value
Type (Length)
필수
Reference
더 알아보기
"test"
aN(8)
Y
파트너 ID
"abcd1234567890"
aN(255)
Y
파트너 인증키
"Q0RSSkYzWUI3..."
aN(64)
Y
실행 그룹 키
그룹별 지급이체결과 조회 Request 예시
{ "cst_id":"test", "custKey":"abcd1234567890", "group_key": "Q0RSSkYzWUI3..." }
JSON
복사
Search
Parameter
Response Value
Type
Reference
더 알아보기
"A0000"
aN(8)
응답 코드
"처리 성공"
aN(255)
응답 메시지
"3000"
N
해당 그룹키의 총 지급이체 완료금액
"3"
N
해당 그룹키의 총 지급이체 완료건수
"test"
aN(8)
파트너 ID
"test12385610"
aN(64)
파트너사 하위고객 ID
"Q0RSSkYzWUI3..."
aN(64)
실행 그룹 키
"6fen3g2m-j9hb-..."
aNS(40)
(실명 인증된) 계좌 빌링키
"9wm5a36z-5hj..."
aNS(40)
지급이체 거래고유번호
"20211022152040289"
N(17)
지급이체일시(밀리세컨드)
"M202112389U152040289"
AN(20)
은행 거래고유번호
"20211022"
N(8)
지급이체일자
"000"
AN(3)
지급이체기관 응답코드
"020"
AN(3)
지급이체기관 표준코드
"1234567"
AN(7)
지급이체기관 점별코드
"우리은행"
AH(20)
지급이체기관명
"1234567890123456"
AN(16)
계좌번호
"1234567890123***"
계좌번호(마스킹처리)
"홍길동"
AH(20)
계좌예금주명
"정산테스트"
AH(20)
입금계좌인자내역
"1000"
N(12)
지급이체금액
COUNT21
그룹별 지급이체결과 조회 Response 예시
{ "result": "A0000", "message": "처리 성공", "total": "3000", "count": "3", "list": [ { "cst_id": "test", "sub_id": "test12385fs10", "group_key": "Q0RSSkYzWUI3...", "billing_tran_id": "4s01156u-jc...", "api_tran_id": "ofxlrep6-0jvu-...", "api_tran_dtm": "20211029113535653", "bank_tran_id": "M202112389U113535652", "bank_tran_date": "20211029", "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" }, { "cst_id": "test", "sub_id": "test1238510", "group_key": "Q0RSSkYzWUI3...", "billing_tran_id": "4s01156u-jc...", "api_tran_id": "lpb8dswe-qv2t-...", "api_tran_dtm": "20211029113535666", "bank_tran_id": "M202112389U113535664", "bank_tran_date": "20211029", "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" }, { "cst_id": "test", "sub_id": "test1238510", "group_key": "Q0RSSkYzWUI3...", "billing_tran_id": "4s01156u-jc...", "api_tran_id": "9dpsom2p-h97n-...", "api_tran_dtm": "20211029113535676", "bank_tran_id": "M202112389U113535675", "bank_tran_date": "20211029", "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
복사

지급이체 요청(request)정보 조회 파라미터

Search
Parameter
Request Value
Type (Length)
필수
Reference
더 알아보기
"test"
aN(8)
Y
파트너 ID
"abcd1234567890"
aN(255)
Y
파트너 인증키
"Q0RSSkYzWUI3..."
aN(64)
Y
실행 그룹 키