fonzip_ecards
Manage donation e-cards and their transactions: create, update, and delete card categories; list, retrieve, and delete e-card sales with filters for date, payment, status, and delivery.
Instructions
E-kartlar: kart ve kart kategorisi yonetimi, e-kart satis islemlerini listeleme, detay ve silme.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| list | No | [list_transactions] *(paid only)* Selects the optional fields returned for each transaction. Repeat the parameter to request several fields, e.g. `?list=ecard&list=amount&list=category`. Every response always contains this base set, whatever `list` holds: `id`, `user_id`, `first_name`, `last_name`, `email`, `phone`, `certificate_id`, `ce… | |
| name | No | [create_category, update_category] Donation/E-Card Category name | |
| query | No | [list, list_categories, list_transactions] search parameter. start with - (minus) char to exclude searched text | |
| action | Yes | Yapilacak islem. Her action'in kendi zorunlu alanlari vardir; asagidaki aciklamalarda hangi alanin hangi action'a ait oldugu koseli parantez icinde belirtilir. | |
| amount | No | [list_transactions] payment/debt amount | |
| status | No | [list_transactions] E-Card Transaction status. Defaults to `paid` when omitted. Any other value is rejected with HTTP 400. - paid: successful E-Card transactions - refund: refunded E-Card transactions - failed: failed E-Card transactions | paid |
| amt_cnd | No | [list_transactions] amount condition if amount filter is present - null: equals to amount - !=: not equals to amount - <: smaller than amount - <=: smaller and equal to amount - \>: bigger than amount - \>=: bigger and equal to amount | |
| listing | No | [list] E-Card available for sale in E-Card page - 0: private - 1: available - 2: available only via url | |
| sale_id | No | [delete_transaction, get_transaction] Zorunlu: delete_transaction, get_transaction. | |
| ecard_id | No | [get, list_transactions] Zorunlu: get. | |
| end_date | No | [list_transactions] Zorunlu: list_transactions. End date filtering for transaction__complete_date or complete_date fields. Must be after start_date. | |
| how_many | No | [list, list_categories, list_transactions] How many records should be listed | |
| order_by | No | [list_transactions] Ordering. Any field of the `CertificateSale` model (or a `transaction__` / `certificate__` related field) is accepted; an unknown field is rejected with HTTP 400. Rows are always tie-broken by `id`. The default depends on `status`: `-transaction__refund_date` for `refund`, `-transaction__complete_date` for `paid` and… | -transaction__complete_date |
| bill_type | No | [list_transactions] *(paid only)* filter on the requested billing information type - 0: no bill - 1: personal - 2: corporate | |
| card_type | No | [list_transactions] *(paid only)* filter card payments on card type. Any other value is rejected with HTTP 400. - 1: credit - 2: debit - 3: prepaid - 4: unknown (BIN not recognised) | |
| last_four | No | [list_transactions] card last four digits | |
| bin_number | No | [list_transactions] card BIN number | |
| start_date | No | [list_transactions] Zorunlu: list_transactions. Start date filtering for transaction__complete_date or complete_date fields. Must be before end_date. | |
| start_page | No | [list, list_categories, list_transactions] start page of records | |
| utm_medium | No | [list_transactions] *(paid only)* Filter e-card transactions by one or more `utm_medium` values (IN-list). | |
| utm_source | No | [list_transactions] *(paid only)* Filter e-card transactions whose marketing channel `utm_source` matches one of the supplied values (IN-list). Repeat the parameter to supply multiple values, e.g. `?utm_source=google&utm_source=bing`. | |
| category_id | No | [delete_category, list, update_category] Zorunlu: delete_category, update_category. | |
| currency_id | No | [list_transactions] *(paid only)* filter transactions on currency id | |
| utm_content | No | [list_transactions] *(paid only)* Filter e-card transactions by one or more `utm_content` values (IN-list). | |
| card_country | No | [list_transactions] *(paid only)* filter card payments on the issuing bank's country, relative to the association's own country. Any other value is rejected with HTTP 400. - 1: local (issued in the association's country) - 2: abroad - 3: unknown (BIN not recognised) | |
| cargo_status | No | [list_transactions] *(paid only)* filter based on cargo status - null: all - 0: will not be sent - 1: waiting to be prepared - 2: waiting for cargo info - 3: posted - 4: waiting to be prepared **or** waiting for cargo info (1 and 2 combined) | |
| utm_campaign | No | [list_transactions] *(paid only)* Filter e-card transactions by one or more `utm_campaign` values (IN-list). | |
| delivery_date | No | [list_transactions] *(paid only)* Return only transactions scheduled for future delivery (`delivery_time_mode` 1 or 2) whose delivery date - either on the transaction itself or on one of its recipients - equals this date. Sent as a date-time; it is converted to the association timezone and compared as a date. | |
| payment_method | No | [list_transactions] payment type code - null: All - 0: Card - 1: Cash - 2: Wire Transfer - 3: POS - 4: SMS - 6: Postal Check - 7: Paypal - 8: BKM Express - 9: iDEAL - 10: Pay With Iyzico | |
| bank_account_id | No | [list_transactions] *(paid only)* bank account id | |
| payment_settings_id | No | [list_transactions] *(paid only)* payment settings id | |
| marketing_channel_null | No | [list_transactions] *(paid only)* When true, return only e-card transactions with no marketing channel attached (organic / direct traffic). Mutually exclusive with the four UTM filters above — when set, those are ignored. |