Tcl Stripe: List all Disputes

Back to Index

Returns a list of your disputes.

Documentation: https://stripe.com/docs/api/curl#list_disputes

CURL Command

curl https://api.stripe.com/v1/disputes?limit=3 \
   -u STRIPE_SECRET_KEY: \
   -G

Tcl Example

load ./chilkat.dll

set rest [new_CkRest]

#  URL: https://api.stripe.com/v1/disputes?limit=3
set bTls 1
set port 443
set bAutoReconnect 1
set success [CkRest_Connect $rest "api.stripe.com" $port $bTls $bAutoReconnect]
if {[expr $success != 1]} then {
    puts "ConnectFailReason: [CkRest_ConnectFailReason $rest]"
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    exit
}

CkRest_SetAuthBasic $rest "STRIPE_SECRET_KEY" ""

set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestNoBodySb $rest "GET" "/v1/disputes?limit=3" $sbResponseBody]
if {[expr $success != 1]} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jsonResponse [new_CkJsonObject]

CkJsonObject_LoadSb $jsonResponse $sbResponseBody

set object [CkJsonObject_stringOf $jsonResponse "object"]
set url [CkJsonObject_stringOf $jsonResponse "url"]
set has_more [CkJsonObject_BoolOf $jsonResponse "has_more"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jsonResponse "data"]
while {[expr $i < $count_i]} {
    CkJsonObject_put_I $jsonResponse $i
    set id [CkJsonObject_stringOf $jsonResponse "data[i].id"]
    set object [CkJsonObject_stringOf $jsonResponse "data[i].object"]
    set amount [CkJsonObject_IntOf $jsonResponse "data[i].amount"]
    set balance_transaction [CkJsonObject_stringOf $jsonResponse "data[i].balance_transaction"]
    set charge [CkJsonObject_stringOf $jsonResponse "data[i].charge"]
    set created [CkJsonObject_IntOf $jsonResponse "data[i].created"]
    set currency [CkJsonObject_stringOf $jsonResponse "data[i].currency"]
    set evidenceAccess_activity_log [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.access_activity_log"]
    set evidenceBilling_address [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.billing_address"]
    set evidenceCancellation_policy [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.cancellation_policy"]
    set evidenceCancellation_policy_disclosure [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.cancellation_policy_disclosure"]
    set evidenceCancellation_rebuttal [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.cancellation_rebuttal"]
    set evidenceCustomer_communication [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.customer_communication"]
    set evidenceCustomer_email_address [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.customer_email_address"]
    set evidenceCustomer_name [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.customer_name"]
    set evidenceCustomer_purchase_ip [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.customer_purchase_ip"]
    set evidenceCustomer_signature [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.customer_signature"]
    set evidenceDuplicate_charge_documentation [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.duplicate_charge_documentation"]
    set evidenceDuplicate_charge_explanation [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.duplicate_charge_explanation"]
    set evidenceDuplicate_charge_id [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.duplicate_charge_id"]
    set evidenceProduct_description [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.product_description"]
    set evidenceReceipt [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.receipt"]
    set evidenceRefund_policy [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.refund_policy"]
    set evidenceRefund_policy_disclosure [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.refund_policy_disclosure"]
    set evidenceRefund_refusal_explanation [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.refund_refusal_explanation"]
    set evidenceService_date [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.service_date"]
    set evidenceService_documentation [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.service_documentation"]
    set evidenceShipping_address [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.shipping_address"]
    set evidenceShipping_carrier [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.shipping_carrier"]
    set evidenceShipping_date [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.shipping_date"]
    set evidenceShipping_documentation [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.shipping_documentation"]
    set evidenceShipping_tracking_number [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.shipping_tracking_number"]
    set evidenceUncategorized_file [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.uncategorized_file"]
    set evidenceUncategorized_text [CkJsonObject_IsNullOf $jsonResponse "data[i].evidence.uncategorized_text"]
    set evidence_detailsDue_by [CkJsonObject_IntOf $jsonResponse "data[i].evidence_details.due_by"]
    set evidence_detailsHas_evidence [CkJsonObject_BoolOf $jsonResponse "data[i].evidence_details.has_evidence"]
    set evidence_detailsPast_due [CkJsonObject_BoolOf $jsonResponse "data[i].evidence_details.past_due"]
    set evidence_detailsSubmission_count [CkJsonObject_IntOf $jsonResponse "data[i].evidence_details.submission_count"]
    set is_charge_refundable [CkJsonObject_BoolOf $jsonResponse "data[i].is_charge_refundable"]
    set livemode [CkJsonObject_BoolOf $jsonResponse "data[i].livemode"]
    set reason [CkJsonObject_stringOf $jsonResponse "data[i].reason"]
    set status [CkJsonObject_stringOf $jsonResponse "data[i].status"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jsonResponse "data[i].balance_transactions"]
    while {[expr $j < $count_j]} {
        CkJsonObject_put_J $jsonResponse $j
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}

delete_CkRest $rest
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jsonResponse

Sample JSON Response Body

{
  "object": "list",
  "url": "/v1/disputes",
  "has_more": false,
  "data": [
    {
      "id": "dp_1BnETJGswQrCoh0Xefx4zP2a",
      "object": "dispute",
      "amount": 1000,
      "balance_transaction": "txn_1BnETJGswQrCoh0XPNBs9uW2",
      "balance_transactions": [
      ],
      "charge": "ch_1BnETJGswQrCoh0XlANDK278",
      "created": 1516662781,
      "currency": "usd",
      "evidence": {
        "access_activity_log": null,
        "billing_address": null,
        "cancellation_policy": null,
        "cancellation_policy_disclosure": null,
        "cancellation_rebuttal": null,
        "customer_communication": null,
        "customer_email_address": null,
        "customer_name": null,
        "customer_purchase_ip": null,
        "customer_signature": null,
        "duplicate_charge_documentation": null,
        "duplicate_charge_explanation": null,
        "duplicate_charge_id": null,
        "product_description": null,
        "receipt": null,
        "refund_policy": null,
        "refund_policy_disclosure": null,
        "refund_refusal_explanation": null,
        "service_date": null,
        "service_documentation": null,
        "shipping_address": null,
        "shipping_carrier": null,
        "shipping_date": null,
        "shipping_documentation": null,
        "shipping_tracking_number": null,
        "uncategorized_file": null,
        "uncategorized_text": null
      },
      "evidence_details": {
        "due_by": 1518307199,
        "has_evidence": false,
        "past_due": false,
        "submission_count": 0
      },
      "is_charge_refundable": false,
      "livemode": false,
      "metadata": {},
      "reason": "general",
      "status": "needs_response"
    }
  ]
}