| Required role: | Reseller |
| GET | /merchants/{merchantKey}/processing-profiles | Get a list of processor profiles for the specified merchant. |
|---|
| 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
|
| 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. |
| 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 .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ProcessorName: String,
MerchantKey: 0,
PaymentConfigurations:
[
{
PaymentMethodKey: 0,
PaymentType: String,
IsHostBased: False,
IsHostBasedManualSettle: False,
Settings:
[
{
Key: String,
Value: String
}
]
}
]
}