API explorerPay APIsData APIs
API explorer
Pay APIs
Data APIs

Theme switcher

Get Data Refresh Job

Body Parameters

client_idstring Required

API client identifier

Max length
128
client_secretstring

API client secret for authentication. Required for internal (non-OAuth2) authentication mode (e.g., test-only). Not required when using OAuth2 (Bearer token) authentication.

Max length
128
job_idstring Required

Job ID to retrieve

consent_idstring Required

Consent ID that the job belongs to (for validation)

Response

200
Object

Job information retrieved successfully

Response Attributes

request_idstring

Unique identifier for the API request

job_idstring

Unique identifier of the job

statusstring

Data refresh job status:

  • job_started: Job created and queued for execution
  • accounts_ready: Accounts fetched and stored in the database
  • balances_ready: Balances fetched and stored in the database
  • transactions_fetching: Transactions fetching has started
  • job_partially_completed: Job completed partially (some data was fetched and stored)
  • job_completed: Job completed successfully with all data fetched
  • job_failed: Job failed (no data was fetched and stored)
Enum values:
job_startedaccounts_readybalances_readytransactions_fetchingjob_partially_completedjob_completedjob_failed
consent_idstring

ID of the consent this job is associated with

webhook_urlstring | null

Webhook URL for job status notifications (from request webhook_url or consent config)

ais_providerobject | null

Service provider (bank) details from the consent

Show child attributes

ais_methodobject | null

AIS method details from the consent

Show child attributes

dataobject

Job execution results and statistics

Show child attributes

api_client_appstring

Name of the API client application

completed_atstring
400
Object

Validation error or invalid request

Response Attributes

error_idstring Required

Unique identifier for this error instance

request_idstring Required

Request identifier for tracking and correlation

codestring Required

Machine-readable error code for 400 errors:

  • bad_request: Generic validation or request error
  • validation_error: Request payload validation failed
  • invalid_input: Invalid input data provided
  • internal_error: AIS-side unexpected internal error
  • external_api_unavailable: External provider HTTP failure (timeout, connection refused, DNS, etc.). Surfaced as HTTP 400 instead of a gateway 504.
  • external_api_error: External provider returned a structured error during the AIS ...
Enum values:
bad_requestvalidation_errorinvalid_inputinternal_errorexternal_api_unavailableexternal_api_errorcooldown_failedconsent_not_activejob_in_progressmethod_selection_error
... 2 other enums
messagestring Required

Human-readable error message

401
Object

Authentication failed

Response Attributes

error_idstring Required

Unique identifier for this error instance

request_idstring Required

Request identifier for tracking and correlation

codestring Required

Machine-readable error code for 401 errors:

  • unauthorized: Authentication failed or insufficient permissions
Enum values:
unauthorized
messagestring Required

Human-readable error message

404
Object

Resource not found

Response Attributes

error_idstring Required

Unique identifier for this error instance

request_idstring Required

Request identifier for tracking and correlation

codestring Required

Machine-readable error code for 404 errors:

  • not_found: Generic resource not found
  • consent_not_found: Specified consent does not exist
  • job_not_found: Specified job does not exist or outside accessible date range
Enum values:
not_foundconsent_not_foundjob_not_found
messagestring Required

Human-readable error message

Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot