PHP ActiveX Stripe: Retrieve a Payout

Back to Index

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.

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

CURL Command

curl https://api.stripe.com/v1/payouts/po_1BnETKGswQrCoh0XeUopRyDR \
   -u STRIPE_SECRET_KEY:

PHP ActiveX Example

<?php

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

//  URL: https://api.stripe.com/v1/payouts/po_1BnETKGswQrCoh0XeUopRyDR
$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','');

$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$success = $rest->FullRequestNoBodySb('GET','/v1/payouts/po_1BnETKGswQrCoh0XeUopRyDR',$sbResponseBody);
if ($success != 1) {
    print $rest->LastErrorText . "\n";
    exit;
}

$jsonResponse = new COM("Chilkat_9_5_0.JsonObject");
$jsonResponse->LoadSb($sbResponseBody);

$id = $jsonResponse->stringOf('id');
$object = $jsonResponse->stringOf('object');
$amount = $jsonResponse->IntOf('amount');
$arrival_date = $jsonResponse->IntOf('arrival_date');
$automatic = $jsonResponse->BoolOf('automatic');
$balance_transaction = $jsonResponse->stringOf('balance_transaction');
$created = $jsonResponse->IntOf('created');
$currency = $jsonResponse->stringOf('currency');
$description = $jsonResponse->stringOf('description');
$destination = $jsonResponse->stringOf('destination');
$failure_balance_transaction = $jsonResponse->IsNullOf('failure_balance_transaction');
$failure_code = $jsonResponse->IsNullOf('failure_code');
$failure_message = $jsonResponse->IsNullOf('failure_message');
$livemode = $jsonResponse->BoolOf('livemode');
$method = $jsonResponse->stringOf('method');
$source_type = $jsonResponse->stringOf('source_type');
$statement_descriptor = $jsonResponse->IsNullOf('statement_descriptor');
$status = $jsonResponse->stringOf('status');
$type = $jsonResponse->stringOf('type');

?>

Sample JSON Response Body

{
  "id": "po_1BnETKGswQrCoh0XeUopRyDR",
  "object": "payout",
  "amount": 1100,
  "arrival_date": 1516662782,
  "automatic": true,
  "balance_transaction": "txn_1BnETKGswQrCoh0X762wrMpF",
  "created": 1516662782,
  "currency": "usd",
  "description": "STRIPE TRANSFER",
  "destination": "ba_1BnETKGswQrCoh0XO5G2kEG5",
  "failure_balance_transaction": null,
  "failure_code": null,
  "failure_message": null,
  "livemode": false,
  "metadata": {},
  "method": "standard",
  "source_type": "card",
  "statement_descriptor": null,
  "status": "in_transit",
  "type": "bank_account"
}