VB.NET 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

VB.NET Example

Dim rest As New Chilkat.Rest
Dim success As Boolean

'  URL: https://api.stripe.com/v1/payouts?limit=3
Dim bTls As Boolean = True
Dim port As Integer = 443
Dim bAutoReconnect As Boolean = True
success = rest.Connect("api.stripe.com",port,bTls,bAutoReconnect)
If (success <> True) Then
    Debug.WriteLine("ConnectFailReason: " & rest.ConnectFailReason)
    Debug.WriteLine(rest.LastErrorText)
    Exit Sub
End If


rest.SetAuthBasic("STRIPE_SECRET_KEY","")


Dim sbResponseBody As New Chilkat.StringBuilder
success = rest.FullRequestNoBodySb("GET","/v1/payouts?limit=3",sbResponseBody)
If (success <> True) Then
    Debug.WriteLine(rest.LastErrorText)
    Exit Sub
End If


Dim jsonResponse As New Chilkat.JsonObject
jsonResponse.LoadSb(sbResponseBody)

Dim object As String
Dim url As String
Dim has_more As Boolean
Dim i As Integer
Dim count_i As Integer
Dim id As String
Dim amount As Integer
Dim arrival_date As Integer
Dim automatic As Boolean
Dim balance_transaction As String
Dim created As Integer
Dim currency As String
Dim description As String
Dim destination As String
Dim failure_balance_transaction As Boolean
Dim failure_code As Boolean
Dim failure_message As Boolean
Dim livemode As Boolean
Dim method As String
Dim source_type As String
Dim statement_descriptor As Boolean
Dim status As String
Dim type As String

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
End While

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