v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB
Gateway Features
Users

Username Availability

❗️ Never Use Real API Keys

Never use real API Keys when testing. The gateway allows Partners to create Test Merchant Accounts. Testing should always use keys from the Test Accounts and never keys from a Standard Account.

<details> <summary>Usage</summary> This is optional, but you can check to make sure a username is available before submitting your merchant creation request.<br><br> This can be useful if you want to do form validation on your website to prevent the user from entering a username that has already been taken. </details>
post/v4/usernames/search

Headers

Content-Typestring required

The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending).

Authorizationstring required

Your v4 API key that was generated in the Partner portal.

Request body

usernamestring required

String representing the username to check.

typestring required

String representing the type of account to check the username availability.

Response

Success

usernamestring

String representing the username to check.

availableboolean

Boolean representing if the username is available.