| 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 .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
[
{
gatewayName: String,
gatewayNameWithAmount: String,
applyConvenienceFee: False,
totalPaymentAmount: 0,
convenienceFee: 0,
maxPaymentAmount: 0,
minPaymentAmount: 0,
defaultDisplay: False,
netDue: 0,
totalDue: 0,
totalPaid: 0
}
]