| Required role: | Reseller |
| GET | /merchants | Get a list of merchants for the reseller request. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MerchantName | query | string | No | Filters to a 'contains' match on the merchant name. |
| ResellerName | query | string | No | Filters to a 'contains' match on the reseller name. |
| MerchantId | query | string | No | Filters to an exact match of the merchant id. |
| PhoneNumber | query | string | No | Filters to a merchant by phone number |
| SortField | query | string | No | The field name by which the records will be sorted. Default is 'Merchant Name'.Allowable Values
|
| IncludeDeleted | query | bool | No | Whether to include deleted records in the response, defaults to false. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SortDirection | query | string | No | The direction in which the records will be sorted. Default is 'asc'.Allowable Values
|
| SortField | query | string | No | The field name by which the records will be sorted. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PageSize | query | short | No | The number of records per page. Default is 20. |
| PageNumber | query | short | No | The page number to fetch. Default is 1. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Merchants | model | List<MerchantDetail> | No | A collection of merchants. |
| Pagination | model | PaginationStats | No | Pagination stats regarding the result set. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MerchantKey | model | int | No | Unique (system-generated) identifier. |
| ResellerKey | model | int | No | Parent reseller containing the merchant. |
| DefaultUserKey | model | int? | No | The default user for the merchant. |
| PrimaryContactKey | model | int? | No | The primary contact for the merchant. |
| MerchantName | model | string | No | The name of the merchant. |
| MerchantId | model | string | No | Identifier (user-supplied) for the merchant. |
| AlternateMerchantId | model | string | No | Alternate identifier (user-supplied) for the merchant. |
| AutoCloseBatch | model | bool | No | Enable/disable auto-closing of the merchant's batch (for terminal capture processor configurations). |
| AutoCloseBatchHour | model | DateTime | No | Hour for auto-close to occur, if enabled. |
| ForceDuplicate | model | bool | No | If enabled, the gateway will block transactions that appear to duplicate an existing transaction within the same day, and will require a ForceDuplicate flag to override. |
| RequirePNRef | model | bool? | No | If enabled, the merchant must supply a valid PNRef of an original sale to process a refund, and the refund may not be greater than the amount of the original sale. Disabling this option allows 'unlinked returns'. |
| IsTestMerchant | model | bool | No | When enabled, transactions are directed to the processors' test hosts for development and testing purposes. |
| ActivationStatus | model | ActivationStatus | No | The activation status of the merchant.Allowable Values
|
| EnableFraud | model | bool? | No | Indicated if fraud detection is on or off. |
| EnableOfflineBatch | model | bool? | No | Indicates if offline batched are on or off. |
| AllowHostedPage | model | bool? | No | Indicates is the merchant should have access to the hosted payments page. |
| AllowEmulator | model | bool? | No | Indicates if use of the emulator is allowed. |
| LimitToDebit | model | bool? | No | |
| CollectLevel3 | model | bool? | No | |
| CreationTimestamp | model | DateTime | No | The timestamp of the merchant record's creation. |
| MerchantConfigurations | model | MerchantConfigurations | No | A collection of merchant configuration data. |
| ResellerParents | model | List<ResellerTreeParent> | No | Parent reseller (or resellers) of this merchant, and the relationship among them if there are multiple |
| SelfLink | model | string | No | A self reference to the merchant. |
| ResellerLink | model | string | No | A reference to the reseller of the merchant. |
| DefaultUserLink | model | string | No | A reference to the default user of the merchant. |
| PrimaryContactLink | model | string | No | A reference to the primary contact of the merchant. |
| ProcessorProfilesLink | model | string | No | A reference to the processor profiles of the merchant. |
| BusinessInformationLink | model | string | No | A reference to the business information of the merchant. |
| AddressInformationLink | model | string | No | A reference to the address information of the merchant. |
| Pending | |
| Active | |
| Inactive | |
| Deleted |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SecuritySettings | model | MerchantSecuritySettings | No | A collection of security settings for the merchant. |
| AccessSettings | model | MerchantAccessSettings | No | A collection of access settings for the merchant. |
| MerchantVirtualTerminalSettings | model | MerchantVirtualTerminalSettings | No | A collection of virtual terminal settings for the merchant. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SaleLevel | form | string | No | |
| CreditLevel | form | string | No | |
| VoidLevel | form | string | No | |
| PreAuthLevel | form | string | No | |
| ForceAuthLevel | form | string | No | |
| AdjustLevel | form | string | No | |
| ActivateLevel | form | string | No | |
| DeactivateLevel | form | string | No | |
| InquireLevel | form | string | No | |
| RedeemLevel | form | string | No | |
| ReloadLevel | form | string | No | |
| RefundLevel | form | string | No | |
| ToolsLevel | form | string | No | |
| ReportsLevel | form | string | No | |
| CurrentBatchLevel | form | string | No | |
| BatchesLevel | form | string | No | |
| AdminLevel | form | string | No | |
| ChangeSecurityLevel | form | string | No | |
| SettleLevel | form | string | No | |
| RecurringBillingLevel | form | string | No | |
| PreferenceLevel | form | string | No | |
| FraudLevel | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BinManagementApi | form | bool | No | |
| DialIn | form | bool | No | |
| Internet | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AllowForceCapture | form | bool | No | |
| VirtualTerminalCreditAccess | form | bool | No | |
| VirtualTerminalLevel3Amount | form | bool | No | |
| VirtualTerminalConvenienceAmount | form | bool | No | |
| VirtualTerminalConvenienceAmountPercentage | form | bool | No | |
| VirtualTerminalConvenienceLabel | form | string | No | |
| virtualTerminalConvenienceAmountPercentageDefault | form | double | No | |
| VirtualTerminalDutyAmount | form | bool | No | |
| VirtualTerminalTaxAmount | form | bool | No | |
| VirtualTerminalTipAmount | form | bool | No | |
| ImageCapture | form | bool | No | |
| ReceiptCapture | form | bool | No | |
| AutoSettleMerchantEmail | form | bool | No | |
| InvoiceDuplicate | form | bool | No | |
| VirtualTerminalCommercialCard | form | bool | No | |
| VirtualTerminalShippingAmount | form | bool | No | |
| VirtualTerminalAllowRepeat | form | bool | No | |
| RequireInvoice | form | bool | No | |
| RequireNameOnCard | form | bool | No | |
| RequireLevelII | form | bool | No | |
| VirtualTerminalRecurringBilling | form | bool | No | |
| VirtualTerminalEmailReceipts | form | bool | No | |
| VirtualTerminalPrintTwoReceipts | form | bool | No | |
| VirtualTerminalInvNum | form | bool | No | |
| VirtualTerminalPONum | form | bool | No | |
| VirtualTerminalCustomerID | form | bool | No | |
| VirtualTerminalCustomer | form | bool | No | |
| VirtualTerminalStreet | form | bool | No | |
| VirtualTerminalCity | form | bool | No | |
| VirtualTerminalState | form | bool | No | |
| VirtualTerminalZip | form | bool | No | |
| VirtualTerminalPhone | form | bool | No | |
| VirtualTerminalEmail | form | bool | No | |
| VirtualTerminalAutoTaxAmount | form | float | No | |
| VirtualTerminalAutoCalcTax | form | bool | No | |
| EnableFraud | form | bool | No | |
| EnableOfflineBatch | form | bool | No | |
| EnableHostedPage | form | bool | No | |
| EnableEmulator | form | bool | No | |
| LimitToDebit | form | bool | No | |
| CollectLevel3 | form | bool | No | |
| AuthEdit | form | bool | No | |
| IsMerchantBillingAccount | form | bool | No | |
| ApplyLevel2DefaultsToApi | form | bool | No | |
| RequireShipping | form | bool | No | |
| RequireZipCode | form | bool | No | |
| EnableGsaBinCheck | form | bool | No | |
| ResellerOnlyCustomFieldsMenu | form | bool | No | |
| ResellerOnlyHostedPaymentPageMenu | form | bool | No | |
| ResellerOnlyOrderDataDefaultsMenu | form | bool | No | |
| ResellerOnlyEmulatorMenu | form | bool | No | |
| ResellerOnlyFraudControlSettingsMenu | form | bool | No | |
| ResellerOnlyFraudControlHeldLogMenus | form | bool | No | |
| CardVerification | form | MerchantCardVerificationSettings | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AVAddNotVerifiable | form | bool | No | |
| AVInvalidAddZip | form | bool | No | |
| AVZipOnly | form | bool | No | |
| AVNoMatch | form | bool | No | |
| AVIssuerUnavail | form | bool | No | |
| AVVerUnavail | form | bool | No | |
| AVAddOnly | form | bool | No | |
| AVNotRequested | form | bool | No | |
| AVUnregCode | form | bool | No | |
| AVServUnsupported | form | bool | No | |
| AVExactMatch | form | bool | No | |
| AVNoData | form | bool | No | |
| AVAddNotVerifiableGlobal | form | bool | No | |
| CVNotPresent | form | bool | No | |
| CVNoData | form | bool | No | |
| CVNotProcessed | form | bool | No | |
| CVNoDataFromIssuer | form | bool | No | |
| CVMatch | form | bool | No | |
| CVUnregCode | form | bool | No | |
| CVNoMatch | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResellerKey | form | int | No | |
| ResellerName | form | string | No | |
| Level | form | int | No | |
| Parent | form | int? | No | |
| Child | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CurrentPageNumber | form | int | No | |
| PageSize | form | int | No | |
| TotalRecordCount | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /merchants HTTP/1.1 Host: syntch.simpay.net Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Merchants":[{"MerchantKey":0,"ResellerKey":0,"DefaultUserKey":0,"PrimaryContactKey":0,"MerchantName":"String","MerchantId":"String","AlternateMerchantId":"String","AutoCloseBatch":false,"AutoCloseBatchHour":"0001-01-01T00:00:00.0000000","ForceDuplicate":false,"RequirePNRef":false,"IsTestMerchant":false,"ActivationStatus":"Pending","EnableFraud":false,"EnableOfflineBatch":false,"AllowHostedPage":false,"AllowEmulator":false,"LimitToDebit":false,"CollectLevel3":false,"CreationTimestamp":"0001-01-01T00:00:00.0000000","MerchantConfigurations":{"SecuritySettings":{"SaleLevel":"String","CreditLevel":"String","VoidLevel":"String","PreAuthLevel":"String","ForceAuthLevel":"String","AdjustLevel":"String","ActivateLevel":"String","DeactivateLevel":"String","InquireLevel":"String","RedeemLevel":"String","ReloadLevel":"String","RefundLevel":"String","ToolsLevel":"String","ReportsLevel":"String","CurrentBatchLevel":"String","BatchesLevel":"String","AdminLevel":"String","ChangeSecurityLevel":"String","SettleLevel":"String","RecurringBillingLevel":"String","PreferenceLevel":"String","FraudLevel":"String"},"AccessSettings":{"BinManagementApi":false,"DialIn":false,"Internet":false},"MerchantVirtualTerminalSettings":{"AllowForceCapture":false,"VirtualTerminalCreditAccess":false,"VirtualTerminalLevel3Amount":false,"VirtualTerminalConvenienceAmount":false,"VirtualTerminalConvenienceAmountPercentage":false,"VirtualTerminalConvenienceLabel":"String","virtualTerminalConvenienceAmountPercentageDefault":0,"VirtualTerminalDutyAmount":false,"VirtualTerminalTaxAmount":false,"VirtualTerminalTipAmount":false,"ImageCapture":false,"ReceiptCapture":false,"AutoSettleMerchantEmail":false,"InvoiceDuplicate":false,"VirtualTerminalCommercialCard":false,"VirtualTerminalShippingAmount":false,"VirtualTerminalAllowRepeat":false,"RequireInvoice":false,"RequireNameOnCard":false,"RequireLevelII":false,"VirtualTerminalRecurringBilling":false,"VirtualTerminalEmailReceipts":false,"VirtualTerminalPrintTwoReceipts":false,"VirtualTerminalInvNum":false,"VirtualTerminalPONum":false,"VirtualTerminalCustomerID":false,"VirtualTerminalCustomer":false,"VirtualTerminalStreet":false,"VirtualTerminalCity":false,"VirtualTerminalState":false,"VirtualTerminalZip":false,"VirtualTerminalPhone":false,"VirtualTerminalEmail":false,"VirtualTerminalAutoTaxAmount":0,"VirtualTerminalAutoCalcTax":false,"EnableFraud":false,"EnableOfflineBatch":false,"EnableHostedPage":false,"EnableEmulator":false,"LimitToDebit":false,"CollectLevel3":false,"AuthEdit":false,"IsMerchantBillingAccount":false,"ApplyLevel2DefaultsToApi":false,"RequireShipping":false,"RequireZipCode":false,"EnableGsaBinCheck":false,"ResellerOnlyCustomFieldsMenu":false,"ResellerOnlyHostedPaymentPageMenu":false,"ResellerOnlyOrderDataDefaultsMenu":false,"ResellerOnlyEmulatorMenu":false,"ResellerOnlyFraudControlSettingsMenu":false,"ResellerOnlyFraudControlHeldLogMenus":false,"CardVerification":{"AVAddNotVerifiable":false,"AVInvalidAddZip":false,"AVZipOnly":false,"AVNoMatch":false,"AVIssuerUnavail":false,"AVVerUnavail":false,"AVAddOnly":false,"AVNotRequested":false,"AVUnregCode":false,"AVServUnsupported":false,"AVExactMatch":false,"AVNoData":false,"AVAddNotVerifiableGlobal":false,"CVNotPresent":false,"CVNoData":false,"CVNotProcessed":false,"CVNoDataFromIssuer":false,"CVMatch":false,"CVUnregCode":false,"CVNoMatch":false}}},"ResellerParents":[{"ResellerKey":0,"ResellerName":"String","Level":0,"Parent":0,"Child":0}],"SelfLink":"/merchants/0","ResellerLink":"/resellers/0","DefaultUserLink":"/users/0","PrimaryContactLink":"/contacts/0","ProcessorProfilesLink":"/merchants/0/processor-profiles","BusinessInformationLink":"/merchants/0/business-informations","AddressInformationLink":"/merchants/0/addresses"}],"Pagination":{"CurrentPageNumber":0,"PageSize":0,"TotalRecordCount":0}}