Create Data Refresh Job

Initiates a background job to refresh AIS data (accounts, balances, transactions) from the banking provider.

Consent status: The consent must be active. Otherwise, this endpoint returns 400 with code consent_not_active.

Cooldown Period

To prevent excessive API calls to banking providers, a cooldown period is enforced between refresh requests. If you attempt to create a job during the cooldown period, you’ll receive a 400 error with code cooldown_failed.

Concurrent jobs

Only one data-refresh job can run per consent at a time. If another job is still in progress, this endpoint returns 400 with code job_in_progress.

Callback URL

You can optionally provide a callback URL to receive a notification when the job completes.

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

consent_idstring Required

Consent ID for data refresh

webhook_urlstring

Optional URL to send a webhook to after the job is completed.

Webhook payload for job status updates:

{
  "type": "job_status_update",
  "consent_id": "consent-uuid",
  "job_id": "job-uuid",
  "status": "job_completed"
}

Response

200

Object

Data refresh job started successfully

Response Attributes

request_idstring

Unique identifier for the API request

consent_idstring

ID of the consent this job is associated with

job_idstring

Unique identifier of the created job (use this to track job status)

statusstring

Initial job status (always job_started on creation)

Enum values:

job_started

api_client_appstring

Name of the API client application

400

Object

Cooldown period not elapsed or validation error

Response Attributes

error_idstring Required

Unique identifier for this error instance (useful for support inquiries)

request_idstring Required

Request identifier for tracking and correlation

codestring Required

Machine-readable error code:

General errors:

bad_request: Request payload validation failed (HTTP 400)
unauthorized: Authentication failed or insufficient permissions (HTTP 401)
not_found: Requested resource does not exist (HTTP 404)
unprocessable_entity: Valid request but cannot be processed (e.g., bank rejection of psu_id) (HTTP 422)
validation_error: Request payload validation failed (HTTP 400)
invalid_input: Invalid input data provided (HTTP 400)
`i...

Enum values:

bad_requestunauthorizednot_foundunprocessable_entityvalidation_errorinvalid_inputinternal_errorinternal_server_errorexternal_api_unavailableexternal_api_error

... 7 other enums

messagestring Required

Human-readable error message describing what went wrong

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

Sections

Create Data Refresh Job

Cooldown Period

Concurrent jobs

Callback URL

Body Parameters

ResponseExpand all

Response Attributes

Response Attributes

... 7 other enums

Response Attributes

Response Attributes

Response

Ask an AI

Code with AI

Response