1. 정의
•
페이플 허브에서는 지급이체 실행(execute) 결과, 즉 실제로 지급이체가 완료된 결과에 대해 웹훅(Webhook)으로 발송하고 있습니다.
◦
페이플 허브 계약시 지급이체 결과를 전송받을 웹훅 URL을 등록하게 됩니다.
◦
운영(REAL)로 요청을 보낼 경우, 등록된 웹훅 URL로 결과가 발송되고,
테스트(TEST)로 요청을 보낼 경우, 요청시 보낸 webhook_url로 결과가 발송됩니다.
웹훅(Webhook)이란, 한 응용 프로그램에서 어떤 이벤트가 발생했을 때 다른 응용 프로그램으로 실시간 정보를 제공하는 방법입니다.
포트 443만 사용 가능합니다. (HTTPS 프로토콜 필수)
2. 발송시점
•
Webhook URL로는 지급이체 실행 결과가 발송되는데,
지급이체 실행(execute) 요청을 보낸 즉시가 아니라, 지급이체 실행(execute) 요청 후 실제로 지급이체가 완료되었을 때, 즉 파트너의 하위 고객사의 계좌에 실제로 지급이체가 수행된 후 발송됩니다.
지급이체 실행(execute) 요청 후 실제 지급이체는 최대 1분내 순차적으로 시작될 수 있습니다.
3. Webhook URL 등록/수정
•
Webhook URL은 유효성 검사를 하고 있습니다.
4. 전송 규약
•
JSON 방식으로 데이터를 POST
5. Data Sample
•
지급이체 결과 수신데이터의 예시입니다.
Response sample
{
"result":"A0000",
"message":"처리 성공",
"cst_id":"test",
"sub_id":"test12385610",
"group_key":"Q0RSSkYzWUI3...",
"billing_tran_id":"6fen3g2m-j9hb-...",
"api_tran_id":"ohr8ps3m-j5x...",
"api_tran_dtm":"20211025142315647",
"bank_tran_id":"M202112389U142315646",
"bank_tran_date":"20211025",
"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
복사