Application

Upsert Properties

put

Create or update properties for your merchantnumber.

Path parameters
merchantNumberanyRequired
Query parameters
queryParametersanyOptional

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}

Header parameters
exchangeIdanyOptional

Correlation Id for the request

Responses
200
Parameters were successfully updated.
application/json
put
PUT /api/BoardingManagement/v1.0/Applications/{merchantNumber}/Properties HTTP/1.1
Host: 
Accept: */*
{
  "content": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Get Properties

get

Retrieve properties created for the merchantnumber.

Path parameters
merchantNumberanyRequired
propertyNameanyRequired
Header parameters
exchangeIdanyOptional

Correlation Id for the request

Responses
200
Returns a property.
application/json
get
GET /api/BoardingManagement/v1.0/Applications/{merchantNumber}/Properties/{propertyName} HTTP/1.1
Host: 
Accept: */*
{
  "content": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Create Application

post

Create an application for a customer (merchant) to do business.

Header parameters
exchangeIdanyOptional

Correlation Id for the request

Body
hierarchyNodeKeystringRequired
dbaNamestringOptional
Responses
201
Returns a merchant number.
application/json
post
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"
}

Create Default Pricing

post

Initialize a pricing plan for the merchantnumber in the request.

Path parameters
merchantNumberanyRequired
Header parameters
exchangeIdanyOptional

Correlation Id for the request

Responses
200
Creating a pre-defined, default pricing plan.
application/json
Responseobject
post
POST /api/BoardingManagement/v1.0/Applications/{merchantNumber}/InitializePricing HTTP/1.1
Host: 
Accept: */*
{}

Submit Signatures

post

After the signatures are provided and no administrative adjustments need to be made.

Path parameters
merchantNumberanyRequired
Header parameters
exchangeIdanyOptional

Correlation Id for the request

Responses
200
Successfully submitted the signatures.
application/json
Responseobject
post
POST /api/BoardingManagement/v1.0/Applications/{merchantNumber}/SubmitSignatures HTTP/1.1
Host: 
Accept: */*
{}

Submit Application

post

Submit an application. This is used after all of the application data is entered and is satisfactory.

Path parameters
merchantNumberanyRequired
Header parameters
exchangeIdanyOptional

Correlation Id for the request

Responses
200
Successfully submitted merchant. The data entering process is complete.
application/json
Responseobject
post
POST /api/BoardingManagement/v1.0/Applications/{merchantNumber}/Submit HTTP/1.1
Host: 
Accept: */*
{}

Was this helpful?