PureBasic 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

PureBasic Example

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ;  URL: https://api.stripe.com/v1/payouts?limit=3
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"api.stripe.com",port,bTls,bAutoReconnect)
    If success <> 1
        Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    CkRest::ckSetAuthBasic(rest,"STRIPE_SECRET_KEY","")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkRest::ckFullRequestNoBodySb(rest,"GET","/v1/payouts?limit=3",sbResponseBody)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jsonResponse.i = CkJsonObject::ckCreate()
    If jsonResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jsonResponse,sbResponseBody)

    object.s
    url.s
    has_more.i
    i.i
    count_i.i
    id.s
    amount.i
    arrival_date.i
    automatic.i
    balance_transaction.s
    created.i
    currency.s
    description.s
    destination.s
    failure_balance_transaction.i
    failure_code.i
    failure_message.i
    livemode.i
    method.s
    source_type.s
    statement_descriptor.i
    status.s
    type.s

    object = CkJsonObject::ckStringOf(jsonResponse,"object")
    url = CkJsonObject::ckStringOf(jsonResponse,"url")
    has_more = CkJsonObject::ckBoolOf(jsonResponse,"has_more")
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jsonResponse,"data")
    While i < count_i
        CkJsonObject::setCkI(jsonResponse, i)
        id = CkJsonObject::ckStringOf(jsonResponse,"data[i].id")
        object = CkJsonObject::ckStringOf(jsonResponse,"data[i].object")
        amount = CkJsonObject::ckIntOf(jsonResponse,"data[i].amount")
        arrival_date = CkJsonObject::ckIntOf(jsonResponse,"data[i].arrival_date")
        automatic = CkJsonObject::ckBoolOf(jsonResponse,"data[i].automatic")
        balance_transaction = CkJsonObject::ckStringOf(jsonResponse,"data[i].balance_transaction")
        created = CkJsonObject::ckIntOf(jsonResponse,"data[i].created")
        currency = CkJsonObject::ckStringOf(jsonResponse,"data[i].currency")
        description = CkJsonObject::ckStringOf(jsonResponse,"data[i].description")
        destination = CkJsonObject::ckStringOf(jsonResponse,"data[i].destination")
        failure_balance_transaction = CkJsonObject::ckIsNullOf(jsonResponse,"data[i].failure_balance_transaction")
        failure_code = CkJsonObject::ckIsNullOf(jsonResponse,"data[i].failure_code")
        failure_message = CkJsonObject::ckIsNullOf(jsonResponse,"data[i].failure_message")
        livemode = CkJsonObject::ckBoolOf(jsonResponse,"data[i].livemode")
        method = CkJsonObject::ckStringOf(jsonResponse,"data[i].method")
        source_type = CkJsonObject::ckStringOf(jsonResponse,"data[i].source_type")
        statement_descriptor = CkJsonObject::ckIsNullOf(jsonResponse,"data[i].statement_descriptor")
        status = CkJsonObject::ckStringOf(jsonResponse,"data[i].status")
        type = CkJsonObject::ckStringOf(jsonResponse,"data[i].type")
        i = i + 1
    Wend


    CkRest::ckDispose(rest)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jsonResponse)


    ProcedureReturn
EndProcedure

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