Swift Stripe: List all Refunds

Back to Index

Returns a list of all refunds you’ve previously created.

Documentation: https://stripe.com/docs/api/curl#list_refunds

CURL Command

curl https://api.stripe.com/v1/refunds?limit=3 \
   -u STRIPE_SECRET_KEY: \
   -G

Swift Example

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

    //  URL: https://api.stripe.com/v1/refunds?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/refunds?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 balance_transaction: Bool
    var charge: String?
    var created: Int
    var currency: String?
    var reason: Bool
    var receipt_number: Bool
    var status: 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
        balance_transaction = jsonResponse.IsNullOf("data[i].balance_transaction")
        charge = jsonResponse.StringOf("data[i].charge")
        created = jsonResponse.IntOf("data[i].created").integerValue
        currency = jsonResponse.StringOf("data[i].currency")
        reason = jsonResponse.IsNullOf("data[i].reason")
        receipt_number = jsonResponse.IsNullOf("data[i].receipt_number")
        status = jsonResponse.StringOf("data[i].status")
        i = i + 1
    }


}

Sample JSON Response Body

{
  "object": "list",
  "url": "/v1/refunds",
  "has_more": false,
  "data": [
    {
      "id": "re_1BnETKGswQrCoh0XT2qLx7S0",
      "object": "refund",
      "amount": 100,
      "balance_transaction": null,
      "charge": "ch_1BnETKGswQrCoh0XE7kJI2wj",
      "created": 1516662782,
      "currency": "usd",
      "metadata": {},
      "reason": null,
      "receipt_number": null,
      "status": "succeeded"
    }
  ]
}