UnifiedJob

모든 계좌 작업 제출

계좌 전부(또는 bank_account_credential_ids 로 고른 계좌들)로 작업을 계좌마다 하나씩 접수한다. 계좌마다 사용 토큰이 하나씩 듭니다. 기업정보 브리프처럼 한 번에 여러 사용 토큰을 쓰는 업무는 그 값만큼 계좌마다 듭니다.

응답 분기:

  • 새로 접수한 줄이 하나라도 있다 -> 202 Accepted
  • 새로 접수한 줄이 없다(같은 멱등키의 재전송이거나 전부 접수하지 못했다) -> 200 OK
  • 사용 토큰이 모자라다 -> 하나도 접수하지 않고 거절한다. 거절 문장에 필요한 토큰과 지금 남은 토큰이 있다.
  • 은행 동시 작업 상한 때문에 아직 접수하지 못한 줄은 NOT_SUBMITTED 로 남고, 응답의 next 가 그 계좌 목록을 준다.
  • 줄을 접수한 뒤 동시 작업 상한이 아닌 다른 거절로 호출이 멈추면 오류로 돌려주지 않는다 - 이미 접수한 줄은 그대로 두고 응답에 interruption(코드 · 문장 · 세부 까닭)을 더한다. 멈춘 줄과 그 뒤 줄은 NOT_SUBMITTED + interrupted 이고 next 가 그 계좌 목록을 준다.
  • 계좌가 하나도 없거나 이 액션이 계좌를 고르지 않는 액션이면 접수 없이 거절한다.

Idempotency-Key 헤더가 필수다. 계좌마다 키를 만들어 쓰므로 같은 요청을 같은 키로 다시 보내면 이미 접수한 줄은 새 작업 없이 그대로 돌아온다.

post/v1/jobs/all-accounts

Request

  • Base URL: https://api.xdata.kr (the document declares no server; this is the origin it was published from)
  • URL: https://api.xdata.kr/v1/jobs/all-accounts
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://api.xdata.kr/oauth/authorize, token URL https://api.xdata.kr/oauth/token)

Query parameters

env_scope'production' | 'real_test' | 'sandbox' nullable

환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.

Headers

Authorizationstring nullable
Idempotency-Keystring nullable
User-Agentstring nullable
X-Env-Scope'production' | 'real_test' | 'sandbox' nullable

환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.

Request body

providerstring required

요청 provider - 계좌를 고르는 은행 상품이어야 한다.

actionstring required

요청 action - 계좌를 고르는 액션이어야 한다 (은행 거래내역 조회 등). 계좌를 고르지 않는 액션은 거절한다.

account_link_idstring nullable

연동 계정 식별자 (선택). 주면 그 연동의 계좌만 처리한다. 생략하면 이 은행의 모든 연동이다.

bank_account_credential_idsstring[] nullable

처리할 계좌 식별자 목록 (선택). 생략하면 계좌 전부를 처리한다. 동시 상한 때문에 아직 접수하지 못한 계좌를 이어서 접수할 때 응답의 next.bank_account_credential_ids 로 받은 목록을 준다.

paramsobject nullable

액션별 파라미터 (선택). 계좌 하나를 고르는 칸(bank_account_credential_id)은 넣지 않는다 - 이 호출이 계좌마다 채운다.

Response

새로 접수한 줄이 없다 - 같은 멱등키의 재전송이거나 전부 접수하지 못했다.

env_scopestring required

요청한 환경 그대로. sandbox · real_test · production.

providerstring required
actionstring required
submitted_atstring required

호출을 받은 시각 (KST ISO-8601). 줄마다 작업의 접수 시각은 GET /v1/jobs/{job_id} 에 있다.

account_countinteger required

이 호출이 다룬 계좌 수.

submitted_countinteger required

작업을 접수한 줄 수 - 같은 멱등키의 재생으로 돌아온 줄도 센다.

Changes

No recorded changes to this operation across all 1 revision of this API.