XS2A.api.users

Create a xs2a.api bank user

put/api/users

Request

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

Request body

namestring required

The name of the user.

emailstring email

The email of the user.

Example request

{
  "name": "Max Mustermann",
  "email": "user@example.com"
}

Response

Request successfully processed

idstring

Bank user ID

namestring

Name of the user

emailstring email

E-Mail of the test user

testmodeboolean

True, if this user has been created with a testing API key, false otherwise.

created_atstring

Date of creation

objectstring

The value bank_user

Example response

{
  "id": "bus_NIB48H6IiB57ySH1",
  "name": "Max Mustermann",
  "email": "user@example.com",
  "testmode": true,
  "created_at": "2017-12-14 16:52:44",
  "object": "bank_user"
}

Changes

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