PUT v1/Gateways

Request Information

URI Parameters

None.

Body Parameters

Common.Dto.Put.Gateway
NameDescriptionTypeAdditional information
AccountConfigurationId

integer

None.

ProcessorId

integer

None.

IsCreditCardDefault

boolean

None.

IsAchDefault

boolean

None.

AccountConfigurationName

string

String length: inclusive between 0 and 255

SerializedConfiguration

string

None.

ExpiryRetry

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "AccountConfigurationId": 1,
  "ProcessorId": 2,
  "IsCreditCardDefault": true,
  "IsAchDefault": true,
  "AccountConfigurationName": "sample string 5",
  "SerializedConfiguration": "sample string 6",
  "ExpiryRetry": true
}

Response Information

Resource Description

Common.Dto.Get.Gateway
NameDescriptionTypeAdditional information
AccountConfigurationId

integer

None.

ProcessorId

integer

None.

AccountConfigurationName

string

None.

SerializedConfiguration

string

None.

Deleted

date

None.

IsCreditCardDefault

boolean

None.

IsAchDefault

boolean

None.

NumberOfRoutes

integer

None.

Processor

Common.Dto.Get.Processor

None.

IsSurcharging

boolean

None.

SurchargingPolicy

string

None.

ExpiryRetry

boolean

None.

DateCreated

date

None.

DateModified

date

None.

Count

integer

None.

id

integer

None.

uri

string

None.

Response Formats

application/json, text/json

Sample:
{
  "AccountConfigurationId": 1,
  "ProcessorId": 2,
  "AccountConfigurationName": "sample string 3",
  "SerializedConfiguration": "sample string 4",
  "Deleted": "2025-05-21T08:14:37.9692901+00:00",
  "IsCreditCardDefault": true,
  "IsAchDefault": true,
  "NumberOfRoutes": 7,
  "Processor": {
    "IsAch": true,
    "IsCreditCard": true,
    "IsPaypal": true,
    "ProcessorName": "sample string 4",
    "LabelName": "sample string 5"
  },
  "IsSurcharging": true,
  "SurchargingPolicy": "sample string 9",
  "ExpiryRetry": true,
  "DateCreated": "2025-05-21T08:14:37.9692901+00:00",
  "DateModified": "2025-05-21T08:14:37.9692901+00:00",
  "Count": 1,
  "id": 12,
  "uri": "sample string 13"
}