Search
⤵️

지급이체 요청(request) API

1. 정의

지급이체 요청(request)이란 파트너가 하위고객에게 지급이체할 건들을 요청하는 기능입니다.
지급이체 요청(request) 말 그대로 지급이체를 요청하는 기능으로, 실제로 지급이체가 수행되기 전입니다. 지급이체 요청(request)한 후에 지급이체 실행(execute)을 하셔야 최종적으로 지급이체가 수행됩니다. 즉, 실제 지급이체는 지급이체 실행(execute) 요청을 보내셔야 수행됩니다.

2. 프로세스 개요

3. 토큰발급

파트너 서버
파트너 인증을 위한 토큰발급을 진행해야합니다.
발급받은 access_token은 이후 다른 요청에서 필요하며, 토큰의 만료기간(60초)이 지나면 다시 토큰을 발급받으셔야 합니다. ⦁ 파트너에서는 access_token 유효기간에 맞춰서 유효한 토큰값 유지를 위한 로직을 구현하셔야 합니다.
페이플 허브에서는 사용자 인증을 OAuth 2.0으로 진행합니다.

Request Message

code는 반드시 영문자+숫자만 포함하여 10자만 입력해야합니다.
파라미터 정보
Search
Parameter
더 알아보기
Request Value
필수
Type (Length)
Reference
custKey
Open
"abcd1234567890"
Y
aN(255)
파트너 인증키
code
Open
"as12345678"
Y
aN(10)
파트너용 토큰 확인 코드
요청 파라미터의 Type 보는 방법에 대해 더 자세히 알아보세요!
Request sample
Header 정보
/* * Request HTTP URL * TEST : https://demohub.payple.kr/oauth/token * REAL : https://hub.payple.kr/oauth/token */ Reauest HTTP URL: "https://demohub.payple.kr/oauth/token" HTTP Method: POST Content-Type: application/json Cache-Control: no-cache
JSON
Body(Payload) 값
{ "cst_id":"test", "custKey":"abcd1234567890", "code":"as12345678" }
JSON

Response Message

토큰발급 요청이 성공하면 페이플에서 파트너에 다음과 같은 성공 리턴을 드립니다.
파라미터 정보
Search
Parameter
더 알아보기
Response Value
Reference
Type
result
Open
"T0000"
응답 코드
String
message
Open
"처리 성공"
응답 메시지
String
code
Open
"as12345678"
파트너용 토큰 확인 코드
String
access_token
Open
"eyJhlNDlj..."
발행된 Access Token
String
token_type
Open
"Bearer" (고정값)
Access Token 유형
String
expires_in
Open
"60"
Access Token 만료 기간(초)
String
COUNT6
Response sample
{ "result":"T0000", "message":"처리 성공", "code":"as12345678", "access_token":"eyJhlNDlj...", "token_type":"Bearer", "expires_in":"60" }
JSON
result= "T0000", message= "처리 성공"인 경우 요청 성공으로 판단합니다.
발급받은 access_token은 모든 요청에 Authorization 값으로 필요합니다.

4. 실명인증

파트너 서버
파트너는 토큰발급 후 지급이체할 계좌에 대한 실명인증 요청을 수행합니다.
매 요청마다 실명인증을 매번 해야하는 것은 아닙니다. 실명인증은 한 계좌에 대해 최초 1회만 하신 후, 파트너에서 실명인증 리턴값에 대한 판단이 완료되면 해당 빌링키를 저장하여 지급이체 요청(request)을 진행하시면 됩니다.

5. 지급이체 요청

파트너 서버
실명인증을 마친 계좌에 대해 지급이체 요청을 수행합니다.
이때 사용자 인증, 즉 토큰발급 요청 후 Response 받은 access_token을 Header 값으로 보내야합니다.
발급받은 토큰(access_token)의 유효기간은 60초입니다. 파트너에서는 access_token 유효기간에 맞춰서 유효한 토큰값 유지를 위한 로직을 구현하셔야 합니다. 유효기간이 지난 토큰(access_token)은 요청이 거부되니 유의해주시기 바랍니다.

Request Message

지급이체 요청 파라미터 중 유의해야하는 부분에 대해 확인해보세요.
테스트 서버테스트 지급이체 요청을 수행할 경우, 이체금액(tran_amt)은 1000원으로 고정되어 있습니다. 이외의 값을 넣으시면 오류가 발생하여 요청이 거부되니 유의해주시기 바랍니다.
입금계좌인자내역(print_content) 파라미터에 대한 유의사항을 확인해보세요!길이(Length)는 바이트(Btye)단위가 아닌 자릿수입니다. 6자 이하로 지정해주시기 바랍니다. ⦁ 선택값이며, 해당 값을 보내지 않을 경우 파트너사명이 입금계좌에 출력됩니다. 파트너사명이 6자를 초과하면 6자까지만 출력되고 나머지 값은 생략됩니다. 공백을 넣어보내도 모두 제거됩니다.
파라미터 정보
Search
Parameter
더 알아보기
Request Value
필수
Type (Length)
Reference
cst_id
Open
"test"
Y
aN(8)
파트너 ID
custKey
Open
"abcd1234567890"
Y
aN(255)
파트너 인증키
sub_id
Open
"test12385610"
N
aN(64)
파트너사 하위고객 ID
billing_tran_id
Open
"6fen3g2m-j9hb-..."
Y
aNS(40)
(실명 인증된) 계좌 빌링키
tran_amt
Open
"1000"
Y
N(12)
지급이체금액
print_content
Open
"정산테스트"
N
AH(6자) print_content의 Length단위는 자릿수 - 바이트(Byte)단위 아님 ※ Default: 파트너사명
입금계좌인자내역
요청 파라미터의 Type 보는 방법에 대해 더 자세히 알아보세요!
Request example
Header 정보
/* * Request HTTP URL * TEST : https://demohub.payple.kr/transfer/request * REAL : https://hub.payple.kr/transfer/request */ Reauest HTTP URL: "https://demohub.payple.kr/transfer/request" HTTP Method: POST Content-Type: application/json Cache-Control: no-cache Authorization: Bearer, Access Token
JSON
$arrObHeader = array ( "Authorization: Bearer $paypleToken[access_token]", "Accept: application/json" );
PHP
PHP - Header 값 설정 예시
Body(Payload) 값
{ "cst_id":"test", "custKey":"abcd1234567890", "sub_id":"test12385610", "billing_tran_id":"6fen3g2m-j9hb-...", "tran_amt":"1000", "print_content":"정산테스트" }
JSON

Response Message

지급이체 요청이 성공하면 페이플에서 파트너에 다음과 같은 성공 리턴을 드립니다.
파라미터 정보
Search
Parameter
더 알아보기
Response Value
Reference
Type
result
Open
"A0000"
응답 코드
String
message
Open
"처리 성공"
응답 메시지
String
cst_id
Open
"test"
파트너 ID
String
sub_id
Open
"test12385610"
파트너사 하위고객 ID
String
group_key
Open
"Q0RSSkYzWUI3..."
실행 그룹 키
String
billing_tran_id
Open
"6fen3g2m-j9hb-..."
(실명 인증된) 계좌 빌링키
String
tran_amt
Open
"1000"
지급이체금액
String
remain_amt
Open
"9995000"
지급이체 한도잔여금액
String
print_content
Open
"정산테스트"
입금계좌인자내역
String
api_tran_dtm
Open
"20211022152040289"
지급이체일시(밀리세컨드)
String
COUNT10
Response example
{ "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
result= "A0000", message= "처리 성공"인 경우 요청 성공으로 판단합니다.