Get Collection of Payments
This action returns a collection of payments with statuses if desired.
Table - Get Collection of Payments
Resource Template |
|
Http Method | GET |
Description |
Returns a collection of payment representations. To request payment statuses, 'ids' parameter should be submitted with comma separated payments' id values. To request payments only in a specific status, a ' status' parameter should be submitted with valid payment status. If a payment is in ' NotAccepted' status, an 'errorCode' field will indicate the reason. To limit returned payment representations to only desired fields, the ' fields' parameter should be used, with comma separated list of fields to return. ' id' field will always be returned. To sort output by a specific field, 'sortBy' parameter can be used (default is by CreatedOn timestamp with descending order). Supported fields to be used with 'sortBy' are 'CreatedOn', 'LastUpdatedOn', 'Id'. Returned list is limited to 1000 payments with applied default or specified sorting. |
Input |
|
Output |
|
Output (errors) |
|
|