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 or to register as a partner.

Endpoints

GET '/merchant_activations?code=XXXXXX&externalID=XXXXXX&hasActivated?true&businessName=PAYADVANTAGE'
POST '/merchant_activations'
DELETE '/merchant_activations'

GET Merchant Activations

This documentation is deprecated

Please refer to the updated documentation https://docs.payadvantage.com.au/reference/merchant_activations_get-1

Example Request

curl -L -X GET 'https://api.payadvantage.com.au/v3/merchant_activations?code=XXXXXX&externalID=XXXXXX&hasActivated?true&businessName=PAYADVANTAGE' \
 -H 'Authorization: Bearer {access_token}'

Query String

Parameter used in the GET function URL.

Code (optional) min = 6, max = 6
Unique internal Identifier that was created once the merchant activation was initiated
externalID (optional) min = 4, max = 50
Unique external Identifier defined by the authoring organisation to reference the merchant activation record
hasActivated (optional) bool
Return the merchant activations that have successfully been activated
businessName (optional) min = 2, max = 200
Business name of the activation
referrerPlanMerchantID (optional) min = 4, max = 6
Return a list of the merchant activations for this merchant ID

Example Responses

STATUS 200 // Successful
    
{
    "Records": [
        {
            "Code": "4ZYSGA",
            "ExternalID": "myID123",
            "DateCreated": "2022-12-09T06:53:23.810+00:00",
            "BusinessName": "New Business Name",
            "FirstName": "Thomas",
            "LastName": "Fredrick",
            "Email": "lead@email.com",
            "Merchant": null,
            "ActivationLink": "https://secure.payadvantage.com.au/Activation/?code=4ZYSGA",
            "PartnerCode": "PAYADVANTAGE"
        },
        {
            "Code": "H8SSGA",
            "ExternalID": "myID456",
            "DateCreated": "2022-12-09T06:37:39.307+00:00",
            "BusinessName": "New Business",
            "FirstName": "Allison",
            "LastName": "Little",
            "Email": "lead@email.com",
            "Merchant": null,
            "ActivationLink": "https://secure.payadvantage.com.au/Activation/?code=H8SSGA",
            "PartnerCode": "PAYADVANTAGE"
        },
    ],
    "Meta": {
        "page": 0,
        "recs_per_page": 100,
        "total_recs": 2
    }
}

STATUS 4## // Error
    
{
	"errorCode": "error_code",
	"messages": [
		"Error message." 
	]
}

ADD Merchant Activations

This documentation is deprecated

Please refer to the updated documentation https://docs.payadvantage.com.au/reference/merchant_activations_post-1

Example Request

curl -L -X POST 'https://api.payadvantage.com.au/v3/merchant_activations' \
 -H 'Authorization: Bearer {access_token}'

Request Parameters

Query String

Parameter used in the GET function URL.

ExternalID (required) min = 4, max = 50
Unique external Identifier defined by the authoring organisation to reference the merchant activation creation record
Business Name (required) min = 2, max 200
Business Name of the user receiving the merchant activation
First Name (required) min = 2
First Name of the user receiving the merchant activation
Last Name (required) min = 2
Last Name of the user receiving the merchant activation
Partner Code (optional) min = 2
Pay Advantage's internal Partner Code. If you do not know this code please reach out to our support team to get assistance.
SendEmail (optional) bool
true: Sends the business an email with the activation code false: Does not send an activation email (Default if not passed)

Example Request


{
    "businessName":"New Business Name",
    "email":"admin@newbusiness.com.au",
    "externalID":"myID123",
    "firstName":"Thomas",
    "lastName":"Fredrick",
    "partnerCode":"PAYADVANTAGE",
    "sendEmail":true
}

Example Responses

STATUS 200 // Successful
    
{
    "Code": "P8SSGA",
    "ExternalID": "myID123",
    "DateCreated": "2022-12-09T06:43:17.683+00:00",
    "BusinessName": "New Business name",
    "FirstName": "Thomas",
    "LastName": "Fredrick",
    "Email": "admin@newbusiness.com.au",
    "Merchant": null,
    "ActivationLink": "https://secure.payadvantage.com.au/Activation/?code=P8SSGA",
    "PartnerCode": "PAYADVANTAGE"
}

STATUS 422 // Error
    
{
    "ErrorCode": "unprocessable",
    "Messages": [
        "ExternalID is already in use."
        ]
}

DELETE Merchant Activations

This documentation is deprecated

Please refer to the updated documentation https://docs.payadvantage.com.au/reference/merchant_activations_delete-1

Example Request

curl -L -X DELETE 'https://api.payadvantage.com.au/v3/merchant_activations/{code}' \
 -H 'Authorization: Bearer {access_token}'

Example Responses

STATUS 200 // Successful
    
//No Body Response

STATUS 404 // Error
    
{ 
   "ErrorCode": "not_found",
   "Messages": [
      "The requested resource could not be found."
   ]
}

STATUS 422 // Error

{
    "ErrorCode": "unprocessable",
    "Messages": [
        "You can't delete once activated."
    ]
}

Articles in this section

Merchant Onboarding/Activations (Beta)

GET Merchant Activations

ADD Merchant Activations

DELETE Merchant Activations

Comments

Articles in this section

GET Merchant Activations

ADD Merchant Activations

DELETE Merchant Activations

Related articles