Delphi 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

Delphi ActiveX Example

var
rest: TChilkatRest;
success: Integer;
bTls: Integer;
port: Integer;
bAutoReconnect: Integer;
sbResponseBody: TChilkatStringBuilder;
jsonResponse: TChilkatJsonObject;
object: WideString;
url: WideString;
has_more: Integer;
i: Integer;
count_i: Integer;
id: WideString;
amount: Integer;
arrival_date: Integer;
automatic: Integer;
balance_transaction: WideString;
created: Integer;
currency: WideString;
description: WideString;
destination: WideString;
failure_balance_transaction: Integer;
failure_code: Integer;
failure_message: Integer;
livemode: Integer;
method: WideString;
source_type: WideString;
statement_descriptor: Integer;
status: WideString;
type: WideString;

begin
rest := TChilkatRest.Create(Self);

//  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) then
  begin
    Memo1.Lines.Add('ConnectFailReason: ' + IntToStr(rest.ConnectFailReason));
    Memo1.Lines.Add(rest.LastErrorText);
    Exit;
  end;

rest.SetAuthBasic('STRIPE_SECRET_KEY','');

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := rest.FullRequestNoBodySb('GET','/v1/payouts?limit=3',sbResponseBody.ControlInterface);
if (success <> 1) then
  begin
    Memo1.Lines.Add(rest.LastErrorText);
    Exit;
  end;

jsonResponse := TChilkatJsonObject.Create(Self);
jsonResponse.LoadSb(sbResponseBody.ControlInterface);

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 do
  begin
    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;
  end;

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