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
Sandbox
POST
https://base.merchantwarrior.com/partner/
Copy
Production
POST
https://api.merchantwarrior.com/partner/
Copy
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.
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. |
partnerUUID | The value of this parameter is provided to you by Merchant Warrior. |
apiKey | The value of this parameter is provided to you by Merchant Warrior. |
merchantCompanyLegalName | The legal name of the company. |
merchantCompanyTradingName | The trading name of the company. This may be the same as the legal name. |
merchantCompanyRegNumber | The registration number of the company, eg. ABN, NZBN, EIN etc. |
merchantIndustry | The industry that best defines the merchant's operations. Must be one of the followings: |
merchantWebsite | The website of the company. Starts with http:// or https:// |
merchantCountry | Two letter ISO 3166-1 alpha-2 country code. |
merchantState | Freeform field, keep consistent for your records and reporting. |
merchantCity | Freeform field, keep consistent for your records and reporting. |
merchantStreet | Freeform field. |
merchantPostcode | This can also accomodate ZIP/Post codes for international transactions. |
merchantTimezone | Must be a valid timezone. |
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. |
merchantContactEmail | The main contact email of this merchant. |
merchantContactPhone | The main contact phone number of this merchant. |
merchantContactMobile | The main contact mobile number of this merchant. |
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. |
merchantBillingContactEmail | The billing contact email of this merchant. |
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. |
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. |
ddSettlementAccountBSB | The merchant's settlement account BSB for direct debit (bank account) transactions. This field is required if you specify either ddSettlementAccountName or ddSettlementAccountNumber. |
ddSettlementAccountNumber | The merchant's settlement account number for direct debit (bank account) transactions. This field is required if you specify either ddSettlementAccountBSB or ddSettlementAccountName. |
ccSettlementAccountName | The merchant's settlement account name for credit card transactions. This field is required if you specify either ccSettlementAccountBSB or ccSettlementAccountNumber. |
ccSettlementAccountBSB | The merchant's settlement account BSB for credit card transactions. This field is required if you specify either ccSettlementAccountName or ccSettlementAccountNumber. |
ccSettlementAccountNumber | The merchant's settlement account number for credit card transactions. This field is required if you specify either ccSettlementAccountBSB or ccSettlementAccountName. |
cardAcceptorName | Freeform field. The name that will appear on the card holder's statement. |
merchantCategoryCode | MCC used to classify a merchant's business |
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. |
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. |
partnerUUID | The value of this parameter is provided to you by Merchant Warrior. |
apiKey | The value of this parameter is provided to you by Merchant Warrior. |
requestReference | This parameter is returned by addMerchant. |
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. |