ISV Invitations

Create merchant invitation

Creates a new invitation for a merchant to join payware via this ISV. Returns an invitation link that the ISV must deliver to the merchant. No email is sent - the ISV distributes the link through their own channels (email, SMS, in-app, etc.). The invitation type is auto-detected: REGISTRATION for new merchants, AUTHORIZATION_ONLY for existing ones.

post/api/isv/invitations

Request

  • Base URL: https://api.payware.eu
  • URL: https://api.payware.eu/api/isv/invitations
  • Auth: HTTP bearer

Request body

emailstring required

Merchant's email address. Determines invitation type: REGISTRATION for new emails, AUTHORIZATION_ONLY for existing merchants.

phonestring

Merchant's phone number

contactNamestring

Merchant contact's first name

contactSurnamestring

Merchant contact's surname

companyNamestring

Company legal name

vatIdstring

VAT identification number

registeredIdstring

Company registration ID (e.g. EIK in Bulgaria). When jurisdictionCode is BG, this triggers auto-population from the Bulgarian commercial registry.

streetstring

Street address

streetNumberstring

Street number

zipstring

ZIP / postal code

citystring

City

legalFormIdinteger

Legal form ID from reference data

businessActivityIdinteger

Business activity ID from reference data

jurisdictionCodestring

ISO 3166-1 alpha-2 country code

preferredLanguageCodestring

Preferred language for the invitation (ISO 639-1)

Example request

{
  "email": "merchant@example.com",
  "phone": "+35912345678",
  "contactName": "John",
  "contactSurname": "Doe",
  "companyName": "ACME Corp Ltd",
  "vatId": "BG123456789",
  "registeredId": "123456789",
  "street": "Main Street",
  "streetNumber": "10",
  "zip": "1000",
  "city": "Sofia",
  "jurisdictionCode": "BG",
  "preferredLanguageCode": "bg"
}

Response

Invitation created successfully

Changes

No recorded changes to this operation across all 1 revision of this API.