Payment Method
Base URL: https://api.covasoft.net/paymentmethods
Endpoints
| Endpoint | Description |
|---|---|
GET v1/Companies({CompanyId})/MappedPayments | Returns All the Payment Methods for a Company |
GET v1/Companies({CompanyId})/MappedPayments
Returns All the Payment Methods for a Company
Base URL:
https://api.covasoft.net/paymentmethods
Example of a call would be:
https://api.covasoft.net/paymentmethods/v1/Companies({CompanyId})/MappedPayments?$filter=EntityId eq {LocationId} & $skip=0 & $top=100
Odata Filters
Optional: filter=EntityId eq {LocationId}
The LocationId can be used to narrow down Payment Methods only to a specific Location
Normal Odata pagings with $top & $skip
Max $top is 100 records
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyId | The unique Company Id that was provided in your onboarding pacakage | integer | Required |
Body Parameters
None.
Response Information
Resource Description
All the Payment Methods for a Company
Collection of MappedPaymentsByCompanyReturn
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer | None. | |
| CompanyId | integer | None. | |
| EntityId | integer | None. | |
| CustomName | string | None. | |
| Enabled | boolean | None. | |
| PaymentAssociationGroupId | integer | None. | |
| PaymentMethodId | integer | None. | |
| PaymentMethod | PaymentMethod | None. | |
| EnableRounding | boolean | None. | |
| MaxPositiveTransaction | decimal number | None. | |
| MaxNegativeTransaction | decimal number | None. | |
| CanOverpay | boolean | None. |
Response Formats
application/json, text/json
[
{
"Id": 1,
"CompanyId": 2,
"EntityId": 1,
"CustomName": "sample string 3",
"Enabled": true,
"PaymentAssociationGroupId": 5,
"PaymentMethodId": 6,
"PaymentMethod": {
"Id": 1,
"PaymentName": "sample string 2",
"IsPrivate": true,
"PaymentMethodType": "sample string 4",
"DefaultCanOverpay": true
},
"EnableRounding": true,
"MaxPositiveTransaction": 1.1,
"MaxNegativeTransaction": 1.1,
"CanOverpay": true
},
{
"Id": 1,
"CompanyId": 2,
"EntityId": 1,
"CustomName": "sample string 3",
"Enabled": true,
"PaymentAssociationGroupId": 5,
"PaymentMethodId": 6,
"PaymentMethod": {
"Id": 1,
"PaymentName": "sample string 2",
"IsPrivate": true,
"PaymentMethodType": "sample string 4",
"DefaultCanOverpay": true
},
"EnableRounding": true,
"MaxPositiveTransaction": 1.1,
"MaxNegativeTransaction": 1.1,
"CanOverpay": true
}
]