Skip to content
/
Update a buyer

Update a buyer

Request

Update the buyer currencies and admin roles.

Required user role: ADMIN

Security
apiKey and authToken
Bodyapplication/jsonrequired
adminUserobject
supportedCurrenciesArray of strings
curl -i -X PATCH \
  https://sandbox.weavr.io/payment-run/v1/buyers \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "adminUser": {
      "roles": [
        "ADMIN"
      ]
    },
    "supportedCurrencies": [
      "GBP"
    ]
  }'

Responses

Success

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

Id of the buyer.

tagstring, <= 50 characters^[a-zA-Z0-9_-]+$

The tag field is a custom field that can be used to search and filter.

adminUserobjectrequired

The admin user of the Buyer Identity.

companyobjectrequired

The details associated with the company being on-boarded. The details provided need to match exactly with the details provided during KYB.

acceptedTermsbooleanrequired

Must be set to true to indicate that the admin user has accepted the terms and conditions.

supportedCurrenciesArray of objectsrequired
creationTimestampinteger, (int64)read-onlyrequired

The time when the Buyer was created, expressed in Epoch timestamp using millisecond precision.

Response
{
  "id": "string",
  "tag": "string",
  "adminUser": {
    "id": "string",
    "name": "string",
    "surname": "string",
    "email": "user@example.com",
    "mobile": { … },
    "companyPosition": "DIRECTOR",
    "dateOfBirth": { … },
    "active": true,
    "emailVerified": true,
    "mobileNumberVerified": true,
    "roles": [ … ]
  },
  "company": {
    "type": "LLC",
    "name": "string",
    "registrationNumber": "string",
    "businessAddress": { … },
    "countryOfRegistration": "GB",
    "registeredAddress": { … },
    "incorporatedOn": { … }
  },
  "acceptedTerms": true,
  "supportedCurrencies": [
    { … }
  ],
  "creationTimestamp": 0
}