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".
Callback URL
You can optionally provide a callback URL to receive a notification when the job completes.
Body Parameters
API client identifier
API client secret for authentication. Required for internal (non-OAuth2) authentication mode (e.g., test-only). Not required when using OAuth2 (Bearer token) authentication.
Consent ID for data refresh
Optional callback URL for data refresh job status notifications.
Webhook payload for job status updates:
{
"type": "job_status_update",
"consent_id": "consent-uuid",
"job_id": "job-uuid",
"status": "job_completed"
}
Response
Response Attributes
Unique identifier for the API request
ID of the consent this job is associated with
Unique identifier of the created job (use this to track job status)
Initial job status (always job_started on creation)
job_startedName of the API client application
Response Attributes
Unique identifier for this error instance (useful for support inquiries)
Request identifier for tracking and correlation
Machine-readable error code:
General errors:
bad_request: Request payload validation failedunauthorized: Authentication failed or insufficient permissionsnot_found: Requested resource does not existunprocessable_entity: Valid request but cannot be processed (e.g., bank rejection)validation_error: Request payload validation failed
bad_requestunauthorizednot_foundunprocessable_entityvalidation_errorinvalid_inputinternal_errorinternal_server_errorcooldown_failedconsent_not_active... 7 other enums
Human-readable error message describing what went wrong
Response Attributes
Unique identifier for this error instance
Request identifier for tracking and correlation
Machine-readable error code for 401 errors:
unauthorized: Authentication failed or insufficient permissions
unauthorizedHuman-readable error message
Response Attributes
Unique identifier for this error instance
Request identifier for tracking and correlation
Machine-readable error code for 404 errors:
not_found: Generic resource not foundconsent_not_found: Specified consent does not existjob_not_found: Specified job does not exist or outside accessible date range
not_foundconsent_not_foundjob_not_foundHuman-readable error message