Get a List of Payments

Returns list of payments by status.

This service returns a list of payments that have been made against BigChange invoices within a given date range for a given status. Where the payment syncstatus is set to 1, the routine changes the status of the payment to 2 ("sending") for a short period. This process enables users to process the payment and update the status using the web service PaymentSetStatusByID. Where the payment status is not updated, the syncStatus is changed back to 1.

Query String Parameters

Name	Type	Description	Required
Action	String	Payments	Required
SyncStatus	Int	The status of the transaction.	Required
Start	String	The start date of the payments to be retrieved	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
V2	Int	Adds the option to return additional parameters that are used as part of financial integrations. Returns the parents account contact reference. Location in CRM=>Financial=>Terms.	Optional

Response Codes

Example

Request

Request URL

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

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"
    }
  ]
}