API Playground - list_payments

list_payments


List payments made for your reservations. You can specify a number of parameters to filter the results. (click for full documentation)

start_date

The returned payments will be limited to those which were made between the spacified start and end date. For example, for the values start_date=2016-08-01&end_date=2016-08-31 the results will be limited to the payments made in August 2016.

end_date

End date limiting the time span for the returned payment. For example, 2016-08-31. See start_date above.

resource_id

If you specify resource ID, only payments made for reservations made for this resource will be listed.

site_id

If using a metasite api key, setting site_id and not specifying any resource_id will list all payments for this site. If you specified a resource_id you may leave this parameter empty.

payment_mode_id_filter

Optionally you can filter the results by a single payment mode ID

status

By using this filter you can limit the results to payments with the given status. The allowed values are '1' for paid/successful payment, '2' for pending, '3' for errors and '4' for refunds.

language

by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned

api_key

your API key - Click here to get your key
* - påkrevd felt