PATCH Update Submerchant Information: Available Paths and Operations
Use the Update Submerchant Information endpoint to update the following submerchant details in Backoffice. This endpoint uses the JSON Patch format. See the paths, operations, and example syntax below.
Submerchant Details
| Path | Available Operations |
|---|---|
| /LegalEntityName | Add, Replace |
| /DbaName | Add, Replace |
| /AccountStatus | Add, Replace |
| /ContactPhone | Add, Replace |
| /WebsiteAddress | Add, Replace |
| /AnnualCreditCardSalesVolume | Add, Replace |
| /PrincipalFirstName | Add, Replace, Remove |
| /PrincipalLastName | Add, Replace, Remove |
| /PrincipalMiddleName | Add, Replace, Remove |
| /BusinessAddress | Add, Replace |
| /BusinessType | Add, Replace |
| /BusinessAddress/Line2 | Add, Replace |
| /BusinessAddress/City | Add, Replace |
| /BusinessAddress/CountryRegion | Add, Replace |
| /BusinessAddress/StateProvince | Add, Replace |
| /BusinessAddress/PostalCode | Add, Replace |
| /ChargebackEmail | Add, Replace, Remove |
| /RiskRating | Add, Replace |
Submerchant Details Example Syntax
{"op": "replace", "path":"/LegalEntityName", "value":"Random Legal Entity Name"},
{"op": "replace", "path":"/DbaName", "value":"Random DBA NAME"},
{"op": "replace", "path":"/AccountStatus", "value": 0},
{"op": "replace", "path":"/ContactPhone", "value": "99999999991"},
{"op": "replace", "path":"/WebsiteAddress", "value": "Random website"},
{"op": "replace", "path":"/AnnualCreditCardSalesVolume", "value": 101},
{"op": "replace", "path":"/PrincipalFirstName", "value":"Random First"},
{"op": "replace", "path":"/PrincipalLastName", "value":"Random First"},
{"op": "replace", "path":"/PrincipalMiddleName", "value":"Random Middle"},
{"op": "replace", "path":"/BusinessAddress/Line2", "value":"Random address2"},
{"op": "replace", "path":"/BusinessAddress/City", "value":"City"},
{"op": "replace", "path":"/BusinessAddress/CountryRegion", "value":" 11"},
{"op": "replace", "path":"/BusinessAddress/StateProvince", "value":"11"},
{"op": "replace", "path":"/BusinessAddress/PostalCode", "value":"Code"},
{"op": "replace", "path":"/ChargebackEmail", "value": "[email protected]"},
{"op": "replace", "path":"/RiskRating", "value": "Moderate"},Banking Information
| Path | Available Operations |
|---|---|
| /BankAccountEncrypted | Add, Replace |
| /BankRoutingEncrypted | Add, Replace |
| /BankAccountUUID | Replace, Test |
Banking Information Example Syntax
{"op": "replace", "path":"/BankAccountUUID", "value": "[email protected]"},
{"op": "replace", "path":"/BankAccountEncrypted", "value": "newAccount#"},
{"op": "replace", "path":"/BankRoutingEncrypted", "value": "newRouting#"},Fee Profile
| Property | Available Operations |
|---|---|
| /FeeProfile/MonthlyFee | Replace, Test |
| /FeeProfile/ChargebackFee | Replace, Test |
| /FeeProfile/AchReturnFee | Replace, Test |
| /FeeProfile/GatewayFee | Replace, Test |
| /FeeProfile/AchTransactionRate | Replace, Test |
| /FeeProfile/AchTransactionFee | Replace, Test |
Fee Profile Example Syntax
{"op": "replace", "path":"/FeeProfile/MonthlyFee", "value": 2},
{"op": "replace", "path":"/FeeProfile/ChargebackFee", "value": 2},
{"op": "replace", "path":"/FeeProfile/AchReturnFee", "value": 2},
{"op": "replace", "path":"/FeeProfile/GatewayFee", "value": 2},
{"op": "replace", "path":"/FeeProfile/AchTransactionRate", "value": 2},
{"op": "replace", "path":"/FeeProfile/AchTransactionFee", "value": 2},Rates and Fees
| Property | Available Operations |
|---|---|
| /CardFeeDetailsVisa/cardPresentFee | Replace, Test |
| /CardFeeDetailsVisa/cardPresentRate | Replace, Test |
| /CardFeeDetailsVisa/cardNotPresentFee | Replace, Test |
| /CardFeeDetailsVisa/cardNotPresentRate | Replace, Test |
| /CardFeeDetailsMasterCard/cardPresentFee | Replace, Test |
| /CardFeeDetailsMasterCard/cardPresentRate | Replace, Test |
| /CardFeeDetailsMasterCard/cardNotPresentFee | Replace, Test |
| /CardFeeDetailsMasterCard/cardNotPresentRate | Replace, Test |
| /CardFeeDetailsAmex/cardPresentFee | Replace, Test |
| /CardFeeDetailsAmex/cardPresentRate | Replace, Test |
| /CardFeeDetailsAmex/cardNotPresentFee | Replace, Test |
| /CardFeeDetailsAmex/cardNotPresentRate | Replace, Test |
| /CardFeeDetailsDiscover/cardPresentFee | Replace, Test |
| /CardFeeDetailsDiscover/cardPresentRate | Replace, Test |
| /CardFeeDetailsDiscover/cardNotPresentFee | Replace, Test |
| /CardFeeDetailsDiscover/cardNotPresentRate | Replace, Test |
| /CardFeeDetailsDebit/cardPresentFee | Replace, Test |
| /CardFeeDetailsDebit/cardPresentRate | Replace, Test |
| /CardFeeDetailsDebit/cardNotPresentFee | Replace, Test |
| /CardFeeDetailsDebit/cardNotPresentRate | Replace, Test |
Rates and Fees Example Syntax
{"op":"replace", "path":"/CardFeeDetailsVisa//cardPresentFee", "value":1},
{"op":"replace", "path":"/CardFeeDetailsVisa/cardPresentRate", "value":0.1},
{"op":"replace", "path":"/CardFeeDetailsVisa/cardNotPresentFee", "value":1},
{"op":"replace", "path":"/CardFeeDetailsVisa/cardNotPresentRate", "value":0.1},
{"op":"replace", "path":"/CardFeeDetailsMasterCard/cardPresentFee", "value":2},
{"op":"replace", "path":"/CardFeeDetailsMasterCard/cardPresentRate", "value":0.2},
{"op":"replace", "path":"//CardFeeDetailsMasterCard/cardNotPresentFee", "value":2},
{"op":"replace", "path":"/CardFeeDetailsMasterCard/cardNotPresentRate", "value":0.2},
{"op":"replace", "path":"/CardFeeDetailsAmex/cardPresentFee", "value":3},
{"op":"replace", "path":"/CardFeeDetailsAmex/cardPresentRate", "value":0.3},
{"op":"replace", "path":"/CardFeeDetailsAmex/cardNotPresentFee", "value":3},
{"op":"replace", "path":"/CardFeeDetailsAmex/cardNotPresentRate", "value":0.3},
{"op":"replace", "path":"/CardFeeDetailsDiscover/cardPresentFee", "value":4},
{"op":"replace", "path":"/CardFeeDetailsDiscover/cardPresentRate", "value":0.4},
{"op":"replace", "path":"/CardFeeDetailsDiscover/cardNotPresentFee", "value":4},
{"op":"replace", "path":"/CardFeeDetailsDiscover/cardNotPresentRate", "value":0.4},
{"op":"replace", "path":"/CardFeeDetailsDebit/cardPresentFee", "value":5},
{"op":"replace", "path":"/CardFeeDetailsDebit/cardPresentRate", "value":0.5},
{"op":"replace", "path":"/CardFeeDetailsDebit/cardNotPresentFee", "value":5},
{"op":"replace", "path":"/CardFeeDetailsDebit/cardNotPresentRate", "value":0.5},Approved Parameters
NOTE: The approved parameters available for updating via this endpoint are informational only. For clients using the Exception Reporting area in Backoffice, we recommend using the PATCH Submerchant Approved Parameters endpoint for updating the risk exception parameters that are used for calculating risk.
| Property | Available Operations |
|---|---|
| /ApprovedMonthlyVolume | Replace, Test |
| /ApprovedAverageTicketAmount | Replace, Test |
| /ApprovedCardNotPresentPercentage | Replace, Test |
| /ApprovedCardPresentPercentage | Replace, Test |
Approved Parameters Example Syntax
{"op":"replace", "path":"/ApprovedMonthlyVolume", "value":5},
{"op":"replace", "path":"/ApprovedAverageTicketAmount", "value":5},
{"op":"replace", "path":"/ApprovedCardNotPresentPercentage", "value":0.05},
{"op":"replace", "path":"/ApprovedCardPresentPercentage", "value":0.05}Updated 5 months ago