PHP ActiveX Stripe: Update a charge

Back to Index

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

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

CURL Command

curl -X POST  https://api.stripe.com/v1/charges/ch_1BnETJGswQrCoh0XTs0EERBj \
   -u STRIPE_SECRET_KEY: \
   -d description="Charge for aiden.jones@example.com"

PHP ActiveX Example

<?php

$rest = new COM("Chilkat_9_5_0.Rest");

//  URL: https://api.stripe.com/v1/charges/ch_1BnETJGswQrCoh0XTs0EERBj
$bTls = 1;
$port = 443;
$bAutoReconnect = 1;
$success = $rest->Connect('api.stripe.com',$port,$bTls,$bAutoReconnect);
if ($success != 1) {
    print 'ConnectFailReason: ' . $rest->ConnectFailReason . "\n";
    print $rest->LastErrorText . "\n";
    exit;
}

$rest->SetAuthBasic('STRIPE_SECRET_KEY','');

$rest->AddQueryParam('description','Charge for aiden.jones@example.com');

$strResponseBody = $rest->fullRequestFormUrlEncoded('POST','/v1/charges/ch_1BnETJGswQrCoh0XTs0EERBj');
if ($rest->LastMethodSuccess != 1) {
    print $rest->LastErrorText . "\n";
    exit;
}

$jsonResponse = new COM("Chilkat_9_5_0.JsonObject");
$jsonResponse->Load($strResponseBody);

$id = $jsonResponse->stringOf('id');
$object = $jsonResponse->stringOf('object');
$amount = $jsonResponse->IntOf('amount');
$amount_refunded = $jsonResponse->IntOf('amount_refunded');
$application = $jsonResponse->IsNullOf('application');
$application_fee = $jsonResponse->IsNullOf('application_fee');
$balance_transaction = $jsonResponse->stringOf('balance_transaction');
$captured = $jsonResponse->BoolOf('captured');
$created = $jsonResponse->IntOf('created');
$currency = $jsonResponse->stringOf('currency');
$customer = $jsonResponse->IsNullOf('customer');
$description = $jsonResponse->stringOf('description');
$destination = $jsonResponse->IsNullOf('destination');
$dispute = $jsonResponse->IsNullOf('dispute');
$failure_code = $jsonResponse->IsNullOf('failure_code');
$failure_message = $jsonResponse->IsNullOf('failure_message');
$invoice = $jsonResponse->IsNullOf('invoice');
$livemode = $jsonResponse->BoolOf('livemode');
$on_behalf_of = $jsonResponse->IsNullOf('on_behalf_of');
$order = $jsonResponse->IsNullOf('order');
$outcome = $jsonResponse->IsNullOf('outcome');
$paid = $jsonResponse->BoolOf('paid');
$receipt_email = $jsonResponse->IsNullOf('receipt_email');
$receipt_number = $jsonResponse->IsNullOf('receipt_number');
$refunded = $jsonResponse->BoolOf('refunded');
$refundsObject = $jsonResponse->stringOf('refunds.object');
$refundsHas_more = $jsonResponse->BoolOf('refunds.has_more');
$refundsTotal_count = $jsonResponse->IntOf('refunds.total_count');
$refundsUrl = $jsonResponse->stringOf('refunds.url');
$review = $jsonResponse->IsNullOf('review');
$shipping = $jsonResponse->IsNullOf('shipping');
$sourceId = $jsonResponse->stringOf('source.id');
$sourceObject = $jsonResponse->stringOf('source.object');
$sourceAddress_city = $jsonResponse->IsNullOf('source.address_city');
$sourceAddress_country = $jsonResponse->IsNullOf('source.address_country');
$sourceAddress_line1 = $jsonResponse->IsNullOf('source.address_line1');
$sourceAddress_line1_check = $jsonResponse->IsNullOf('source.address_line1_check');
$sourceAddress_line2 = $jsonResponse->IsNullOf('source.address_line2');
$sourceAddress_state = $jsonResponse->IsNullOf('source.address_state');
$sourceAddress_zip = $jsonResponse->IsNullOf('source.address_zip');
$sourceAddress_zip_check = $jsonResponse->IsNullOf('source.address_zip_check');
$sourceBrand = $jsonResponse->stringOf('source.brand');
$sourceCountry = $jsonResponse->stringOf('source.country');
$sourceCustomer = $jsonResponse->IsNullOf('source.customer');
$sourceCvc_check = $jsonResponse->IsNullOf('source.cvc_check');
$sourceDynamic_last4 = $jsonResponse->IsNullOf('source.dynamic_last4');
$sourceExp_month = $jsonResponse->IntOf('source.exp_month');
$sourceExp_year = $jsonResponse->IntOf('source.exp_year');
$sourceFingerprint = $jsonResponse->stringOf('source.fingerprint');
$sourceFunding = $jsonResponse->stringOf('source.funding');
$sourceLast4 = $jsonResponse->stringOf('source.last4');
$sourceName = $jsonResponse->IsNullOf('source.name');
$sourceTokenization_method = $jsonResponse->IsNullOf('source.tokenization_method');
$source_transfer = $jsonResponse->IsNullOf('source_transfer');
$statement_descriptor = $jsonResponse->IsNullOf('statement_descriptor');
$status = $jsonResponse->stringOf('status');
$transfer_group = $jsonResponse->IsNullOf('transfer_group');
$i = 0;
$count_i = $jsonResponse->SizeOfArray('refunds.data');
while ($i < $count_i) {
    $jsonResponse->I = $i;
    $i = $i + 1;
}


?>

Sample JSON Response Body

{
  "id": "ch_1BnETJGswQrCoh0XTs0EERBj",
  "object": "charge",
  "amount": 100,
  "amount_refunded": 0,
  "application": null,
  "application_fee": null,
  "balance_transaction": "txn_1BnETJGswQrCoh0XxO2tGYr7",
  "captured": false,
  "created": 1516662781,
  "currency": "usd",
  "customer": null,
  "description": "Charge for aiden.jones@example.com",
  "destination": null,
  "dispute": null,
  "failure_code": null,
  "failure_message": null,
  "fraud_details": {},
  "invoice": null,
  "livemode": false,
  "metadata": {},
  "on_behalf_of": null,
  "order": null,
  "outcome": null,
  "paid": true,
  "receipt_email": null,
  "receipt_number": null,
  "refunded": false,
  "refunds": {
    "object": "list",
    "data": [
    ],
    "has_more": false,
    "total_count": 0,
    "url": "/v1/charges/ch_1BnETJGswQrCoh0XTs0EERBj/refunds"
  },
  "review": null,
  "shipping": null,
  "source": {
    "id": "card_18ropuGswQrCoh0XjCJ5Zvma",
    "object": "card",
    "address_city": null,
    "address_country": null,
    "address_line1": null,
    "address_line1_check": null,
    "address_line2": null,
    "address_state": null,
    "address_zip": null,
    "address_zip_check": null,
    "brand": "Visa",
    "country": "US",
    "customer": null,
    "cvc_check": null,
    "dynamic_last4": null,
    "exp_month": 8,
    "exp_year": 2017,
    "fingerprint": "F9mANtIt1TaukpRJ",
    "funding": "credit",
    "last4": "4242",
    "metadata": {},
    "name": null,
    "tokenization_method": null
  },
  "source_transfer": null,
  "statement_descriptor": null,
  "status": "succeeded",
  "transfer_group": null
}