Weavr
Powered by Redocly

Buyers

Buyers are identities representing a business

Once on-boarded, Buyers can create payment runs and pay their suppliers in your application.

Create a buyer

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.

SecurityapiKey
Request
header Parameters
idempotency-ref
string

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.

Request Body schema: application/json
required
tag
string <= 50 characters ^[a-zA-Z0-9_-]+$

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

required
object

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.

required
object

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

acceptedTerms
required
boolean

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

ipAddress
required
string [ 5 .. 45 ] characters

The IP address of the buyer user doing the registration.

supportedCurrencies
required
Array of strings non-empty
Items Enum: "GBP" "EUR"
Responses
200

Success

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

409

Conflict

413

Content Too Large

422

Unprocessable Entity

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

post/v1/buyers
Request samples
application/json
{
  • "tag": "string",
  • "adminUser": {
    },
  • "company": {
    },
  • "acceptedTerms": true,
  • "ipAddress": "string",
  • "supportedCurrencies": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "tag": "string",
  • "adminUser": {
    },
  • "company": {
    },
  • "acceptedTerms": true,
  • "supportedCurrencies": [
    ],
  • "creationTimestamp": 0,
  • "ipAddress": "string"
}

Get buyer details

Retrieve the details of the buyer that the logged-in user belongs to.

Required user role: ADMIN

SecurityapiKey and authToken
Responses
200

Success

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

get/v1/buyers
Response samples
application/json
{
  • "id": "string",
  • "tag": "string",
  • "adminUser": {
    },
  • "company": {
    },
  • "acceptedTerms": true,
  • "supportedCurrencies": [
    ],
  • "creationTimestamp": 0,
  • "ipAddress": "string"
}

Update a buyer

Update the buyer currencies and admin roles.

Required user role: ADMIN

SecurityapiKey and authToken
Request
Request Body schema: application/json
required
object
supportedCurrencies
Array of strings
Items Enum: "GBP" "EUR"
Responses
200

Success

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

409

Conflict

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

patch/v1/buyers
Request samples
application/json
{
  • "adminUser": {
    },
  • "supportedCurrencies": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "tag": "string",
  • "adminUser": {
    },
  • "company": {
    },
  • "acceptedTerms": true,
  • "supportedCurrencies": [
    ],
  • "creationTimestamp": 0
}

Start admin user email verification

The first step in verifying a admin user's email. The admin user whose email address is to be verified is sent an email containing a randomly generated code.

This code must then be provided in the buyerAdminUserEmailVerify operation to verify the admin user's email address.

Note that on the Sandbox Environment, the verificationCode is always set to "123456".

SecurityapiKey
Request
header Parameters
idempotency-ref
string

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.

Request Body schema: application/json
required
email
required
string <email>

E-mail Address of the user

Responses
204

Success - No Content.

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

409

Conflict

413

Content Too Large

422

Unprocessable Entity

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

post/v1/buyers/verification/email/send
Request samples
application/json
{
  • "email": "user@example.com"
}
Response samples
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}

Verify admin user email

The second step in verifying the admin user's email. The randomly generated code sent to the admin user via email, using the buyerAdminUserEmailVerificationCodeSend operation, is submitted here to verify the admin user's email.

This is needed as part of the verification process for basic due diligence.

Note that on the Sandbox Environment, the verificationCode is always set to "123456".

SecurityapiKey
Request
header Parameters
idempotency-ref
string

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.

Request Body schema: application/json
required
email
required
string <email>

E-mail Address of the user

verificationCode
required
string = 6 characters ^[0-9]+$

A randomly generated one-time use code used to verify the user's email address or mobile number.

Responses
204

Success - No Content.

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

409

Conflict

413

Content Too Large

422

Unprocessable Entity

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

post/v1/buyers/verification/email/verify
Request samples
application/json
{
  • "email": "user@example.com",
  • "verificationCode": "string"
}
Response samples
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}

Start buyer KYB

Buyers need to complete due diligence (KYB) before they can create payment runs and pay their suppliers.

This operation initiates the due diligence process for the buyer that the logged-in user belongs to.

Due Diligence is handled by a KYB provider - you will need to embed the KYB UI Component in your application so that the buyer will be able to perform the KYB process.

To initialise the KYB UI Component, you need a reference that is given you in the response of this operation.

Required user role: ADMIN

SecurityapiKey and authToken
Request
header Parameters
idempotency-ref
string

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.

Responses
200

Success

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

409

Conflict

413

Content Too Large

422

Unprocessable Entity

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

post/v1/buyers/kyb
Response samples
application/json
{
  • "reference": "string"
}

Get buyer KYB status

Returns the KYB status for the buyer that the logged-in user belongs to.

Required user role: ADMIN

SecurityapiKey and authToken
Responses
200

Success

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

get/v1/buyers/kyb
Response samples
application/json
{
  • "kybStatus": "NOT_STARTED",
  • "ongoingKybStatus": "NOT_STARTED"
}

Update Buyer's KYB details

Update the details of the buyer that the logged-in user belongs to.

The following Buyer details are verified during due diligence (KYB) and cannot be updated via the API once the Buyer has been verified:

  • Admin User Name
  • Admin User Surname
  • Admin User Email
  • Admin User Mobile Country Code
  • Admin User Mobile Number
  • Admin Date of Birth
  • Company Business Address

If these details need to be changed after due diligence is completed, please contact Customer Support to restart the Due Diligence process.

Required user role: ADMIN

SecurityapiKey and authToken
Request
Request Body schema: application/json
required
tag
string <= 50 characters ^[a-zA-Z0-9_-]+$

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

object

The details associated with the company. The details provided need to match exactly with the details provided during KYB.

object

The legal representative of the buyer. Admin users can invite and manage the buyer's authorised users.

Responses
200

Success

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

409

Conflict

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

patch/v1/buyers/kyb
Request samples
application/json
{
  • "tag": "string",
  • "company": {
    },
  • "adminUser": {
    }
}
Response samples
application/json
{
  • "id": "string",
  • "tag": "string",
  • "adminUser": {
    },
  • "company": {
    },
  • "acceptedTerms": true,
  • "supportedCurrencies": [
    ],
  • "creationTimestamp": 0
}
➔ Next to Buyer Authorised Users