Unicode C++ 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

Unicode C++ Example

#include <CkRestW.h>
#include <CkStringBuilderW.h>
#include <CkJsonObjectW.h>

void ChilkatSample(void)
    {
    CkRestW rest;
    bool success;

    //  URL: https://api.stripe.com/v1/payouts?limit=3
    bool bTls = true;
    int port = 443;
    bool bAutoReconnect = true;
    success = rest.Connect(L"api.stripe.com",port,bTls,bAutoReconnect);
    if (success != true) {
        wprintf(L"ConnectFailReason: %d\n",rest.get_ConnectFailReason());
        wprintf(L"%s\n",rest.lastErrorText());
        return;
    }

    rest.SetAuthBasic(L"STRIPE_SECRET_KEY",L"");

    CkStringBuilderW sbResponseBody;
    success = rest.FullRequestNoBodySb(L"GET",L"/v1/payouts?limit=3",sbResponseBody);
    if (success != true) {
        wprintf(L"%s\n",rest.lastErrorText());
        return;
    }

    CkJsonObjectW jsonResponse;
    jsonResponse.LoadSb(sbResponseBody);

    const wchar_t *object = 0;
    const wchar_t *url = 0;
    bool has_more;
    int i;
    int count_i;
    const wchar_t *id = 0;
    int amount;
    int arrival_date;
    bool automatic;
    const wchar_t *balance_transaction = 0;
    int created;
    const wchar_t *currency = 0;
    const wchar_t *description = 0;
    const wchar_t *destination = 0;
    bool failure_balance_transaction;
    bool failure_code;
    bool failure_message;
    bool livemode;
    const wchar_t *method = 0;
    const wchar_t *source_type = 0;
    bool statement_descriptor;
    const wchar_t *status = 0;
    const wchar_t *type = 0;

    object = jsonResponse.stringOf(L"object");
    url = jsonResponse.stringOf(L"url");
    has_more = jsonResponse.BoolOf(L"has_more");
    i = 0;
    count_i = jsonResponse.SizeOfArray(L"data");
    while (i < count_i) {
        jsonResponse.put_I(i);
        id = jsonResponse.stringOf(L"data[i].id");
        object = jsonResponse.stringOf(L"data[i].object");
        amount = jsonResponse.IntOf(L"data[i].amount");
        arrival_date = jsonResponse.IntOf(L"data[i].arrival_date");
        automatic = jsonResponse.BoolOf(L"data[i].automatic");
        balance_transaction = jsonResponse.stringOf(L"data[i].balance_transaction");
        created = jsonResponse.IntOf(L"data[i].created");
        currency = jsonResponse.stringOf(L"data[i].currency");
        description = jsonResponse.stringOf(L"data[i].description");
        destination = jsonResponse.stringOf(L"data[i].destination");
        failure_balance_transaction = jsonResponse.IsNullOf(L"data[i].failure_balance_transaction");
        failure_code = jsonResponse.IsNullOf(L"data[i].failure_code");
        failure_message = jsonResponse.IsNullOf(L"data[i].failure_message");
        livemode = jsonResponse.BoolOf(L"data[i].livemode");
        method = jsonResponse.stringOf(L"data[i].method");
        source_type = jsonResponse.stringOf(L"data[i].source_type");
        statement_descriptor = jsonResponse.IsNullOf(L"data[i].statement_descriptor");
        status = jsonResponse.stringOf(L"data[i].status");
        type = jsonResponse.stringOf(L"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"
    }
  ]
}