Skip to content
/
Create a buyer

Create a buyer

Request

Buyers are identities representing a business. Once on-boarded, Buyers can create and manage their own instruments via your plugin.

The information provided must be accurate and will be passed on for KYB verification with our partner.

Security
apiKey
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
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 needs to be a director or a legal representative of the buyer that is being onboarded - this user cannot be deactivated.

Admin users need to verify their email address and mobile number, as well as complete KYC as part of the Buyer's due diligence process.

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 buyer admin user has accepted the terms and conditions.

ipAddressstring, [ 5 .. 45 ] charactersrequired

The IP address of the buyer user doing the registration.

supportedCurrenciesArray of strings, non-emptyrequired
curl -i -X POST \
  https://sandbox.weavr.io/payment-run/v1/buyers \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -H 'idempotency-ref: string' \
  -d '{
    "tag": "string",
    "adminUser": {
      "name": "string",
      "surname": "string",
      "email": "user@example.com",
      "mobile": {
        "countryCode": "string",
        "number": "string"
      },
      "companyPosition": "DIRECTOR",
      "dateOfBirth": {
        "year": 1900,
        "month": 1,
        "day": 1
      }
    },
    "company": {
      "type": "LLC",
      "name": "string",
      "registrationNumber": "string",
      "businessAddress": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "postCode": "string",
        "state": "string",
        "country": "st"
      },
      "countryOfRegistration": "GB"
    },
    "acceptedTerms": true,
    "ipAddress": "string",
    "supportedCurrencies": [
      "GBP"
    ]
  }'

Responses

Success

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

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.

ipAddressstring, [ 5 .. 45 ] characters

The IP address of the user doing the registration.

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,
  "ipAddress": "string"
}