Create a new Merchant Activation

post

https://api.test.payadvantage.com.au/v3/merchant_activations

The merchant activations endpoint is perfect for software partners or industry associations who would like to streamline the onboarding process. The system allows you to pre register a new merchant and then instantly commence the activation process and/or send an invitation to activate their account.

This allows you to:
- Initiate the signup process from within the client portal or via an API call.
- If via the API a link is returned allowing merchants to instantly begin the activation process without having to wait for an activation email.
- Monitor a merchants progress through the various stages of onboarding and verification

Please note this feature and endpoint is only available to registered partners. Certain steps in the merchant activation process can also be co branded with a partners logo to provide an enhanced experience for new merchants.
Please contact support to discuss this option to register as a partner.

Create a new merchant activation

Body Params

ExternalID

string

required

length between 4 and 50

The entities ID from the external system that created it.

BusinessName

string

required

length between 2 and 200

The business name of the recipient of the merchant activation request.

FirstName

string

required

length between 2 and 100

The first name of the recipient of the merchant activation request.

LastName

string

required

length between 2 and 100

The last name of the recipient of the merchant activation request.

string

required

length ≥ 1

The email of the recipient of the merchant activation request.

Phone

string | null

The Merchant's primary phone number. This string doesn't accept special characters such as and should be a local number instead i.e. don't pass +61400000000 instead use 0400000000

PartnerCode

string | null

The partner code. If you do not know this code please reach out to the Pay Advantage support team to get assistance.

SendEmail

boolean

required

Request Pay Advantage to send an email to the user's email address. If false then you will be responsible for sending the merchant activation URL link.

Responses

200OK

201The created Merchant Activation.

400Bad request

401User is not authorized

403The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource, or may need an account of some sort

404The requested resource could not be found

422The request was well-formed but was unable to be followed due to semantic errors

429Request limit exceeded

500Internal server error

504Gateway timeout