List Payments

PHP examples use the PHP Client Library with SimpleXML

Description

object list_payments ( [ string $queryString = "" [, int $channel = 0 ]] ) 

Parameters

queryString

Search query string, see possible values in the table below

$channel

ID for a Channel (supplier) to list payments from

Example

// Set the Channel ID
// For Suppliers this can be found in the API settings page
// For Partners this can be a specific Channel or 0 to list from all
$channel = 3;

//QueryString: period
$qs= "from_date=2016-03-18&from_time=00:00:00&to_date=2018-03-21";

// Query the TourCMS API
$result = $tourcms->list_payments($qs, $channel);

// Loop through each Tour and print out the Tour ID
foreach($result->payments->payment as $payment) {
	print 'Booking id: ' . $payment->booking_id .' - ';
	print 'Payment type: ' . $payment->payment_type .'
';
}

Booking id: 10 - Payment type: cash
Booking id: 11 - Booking type: card

C# examples use the .Net Client Library

Code sample here soon

VB examples use the .Net Client Library

Code sample here soon

NodeJS examples use the NodeJS Wrapper

Example

TourCMS.listPayments({
  channelId: 3,
  qs: {
    from_date: "2018-03-23",
    to_date: "2018-03-26"
  },
  callback: function(response, status) {
    if (response.total_payments == 0)
      console.log("No payments made");
    else{
      //Loop through each component and output its component key
      response.payments.payment.forEach(function(payment) {
        console.log("Booking " + payment.booking_id + ": " + payment.payment_value + "(" + payment.payment_currency + ")");
      });
    }
  }
});
						

Booking 19280: 45.34(GBP)
Booking 19284: 4.67(GBP)
Booking 19286: 4.67(GBP)
Booking 19288: 4.67(GBP)
Booking 19288: 41.89(GBP)
Booking 19290: 4.67(GBP)
Booking 19324: 16.63(GBP)
Booking 19327: 16.63(GBP)

Looking for sample code in a different language? TourCMS and community provided API libraries