Updating the Account
Account manages the product that you are willing to board.
Introduction
In this section, you will learn about the Account object and its significance in the boarding process, instructions for constructing and sending an account update request, and guidance on selecting product configurations, features, and sponsor details.
Note: As of September 2021, our documentation refers to the new MXC boarding APIs. If you would like to review documentation referencing our old boarding APIs, please change the page version from v2 to v1 at the top left corner
Prerequisites
- UAR must already be created with an associated accountId
- Authentication via a valid JWT token from the security API
- A valid partner domain ID
- Product-specific configurations details such as:
- Product ID (e.g., TSYS)
- Feature groups (e.g., Visa, Mastercard, Amex settings)
- Funding and billing account information
- Sponsor bank data, if applicable
Limitations
- The configuration options vary based on the selected product; incorrect combinations may lead to validation errors
- The Account object must be accurately completed before finalizing the merchant setup
- Complex feature group structures must align with predefined templates; invalid settings can prevent activation
- The API does not perform full semantic validation of configuration mismatches—business validation must be managed externally
Account Updating
Updating the account endpoint will vary greatly between different products. This will be an endpoint that will be heavily considered based on your company's business needs. Below is a snapshot of what a complete account request body will look like.
PUT https://api.mxconnect.com/boarding/v1/uar/(accountIDHere)/account
{
"domain": {
"id": "00000000-0000-0000-0000-000000000001"
},
"status": "Draft",
"product": {
"id": "3",
"name": "TSYS"
},
"id": "0811ece2-ec7d-5150-ba8e-0a558b206b3f",
"featureGroups": [
{
"features": [
{
"group": 0,
"id": "visa_debit",
"name": "Visa Debit",
"pos": 0,
"value": true,
"isDisabled": false
},
{
"group": 0,
"id": "visa_credit",
"name": "Visa Credit",
"pos": 1,
"value": true,
"isDisabled": false
},
{
"group": 0,
"id": "mastercard_debit",
"name": "Mastercard Debit",
"pos": 2,
"value": true,
"isDisabled": false
},
{
"group": 0,
"id": "mastercard_credit",
"name": "Mastercard Credit",
"pos": 3,
"value": true,
"isDisabled": false
},
{
"group": 0,
"id": "american_express",
"name": "American Express (OptBlue)",
"pos": 4,
"value": false,
"isDisabled": false
},
{
"group": 0,
"id": "discover",
"name": "Discover Full Acquiring (MAP)",
"pos": 5,
"value": false,
"isDisabled": false
},
{
"group": 0,
"id": "pin_debit",
"name": "PIN Debit",
"pos": 6,
"value": false,
"isDisabled": false
},
{
"group": 0,
"id": "ebt_cash_benefit",
"name": "EBT Cash Benefit",
"pos": 7,
"value": false,
"isDisabled": false
},
{
"group": 0,
"id": "ebt_food_stamp",
"name": "EBT Food Stamp",
"pos": 8,
"value": false,
"isDisabled": false
}
],
"id": "acquiring-tsys-basic",
"name": "Basic",
"pos": 0,
"toggleAlias": "Enabled",
"visibility": "partnerMerchant"
},
{
"features": [
{
"featureTypes": [
{
"group": 1,
"helpText": "CAP #",
"id": "0fea6cb7-7869-5578-b738-02f02936ae20",
"item": 0,
"maxLength": 10,
"minLength": 10,
"name": "CAP #",
"pos": 0,
"readOnly": false,
"required": false,
"type": "string",
"isDisabled": false
}
],
"group": 1,
"id": "american_express_direct",
"name": "American Express Direct (ESA)",
"pos": 0,
"value": false,
"isDisabled": false
},
{
"group": 1,
"id": "american_express_commercial_marketing_communication_opt_out",
"name": "American Express commercial marketing communication opt out",
"pos": 2,
"value": false,
"isDisabled": false
},
{
"group": 1,
"id": "discover_direct",
"name": "Discover Direct",
"pos": 1,
"value": false,
"isDisabled": false
}
],
"id": "acquiring-tsys-advanced",
"name": "Advanced",
"pos": 1,
"toggleAlias": "Enabled",
"visibility": "partnerMerchant"
},
{
"features": [
{
"group": 2,
"id": "668e2b7b-6493-55de-8835-7a6e0a6123d1",
"name": "Request Next Day Funding",
"pos": 2,
"value": false,
"isDisabled": false
},
{
"group": 2,
"id": "20cc456d-27e6-5fa0-913f-00272068d3d7",
"name": "Request Daily Discount",
"pos": 0,
"value": false,
"isDisabled": false
},
{
"group": 2,
"id": "727292a4-6760-588a-b28d-ba94c84b5fde",
"name": "Request Daily Interchange",
"pos": 1,
"value": false,
"isDisabled": false
},
{
"featureTypes": [
{
"group": 2,
"id": "9bfcbcc0-ffae-542d-8d8a-1aff08aac282",
"item": 4,
"name": "Business Sales",
"options": [
"1% - 10%",
"11% - 20%",
"21% - 30%",
"31% - 40%",
"41% - 50%",
"51% - 60%",
"61% - 70%",
"71% - 80%",
"81% - 90%",
"91% - 100%"
],
"pos": 0,
"readOnly": false,
"required": false,
"type": "dropdown",
"value": "1% - 10%",
"isDisabled": false
},
{
"group": 2,
"id": "b12d68a9-04b2-5625-b4c6-9aac9e3e073a",
"item": 4,
"name": "Commercial Sales",
"options": [
"1% - 10%",
"11% - 20%",
"21% - 30%",
"31% - 40%",
"41% - 50%",
"51% - 60%",
"61% - 70%",
"71% - 80%",
"81% - 90%",
"91% - 100%"
],
"pos": 1,
"readOnly": false,
"required": false,
"type": "dropdown",
"value": "1% - 10%",
"isDisabled": false
},
{
"group": 2,
"id": "9361d163-1a4b-5f86-8812-a0a53db519c3",
"item": 4,
"name": "Government Sales",
"options": [
"1% - 10%",
"11% - 20%",
"21% - 30%",
"31% - 40%",
"41% - 50%",
"51% - 60%",
"61% - 70%",
"71% - 80%",
"81% - 90%",
"91% - 100%"
],
"pos": 2,
"readOnly": false,
"required": false,
"type": "dropdown",
"value": "1% - 10%",
"isDisabled": false
}
],
"group": 2,
"id": "d5fdae8f-17b2-53b6-ab80-cd9f6390ed9c",
"name": "Commercial Transactions",
"pos": 4,
"value": false,
"isDisabled": false
},
{
"featureTypes": [
{
"group": 2,
"id": "ach_method",
"item": 5,
"name": "ACH Method",
"options": [
"Individual - By Batch",
"Combined - All Batches"
],
"pos": 0,
"readOnly": false,
"required": false,
"type": "dropdown",
"value": "individual - by batch",
"isDisabled": false
}
],
"group": 2,
"id": "change_ach_method",
"name": "Request ACH Method Change",
"pos": 5,
"value": false,
"isDisabled": false
},
{
"group": 2,
"id": "debt_repayment",
"name": "Debt Repayment",
"pos": 3,
"value": false,
"isDisabled": false
}
],
"id": "1ac1dac8-dc5e-5880-b76a-bcf387b074c5",
"name": "Partner Only",
"pos": 2,
"toggleAlias": "Enabled",
"visibility": "partner"
}
],
"platform": "vortex",
"sponsor": {
"id": "12",
"applicationVersion": "2.6.1",
"bankNumber": "5631",
"bin": "425761",
"city": "Maitland",
"disabled": false,
"fullName": "Axiom Bank N.A., FL",
"ica": "21054",
"mpgVersion": "2.6.1",
"name": "Axiom Bank",
"phoneNumber": " (321) 249-7847",
"prefix": "5631",
"prefixPad": "7",
"products": [
{
"id": "3",
"name": "TSYS"
}
],
"programGuide": "https://prioritypaymentsystems.com/manuals/Axiom_Bank_PPS_Program_Guide_09.24.19.pdf",
"state": "FL",
"streetAddress1": "258 Southhall Ln Suite 400",
"zipcode": "32751",
"enabled": true,
"default": true,
"registrationType": "Unregistered"
},
"statementBranding": "2a4e26e3-5f61-516e-8300-dd3c76558d39",
"welcomeKit": "251b7d9c-2eaa-5f9f-a85f-e30e9fdde2be",
"funding": [
{
"fundingAccountType": "fees",
"alias": "Billing Account",
"accountNumber": "111333",
"accountType": "Checking",
"bankName": "BANK OF AMERICA, N.A.",
"routingNumber": "061000052",
"bankAddress": {
"country": "United States"
}
},
{
"fundingAccountType": "deposits",
"alias": "Funding Account",
"accountNumber": "111333",
"accountType": "Checking",
"bankName": "BANK OF AMERICA, N.A.",
"routingNumber": "061000052",
"bankAddress": {
"country": "United States"
}
}
],
"meta": {
"cyris": {
"addPts": 10,
"existingMerchantMDB": 350,
"maxPercentage": 31,
"minMtdVolume": 500,
"newMerchantMDB": 500,
"overMaxPercentage": 1,
"points": 20,
"existingMerchantItems": [
{
"exception1": 10,
"additionalPoints1": 3,
"exception2": 15,
"additionalPoints2": 4
},
{
"exception1": 5,
"additionalPoints1": 3,
"exception2": 8,
"additionalPoints2": 4
},
{
"exception1": 4,
"additionalPoints1": 3,
"exception2": 5,
"additionalPoints2": 4
},
{
"exception1": 3,
"additionalPoints1": 4,
"exception2": 4,
"additionalPoints2": 5
},
{
"exception1": 2,
"additionalPoints1": 5,
"exception2": 3,
"additionalPoints2": 6
},
{
"exception1": 1,
"additionalPoints1": 5,
"exception2": 3,
"additionalPoints2": 6
},
{
"exception1": 2,
"additionalPoints1": 5,
"exception2": 3,
"additionalPoints2": 6
}
],
"newMerchantItems": [
{
"average": 50,
"exception": 5,
"points": 2
},
{
"average": 100,
"exception": 4,
"points": 2
},
{
"average": 200,
"exception": 3,
"points": 2
},
{
"average": 500,
"exception": 2,
"points": 3
},
{
"average": 750,
"exception": 2,
"points": 4
},
{
"average": 2500,
"exception": 1,
"points": 5
},
{
"average": 2500,
"exception": 1,
"points": 6
}
],
"forcedTransaction": {
"points": 5,
"additionalPoints": 10,
"percentAboveAvg": 1
},
"multiBin": {
"points": 2,
"maxNumber": 2,
"additionalPoints": 1
},
"duplicateCards": {
"points": 1,
"maxTimes": 5,
"additionalPoints": 2
},
"offsettingSale": {
"points": 2,
"exceedingSales": 1
},
"authDeclines": {
"anyCard": 2,
"anyCardPoints": 2,
"anyCardAdditionalPoints": 1,
"sameCard": 2,
"sameCardPoints": 1,
"sameCardAdditionalPoints": 1,
"reason": 0,
"reasonPoints": 1,
"reasonAdditionalPoints": 1
},
"chargeBacks": {
"points": 1,
"maxPercentage": 0,
"additionalPoints": 25,
"forEvery": 1
},
"negativeDailyBatch": {
"points": 10,
"additionalPoints": 20,
"forEvery": 100
},
"motoAvs": {
"xy": 0,
"wz": 0,
"ap": 0,
"n": 3,
"u": 0,
"r": 1,
"s": 0,
"d": 0,
"e": 1,
"g": 1
},
"monthlyLimit": {
"points": 10,
"additionalPoints": 5,
"forEvery": 1
},
"largeTransaction": {
"points": 1,
"maxAmount": 5000,
"additionalPoints": 1,
"forEvery": 5000
},
"ddaChange": {
"points": 100
},
"foreignCards": {
"points": 1,
"maxNumber": 2,
"additionalPoints": 10,
"forEvery": 1
},
"openBatch": {
"points": 10,
"maxNumber": 10,
"additionalPoints": 15
}
},
"sendToMerchant": false
},
"research": {
"addenda": {
"motoEcom": {
"usesThirdParty": false
}
},
"risk": {
"chargebackReversalEnabled": false,
"creditRewrite": false,
"merchantWatchlist": false,
"periodicReview": false,
"qmaEnabled": false
},
"processing": {
"open": {
"january": false,
"february": false,
"march": false,
"april": false,
"may": false,
"june": false,
"july": false,
"august": false,
"september": false,
"october": false,
"november": false,
"december": false
},
"avgTicket": 25,
"moto": 0,
"ecom": 0,
"swiped": 100,
"daysToDelivery": 0,
"volume": 10000,
"amexAvgTicket": 0,
"amexHighTicket": 0,
"amexVolume": 0,
"b2b": 0,
"b2c": 0,
"b2g": 0,
"highTicket": 0
}
},
"acceptsCreditCards": false,
"active": false,
"billing": {
"ledger": false
},
"billingItems":[
{
"amount": 0.24,
"calculationOptions": "Percent (%)",
"catalogId": "7b85e324-01c6-5912-a305-62733dc56fd7",
"catalogName": "Transaction Fees",
"categoryId": "0281cd01-0413-55ef-b44f-07be36737b86",
"key1": [
"f4b59d05-1bdc-5d6f-aa89-0d04d7823c6c",
"268bf887-89cc-5b70-a41c-8291a648d388",
"7c2bd192-772d-513f-9ed2-12da0e925eb9",
"8e16e206-4784-583a-b552-d9c8dee5b1e7"
],
"key2": [
"f21962a9-c8a7-5cda-87d2-9cc0ac77f751",
"6422b701-3d0f-5bca-a599-0242feb3225a",
"59ccf00b-7dbe-5215-a210-0c2571e41a4f"
]
}
],
"compliance": {
"pciDss": {
"audit": {
"required": false
},
"cppInvestigation": false,
"priorBreach": false,
"thirdPartyProgram": false,
"scanning": {
"required": false
}
}
},
"everTerminated": false,
"frozen": false,
"reserve": {
"disabled": false
},
"setup": {
"creditOffsetBlock": "Option 1, 2, 3, 4",
"excessiveCreditBlock": true,
"bypassForcePost": false,
"forcePostThresholdAmount": 0,
"excessiveTransactionBlock": true,
"isDiscoverFullAcquiringNumber": false,
"mccBlock": true,
"merchantBillingType": "Gross Billing"
},
"underwritingQACheck": {
"hasMerchantApp": false,
"hasWhoIsLookup": false,
"hasMerchantWebsite": false,
"hasRelatedAccounts": false,
"hasPendingDocsReviewed": false,
"hasSettlementRouting": false,
"hasMATCH": false,
"hasOFAC": false,
"hasSOS": false,
"hasG2": false,
"hasGoogleSearches": false,
"hasSICMCC": false,
"hasCreditCheck": false,
"hasMatchCheck": false,
"hasOfacCheck": false,
"hasG2Check": false
}
}
Updated 30 days ago