파라미터

허브〉플랫폼 정산 자동화

1. 파트너 인증 요청

파트너 인증에 필요한 Request 파라미터는 아래와 같습니다.

파라미터	타입	길이	설명	값 예시
cst_id	String	12	파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.	test
custKey	String	255	파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다. 외부에 노출되면 안되는 정보입니다. 보안에 유의해주세요.	abcd1234567890
code	String	10	파트너 인증에 필요한 토큰을 확인하는 용도로 사용되며, 파트너(상점)가 직접 생성하여 전송해야 하는 중요한 요소입니다. 영문+숫자 조합 10자리로 구성되어야 합니다.	as12345678

파트너 인증이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.

파라미터	타입	설명	값 예시
result	String	응답 코드입니다.	T0000
message	String	응답 메시지입니다.	처리 성공
code	String	토큰 확인 코드입니다.	as12345678
access_token	String	발행된 Access 토큰입니다. API 요청 시 Header의 Authorization 필드에 포함하여 전송해야 합니다.	eyJhlNDlj...
token_type	String	Access 토큰 유형이며, 고정값입니다.	Bearer
expires_in	String	Access 토큰 만료 시간입니다.(초)	60

2. 계좌인증 요청

파트너 인증 후 계좌인증 요청 시 필요한 Request 파라미터는 아래와 같습니다.

파라미터	타입	길이	설명	값 예시
cst_id	String	255	파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.	test
custKey	String	255	파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다. 외부에 노출되면 안되는 정보입니다. 보안에 유의해주세요.	abcd1234567890
bank_code_std	String	3	금융기관 코드입니다.	020
account_num	String	13	계좌번호입니다.	1234567890123456
account_holder_info_type	String	1	예금주 구분 코드입니다. 0 : 개인, 개인사업자 6 : 법인사업자	0
account_holder_info	String	10	예금주 생년월일(사업자번호)입니다. 개인, 개인사업자 : 생년월일 6자리(YYMMDD) 법인사업자 : 사업자번호 10자리	880212
sub_id	String	64	파트너 하위 셀러의 ID 입니다.	sub01

계좌인증이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.

파라미터	타입	설명	값 예시
result	String	페이플 응답코드입니다.	A0000
message	String	응답 메시지입니다.	처리 성공
cst_id	String	파트너 ID입니다.	test
sub_id	String	파트너 하위 셀러의 ID 입니다.	sub01
billing_tran_id	String	인증 완료된 계좌의 빌링키입니다.	cb9d695e-c034-4eeb-9550-c53a9ab7c2e4
api_tran_dtm	String	금융기관으로부터 수신한 인증 완료 상세일시입니다. (밀리세컨드)	20240131175503547
bank_tran_id	String	금융기관과 통신을 위해 필요한 고유 키입니다.	M202112389U152040289
bank_tran_date	String	금융기관관으로부터 수신한 인증 완료 일자입니다.	20240131
bank_rsp_code	String	금융기관 응답코드입니다.	000
bank_code_std	String	금융기관 코드입니다.	020
bank_code_sub	String	금융기관 점별 코드입니다. 금융기관 공동코드 3자리와 지점코드 4자리로 구성.	0201234
bank_name	String	금융기관명입니다.	우리은행
account_num	String	계좌번호입니다.	1234567890123456
account_holder_name	String	예금주명입니다.	김이플

3. 빌링키로 이체 대기 요청

파트너 인증 후 이체대기 요청 시 필요한 Request 파라미터는 아래와 같습니다.

파라미터	타입	길이	설명	값 예시
cst_id	String	255	파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.	test
custKey	String	255	파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다. 외부에 노출되면 안되는 정보입니다. 보안에 유의해주세요.	abcd1234567890
billing_tran_id	String	40	계좌인증 완료된 계좌의 빌링키입니다.	cb9d695e-c034-4eeb-9550-c53a9ab7c2e4
tran_amt	String	12	이체할 금액입니다. 테스트 시에는 금액을 1000으로 고정해야 합니다. 이 금액 이외의 다른 값으로 요청하실 경우 오류가 발생하여 요청이 거부될 수 있으니 이 점을 유의하시기 바랍니다.	1000
sub_id	String	64	파트너 하위 셀러의 ID 입니다.	sub01
distinct_key	String	64	중복 이체를 방지하기 위한 키입니다. 미입력 시 페이플에서 자동 발급됩니다.	c9z116521650283…
print_content	String	Byte 가 아닌 자릿수(6자)	상대방 계좌 거래 내역에 표시될 수 있는 최대 6자까지의 문구입니다. 미입력 시 파트너(상점) 상호명으로 표시됩니다.	테스트입니다

대기 요청이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.

