Swift Stripe: Retrieve an Event

Back to Index

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

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

CURL Command

curl https://api.stripe.com/v1/events/evt_1BnETJGswQrCoh0XAl7jSmFB \
   -u STRIPE_SECRET_KEY:

Swift Example

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

    //  URL: https://api.stripe.com/v1/events/evt_1BnETJGswQrCoh0XAl7jSmFB
    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/events/evt_1BnETJGswQrCoh0XAl7jSmFB", sb: sbResponseBody)
    if success != true {
        print("\(rest.LastErrorText)")
        return
    }

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

    var id: String?
    var object: String?
    var api_version: Bool
    var created: Int
    var dataObjectId: String?
    var dataObjectObject: String?
    var dataObjectAmount: Int
    var dataObjectCreated: Int
    var dataObjectCurrency: String?
    var dataObjectInterval: String?
    var dataObjectInterval_count: Int
    var dataObjectLivemode: Bool
    var dataObjectName: String?
    var dataObjectStatement_descriptor: Bool
    var dataObjectTrial_period_days: Bool
    var livemode: Bool
    var pending_webhooks: Int
    var requestId: Bool
    var requestIdempotency_key: Bool
    var type: String?

    id = jsonResponse.StringOf("id")
    object = jsonResponse.StringOf("object")
    api_version = jsonResponse.IsNullOf("api_version")
    created = jsonResponse.IntOf("created").integerValue
    dataObjectId = jsonResponse.StringOf("data.object.id")
    dataObjectObject = jsonResponse.StringOf("data.object.object")
    dataObjectAmount = jsonResponse.IntOf("data.object.amount").integerValue
    dataObjectCreated = jsonResponse.IntOf("data.object.created").integerValue
    dataObjectCurrency = jsonResponse.StringOf("data.object.currency")
    dataObjectInterval = jsonResponse.StringOf("data.object.interval")
    dataObjectInterval_count = jsonResponse.IntOf("data.object.interval_count").integerValue
    dataObjectLivemode = jsonResponse.BoolOf("data.object.livemode")
    dataObjectName = jsonResponse.StringOf("data.object.name")
    dataObjectStatement_descriptor = jsonResponse.IsNullOf("data.object.statement_descriptor")
    dataObjectTrial_period_days = jsonResponse.IsNullOf("data.object.trial_period_days")
    livemode = jsonResponse.BoolOf("livemode")
    pending_webhooks = jsonResponse.IntOf("pending_webhooks").integerValue
    requestId = jsonResponse.IsNullOf("request.id")
    requestIdempotency_key = jsonResponse.IsNullOf("request.idempotency_key")
    type = jsonResponse.StringOf("type")

}

Sample JSON Response Body

{
  "id": "evt_1BnETJGswQrCoh0XAl7jSmFB",
  "object": "event",
  "api_version": null,
  "created": 1516662781,
  "data": {
    "object": {
      "id": "gold",
      "object": "plan",
      "amount": 2000,
      "created": 1516662781,
      "currency": "usd",
      "interval": "month",
      "interval_count": 1,
      "livemode": false,
      "metadata": {},
      "name": "T-shirt",
      "statement_descriptor": null,
      "trial_period_days": null
    }
  },
  "livemode": false,
  "pending_webhooks": 0,
  "request": {
    "id": null,
    "idempotency_key": null
  },
  "type": "plan.created"
}