Swift 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

Swift Example

func chilkatTest() {
    let rest = CkoRest()
    var success: Bool

    //  URL: https://api.stripe.com/v1/payouts?limit=3
    var bTls: Bool = true
    var port: Int = 443
    var bAutoReconnect: Bool = true
    success = rest.Connect("api.stripe.com", port: port, tls: bTls, autoReconnect: bAutoReconnect)
    if success != true {
        print("ConnectFailReason: \(rest.ConnectFailReason.integerValue)")
        print("\(rest.LastErrorText)")
        return
    }

    rest.SetAuthBasic("STRIPE_SECRET_KEY", password: "")

    let sbResponseBody = CkoStringBuilder()
    success = rest.FullRequestNoBodySb("GET", uriPath: "/v1/payouts?limit=3", sb: sbResponseBody)
    if success != true {
        print("\(rest.LastErrorText)")
        return
    }

    let jsonResponse = CkoJsonObject()
    jsonResponse.LoadSb(sbResponseBody)

    var object: String?
    var url: String?
    var has_more: Bool
    var i: Int
    var count_i: Int
    var id: String?
    var amount: Int
    var arrival_date: Int
    var automatic: Bool
    var balance_transaction: String?
    var created: Int
    var currency: String?
    var description: String?
    var destination: String?
    var failure_balance_transaction: Bool
    var failure_code: Bool
    var failure_message: Bool
    var livemode: Bool
    var method: String?
    var source_type: String?
    var statement_descriptor: Bool
    var status: String?
    var type: String?

    object = jsonResponse.StringOf("object")
    url = jsonResponse.StringOf("url")
    has_more = jsonResponse.BoolOf("has_more")
    i = 0
    count_i = jsonResponse.SizeOfArray("data").integerValue
    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").integerValue
        arrival_date = jsonResponse.IntOf("data[i].arrival_date").integerValue
        automatic = jsonResponse.BoolOf("data[i].automatic")
        balance_transaction = jsonResponse.StringOf("data[i].balance_transaction")
        created = jsonResponse.IntOf("data[i].created").integerValue
        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
    }


}

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