API - Planyo Web Services - list_coupon_payments

You are here: Planyo » Help » API » list_coupon_payments

list_coupon_payments

Description:

Lists coupon payments. See blow for the parameters to filter the results.

Input:

start_date DateTime optional
Allows you to limit returned payments to those made after the specified date. For example, for start_date=2020-08-01 the results will be limited to the payments made after August 2020.
Together with end_date you can limit results to a certain period, e.g. start_date=2020-08-01&end_date=2020-08-31. When empty, no limit will be applied.
end_date DateTime optional
Allows you to limit returned payment to those made before the specified date. When empty, no limit will be applied.
coupon_type_id int optional
When passed, payments made only for this coupon type will be returned. See list_coupon_types
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:

count int
Number of payments returned in the results array below.
results array
Array whose items are named arrays with the following keys:
payment_id int
Unique identifier for the payment in our system.
email string
The email address for which the coupon was purchased.
coupon_type_id int
ID of the coupon type being purchased. See list_coupon_types.
payment_mode_id int
The method used to make the payment. See list_payments for the possible values.
payment_mode string
Name of the payment method.
payment_amount float
Amount of the payment.
payment_currency string
Currency used.
payment_date DateTime
Date and time when the payment was made.
custom_id string
(optional) ID of the payment in the payment gateway
type int
The type of the purchased coupon. See list_coupons for the possible values.
amount float
The purchased coupon's amount. Depending on the coupon type, this can be: prepaid amount, number of hours, number of entries or number of days.
discount_amount float
For the Discount valid for given number of days type, this is the discount value in percent. Value between 0 and 100 is expected.
is_gift_certificate bool
True when the purchase was made as a gift certificate.
holder_name string
Name of the coupon holder as entered by the client.
buyer_info string
Additional information about the coupon buyer as entered by the client.

API playground:

Click here to test this function in the API playground.