Introduction

Merchant Create

The Merchant Create endpoint allows partners (resellers) to create a new client (submerchant) profile within the Billink platform. It is typically used during onboarding to register a client with all the necessary business, billing, and contact details. billinkUsername and billinkID are your partner account credentials — the new client is created under and linked to your partner account. The new client's username and email must be unique across Billink. The method field controls workflow setup: send 1 to configure payment workflows for the new client (Billink defaults, or the configuration you pass in workflows); any other numeric value skips workflow setup. Set changePasswordLink to "true" to receive a one-time password-reset link for the new client in the response.

All available errors for this endpoint you can find in errors section.

Body Parameters

billinkIDstring

The unique API identifier (UID) of your partner account.

billinkUsernamestring

The username of your partner (reseller) account.

bankAccountNumberstring Required

IBAN bank account number of the new client.

bicstring Required

BIC of the client's bank (ISO 9362).

changePasswordLinkstring

Set to "true" to receive a one-time password-reset link in the response. Default "false".

clientPlatformstring

Numeric ID of the client's webshop platform (existing ID required — contact Billink for the list). Applies platform-specific presets.

citystring Required

City name; letters, spaces, -, . and ' only.

cocNumberstring Required

Chamber of Commerce number, exactly 8 digits.

companyNamestring Required

Company name of the new client, 2–100 characters.

contactEmailstring Required

Contact email address for the new client.

contactPhonestring Required

Contact phone number, same format as phone.

countryCodestring Required

Two-letter ISO country code supported by Billink (e.g. NL).

emailstring Required

Email address of the new client. Must be unique (error 428 if taken).

firstNamestring Required

Contact person's first name, 2–255 characters.

houseExtensionstring

House number extension, max 15 characters.

houseNumberstring Required

House number of the client's address.

lastNamestring Required

Contact person's last name, 2–255 characters.

logoBase64string

Client logo as a base64-encoded image.

methodstring

Workflow setup method (numeric). 1 = configure payment workflows (defaults, or the provided workflows); any other numeric value = no workflow setup.

phonestring Required

Phone number, 9–18 characters; digits, spaces, +, () and - only.

postCodestring Required

Postal code of the client's address.

streetstring Required

Street name; letters, numbers, spaces, -, ' and . allowed.

tnvstring Required

Name of the bank account holder ("ten name van"), max 255 characters.

usernamestring Required

Username for the new client. 4–50 characters; letters, digits, - and _ (must not start with _). Must be unique (error 427 if taken).

vatNumberstring Required

VAT number of the new client (e.g. NL123456789B01).

websitestring

Website URL of the new client, e.g. www.example.com.

Response

200

Object

Response Attributes

changePasswordLinkstring

One-time password-reset link; only present when requested.

codestring

Result code; 200 on success.

descriptionstring

Human-readable result, e.g. "Client successfully created".

resultstring

MSG on success, ERROR on failure.

uidstring

UID of the created client — the new client's billinkID for API calls.

usernamestring

Username of the created client.

425

Object

Response Attributes

codestring

The response code.

descriptionstring

The description in the response.

resultstring

The result in the response.

102

Object

Response Attributes

codestring

The response code.

descriptionstring

The description in the response.

resultstring

The result in the response.

Sections

Merchant Create

Body Parameters

Response

Response Attributes

Response Attributes

Response Attributes

Response