API 레퍼런스  >  은행 연동

계좌 수집 상태 조회

계좌의 연동 상태와 마지막 수집 결과를 조회합니다.

상태 정의

- ADDED: 신규 등록 또는 인증정보 변경 후 검증 대기. 자동 수집 대상

- VALIDATING: 최초 연결 가능 여부와 인증정보를 검증 중

- ACTIVE: 정상 연결되어 수집 가능한 상태. 자동 수집 대상

- INITIAL_FAILED: 최초 검증에서 ID/PW, 금융 비밀번호, 인증값 등 인증정보 오류 발생. 자동 재시도하지 않으며 인증정보를 수정하면 ADDED로 바뀌어 다시 검증합니다.

- FAILED: 네트워크·타임아웃 등 일시적·기술적 오류. 다음 수집 주기에 자동 재시도

- SUSPENDED: 정상 사용 중이던 설정에서 로그인 실패, 비밀번호 변경 등 인증 오류 발생. 자동 수집이 중지되며 인증정보를 수정하면 ADDED로 바뀌어 다시 검증합니다.

GET https://dev.sendbill.co.kr:444/api/v1/accounts/{settingId}/status

Request

Request 항목 명세 ›
No 변수명 타입 길이 필수 설명 비고
1 settingId Long Y 계좌 설정 ID (Path). 계좌 등록·목록 조회 응답의 settingId 1 이상의 숫자
Request 샘플 ›
Request 샘플
GET https://api.sendbill.co.kr/api/v1/accounts/65/status

SBKEY: xxxxxxxxxxxxxxxxxxxxxxxxx
Accept-Charset: UTF-8

Response

Response 항목 명세 ›
NO 변수명 타입 설명
1 code Integer 처리 결과 코드. 성공 시 200, 실패 시 음수
2 data Object 수집 상태
3 data.status String 연동 상태. ADDED(검증 대기), VALIDATING(최초 검증 중), ACTIVE(정상 수집), INITIAL_FAILED(최초 검증 인증 오류), FAILED(일시적 오류·재시도), SUSPENDED(인증 오류로 자동 수집 중지)
4 data.scrapingRunning Boolean 현재 수집 실행 중 여부
5 data.errorCode String 마지막 수집의 오류 코드. 없으면 null
6 data.errorMessage String 마지막 수집의 오류 메시지. 없으면 null
Response JSON 샘플 › 
{
    "code": 200,
    "data": {
        "status": "ACTIVE",
        "scrapingRunning": false,
        "errorCode": null,
        "errorMessage": null
    }
}