Swift Stripe: Pay an Invoice

Back to Index

Attempts payment on an invoice out of the normal collection schedule.

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

CURL Command

curl https://api.stripe.com/v1/invoices/in_1BnETLGswQrCoh0X6M67Qy9c/pay \
   -u STRIPE_SECRET_KEY: \
   -X POST

Swift Example


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

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

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

    var id: String?
    var object: String?
    var amount_due: Int
    var application_fee: Bool
    var attempt_count: Int
    var attempted: Bool
    var billing: String?
    var charge: String?
    var closed: Bool
    var currency: String?
    var customer: String?
    var date: Int
    var description: Bool
    var discount: Bool
    var due_date: Bool
    var ending_balance: Bool
    var forgiven: Bool
    var linesHas_more: Bool
    var linesObject: String?
    var linesUrl: String?
    var livemode: Bool
    var next_payment_attempt: Int
    var number: String?
    var paid: Bool
    var period_end: Int
    var period_start: Int
    var receipt_number: Bool
    var starting_balance: Int
    var statement_descriptor: Bool
    var subscription: Bool
    var subtotal: Int
    var tax: Bool
    var tax_percent: Bool
    var total: Int
    var webhooks_delivered_at: Bool
    var last_payment_attempt: Bool
    var i: Int
    var count_i: Int
    var amount: Int
    var description_str: String?
    var discountable: Bool
    var periodStart: Int
    var periodEnd: Int
    var planId: String?
    var planObject: String?
    var planAmount: Int
    var planCreated: Int
    var planCurrency: String?
    var planInterval: String?
    var planInterval_count: Int
    var planLivemode: Bool
    var planName: String?
    var planStatement_descriptor: Bool
    var planTrial_period_days: Bool
    var proration: Bool
    var quantity: Int
    var subscription_item: String?
    var type: String?

    id = jsonResponse.StringOf("id")
    object = jsonResponse.StringOf("object")
    amount_due = jsonResponse.IntOf("amount_due").integerValue
    application_fee = jsonResponse.IsNullOf("application_fee")
    attempt_count = jsonResponse.IntOf("attempt_count").integerValue
    attempted = jsonResponse.BoolOf("attempted")
    billing = jsonResponse.StringOf("billing")
    charge = jsonResponse.StringOf("charge")
    closed = jsonResponse.BoolOf("closed")
    currency = jsonResponse.StringOf("currency")
    customer = jsonResponse.StringOf("customer")
    date = jsonResponse.IntOf("date").integerValue
    description = jsonResponse.IsNullOf("description")
    discount = jsonResponse.IsNullOf("discount")
    due_date = jsonResponse.IsNullOf("due_date")
    ending_balance = jsonResponse.IsNullOf("ending_balance")
    forgiven = jsonResponse.BoolOf("forgiven")
    linesHas_more = jsonResponse.BoolOf("lines.has_more")
    linesObject = jsonResponse.StringOf("lines.object")
    linesUrl = jsonResponse.StringOf("lines.url")
    livemode = jsonResponse.BoolOf("livemode")
    next_payment_attempt = jsonResponse.IntOf("next_payment_attempt").integerValue
    number = jsonResponse.StringOf("number")
    paid = jsonResponse.BoolOf("paid")
    period_end = jsonResponse.IntOf("period_end").integerValue
    period_start = jsonResponse.IntOf("period_start").integerValue
    receipt_number = jsonResponse.IsNullOf("receipt_number")
    starting_balance = jsonResponse.IntOf("starting_balance").integerValue
    statement_descriptor = jsonResponse.IsNullOf("statement_descriptor")
    subscription = jsonResponse.IsNullOf("subscription")
    subtotal = jsonResponse.IntOf("subtotal").integerValue
    tax = jsonResponse.IsNullOf("tax")
    tax_percent = jsonResponse.IsNullOf("tax_percent")
    total = jsonResponse.IntOf("total").integerValue
    webhooks_delivered_at = jsonResponse.IsNullOf("webhooks_delivered_at")
    last_payment_attempt = jsonResponse.IsNullOf("last_payment_attempt")
    i = 0
    count_i = jsonResponse.SizeOfArray("lines.data").integerValue
    while i < count_i {
        jsonResponse.I = i
        id = jsonResponse.StringOf("lines.data[i].id")
        object = jsonResponse.StringOf("lines.data[i].object")
        amount = jsonResponse.IntOf("lines.data[i].amount").integerValue
        currency = jsonResponse.StringOf("lines.data[i].currency")
        description_str = jsonResponse.StringOf("lines.data[i].description")
        discountable = jsonResponse.BoolOf("lines.data[i].discountable")
        livemode = jsonResponse.BoolOf("lines.data[i].livemode")
        periodStart = jsonResponse.IntOf("lines.data[i].period.start").integerValue
        periodEnd = jsonResponse.IntOf("lines.data[i].period.end").integerValue
        planId = jsonResponse.StringOf("lines.data[i].plan.id")
        planObject = jsonResponse.StringOf("lines.data[i].plan.object")
        planAmount = jsonResponse.IntOf("lines.data[i].plan.amount").integerValue
        planCreated = jsonResponse.IntOf("lines.data[i].plan.created").integerValue
        planCurrency = jsonResponse.StringOf("lines.data[i].plan.currency")
        planInterval = jsonResponse.StringOf("lines.data[i].plan.interval")
        planInterval_count = jsonResponse.IntOf("lines.data[i].plan.interval_count").integerValue
        planLivemode = jsonResponse.BoolOf("lines.data[i].plan.livemode")
        planName = jsonResponse.StringOf("lines.data[i].plan.name")
        planStatement_descriptor = jsonResponse.IsNullOf("lines.data[i].plan.statement_descriptor")
        planTrial_period_days = jsonResponse.IsNullOf("lines.data[i].plan.trial_period_days")
        proration = jsonResponse.BoolOf("lines.data[i].proration")
        quantity = jsonResponse.IntOf("lines.data[i].quantity").integerValue
        subscription = jsonResponse.IsNullOf("lines.data[i].subscription")
        subscription_item = jsonResponse.StringOf("lines.data[i].subscription_item")
        type = jsonResponse.StringOf("lines.data[i].type")
        i = i + 1
    }


}

