Partner API

The Merchant Warrior Partner API enables approved development and industry partners to generate merchant accounts in real-time

  • Endpoints
  • Introduction
  • addMerchant

    The addMerchant method is the method used to perform a merchant creation request

  • checkMerchant

    The checkMerchant method is the method used to check the status of a merchant creation request

Endpoints

Sandbox
POST https://base.merchantwarrior.com/partner/ Copy

Production
POST https://api.merchantwarrior.com/partner/ Copy

Introduction

The Merchant Warrior Partner API enables approved development and industry partners to generate merchant accounts in real-time.

You will need to obtain a Partner UUID, API Key and API passphrase in order to use this feature. These details will be made available to you after your Partner application has been processed.

addMerchant

The addMerchant method is the method used to perform a merchant creation request.
If you supply a notifyURL to MW when setting up your partner account, you will receive a notification message in real-time when the creation request has completed.

Required Parameters

Parameter Description
method

This field is case sensitive.
Example: addMerchant
partnerUUID

The value of this parameter is provided to you by Merchant Warrior.
Example: 123456789abcd
apiKey

The value of this parameter is provided to you by Merchant Warrior.
Example: 1a3b5c
merchantCompanyLegalName

The legal name of the company.
Example: Company ABC PTY LTD
merchantCompanyTradingName

The trading name of the company. This may be the same as the legal name.
Example: ABC COMPANY
merchantCompanyRegNumber

The registration number of the company, eg. ABN, NZBN, EIN etc.
Example: 123456
Valid length: Up to 64 characters.
merchantIndustry

The industry that best defines the merchant's operations. Must be one of the followings:
'Professional Services',
'Mail/Telephone Order',
'Business Services',
'Retail Store',
'Airline Services',
'Entertainment',
'Automobiles',
'Clothing',
'Contracted Services',
'Government',
'Hotel',
'Personal Services',
'Repair Services',
'Transportation',
'Utilities',
'Wholesale',
'Other'
Example: Clothing
Valid length: Up to 75 characters.
merchantWebsite

The website of the company. Starts with http:// or https://
Example: https://apple.com.au
Valid length: Up to 75 characters.
merchantCountry

Two letter ISO 3166-1 alpha-2 country code.
Example: AU
Valid length: 2 characters
merchantState

Freeform field, keep consistent for your records and reporting.
Example: Queensland
Valid length: Up to 75 characters
merchantCity

Freeform field, keep consistent for your records and reporting.
Example: Brisbane
Valid length: Up to 75 characters

merchantStreet

Freeform field.
Example: 123 Test Street
Valid length: Up to 255 characters
merchantPostcode

This can also accomodate ZIP/Post codes for international transactions.
Example: 4000
Valid length: Between 4 and 10 characters
merchantTimezone

Must be a valid timezone.
Example: Australia/Brisbane
Valid length: Up to 75 characters

merchantContactName

The main contact name of this merchant. This field can only contain alphanumeric characters, as well as the full stop, comma, apostrophe, ampersand, space and hyphen characters.
Example: Mr. Example Person
Valid length: Between 2 and 255 characters
merchantContactEmail

The main contact email of this merchant.
Example: [email protected]
Valid length: Up to 255 characters
merchantContactPhone

The main contact phone number of this merchant.
Example: 0401234567 or 61731234567
Valid length: Up to 25 characters
merchantContactMobile

The main contact mobile number of this merchant.
Example: 0401234567 or 61731234567
Valid length: Up to 25 characters
merchantBillingContactName

The billing contact name of this merchant. This field can only contain alphanumeric characters, as well as the full stop, comma, apostrophe, ampersand, space and hyphen characters.
Example: Mr. Example Person
Valid length: Between 2 and 255 characters
merchantBillingContactEmail

The billing contact email of this merchant.
Example: [email protected]
Valid length: Up to 255 characters
hash

The verification hash is a combination of the MD5 of your API Passphrase, and specific parameters sent in the transaction. See Partner Type Hash for information on how to construct the hash correctly.
Example: e9ddc296b76b3398934bfc06239073df
Valid length: 32 characters

Optional Parameters

Parameter Description
ddSettlementAccountName

The merchant's settlement account name for direct debit (bank account) transactions. This field is required if you specify either ddSettlementAccountBSB or ddSettlementAccountNumber.
Example: Test Name
Valid length: Up to 75 characters
ddSettlementAccountBSB

The merchant's settlement account BSB for direct debit (bank account) transactions. This field is required if you specify either ddSettlementAccountName or ddSettlementAccountNumber.
Example: 123456
Valid length: Up to 75 characters
ddSettlementAccountNumber

The merchant's settlement account number for direct debit (bank account) transactions. This field is required if you specify either ddSettlementAccountBSB or ddSettlementAccountName.
Example: 00123456
Valid length: Up to 75 characters
ccSettlementAccountName

