Type은 파라미터의 '자료형'을 의미하는것이 아니라, 파라미터 값의 형태를 의미합니다. Type 보는 방법에 대해 알아보세요!
※ 자료형은 Request, Response Parameter 모두 String 입니다.
에 대해 알아보세요!
※ 자료형은 Request, Response Parameter 모두 String 입니다. 메시지 포맷은 JSON(JavaScript Object Notation)입니다. 요청 후 받는 응답 파라미터는 JSON 표준대로 받아서 처리해주세요.
전체 파라미터 정의
전체 파라미터를 요청(Request)와 응답(Response)으로 구분하여 정리하였습니다.
전체 Parameter 하단에서 API별 요청 및 응답 파라미터도 확인해보세요.
도 확인해보세요.※ 표 우측 상단에 있는 검색기능을 사용하여 빠르고 쉽게 파라미터를 검색해보세요!
기본 보기
Search
API별 파라미터 정의
요청, 응답 파라미터를 API별로 나누어서 설명합니다.
필수 요청 파라미터 보는 방법 상황별 Request 표에서 필수 여부를 보고 각 상황마다 필수 요청 파라미터를 확인합니다.
•
필수 : 해당 파라미터의 필수 값 여부
각 상황별 더욱 자세한 설명은 페이플 연동가이드 문서로 확인해주세요
토큰발급 파라미터
기본 보기
Search
토큰발급 Request 예시
{
"cst_id":"test",
"custKey":"abcd1234567890",
"code":"as12345678"
}
JSON
기본 보기
Search
토큰발급 Response 예시
{
"result":"T0000",
"message":"처리 성공",
"code":"as12345678",
"access_token":"eyJhlNDlj...",
"token_type":"Bearer",
"expires_in":"60"
}
JSON
실명인증 파라미터
기본 보기
Search
실명인증 요청 필수 파라미터 확인 예시
•
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
실명인증 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
지급이체 요청 Request 예시
{
"cst_id":"test",
"custKey":"abcd1234567890",
"sub_id":"test12385610",
"billing_tran_id":"6fen3g2m-j9hb-...",
"tran_amt":"1000",
"print_content":"정산테스트"
}
JSON
기본 보기
Search
지급이체 요청 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
지급이체 실행 Request 예시
{
"cst_id":"test",
"custKey":"abcd1234567890",
"group_key":"6fen3g2m-j9hb-...",
"billing_tran_id":"ALL",
"execute_type":"NOW"
}
JSON
기본 보기
Search
지급이체 실행 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
지급이체 결과조회 Request 예시
{
"cst_id":"test",
"custKey":"abcd1234567890",
"api_tran_id":"9wm5a36z-5hj..."
}
JSON
기본 보기
Search
지급이체 결과조회 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
지급이체 잔여한도 조회 Request 예시
{
"cst_id":"test",
"custKey":"abcd1234567890"
}
JSON
기본 보기
Search
지급이체 잔여한도 조회 Response 예시
{
"result": "A0000",
"message": "처리 성공",
"cst_id": "test",
"total_account_amt": "10000000",
"total_transfer_amt": "56000",
"remain_amt": "9944000",
"api_tran_dtm": "20211103090426239"
}
JSON
일별 지급이체결과 조회 파라미터
기본 보기
Search
일별 지급이체결과 조회 Request 예시
{
"cst_id":"test",
"custKey":"abcd1234567890",
"bank_tran_date": "20211022"
}
JSON
기본 보기
Search
일별 지급이체결과 조회 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
그룹별 지급이체결과 조회 Request 예시
{
"cst_id":"test",
"custKey":"abcd1234567890",
"group_key": "Q0RSSkYzWUI3..."
}
JSON
기본 보기
Search
그룹별 지급이체결과 조회 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
지급이체 요청(request)정보 조회 Request 예시
{
"cst_id":"test",
"custKey":"abcd1234567890",
"group_key": "Q0RSSkYzWUI3..."
}
JSON
기본 보기
Search