PHP ActiveX Stripe: List all Payouts

Back to Index

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

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

CURL Command

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

PHP ActiveX Example

<?php

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

//  URL: https://api.stripe.com/v1/payouts?limit=3
$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?limit=3',$sbResponseBody);
if ($success != 1) {
    print $rest->LastErrorText . "\n";
    exit;
}

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

$object = $jsonResponse->stringOf('object');
$url = $jsonResponse->stringOf('url');
$has_more = $jsonResponse->BoolOf('has_more');
$i = 0;
$count_i = $jsonResponse->SizeOfArray('data');
while ($i < $count_i) {
    $jsonResponse->I = $i;
    $id = $jsonResponse->stringOf('data[i].id');
    $object = $jsonResponse->stringOf('data[i].object');
    $amount = $jsonResponse->IntOf('data[i].amount');
    $arrival_date = $jsonResponse->IntOf('data[i].arrival_date');
    $automatic = $jsonResponse->BoolOf('data[i].automatic');
    $balance_transaction = $jsonResponse->stringOf('data[i].balance_transaction');
    $created = $jsonResponse->IntOf('data[i].created');
    $currency = $jsonResponse->stringOf('data[i].currency');
    $description = $jsonResponse->stringOf('data[i].description');
    $destination = $jsonResponse->stringOf('data[i].destination');
    $failure_balance_transaction = $jsonResponse->IsNullOf('data[i].failure_balance_transaction');
    $failure_code = $jsonResponse->IsNullOf('data[i].failure_code');
    $failure_message = $jsonResponse->IsNullOf('data[i].failure_message');
    $livemode = $jsonResponse->BoolOf('data[i].livemode');
    $method = $jsonResponse->stringOf('data[i].method');
    $source_type = $jsonResponse->stringOf('data[i].source_type');
    $statement_descriptor = $jsonResponse->IsNullOf('data[i].statement_descriptor');
    $status = $jsonResponse->stringOf('data[i].status');
    $type = $jsonResponse->stringOf('data[i].type');
    $i = $i + 1;
}


?>

Sample JSON Response Body

{
  "object": "list",
  "url": "/v1/payouts",
  "has_more": false,
  "data": [
    {
      "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"
    }
  ]
}