GET v1/Payments?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Payments

Request Information

URI Parameters

Name	Description	Type	Additional information
fields	A comma-separated list of field names	string	None.
where	A where clause	string	None.
order	An order by clause	string	None.
page	The page number (default: 1)	integer	Default value is 1
rows	Rows per page (default: 50, maximum: 250)	integer	Default value is 50

Body Parameters

None.

Response Information

Resource Description

Collection of Payment

Name	Description	Type	Additional information
Id	The unique Cin7 payment Id.	integer	None.
CreatedDate	Created Date UTC: yyyy-MM-dd HH:mm:ss	date	None.
ModifiedDate	Modified Date UTC: yyyy-MM-dd HH:mm:ss	date	None.
PaymentDate	Payment Date UTC: yyyy-MM-dd HH:mm:ss	date	None.
Amount	Payment Amount	decimal number	None.
Method	Payment Method	string	None.
IsAuthorized	Transaction Authorized	boolean	None.
TransactionRef	Transaction reference e.g. payment gateway transaction Id or ref	string	Max length: 50
Comments	Comments	string	Max length: 250
OrderId	The unique Cin7 sales order or purchase order Id.	integer	None.
OrderRef	A unique sales order or purchase order reference. (Read-only)	string	Max length: 30
PaymentImportedRef	Payment imported ref	string	None.
BatchReference	Batch Reference (Read-only)	string	None.
ReconcileDate	Reconcile date	date	None.
BranchId	Branch Id.	integer	None.
OrderType	Order Type.	OrderType	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "createdDate": "2025-01-14T20:53:07.6326293Z",
    "modifiedDate": null,
    "paymentDate": "2025-01-14T20:53:07.6326293Z",
    "amount": 196.1,
    "method": "Credit Card",
    "isAuthorized": true,
    "transactionRef": "PAYMENT-GATEWAY-REF",
    "comments": "Comment...",
    "orderId": 128,
    "orderRef": "SALE4-28",
    "paymentImportedRef": "INTEGRATION-REF",
    "batchReference": null,
    "reconcileDate": "2025-01-16T09:53:07.6326293+13:00",
    "branchId": 0,
    "orderType": "Undefined"
  }
]