API - Planyo Web Services - list_reservation_payments

You are here: Planyo » Help » API » list_reservation_payments

list_reservation_payments

Description:

List payments made for a reservation, including coupon usage.

Input:

reservation_id int required

ID of the reservation whose payments will be listed.

method string required

must be set to list_reservation_payments

language string optional

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 string required

your API key - Click here to get your key. If your API key uses a hash key, you must also include the parameters hash_key and hash_timestamp.

Output:

results array

Array whose items are named arrays with the following keys: payment_id, amount, currency, payment_status, payment_time, payment_mode, transaction_id, extra_info.
Please see add_reservation_payment for explanation of each field values.

coupons_used array

Array of coupons used by this reservation (keys: amount, coupon_id, type). Type is one of: 1 = prepaid amount, 2 = N hours, 3 = N entries, 4 = valid for N days

API playground:

Click here to test this function in the API playground.