The merchant's settlement account name for credit card transactions. This field is required if you specify either ccSettlementAccountBSB or ccSettlementAccountNumber.
Example: Test Name
Valid length: Up to 75 characters
ccSettlementAccountBSB

The merchant's settlement account BSB for credit card transactions. This field is required if you specify either ccSettlementAccountName or ccSettlementAccountNumber.
Example: 123456
Valid length: Up to 75 characters
ccSettlementAccountNumber

The merchant's settlement account number for credit card transactions. This field is required if you specify either ccSettlementAccountBSB or ccSettlementAccountName.
Example: 512345678912346
Valid length: Up to 75 characters
cardAcceptorName

Freeform field. The name that will appear on the card holder's statement.
Example: NIKE ACCESSORIES
Valid length: Up to 19 characters
merchantCategoryCode

MCC used to classify a merchant's business
Example: 7011
Valid length: 4 digits
fileAttachments

Due diligence documentation. This must be a compressed .zip archive and must not exceed 30MB.
status

The request will be automatically approved or declined based on this parameter. This must be either approved or declined if present. This parameter will only work in the sandbox environment.
Example: approved

Copy 
<?xml version="1.0"?>
<mwResponse>
  <responseCode>0</responseCode>
  <responseMessage>Operation successful</responseMessage>
  <requestReference>679b7f3207674eef052a</requestReference>
</mwResponse>
0 Operation successful 679b7f3207674eef052a 
{
    "responseCode": 0,
    "responseMessage": "Operation successful",
    "requestReference": "679b7f3207674eef052a"
}
{ "responseCode": 0, "responseMessage": "Operation successful", "requestReference": "679b7f3207674eef052a" }
<?xml version="1.0"?>
<mwResponse>
  <requestReference>679b7f3207674eef052a</requestReference>
  <status>approved</status>
</mwResponse>
679b7f3207674eef052a approved 
{
    "requestReference": "679b7f3207674eef052a",
    "status": "approved"
}
{ "requestReference": "679b7f3207674eef052a", "status": "approved" }
<?xml version="1.0"?>
<mwResponse>
  <requestReference>679b7f3207674eef052a</requestReference>
  <status>created</status>
  <merchantUUID>649a620bc7612</merchantUUID>
  <apiKey>mwbvekb4</apiKey>
  <apiPassphrase>v1dvkdvk</apiPassphrase>
</mwResponse>
679b7f3207674eef052a created 649a620bc7612 mwbvekb4 v1dvkdvk 
{
    "requestReference": "679b7f3207674eef052a",
    "status": "created",
    "merchantUUID": "649a620bc7612",
    "apiKey": "mwbvekb4",
    "apiPassphrase": "v1dvkdvk"
}
{ "requestReference": "679b7f3207674eef052a", "status": "created", "merchantUUID": "649a620bc7612", "apiKey": "mwbvekb4", "apiPassphrase": "v1dvkdvk" }
<?xml version="1.0"?>
<mwResponse>
  <merchantUUID>649a620bc7612</merchantUUID>
  <status>sandbox</status>
  <requestReference>679b7f3207674eef052a</requestReference>
</mwResponse>
649a620bc7612 sandbox 679b7f3207674eef052a 
{
    "merchantUUID": "649a620bc7612",
    "status": "sandbox",
    "requestReference": "679b7f3207674eef052a"
}
{ "merchantUUID": "649a620bc7612", "status": "sandbox", "requestReference": "679b7f3207674eef052a" }
<?xml version="1.0"?>
<mwResponse>
  <merchantUUID>649a620bc7612</merchantUUID>
  <status>active</status>
  <requestReference>679b7f3207674eef052a</requestReference>
</mwResponse>
649a620bc7612 active 679b7f3207674eef052a 
{
    "merchantUUID": "649a620bc7612",
    "status": "active",
    "requestReference": "679b7f3207674eef052a"
}
{ "merchantUUID": "649a620bc7612", "status": "active", "requestReference": "679b7f3207674eef052a" }
checkMerchant

The checkMerchant method is the method used to check the status of a merchant creation request

Required Parameters

Parameter Description
method

This field is case sensitive.
Example: checkMerchant
partnerUUID

The value of this parameter is provided to you by Merchant Warrior.
Example: 123456789abcd
apiKey

The value of this parameter is provided to you by Merchant Warrior.
Example: 1a3b5c
requestReference

This parameter is returned by addMerchant.
Example: abdfd1231150fda
hash

The verification hash is a combination of the MD5 of your API Passphrase, and specific parameters sent in the transaction. See Partner Query Hash for information on how to construct the hash correctly.
Example: e9ddc296b76b3398934bfc06239073df
Valid length: 32 characters