파라미터

허브〉운영

1. 이체대기 취소

1 .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

1.2 취소 요청

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

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

요청이 성공적으로 완료된 후에 받게 되는 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	실행을 위한 구분값입니다.	CANCEL
api_tran_dtm	String	금융기관으로부터 수신한 취소 상세일시입니다. (밀리세컨드)	20240131175503547

2. 이체대기 조회

2.1 파트너 인증 요청

조회 요청 시 요구되는 파트너 인증에 필요한 Request 파라미터는 아래와 같습니다.

파라미터	타입	길이	설명	값 예시
cst_id	String	12	파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.	test
service_key	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.2 조회 요청

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

파라미터	타입	길이	설명	값 예시
cst_id	String	255	파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.	test…
custKey	String	255	파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다. 외부에 노출되면 안되는 정보입니다. 보안에 유의해주세요.	abcd1234567890
group_key	String	64	해당 그룹키의 취소를 진행합니다. 그룹키 내의 여러 건 중 일부만 이체 실행이 완료되었을 경우, 나머지 미실행 건들은 기존 그룹키에 계속 묶여 있습니다.	QlJKZDZrNVBzbW9Yc1UzTWNIdW05dz09

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

파라미터	타입	설명	값 예시
result	String	페이플 응답코드입니다.	A0000
message	String	응답 메시지입니다.	처리 성공
total	String	해당 그룹키의 총 대기금액입니다.	3000
count	String	해당 그룹키의 총 대기건수입니다.	3
list	Object[]	이체대기 리스트입니다.
cst_id	String	파트너 ID입니다.	test
sub_id	String	파트너 하위 셀러의 ID 입니다.	sub01
group_key	String	취소가 진행된 그룹키입니다.	QlJKZDZrNVBzbW9Yc1UzTWNIdW05dz09
distinct_key	String	중복 이체를 방지하기 위한 키입니다.	c9z116521650283…
billing_tran_id	String	계좌인증 완료된 계좌의 빌링키입니다.	cb9d695e-c034-4eeb-9550-c53a9ab7c2e4
print_content	String	상대방 계좌 거래 내역에 표시될 수 있는 최대 6자까지의 문구입니다.	테스트입니다
tran_amt	String	해당 그룹키에 속한 개별 건의 금액입니다.	1000
remain_amt	String	이체 가능 금액입니다.	999000
request_date	String	조회 요청 시간입니다.	2023-10-26 10:55:03

3. 건별 실행결과 조회

3.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

3.2 조회 요청

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

파라미터	타입	길이	설명	값 예시
cst_id	String	255	파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.	test
custKey	String	255	파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다. 외부에 노출되면 안되는 정보입니다. 보안에 유의해주세요.	abcd1234567890
api_tran_id	String	40	완료된 이체 건의 고유키입니다.	a9e10979-1cb9-44ff-95fd-bb4b1fb57701

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

파라미터	타입	설명	값 예시
result	String	페이플 응답코드입니다.	A0000
message	String	응답 메시지입니다.	처리 성공
cst_id	String	파트너 ID입니다.	test
sub_id	String	파트너 하위 셀러의 ID 입니다.	sub01
group_key	String	이체가 진행된 그룹키입니다.	QlJKZDZrNVBzbW9Yc1UzTWNIdW05dz09
distinct_key	String	중복 이체를 방지하기 위한 키입니다.	c9z116521650283…
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

4. 일별 실행결과 조회

4.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

4.2 조회 요청

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

파라미터	타입	길이	설명	값 예시
cst_id	String	12	파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.	test
custKey	String	255	파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다. 외부에 노출되면 안되는 정보입니다. 보안에 유의해주세요.	abcd1234567890
bank_tran_date	String	8	조회할 이체 완료 일자입니다. (YYYYMMDD)	20231022

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