파라미터	타입	설명	값 예시
result	String	페이플 응답코드입니다.	A0000
message	String	응답 메시지입니다.	처리 성공
cst_id	String	파트너 ID입니다.	test
sub_id	String	파트너 하위 셀러의 ID 입니다.	sub01
distinct_key	String	중복 이체를 방지하기 위한 키입니다.	uo3h1708394911737306031340821
group_key	String	대기 요청을 수행한 여러 거래 건을 하나의 그룹으로 묶는 키이며, 이 키를 기준으로 다음 단계인 이체 실행이 진행됩니다.	QlJKZDZrNVBzbW9Yc1UzTWNIdW05dz09
billing_tran_id	String	계좌의 빌링키입니다.	cb9d695e-c034-4eeb-9550-c53a9ab7c2e4
tran_amt	String	이체할 금액입니다.	1000
remain_amt	String	이체 가능 금액입니다.	999000
print_content	String	상대방 계좌 거래 내역에 표시될 수 있는 최대 6자까지의 문구입니다.	테스트입니다
api_tran_dtm	String	금융기관으로부터 수신한 계좌인증 완료 상세일시입니다. (밀리세컨드)	20231022152040289

4. 이체 실행 요청

파트너 인증 후 이체 실행 요청 시 필요한 Request 파라미터는 아래와 같습니다.

파라미터	필수	타입	길이	설명	값 예시
cst_id		String	255	파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.	test
custKey		String	255	파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다. 외부에 노출되면 안되는 정보입니다. 보안에 유의해주세요.	abcd1234567890
group_key		String	40	이체 대기 요청 후 수신한 그룹키로 이체 실행을 진행합니다. 그룹키 내의 여러 건 중 일부만 이체 실행이 완료되었을 경우, 나머지 미실행 건들은 기존 그룹키에 계속 묶여 있습니다.	QlJKZDZrNVBzbW9Yc1UzTWNIdW05dz09
billing_tran_id		String	40	계좌의 빌링키입니다. ALL : 그룹키에 속한 모든 대기 건의 이체가 진행 특정 빌링키 : 그룹키에 속한 특정 빌링키 대기 건의 이체가 진행	cb9d695e-c034-4eeb-9550-c53a9ab7c2e4
execute_type		String	8	이체 실행을 위한 구분값입니다. NOW : 즉시 이체 실행 CANCEL : 대기 중인 이체 취소	NOW
webhook_url	테스트 시	String	255	이체 실행 결과를 수신하는 주소입니다. 테스트 서버로 요청시에만 필요합니다.	http://your-test-domain.com

실행 요청이 성공적으로 완료된 후에 받게 되는 Response 파라미터는 다음과 같습니다.

파라미터	타입	설명	값 예시
result	String	페이플 응답코드입니다.	A0000
message	String	응답 메시지입니다.	처리 성공
cst_id	String	파트너 ID입니다.	test
group_key	String	이체 실행한 그룹키입니다.	QlJKZDZrNVBzbW9Yc1UzTWNIdW05dz09
billing_tran_id	String	계좌의 빌링키입니다.	cb9d695e-c034-4eeb-9550-c53a9ab7c2e4
tot_tran_amt	String	이체 완료 금액입니다.	1000
remain_amt	String	이체 가능 금액입니다.	999000
execute_type	String	이체 실행을 위한 구분값입니다.	NOW
api_tran_dtm	String	금융기관으로부터 수신한 이체 완료 상세일시입니다. (밀리세컨드)	20231022152040289

5. 결과 수신

최종 이체가 성공적으로 완료되면, 웹훅을 통해 수신하는 결과입니다.

파라미터	타입	설명	값 예시
result	String	페이플 응답코드입니다.	A0000
message	String	응답 메시지입니다.	처리 성공
cst_id	String	파트너 ID입니다.	6548264741426583803027
sub_id	String	파트너 하위 셀러의 ID 입니다.	sub01
distinct_key	String	중복 이체를 방지하기 위한 키입니다.	uo3h1708394911737306031340821
group_key	String	그룹키입니다.	QlJKZDZrNVBzbW9Yc1UzTWNIdW05dz09
billing_tran_id	String	인증 완료된 계좌의 빌링키입니다.	cb9d695e-c034-4eeb-9550-c53a9ab7c2e4
api_tran_id	String	완료된 이체 건의 고유키입니다.	d2834aa2-11be-4a04-afce-9c0ca5ceacea
api_tran_dtm	String	금융기관으로부터 수신한 이체 완료 상세일시입니다. (밀리세컨드)	20231022152040289
bank_tran_id	String	금융기관과 통신을 위해 필요한 고유 키입니다.	M202112389U152040289
bank_tran_date	String	금육기관관으로부터 수신한 인증 완료 일자입니다.	20240131
bank_rsp_code	String	금융기관 응답코드입니다.	000
bank_code_std	String	금융기관 코드입니다.	020
bank_code_sub	String	금융기관 점별 코드입니다. 금융기관 공동코드 3자리와 지점코드 4자리로 구성	0201234
bank_name	String	금융기관명입니다.	우리은행
account_num	String	계좌번호입니다.	1234567890123456
account_num_masked	String	일부 가림 처리된 계좌번호입니다.	1234567890123***
account_holder_name	String	예금주명입니다.	김이플
print_content	String	상대방 계좌 거래 내역에 표시될 수 있는 최대 6자까지의 문구입니다.	테스트입니다
tran_amt	String	이체 완료 금액입니다.	1000