로고Developer Center
홈페이지가입문의

파라미터

정산지급대행정산지급대행


1. 파트너 인증 요청

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

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

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

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

2. 계좌인증 요청

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

파라미터필수타입길이설명값 예시
cst_idString255파트너 인증을 위한 ID 입니다. 라이브 ID 는 계약이 완료되어야 발급 가능합니다.test
custKeyString255파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다.
외부에 노출되면 안되는 정보입니다. 보안에 유의해주세요.
abcd1234567890
bank_code_stdString3금융기관 코드입니다.020
account_numString13계좌번호입니다.1234567890123456
account_holder_info_typeString1예금주 구분 코드입니다.
  • 0 : 개인, 개인사업자

  • 6 : 법인사업자
0
account_holder_infoString10예금주 생년월일(사업자번호)입니다.
  • 개인, 개인사업자 : 생년월일 6자리(YYMMDD)

  • 법인사업자 : 사업자번호 10자리
880212
sub_idString64파트너 하위 셀러의 ID 입니다.sub01

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

파라미터타입설명값 예시
resultString페이플 응답코드입니다.A0000
messageString응답 메시지입니다.처리 성공
cst_idString파트너 ID입니다.test
sub_idString파트너 하위 셀러의 ID 입니다.sub01
billing_tran_idString인증 완료된 계좌의 빌링키입니다.cb9d695e-c034-4eeb-9550-c53a9ab7c2e4
api_tran_dtmString금융기관으로부터 수신한 인증 완료 상세일시입니다. (밀리세컨드)20240131175503547
bank_tran_idString금융기관과 통신을 위해 필요한 고유 키입니다.M202112389U152040289
bank_tran_dateString금융기관관으로부터 수신한 인증 완료 일자입니다.20240131
bank_rsp_codeString금융기관 응답코드입니다.000
bank_code_stdString금융기관 코드입니다.020
bank_code_subString금융기관 점별 코드입니다.
  • 금융기관 공동코드 3자리와 지점코드 4자리로 구성.
0201234
bank_nameString금융기관명입니다.우리은행
account_numString계좌번호입니다.1234567890123456
account_holder_nameString예금주명입니다.김이플

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

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

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

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

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

4. 이체 실행 요청

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

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

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

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

5. 결과 수신

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

파라미터타입설명값 예시
resultString페이플 응답코드입니다.A0000
messageString응답 메시지입니다.처리 성공
cst_idString파트너 ID입니다.6548264741426583803027
sub_idString파트너 하위 셀러의 ID 입니다.sub01
distinct_keyString중복 이체를 방지하기 위한 키입니다.uo3h1708394911737306031340821
group_keyString그룹키입니다.QlJKZDZrNVBzbW9Yc1UzTWNIdW05dz09
billing_tran_idString인증 완료된 계좌의 빌링키입니다.cb9d695e-c034-4eeb-9550-c53a9ab7c2e4
api_tran_idString완료된 이체 건의 고유키입니다.d2834aa2-11be-4a04-afce-9c0ca5ceacea
api_tran_dtmString금융기관으로부터 수신한 이체 완료 상세일시입니다. (밀리세컨드)20231022152040289
bank_tran_idString금융기관과 통신을 위해 필요한 고유 키입니다.M202112389U152040289
bank_tran_dateString금육기관관으로부터 수신한 인증 완료 일자입니다.20240131
bank_rsp_codeString금융기관 응답코드입니다.000
bank_code_stdString금융기관 코드입니다.020
bank_code_subString금융기관 점별 코드입니다.
  • 금융기관 공동코드 3자리와 지점코드 4자리로 구성
0201234
bank_nameString금융기관명입니다.우리은행
account_numString계좌번호입니다.1234567890123456
account_num_maskedString일부 가림 처리된 계좌번호입니다.1234567890123***
account_holder_nameString예금주명입니다.김이플
print_contentString상대방 계좌 거래 내역에 표시될 수 있는 최대 6자까지의 문구입니다.테스트입니다
tran_amtString이체 완료 금액입니다.1000