Financials
Banking

Open an import job for one borrower

Returns 201 with the job, status open, or 200 with the same job (deduplicated: true) for a retried idempotency_key. A borrower has at most one open job: a second is 409 import_already_open, naming it.

post/api/v1/financials/banking/imports

Request

  • Base URL: https://api.withaccend.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.withaccend.com/api/v1/financials/banking/imports
  • Auth: none declared

Request body

customer_idstring nullable
external_customer_idstring nullable

Your id for the borrower. Send exactly one of this or customer_id.

idempotency_keystring required

Unique per org. Retrying with the same key returns the same job; a new job, including after an abandoned one, needs a new key.

Response

Successful Response

import_idstring required
idempotency_keystring required
customer_idstring required
external_customer_idstring nullable required
status'open' | 'publishing' | 'completed' | 'failed' | 'cancelled' | 'expired' required

Where an import job is. open accepts batches; publishing means complete was accepted and the job is being published; the other four are final.

closed_atstring date-time nullable required
expires_atstring date-time nullable required
failure_code'batch_staging_failed' | 'publish_failed' required

Why a job failed. batch_staging_failed: a batch could not be categorized and staged. publish_failed: publishing could not finish.

failure_reasonstring nullable required
created_atstring date-time required
finished_atstring date-time nullable required
deduplicatedboolean required

Whether this request was a replay of an earlier one.

Changes

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