| GET | /payments/gateways | Gets a collection attempt's available payment gateways |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IsRefund | body | bool | Yes | Whether or not we are dealing with a refund |
| PaymentMethod | body | string | Yes | The Payment Method |
| CollectionAttemptId | body | Guid | Yes | The Collection Attempt Id. |
| PaymentId | body | Guid | No | The payment id if exists Attempt Id. |
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.
GET /payments/gateways HTTP/1.1 Host: api.paylock.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ArrayOfPaymentGatewayforCid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
<PaymentGatewayforCid>
<AcceptedPaymentTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<ApplyConvenienceFee>false</ApplyConvenienceFee>
<ConvenienceFee>0</ConvenienceFee>
<DefaultDisplay>false</DefaultDisplay>
<GatewayName>String</GatewayName>
<GatewayNameWithAmount>String</GatewayNameWithAmount>
<MaxPaymentAmount>0</MaxPaymentAmount>
<MinPaymentAmount>0</MinPaymentAmount>
<NetDue>0</NetDue>
<TotalDue>0</TotalDue>
<TotalPaid>0</TotalPaid>
<TotalPaymentAmount>0</TotalPaymentAmount>
</PaymentGatewayforCid>
</ArrayOfPaymentGatewayforCid>