<back to all web services
GetProcessorConfigurations
Administration - Merchant Management
Requires Authentication
| Required role: | Reseller |
The following routes are available for this service:| GET | /merchants/{merchantKey}/processing-profiles | Get a list of processor profiles for the specified merchant. | |
|---|
GetProcessorConfigurations Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| MerchantKey | path | integer | Yes | Will return all of the processor profiles for the specified merchant (unless filtered by the optional parameters.). |
| ProcessorName | query | string | No | Will return all of the named processor profile's individual payment configurations. |
| PaymentConfigurationKey | query | integer | No | Will return a processor profile's specific payment configuration. |
| ProfileType | query | string | No | Allows retrieval of active or saved profiles. Will default to active profiles if not supplied.Allowable Values |
ProcessorConfiguration Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ProcessorName | model | string | No | The name of the payment processor for this this profile. |
| MerchantKey | model | integer | No | The merchant that owns the processor profiles listed. |
| PaymentConfigurations | model | array | No | A collection of payment configurations. |
PaymentConfiguration Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| PaymentMethodKey | model | integer | No | The unique identifier for this profile. |
| PaymentType | model | string | No | The payment type this configuration supports (i.e. 'EBT', 'VISA', etc.). |
| IsHostBased | model | boolean | No | Indicates if the processing profile supports host-based settlement. |
| IsHostBasedManualSettle | model | boolean | No | Indicates if the processing profile supports host-based manual settlement. |
| Settings | model | array | No | A collection of payment configurations for this profile. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
GET /merchants/{merchantKey}/processing-profiles HTTP/1.1
Host: syntch.simpay.net
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ProcessorConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.ProcessorConfigurations.Responses">
<MerchantKey>0</MerchantKey>
<PaymentConfigurations>
<PaymentConfiguration>
<IsHostBased>false</IsHostBased>
<IsHostBasedManualSettle>false</IsHostBasedManualSettle>
<PaymentMethodKey>0</PaymentMethodKey>
<PaymentType>String</PaymentType>
<Settings xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d4p1:KeyValuePairOfstringstring>
<d4p1:key>String</d4p1:key>
<d4p1:value>String</d4p1:value>
</d4p1:KeyValuePairOfstringstring>
</Settings>
</PaymentConfiguration>
</PaymentConfigurations>
<ProcessorName>String</ProcessorName>
</ProcessorConfiguration>