Skip to content

Buyer Authorised Users

Buyers can invite authorised users to access their account. Once on-boarded, authorised users can transact on behalf of the identity they are on-boarded with.

Authorised users are typically employees who have access to company's banking accounts.

Note that /users endpoints are to be used only for performing operations related to authorised users - getting or updating the details of admin users is to be done via /buyers endpoints.

Operations

Create a user

Request

Creates a user that belongs to the buyer that the logged-in user belongs to. To Create an Authorised User you would need a stepped-up token. After calling this endpoint you need to step-up ( issue a challenge /stepup/challenges/otp/{channel} ). More details on how to step-up a token can be found here Step-Up.

Once on-boarded, users have access and manage the buyer's payment runs.

Users are assigned roles which limit the level of access they have and what they can do on behalf of the buyer.

Required user role: ADMIN

Security
apiKey and authToken
Headers
idempotency-refstring

A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.

Bodyapplication/jsonrequired
namestring, [ 1 .. 20 ] charactersrequired

The first name of the user.

surnamestring, [ 1 .. 20 ] charactersrequired

The last name of the user.

emailstring, (email)required

E-mail Address of the user

mobileobject

Mobile number of the user

dateOfBirthobject

Date of birth of the authorised user.

rolesArray of strings, non-emptyrequired

Roles define the level of access assigned to the user.

  • CREATOR: Users assigned this role can create, view and update payment runs.
  • CONTROLLER: Users assigned this role can view and link their company's bank accounts as well as fund payment runs.
Items Enum:"CREATOR""CONTROLLER"
curl -i -X POST \
  https://sandbox.weavr.io/payment-run/v1/users \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -H 'idempotency-ref: string' \
  -d '{
    "name": "string",
    "surname": "string",
    "email": "user@example.com",
    "mobile": {
      "countryCode": "string",
      "number": "string"
    },
    "dateOfBirth": {
      "year": 1900,
      "month": 1,
      "day": 1
    },
    "roles": [
      "CREATOR"
    ]
  }'

Responses

Success

Bodyapplication/json
idstring^[0-9]+$required

The unique identifier of the user.

buyerIdstring^[0-9]+$required

The identifier for the identity.

namestring, <= 100 charactersrequired

The first name of the user.

surnamestring, <= 100 charactersrequired

The last name of the user.

emailstring, (email)required

E-mail Address of the user

mobileobject

Mobile number of the user

activebooleanrequired

The state of the user. If the active attribute is false, then the user will not be able to log in.

dateOfBirthobject

Date of birth of the authorised user.

rolesArray of strings, non-emptyrequired

Roles define the level of access assigned to the user.

  • CREATOR: Users assigned this role can create, view and update payment runs.
  • CONTROLLER: Users assigned this role can view and link their company's bank accounts as well as fund payment runs.
Items Enum:"CREATOR""CONTROLLER"
addedByobject
Response
{
  "id": "string",
  "buyerId": "string",
  "name": "string",
  "surname": "string",
  "email": "user@example.com",
  "mobile": {
    "countryCode": "string",
    "number": "string"
  },
  "active": true,
  "dateOfBirth": {
    "year": 1900,
    "month": 1,
    "day": 1
  },
  "roles": [
    "CREATOR"
  ],
  "addedBy": {
    "rolesNames": [ … ],
    "userId": "string"
  }
}