API - Planyo Web Services - list_cart_payments

You are here: Planyo » Help » API » list_cart_payments

list_cart_payments

Description:

List payments made for all reservations of a shopping cart. Note that in case of a shopping cart, payments are always assigned to specific reservations belonging to a shopping cart, even though the payment is made for all cart reservations.

Input:

cart_id int required
ID of the shopping cart whose payments will be listed.
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: amount, currency, payment_status, payment_time, payment_mode, transaction_id, reservation_id.
Please see add_reservation_payment for explanation of each field values.
coupons_used array
Array of coupons used by all reservations in this shopping cart (keys: amount, coupon_id, type, reservation_id). 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.
Planyo has a new Terms of Service and Privacy Policy, effective May 25, 2018. By using Planyo on or after this date you agree to the new conditions (the only change being GDPR compliance).