Search
🔎

일별 지급이체결과 조회 API

이 글의 목차

1. 정의

일별 지급이체결과 조회란 지급이체가 완료된 일자의 지급이체결과를 일괄 조회하는 기능입니다.
일별 지급이체결과 조회에서 기준이 되는 '일자'지급이체 실행(execute)을 요청한 일자가 아니라 지급이체가 완료된 일자(은행기준)입니다. 즉, 해당 일자에 지급이체가 완료된 지급이체결과들을 조회할 수 있습니다.

2. 프로세스 개요

3. 토큰발급

파트너 서버
파트너 인증을 위한 토큰발급을 진행해야합니다.
페이플 허브에서는 사용자 인증을 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 정보
Body(Payload) 값

Response Message

토큰발급 요청이 성공하면 페이플에서 파트너에 다음과 같은 성공 리턴을 드립니다.
Response sample
{ "result":"T0000", "message":"처리 성공", "code":"as12345678", "access_token":"eyJhlNDlj...", "token_type":"Bearer", "expires_in":"60" }
JSON
result= "T0000", message= "처리 성공"인 경우 요청 성공으로 판단합니다.
발급받은 access_token은 모든 요청에 Authorization 값으로 필요합니다.

4. 일별 지급이체결과 조회

파트너 서버
파트너는 토큰발급 후 일별 지급이체결과 조회 요청을 수행합니다.

Request Message

일별 지급이체결과 조회 요청 파라미터 중 유의해야하는 부분에 대해 확인해보세요.
bank_tran_date공백으로 보내거나, 해당 일자에 지급이체가 완료된 건이 없다면 일별 지급이체결과 조회요청이 거부됩니다.
기본 보기
Search
Parameter
더 알아보기
Request Value
필수
Type (Length)
Reference
cst_id
Open
"test"
Y
aN(8)
파트너 ID
custKey
Open
"abcd1234567890"
Y
aN(255)
파트너 인증키
bank_tran_date
Open
"20211022"
Y
N(8)
조회할 지급이체일자
요청 파라미터의 Type 보는 방법에 대해 더 자세히 알아보세요!
Request example
Header 정보
Body(Payload) 값

Response Message

일별 지급이체결과 조회요청이 성공하면 페이플에서 파트너에 다음과 같은 성공 리턴을 드립니다.
Response example
{ "result": "A0000", "message": "처리 성공", "total": "3000", "count": "3", "list": [ { "cst_id": "test", "sub_id": "test1238510", "group_key": "YWs1ZE83Q...", "billing_tran_id": "l94mc4kl-...", "api_tran_id": "trdjk6n8-pn6x-...", "api_tran_dtm": "20211029115948614", "bank_tran_id": "M202112389U115948612", "bank_tran_date": "20211029", "bank_rsp_code": "000", "bank_code_std": "020", "bank_code_sub": "0000000", "bank_name": "우리은행", "account_num": "1234567890123456", "account_num_masked": "1234567890123***", "account_holder_name": "홍길동", "print_content": "정산테스트1", "tran_amt": "1000" }, { "cst_id": "test", "sub_id": "test1238510", "group_key": "YWs1ZE83Q...", "billing_tran_id": "l94mc4kl-...", "api_tran_id": "dy9j4neq-zurk-...", "api_tran_dtm": "20211029115948644", "bank_tran_id": "M202112389U115948643", "bank_tran_date": "20211029", "bank_rsp_code": "000", "bank_code_std": "020", "bank_code_sub": "0000000", "bank_name": "우리은행", "account_num": "1234567890123456", "account_num_masked": "1234567890123***", "account_holder_name": "홍길동", "print_content": "정산테스트1", "tran_amt": "1000" }, { "cst_id": "test", "sub_id": "test1238510", "group_key": "S1VvbjNvSEd0bH...", "billing_tran_id": "l94mc4kl-...", "api_tran_id": "cyn61kif-022q-...", "api_tran_dtm": "20211029115948676", "bank_tran_id": "M202112389U115948675", "bank_tran_date": "20211029", "bank_rsp_code": "000", "bank_code_std": "020", "bank_code_sub": "0000000", "bank_name": "우리은행", "account_num": "1234567890123456", "account_num_masked": "1234567890123***", "account_holder_name": "홍길동", "print_content": "정산 ", "tran_amt": "1000" } ] }
JSON
result= "A0000", message= "처리 성공"인 경우 요청 성공으로 판단합니다.