Sign in
Bank Connections

Register a customer API bank connection

Register or upsert a customer-built bank connection and optional accounts under source_type=customer_api.

post/public/v2/bank-connections/

Headers

Idempotency-Keystring

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Request body

connection_source_idstring required
institution_namestring required

Response

Created

created_atstring date-time required

Date and time the record was created

updated_atstring date-time required

Date and time the record was last updated

idinteger required
connection_source_idstring required
institution_namestring nullable
statusstring required
successfully_aggregated_atstring date-time nullable
last_sync_atstring date-time nullable

Changes

Changed in 2 of the 14 revisions of this API.3

  • 48edcb3acb742See the full diff
    • ○

      added the required property created_at to the response with the 201 status

      response-required-property-added

    • ○

      added the required property updated_at to the response with the 201 status

      response-required-property-added

    This revision also has 93 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f338ec8b3f521See the full diff
    • ○

      endpoint added

      endpoint-added