Sample JSON Response Body

{
  "id": "in_1BnETLGswQrCoh0X6M67Qy9c",
  "object": "invoice",
  "amount_due": 0,
  "application_fee": null,
  "attempt_count": 0,
  "attempted": true,
  "billing": "charge_automatically",
  "charge": "ch_1BnETLGswQrCoh0XYoMbCKZ3",
  "closed": false,
  "currency": "usd",
  "customer": "cus_CBbggkUyLoz3pe",
  "date": 1516662783,
  "description": null,
  "discount": null,
  "due_date": null,
  "ending_balance": null,
  "forgiven": false,
  "lines": {
    "data": [
      {
        "id": "sub_CBbgC3EaFZqN3Q",
        "object": "line_item",
        "amount": 999,
        "currency": "usd",
        "description": "1x Silver Express (at $9.99)",
        "discountable": true,
        "livemode": true,
        "metadata": {},
        "period": {
          "start": 1521760383,
          "end": 1524438783
        },
        "plan": {
          "id": "gold",
          "object": "plan",
          "amount": 2000,
          "created": 1516662783,
          "currency": "usd",
          "interval": "month",
          "interval_count": 1,
          "livemode": false,
          "metadata": {},
          "name": "T-shirt",
          "statement_descriptor": null,
          "trial_period_days": null
        },
        "proration": false,
        "quantity": 1,
        "subscription": null,
        "subscription_item": "si_CBbgZxCVF3Ha7P",
        "type": "subscription"
      }
    ],
    "has_more": false,
    "object": "list",
    "url": "/v1/invoices/in_1BnETLGswQrCoh0X6M67Qy9c/lines"
  },
  "livemode": false,
  "metadata": {},
  "next_payment_attempt": 1516666383,
  "number": "330a34b8d5-0001",
  "paid": true,
  "period_end": 1516662783,
  "period_start": 1516662783,
  "receipt_number": null,
  "starting_balance": 0,
  "statement_descriptor": null,
  "subscription": null,
  "subtotal": 0,
  "tax": null,
  "tax_percent": null,
  "total": 0,
  "webhooks_delivered_at": null,
  "last_payment_attempt": null
}