OpenAPI 3.1.02026-08-202444891.9 MB

4849d2498a13

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

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