무엇을 조회하나요
볼타에 연결한 내 사업자의 입출금 계좌와 입출금 내역을 조회합니다. 볼타가 은행에서 가져와 적재한 내역을 그대로 돌려주고, 필요하면 동기화도 요청할 수 있습니다. 조회 대상은 API 키가 속한 사업자 한 곳입니다.이용 조건
포인트를 차감하지 않습니다. 대신 스탠다드 플랜 이상을 구독해야 합니다. 무료체험 중이어도 체험 중인 플랜이 스탠다드 이상이면 이용할 수 있습니다. 플랜이 모자라면 세 경로 모두402와 PLAN_UPGRADE_REQUIRED를 반환합니다. 볼타 대시보드의 결제 메뉴에서 플랜을 업그레이드한 뒤 다시 호출하세요.
계좌는 볼타 대시보드에서 먼저 연결하세요. 연결 방법은 은행 계좌 연동/해지를 참고하세요.
Bolta-Client-Reference-Id)가 필요 없습니다. Authorization 헤더에 Basic {apiKey}만 넣으면 됩니다. 인증은 인증 가이드를 참고하세요.
주요 제한
계좌 목록
은행코드
bankCode는 금융결제원 3자리 표준 은행코드입니다. 볼타가 연결을 지원하는 은행은 아래와 같습니다.
지역농축협 계좌도
011로 내려옵니다.
입출금 내역
기간을 주지 않으면 적재된 전체 내역을 조회합니다.
status에 따라 모양이 다릅니다.
OTHER는 은행이 입금액과 출금액을 모두 0으로 준 거래이며 amount가 0입니다.
순서와 cursor
API는 볼타에서 거래가 바뀐 순서로 돌려줍니다. 거래 시각 순서가 아닙니다. 화면에 최신순으로 보여 주려면 받은 뒤transactionAt으로 정렬하세요.
같은 id가 여러 번 올 수 있습니다. 받은 순서대로 id 기준으로 반영하세요.
ACTIVE: 같은id가 있으면 덮어쓰고, 없으면 추가하세요.REMOVED: 같은id가 있으면 지우고, 없으면 무시하세요.
수집 절차
- cursor 없이 호출하고,
hasMore가false가 될 때까지nextCursor로 이어 호출하세요. - 마지막
nextCursor를 저장하세요.hasMore가false여도nextCursor는 항상 채워집니다. 조건을 여러 개 쓴다면 조건마다 따로 저장하세요. - 다음 수집 때 저장한 cursor로 호출하세요. 그 사이 바뀐 거래만 받습니다.
from, to, bankAccountId, transactionType)과 API 키에 묶입니다. 조건이나 API 키를 바꿨다면 cursor 없이 처음부터 받으세요. 예전 cursor를 보내면 API가 400과 INVALID_CURSOR를 반환합니다. limit은 페이지마다 바꿔도 됩니다.
동기화 요청
볼타는 입출금 내역을 주기적으로 가져옵니다. 그 전에 최신 내역이 필요할 때만 동기화를 요청하세요.202 Accepted로 접수만 하고 은행 조회는 비동기로 진행합니다. 진행 상황은 계좌 목록의 syncStatus로 확인하세요. IN_PROGRESS가 끝나면 저장한 cursor로 입출금 내역을 이어 받으면 됩니다.
요청 한도는 주요 제한을 참고하세요. nextAvailableAt은 30분 간격만 반영하고 24시간 횟수는 반영하지 않습니다.
진행 중이라 거절한 요청(
409)은 한도를 차감하지 않습니다.
테스트 키로 조회하기
테스트 키는 구독과 관계없이 고정 샘플을 돌려주고, 동기화 요청은 한도를 차감하지 않습니다.6번은 보관한 거래라 status와 id만 내려갑니다. limit=3으로 호출하면 cursor 넘김을 두 페이지로 확인할 수 있어요. 테스트 키는 5분 지연 없이 바로 돌려줍니다.
오류
전체 에러 코드는 에러 코드에서 확인하세요.
