Application
Create or update one or more custom properties for the specified merchant.
Properties allow you to store external identifiers and other custom attributes that can be retrieved later.
The merchant's unique identification number.
By passing in an identifier on your query string, you can associate it with your merchant. Example of query parameter: {merchantNumber}/Properties/?ExternalCustomerId={Your Identifier}
Correlation Id for the request.
Parameters were successfully updated.
Request change was accepted.
Invalid Request.
Forbidden
Request change was rejected because there is another one.
Error occurred saving properties.
Retrieve properties created for the merchant.
The merchant's unique identification number.
The name of the property you want to retrieve.
Correlation Id for the request.
Returns a property.
merchantNumber is Required.
Error occurred retrieving data.
Create a new merchant application in the boarding system. This is the first step in the onboarding workflow and creates a merchant record.
The merchant number returned from this endpoint must be used in all subsequent API calls related to this application.
Correlation Id for the request.
The unique key identifying the hierarchy node.
1234567800000001Doing Business As (DBA) name of the merchant.
Sandbox MerchantReturns a merchant number.
HierarchyNodeKey is Required.
Error occurred retrieving data.
Initialize a pre-defined default pricing plan for the specified merchant.
The merchant's unique identification number.
Correlation Id for the request.
Creating a pre-defined, default pricing plan.
MerchantNumber is Required.
Error occurred retrieving data.
Mark the merchant application as having all required signatures from authorized signers.
Call this endpoint only after all required signatures are collected and all administrative adjustments are complete.
The merchant's unique identification number.
Correlation Id for the request.
Successfully submitted the signatures.
Merchant cannot have signatures submitted at this time.
Merchant not found
System error.
Submit a completed merchant application once all required data has been entered, reviewed and is satisfactory.
The merchant's unique identification number.
Correlation Id for the request.
Successfully submitted merchant. The data entering process is complete.
Unable to submit merchant at this time.
Merchant not found
Error occurred retrieving data.
Last updated
Was this helpful?