PureBasic Stripe: Retrieve a Dispute

Back to Index

Retrieves the dispute with the given ID.

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

CURL Command

curl https://api.stripe.com/v1/disputes/dp_1BnETJGswQrCoh0Xefx4zP2a \
   -u STRIPE_SECRET_KEY:

PureBasic Example

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ;  URL: https://api.stripe.com/v1/disputes/dp_1BnETJGswQrCoh0Xefx4zP2a
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"api.stripe.com",port,bTls,bAutoReconnect)
    If success <> 1
        Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    CkRest::ckSetAuthBasic(rest,"STRIPE_SECRET_KEY","")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkRest::ckFullRequestNoBodySb(rest,"GET","/v1/disputes/dp_1BnETJGswQrCoh0Xefx4zP2a",sbResponseBody)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jsonResponse.i = CkJsonObject::ckCreate()
    If jsonResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jsonResponse,sbResponseBody)

    id.s
    object.s
    amount.i
    balance_transaction.s
    charge.s
    created.i
    currency.s
    evidenceAccess_activity_log.i
    evidenceBilling_address.i
    evidenceCancellation_policy.i
    evidenceCancellation_policy_disclosure.i
    evidenceCancellation_rebuttal.i
    evidenceCustomer_communication.i
    evidenceCustomer_email_address.i
    evidenceCustomer_name.i
    evidenceCustomer_purchase_ip.i
    evidenceCustomer_signature.i
    evidenceDuplicate_charge_documentation.i
    evidenceDuplicate_charge_explanation.i
    evidenceDuplicate_charge_id.i
    evidenceProduct_description.i
    evidenceReceipt.i
    evidenceRefund_policy.i
    evidenceRefund_policy_disclosure.i
    evidenceRefund_refusal_explanation.i
    evidenceService_date.i
    evidenceService_documentation.i
    evidenceShipping_address.i
    evidenceShipping_carrier.i
    evidenceShipping_date.i
    evidenceShipping_documentation.i
    evidenceShipping_tracking_number.i
    evidenceUncategorized_file.i
    evidenceUncategorized_text.i
    evidence_detailsDue_by.i
    evidence_detailsHas_evidence.i
    evidence_detailsPast_due.i
    evidence_detailsSubmission_count.i
    is_charge_refundable.i
    livemode.i
    reason.s
    status.s
    i.i
    count_i.i

    id = CkJsonObject::ckStringOf(jsonResponse,"id")
    object = CkJsonObject::ckStringOf(jsonResponse,"object")
    amount = CkJsonObject::ckIntOf(jsonResponse,"amount")
    balance_transaction = CkJsonObject::ckStringOf(jsonResponse,"balance_transaction")
    charge = CkJsonObject::ckStringOf(jsonResponse,"charge")
    created = CkJsonObject::ckIntOf(jsonResponse,"created")
    currency = CkJsonObject::ckStringOf(jsonResponse,"currency")
    evidenceAccess_activity_log = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.access_activity_log")
    evidenceBilling_address = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.billing_address")
    evidenceCancellation_policy = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.cancellation_policy")
    evidenceCancellation_policy_disclosure = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.cancellation_policy_disclosure")
    evidenceCancellation_rebuttal = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.cancellation_rebuttal")
    evidenceCustomer_communication = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.customer_communication")
    evidenceCustomer_email_address = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.customer_email_address")
    evidenceCustomer_name = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.customer_name")
    evidenceCustomer_purchase_ip = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.customer_purchase_ip")
    evidenceCustomer_signature = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.customer_signature")
    evidenceDuplicate_charge_documentation = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.duplicate_charge_documentation")
    evidenceDuplicate_charge_explanation = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.duplicate_charge_explanation")
    evidenceDuplicate_charge_id = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.duplicate_charge_id")
    evidenceProduct_description = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.product_description")
    evidenceReceipt = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.receipt")
    evidenceRefund_policy = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.refund_policy")
    evidenceRefund_policy_disclosure = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.refund_policy_disclosure")
    evidenceRefund_refusal_explanation = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.refund_refusal_explanation")
    evidenceService_date = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.service_date")
    evidenceService_documentation = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.service_documentation")
    evidenceShipping_address = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.shipping_address")
    evidenceShipping_carrier = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.shipping_carrier")
    evidenceShipping_date = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.shipping_date")
    evidenceShipping_documentation = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.shipping_documentation")
    evidenceShipping_tracking_number = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.shipping_tracking_number")
    evidenceUncategorized_file = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.uncategorized_file")
    evidenceUncategorized_text = CkJsonObject::ckIsNullOf(jsonResponse,"evidence.uncategorized_text")
    evidence_detailsDue_by = CkJsonObject::ckIntOf(jsonResponse,"evidence_details.due_by")
    evidence_detailsHas_evidence = CkJsonObject::ckBoolOf(jsonResponse,"evidence_details.has_evidence")
    evidence_detailsPast_due = CkJsonObject::ckBoolOf(jsonResponse,"evidence_details.past_due")
    evidence_detailsSubmission_count = CkJsonObject::ckIntOf(jsonResponse,"evidence_details.submission_count")
    is_charge_refundable = CkJsonObject::ckBoolOf(jsonResponse,"is_charge_refundable")
    livemode = CkJsonObject::ckBoolOf(jsonResponse,"livemode")
    reason = CkJsonObject::ckStringOf(jsonResponse,"reason")
    status = CkJsonObject::ckStringOf(jsonResponse,"status")
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jsonResponse,"balance_transactions")
    While i < count_i
        CkJsonObject::setCkI(jsonResponse, i)
        i = i + 1
    Wend


    CkRest::ckDispose(rest)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jsonResponse)


    ProcedureReturn
EndProcedure

Sample JSON Response Body

{
  "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"
}