Delphi DLL 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 DLL Example

var
rest: HCkRest;
success: Boolean;
bTls: Boolean;
port: Integer;
bAutoReconnect: Boolean;
sbResponseBody: HCkStringBuilder;
jsonResponse: HCkJsonObject;
object: PWideChar;
url: PWideChar;
has_more: Boolean;
i: Integer;
count_i: Integer;
id: PWideChar;
amount: Integer;
arrival_date: Integer;
automatic: Boolean;
balance_transaction: PWideChar;
created: Integer;
currency: PWideChar;
description: PWideChar;
destination: PWideChar;
failure_balance_transaction: Boolean;
failure_code: Boolean;
failure_message: Boolean;
livemode: Boolean;
method: PWideChar;
source_type: PWideChar;
statement_descriptor: Boolean;
status: PWideChar;
type: PWideChar;

begin
rest := CkRest_Create();

//  URL: https://api.stripe.com/v1/payouts?limit=3
bTls := True;
port := 443;
bAutoReconnect := True;
success := CkRest_Connect(rest,'api.stripe.com',port,bTls,bAutoReconnect);
if (success <> True) then
  begin
    Memo1.Lines.Add('ConnectFailReason: ' + IntToStr(CkRest_getConnectFailReason(rest)));
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

CkRest_SetAuthBasic(rest,'STRIPE_SECRET_KEY','');

sbResponseBody := CkStringBuilder_Create();
success := CkRest_FullRequestNoBodySb(rest,'GET','/v1/payouts?limit=3',sbResponseBody);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

jsonResponse := CkJsonObject_Create();
CkJsonObject_LoadSb(jsonResponse,sbResponseBody);

object := CkJsonObject__stringOf(jsonResponse,'object');
url := CkJsonObject__stringOf(jsonResponse,'url');
has_more := CkJsonObject_BoolOf(jsonResponse,'has_more');
i := 0;
count_i := CkJsonObject_SizeOfArray(jsonResponse,'data');
while i < count_i do
  begin
CkJsonObject_putI(jsonResponse,i);
    id := CkJsonObject__stringOf(jsonResponse,'data[i].id');
    object := CkJsonObject__stringOf(jsonResponse,'data[i].object');
    amount := CkJsonObject_IntOf(jsonResponse,'data[i].amount');
    arrival_date := CkJsonObject_IntOf(jsonResponse,'data[i].arrival_date');
    automatic := CkJsonObject_BoolOf(jsonResponse,'data[i].automatic');
    balance_transaction := CkJsonObject__stringOf(jsonResponse,'data[i].balance_transaction');
    created := CkJsonObject_IntOf(jsonResponse,'data[i].created');
    currency := CkJsonObject__stringOf(jsonResponse,'data[i].currency');
    description := CkJsonObject__stringOf(jsonResponse,'data[i].description');
    destination := CkJsonObject__stringOf(jsonResponse,'data[i].destination');
    failure_balance_transaction := CkJsonObject_IsNullOf(jsonResponse,'data[i].failure_balance_transaction');
    failure_code := CkJsonObject_IsNullOf(jsonResponse,'data[i].failure_code');
    failure_message := CkJsonObject_IsNullOf(jsonResponse,'data[i].failure_message');
    livemode := CkJsonObject_BoolOf(jsonResponse,'data[i].livemode');
    method := CkJsonObject__stringOf(jsonResponse,'data[i].method');
    source_type := CkJsonObject__stringOf(jsonResponse,'data[i].source_type');
    statement_descriptor := CkJsonObject_IsNullOf(jsonResponse,'data[i].statement_descriptor');
    status := CkJsonObject__stringOf(jsonResponse,'data[i].status');
    type := CkJsonObject__stringOf(jsonResponse,'data[i].type');
    i := i + 1;
  end;

CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jsonResponse);

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