Application
Create or update properties for your merchantnumber.
By passing in an identifier with the following format on your query string, you can associate it with your merchant: {merchantNumber}/Properties/?ExternalCustomerId={Your Identifier}
Correlation Id for the request
Parameters were successfully updated.
Invalid Request.
Error occurred saving properties.
PUT /api/BoardingManagement/v1.0/Applications/{merchantNumber}/Properties HTTP/1.1
Host:
Accept: */*
{
"content": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}Retrieve properties created for the merchantnumber.
Correlation Id for the request
Returns a property.
merchantNumber is Required.
Error occurred retrieving data.
GET /api/BoardingManagement/v1.0/Applications/{merchantNumber}/Properties/{propertyName} HTTP/1.1
Host:
Accept: */*
{
"content": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}Create an application for a customer (merchant) to do business.
Correlation Id for the request
Returns a merchant number.
HierarchyNodeKey is Required.
Error occurred retrieving data.
POST /api/BoardingManagement/v1.0/Applications/Create HTTP/1.1
Host:
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 68
{
"hierarchyNodeKey": "1234567800000001",
"dbaName": "Sandbox Merchant"
}{
"merchantNumber": "text"
}Initialize a pricing plan for the merchantnumber in the request.
Correlation Id for the request
Creating a pre-defined, default pricing plan.
MerchantNumber is Required.
Error occurred retrieving data.
POST /api/BoardingManagement/v1.0/Applications/{merchantNumber}/InitializePricing HTTP/1.1
Host:
Accept: */*
{}After the signatures are provided and no administrative adjustments need to be made.
Correlation Id for the request
Successfully submitted the signatures.
Merchant cannot have signatures submitted at this time.
Merchant not found
System error.
POST /api/BoardingManagement/v1.0/Applications/{merchantNumber}/SubmitSignatures HTTP/1.1
Host:
Accept: */*
{}Submit an application. This is used after all of the application data is entered and is satisfactory.
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.
POST /api/BoardingManagement/v1.0/Applications/{merchantNumber}/Submit HTTP/1.1
Host:
Accept: */*
{}Was this helpful?