PUT | /customers/{customerId}/paymentgateways/{id} | Updates an existing payment gateway. Fails if the payment gateway doesn't exist. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerId | path | Guid | Yes | The customer Id. |
Id | path | Guid | Yes | The payment gateway Id. |
MerchantId | body | string | No | The merchant id for this customer payment gateway. |
MerchantKey | body | string | No | The merchant key for this customer payment gateway. |
MerchantPin | body | string | No | The merchant pin for this customer payment gateway. |
DisplayName | body | string | Yes | The display name for this customer payment gateway. |
TestMode | body | int | No | Whether or not this payment gateway is in test mode. |
AllowToken | body | bool | No | Whether or not this payment gateway should allow token. |
MaxPaymentAmount | body | decimal | No | The maximum payment amount for this payment gateway. |
MinPaymentAmount | body | decimal | No | The minimum payment amount for this payment gateway. |
BillTypes | body | List<PaymentGatewayBillType> | No | A list of bill types associated with this payment gateway. |
Applications | body | List<Application> | No | A list of applications associated with this payment gateway. |
PaymentTypes | body | List<PaymentGatewayPaymentType> | No | A list of payment types associated with this payment gateway. |
ConvenienceFees | body | List<ConvenienceFee> | No | A list of convenience fees associated with this payment gateway. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No | |
PaymentGatewayId | form | Guid? | No | |
BillTypeId | form | int | No | |
ApplyConvenienceFee | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No | |
PaymentGatewayId | form | Guid? | No | |
ApplicationId | form | Guid | No | |
IsActive | form | bool | No | |
PrimaryPaymentVenue | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No | |
PaymentGatewayId | form | Guid? | No | |
PaymentType | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No | |
PaymentGatewayId | form | Guid? | No | |
PaymentType | form | string | No | |
MinRange | form | decimal? | No | |
MaxRange | form | decimal? | No | |
FeeAmount | form | decimal? | No | |
ApplyAtPaymentOfBoot | form | bool? | No | |
ApplyAtPaymentOfNotice | form | bool? | No | |
ApplyAtPaymentOfTow | form | bool? | No | |
TotalPaymentAmount | form | decimal? | No | |
ApplyConvenienceFee | form | bool? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /customers/{customerId}/paymentgateways/{id} HTTP/1.1
Host: api.paylock.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateCustomerPaymentGateway xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
<AllowToken>false</AllowToken>
<Applications>
<PaymentGatewayApplication>
<ApplicationId>00000000-0000-0000-0000-000000000000</ApplicationId>
<Id>00000000-0000-0000-0000-000000000000</Id>
<IsActive>false</IsActive>
<PaymentGatewayId>00000000-0000-0000-0000-000000000000</PaymentGatewayId>
<PrimaryPaymentVenue>false</PrimaryPaymentVenue>
</PaymentGatewayApplication>
</Applications>
<BillTypes>
<PaymentGatewayBillType>
<ApplyConvenienceFee>false</ApplyConvenienceFee>
<BillTypeId>0</BillTypeId>
<Id>00000000-0000-0000-0000-000000000000</Id>
<PaymentGatewayId>00000000-0000-0000-0000-000000000000</PaymentGatewayId>
</PaymentGatewayBillType>
</BillTypes>
<ConvenienceFees>
<ConvenienceFee>
<ApplyAtPaymentOfBoot>false</ApplyAtPaymentOfBoot>
<ApplyAtPaymentOfNotice>false</ApplyAtPaymentOfNotice>
<ApplyAtPaymentOfTow>false</ApplyAtPaymentOfTow>
<ApplyConvenienceFee>false</ApplyConvenienceFee>
<FeeAmount>0</FeeAmount>
<Id>00000000-0000-0000-0000-000000000000</Id>
<MaxRange>0</MaxRange>
<MinRange>0</MinRange>
<PaymentGatewayId>00000000-0000-0000-0000-000000000000</PaymentGatewayId>
<PaymentType>String</PaymentType>
<TotalPaymentAmount>0</TotalPaymentAmount>
</ConvenienceFee>
</ConvenienceFees>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<DisplayName>String</DisplayName>
<Id>00000000-0000-0000-0000-000000000000</Id>
<MaxPaymentAmount>0</MaxPaymentAmount>
<MerchantId>String</MerchantId>
<MerchantKey>String</MerchantKey>
<MerchantPin>String</MerchantPin>
<MinPaymentAmount>0</MinPaymentAmount>
<PaymentTypes>
<PaymentGatewayPaymentType>
<Id>00000000-0000-0000-0000-000000000000</Id>
<PaymentGatewayId>00000000-0000-0000-0000-000000000000</PaymentGatewayId>
<PaymentType>String</PaymentType>
</PaymentGatewayPaymentType>
</PaymentTypes>
<TestMode>0</TestMode>
</UpdateCustomerPaymentGateway>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">00000000-0000-0000-0000-000000000000</guid>