Get a List of Payments

This service returns a list of BigChange payments within on a given date range. An optional parameter can be used to pass the SyncStatus so a user can list payments by a specific status.

Query String Parameters

Name	Type	Description	Required
Action	String	PaymentsList	Required
Start	String	The start date of the payments to retrieve.	Required
End	String	The end date of the payments to be retrieved. If not specified, the payment date defaults to the current day at 23:59:59.	Optional
SyncStatus	Int	The status of the transaction.	Optional

Response Codes

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=paymentslist

Response

Response Data

{
  "Code": 0,
  "Result": [
    {
      "JourneyId": "12345",
      "StartTime": "2024-08-18T08:00:00Z",
      "EndTime": "2024-08-18T10:00:00Z",
      "StartLocation": "Location A",
      "EndLocation": "Location B",
      "Distance": 25.6,
      "Unit": "kilometers"
    }
  ]
}