파라미터	타입	설명	값 예시
result	String	페이플 응답코드입니다.	A0000
message	String	응답 메시지입니다.	처리 성공
total	String	해당 일자의 총 이체 완료 금액입니다.	3000
count	String	해당 일자의 총 이체 완료 건수입니다.	3
list	Object[]	이체대기 리스트입니다.
cst_id	String	파트너 ID입니다.	test
sub_id	String	파트너 하위 셀러의 ID 입니다.	sub01
group_key	String	이체가 진행된 그룹키입니다.	QlJKZDZrNVBzbW9Yc1UzTWNIdW05dz09
distinct_key	String	중복 이체를 방지하기 위한 키입니다.	c9z116521650283…
billing_tran_id	String	인증 완료된 계좌의 빌링키입니다.	cb9d695e-c034-4eeb-9550-c53a9ab7c2e4
api_tran_id	String	완료된 이체 건의 고유키입니다.	a9e10979-1cb9-44ff-95fd-bb4b1fb57701
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_num_masked	String	일부 가림 처리된 계좌번호입니다.	1234567890123***
account_holder_name	String	예금주명입니다.	김이플
print_content	String	상대방 계좌 거래 내역에 표시될 수 있는 최대 6자까지의 문구입니다.	테스트입니다
tran_amt	String	개별 건의 이체 완료 금액입니다.	1000

5. 그룹별 실행결과 조회

5.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

5.2 조회 요청

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

파라미터	타입	길이	설명	값 예시
cst_id	String	255	파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.	test
custKey	String	255	파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다. 외부에 노출되면 안되는 정보입니다. 보안에 유의해주세요.	abcd1234567890
group_key	String	40	조회할 그룹키입니다.	QlJKZDZrNVBzbW9Yc1UzTWNIdW05dz09…

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

파라미터	타입	설명	값 예시
result	String	페이플 응답코드입니다.	A0000
message	String	응답 메시지입니다.	처리 성공
total	String	해당 일자의 총 이체 완료 금액입니다.	3000
count	String	해당 일자의 총 이체 완료 건수입니다.	3
list	Object[]	이체결과 정보 리스트입니다.
cst_id	String	파트너 ID입니다.	test
sub_id	String	파트너 하위 셀러의 ID 입니다.	sub01
group_key	String	이체가 진행된 그룹키입니다.	QlJKZDZrNVBzbW9Yc1UzTWNIdW05dz09
distinct_key	String	중복 이체를 방지하기 위한 키입니다.	c9z116521650283…
billing_tran_id	String	인증 완료된 계좌의 빌링키입니다.	cb9d695e-c034-4eeb-9550-c53a9ab7c2e4
api_tran_id	String	완료된 이체 건의 고유키입니다.	a9e10979-1cb9-44ff-95fd-bb4b1fb57701
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_num_masked	String	일부 가림 처리된 계좌번호입니다.	1234567890123***
account_holder_name	String	예금주명입니다.	김이플
print_content	String	상대방 계좌 거래 내역에 표시될 수 있는 최대 6자까지의 문구입니다.	테스트입니다
tran_amt	String	개별 건의 이체 완료 금액입니다.	1000

6. 이체가능 잔액조회

6.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

6.2 조회 요청

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

파라미터	필수	타입	길이	설명	값 예시
cst_id		String	255	파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.	test
custKey		String	255	파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다. 외부에 노출되면 안되는 정보입니다. 보안에 유의해주세요.	abcd1234567890

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

파라미터	타입	설명	값 예시
result	String	페이플 응답코드입니다.	A0000
message	String	응답 메시지입니다.	처리 성공
cst_id	String	파트너 ID입니다.	test
total_account_amt	String	허브 사용 시작 시점부터의 누적된 정산금액입니다.	1000000
total_transfer_amt	String	허브 사용 시작 시점부터의 누적된 이체완료 금액입니다.	200000
remain_amt	String	이체 가능한 잔액입니다.	800000
api_tran_dtm	String	API 요청 시점의 타임스탬프 입니다. (밀리세컨드)	20231022152040289