Ruby Stripe: Cancel a Payout

Back to Index

A previously created payout can be canceled if it has not yet been paid out.

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

CURL Command

curl https://api.stripe.com/v1/payouts/po_1BnETKGswQrCoh0XeUopRyDR/cancel \
   -u STRIPE_SECRET_KEY: \
   -X POST

Ruby Example

require 'chilkat'

rest = Chilkat::CkRest.new()

#  URL: https://api.stripe.com/v1/payouts/po_1BnETKGswQrCoh0XeUopRyDR/cancel
bTls = true
port = 443
bAutoReconnect = true
success = rest.Connect("api.stripe.com",port,bTls,bAutoReconnect)
if (success != true)
    print "ConnectFailReason: " + rest.get_ConnectFailReason().to_s() + "\n";
    print rest.lastErrorText() + "\n";
    exit
end

rest.SetAuthBasic("STRIPE_SECRET_KEY","")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestNoBodySb("POST","/v1/payouts/po_1BnETKGswQrCoh0XeUopRyDR/cancel",sbResponseBody)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

jsonResponse = Chilkat::CkJsonObject.new()
jsonResponse.LoadSb(sbResponseBody)

id = jsonResponse.stringOf("id")
object = jsonResponse.stringOf("object")
amount = jsonResponse.IntOf("amount")
arrival_date = jsonResponse.IntOf("arrival_date")
automatic = jsonResponse.BoolOf("automatic")
balance_transaction = jsonResponse.stringOf("balance_transaction")
created = jsonResponse.IntOf("created")
currency = jsonResponse.stringOf("currency")
description = jsonResponse.stringOf("description")
destination = jsonResponse.stringOf("destination")
failure_balance_transaction = jsonResponse.IsNullOf("failure_balance_transaction")
failure_code = jsonResponse.IsNullOf("failure_code")
failure_message = jsonResponse.IsNullOf("failure_message")
livemode = jsonResponse.BoolOf("livemode")
method = jsonResponse.stringOf("method")
source_type = jsonResponse.stringOf("source_type")
statement_descriptor = jsonResponse.IsNullOf("statement_descriptor")
status = jsonResponse.stringOf("status")
type = jsonResponse.stringOf("type")

Sample JSON Response Body

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