Search
🔎

지급이체 잔여한도 조회 API

1. 정의

지급이체 잔여한도 조회란 파트너사의 지급이체 한도잔여금액를 조회하는 기능입니다.
🔗
지급이체 한도잔여금액(remain_amt)에 대한 설명은 이곳↗️에서 확인해보세요.

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. 지급이체 잔여한도 조회

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

Request Message

파라미터 정보
Search
Parameter
더 알아보기
Request Value
필수
Type (Length)
Reference
cst_id
Open
"test"
Y
aN(8)
파트너 ID
custKey
Open
"abcd1234567890"
Y
aN(255)
파트너 인증키
🔗
요청 파라미터의 Type 보는 방법↗️에 대해 더 자세히 알아보세요!
Request example
Header 정보
/* * Request HTTP URL * TEST : https://demohub.payple.kr/account/remain * REAL : https://hub.payple.kr/account/remain */ Reauest HTTP URL: "https://demohub.payple.kr/account/remain" 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" }
JSON

Response Message

지급이체 잔여한도 조회 요청이 성공하면 페이플에서 파트너에 다음과 같은 성공 리턴을 드립니다.
파라미터 정보
Search
Parameter
더 알아보기
Response Value
Reference
Type
result
Open
"A0000"
응답 코드
String
message
Open
"처리 성공"
응답 메시지
String
cst_id
Open
"test"
파트너 ID
String
total_account_amt
Open
"10000000"
총 정산금액(HUB)
String
total_transfer_amt
Open
"56000"
총 지급이체 요청 누적금액
String
remain_amt
Open
"9944000"
지급이체 잔여한도금액
String
api_tran_dtm
Open
"20211103090426239"
지급이체일시(밀리세컨드)
String
COUNT7
Response example
{ "result": "A0000", "message": "처리 성공", "cst_id": "test", "total_account_amt": "10000000", "total_transfer_amt": "56000", "remain_amt": "9944000", "api_tran_dtm": "20211103090426239" }
JSON
⚠️
result= "A0000", message= "처리 성공"인 경우 요청성공으로 판단합니다.
TOP