XS2A.api.connections

Reset a bank connection

Reset a bank connection regardless of his sync mode.

post/api/connections/{connection-id}/reset

Request

Base URL
https://api.xs2a.com/v1
Auth
HTTP basic
TypeScript
https://skmtc.dev/xs2a/apis/xs2a-api/docs/api/connections/:connection-id/reset/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

connection-idstring required

The connection-id for the connection to be reseted.

Response

A structure containing a new wizard_session_key will be returned. The HTTP response code will be 202 in this case.

wizard_session_keystring

Using the wizard_session_key you can now initialize our Wizard which is running on your website

transactionstring

We suggest that you store the internally used XS2A transaction id transaction with your transaction data, because if you later have questions about a transaction, we need this number to be able to quickly assist you.

Example response

{
  "wizard_session_key": "m5A65Cy2lwI1rOXxuvwU4MM47b4tDaV0ME9By6It",
  "transaction": "10001-xv-LEz8-oct7"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.