| 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 .csv suffix or ?format=csv
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: text/csv
Content-Type: text/csv
Content-Length: length
{"customerId":"00000000000000000000000000000000","id":"00000000000000000000000000000000","merchantId":"String","merchantKey":"String","merchantPin":"String","displayName":"String","testMode":0,"allowToken":false,"maxPaymentAmount":0,"minPaymentAmount":0,"billTypes":[{"id":"00000000000000000000000000000000","paymentGatewayId":"00000000000000000000000000000000","billTypeId":0,"applyConvenienceFee":false}],"applications":[{"id":"00000000000000000000000000000000","paymentGatewayId":"00000000000000000000000000000000","applicationId":"00000000000000000000000000000000","isActive":false,"primaryPaymentVenue":false}],"paymentTypes":[{"id":"00000000000000000000000000000000","paymentGatewayId":"00000000000000000000000000000000","paymentType":"String"}],"convenienceFees":[{"id":"00000000000000000000000000000000","paymentGatewayId":"00000000000000000000000000000000","paymentType":"String","minRange":0,"maxRange":0,"feeAmount":0,"applyAtPaymentOfBoot":false,"applyAtPaymentOfNotice":false,"applyAtPaymentOfTow":false,"totalPaymentAmount":0,"applyConvenienceFee":false}]}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length "00000000000000000000000000000000"