개발자 문서
API 레퍼런스

계좌 - NH농협은행 빠른조회

1. NH농협은행 빠른조회 계좌 목록 조회nh_fast_account.accounts.list

MCP 도구 이름 nh_fast_account__accounts__list

POSThttps://api.xdata.kr/v1/jobsX-Env-Scope: real_test

현재 혜택은 요금제에서 확인해 주세요. 현재 데모 정책과 계정의 남은 양을 확인해 주세요.

등록한 NH농협은행 계좌 연동 목록을 마스킹된 계좌번호와 계좌 과목까지 한 번에 나열합니다.

  • 이 API 는 기관 연동과 기관 로그인이 필요 없습니다. 기관 자격증명을 등록하지 않아도 호출할 수 있고, account_link_id 는 보내지 않습니다.

Request

순번변수명필수설명
AuthorizationYAPI 자격증명입니다. client_id 와 client_secret 을 콜론으로 이어 Base64 로 인코딩해 보냅니다.

형식 : Basic base64("{client_id}:{client_secret}")

[참고] 인증

X-Env-ScopeY호출 환경입니다.
  • real_test데모 — 현재 데모 한도 확인 필요
  • production정식 — 현재 공개 요금제 전용

[참고] 환경

Idempotency-KeyY재시도 식별 키입니다. 같은 키와 같은 본문으로 다시 호출하면 기존 작업이 그대로 반환됩니다. ASCII 문자만 사용하며 UUID v4 를 권장합니다. 고객 정보는 넣지 않습니다.

[참고] 재시도

Content-TypeY요청 본문 형식입니다.
  • application/json고정값 (기본값)
X-Trace-IdN추적 아이디입니다. 지정하지 않으면 서버가 발급합니다.
순번변수명타입필수설명
providerstringY호출할 기관입니다.
  • nh_fast_account이 API 고정값 (기본값)

예시 : nh_fast_account

actionstringY호출할 작업입니다.
  • nh_fast_account.accounts.list이 API 고정값 (기본값)

예시 : nh_fast_account.accounts.list

paramsobjectN작업 파라미터입니다. 이 API 는 빈 객체로 호출할 수 있습니다.
encrypted_fieldsobjectN민감한 params 값을 RSA-OAEP-256 으로 암호화해 담는 객체입니다. 서버가 복호화해 params 에 합칩니다. 같은 이름을 params 와 함께 쓰지 않습니다.

[참고] 암호화

추가 파라미터가 없습니다. params 는 {} 로 보냅니다.

bash
curl --request POST \
  --url 'https://api.xdata.kr/v1/jobs' \
  --header 'Authorization: Basic {base64(client_id:client_secret)}' \
  --header 'X-Env-Scope: real_test' \
  --header 'Idempotency-Key: demo-list-001' \
  --header 'Content-Type: application/json' \
  --data '{
  "provider": "nh_fast_account",
  "action": "nh_fast_account.accounts.list",
  "params": {}
}'

Response

순번변수명타입설명
successboolean목록을 돌려줬다는 표지입니다. 항상 true 입니다.
providerstring연동을 가려낸 상품 구분 값입니다. 이 작업에서는 항상 nh_fast_account 입니다(호출한 작업 이름의 앞부분).
linksarray이 계정이 이 상품에 연결해 둔 연동 목록입니다. 사용 중인 연동만 담고 최근에 만든 연동이 앞에 옵니다. 연동이 없으면 빈 배열입니다.
links[].account_link_idstring연동 ID 입니다. 이 상품의 다른 작업을 부를 때 account_link_id 로 보냅니다.
links[].display_labelstring | null연동에 붙인 표시 이름입니다. 이름이 없으면 null 입니다.
links[].accountsarray이 연동에 등록된 계좌 목록입니다. 사용 중인 계좌만 담고 등록한 순서대로(오래된 것이 앞) 옵니다.
links[].accounts[].bank_account_credential_idstring계좌 ID 입니다. 계좌를 고르는 작업을 부를 때 bank_account_credential_id 로 보냅니다.
links[].accounts[].masked_account_nostring가려진 계좌번호입니다. 전체 번호는 돌려주지 않습니다.
links[].accounts[].statusstring계좌의 상태입니다. 사용 중인 계좌만 담으므로 항상 ACTIVE 입니다.
link_countnumberlinks 에 담긴 연동의 수입니다.
account_countnumber모든 연동의 accounts 에 담긴 계좌의 총 수입니다.
truncatedboolean이 계정의 사용 중인 연동 전체(모든 상품의 합계)가 100개를 넘으면 true 입니다. 이때는 최근 100개 연동만 훑어 목록을 만들었으므로 일부 연동이 빠져 있을 수 있습니다.
json
// result.data - 값 자리에는 각 칸의 형식을 적었습니다 (실제 값이 아닙니다)
{
  "success": "<boolean>",
  "provider": "<string>",
  "links": [
    {
      "account_link_id": "<string>",
      "display_label": "<string | null>",
      "accounts": [
        {
          "bank_account_credential_id": "<string>",
          "masked_account_no": "<string>",
          "status": "<string>"
        }
      ]
    }
  ],
  "link_count": "<number>",
  "account_count": "<number>",
  "truncated": "<boolean>"
}