Node.js 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

Node.js Example

var os = require('os');
if (os.platform() == 'win32') {  
    var chilkat = require('chilkat_node6_win32'); 
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('chilkat_node6_arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('chilkat_node6_linux32');
    } else {
        var chilkat = require('chilkat_node6_linux64');
    }
} else if (os.platform() == 'darwin') {
    var chilkat = require('chilkat_node6_macosx');
}

function chilkatExample() {

    var rest = new chilkat.Rest();
    var success;

    //  URL: https://api.stripe.com/v1/payouts/po_1BnETKGswQrCoh0XeUopRyDR/cancel
    var bTls = true;
    var port = 443;
    var bAutoReconnect = true;
    success = rest.Connect("api.stripe.com",port,bTls,bAutoReconnect);
    if (success !== true) {
        console.log("ConnectFailReason: " + rest.ConnectFailReason);
        console.log(rest.LastErrorText);
        return;
    }

    rest.SetAuthBasic("STRIPE_SECRET_KEY","");

    var sbResponseBody = new chilkat.StringBuilder();
    success = rest.FullRequestNoBodySb("POST","/v1/payouts/po_1BnETKGswQrCoh0XeUopRyDR/cancel",sbResponseBody);
    if (success !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    var jsonResponse = new chilkat.JsonObject();
    jsonResponse.LoadSb(sbResponseBody);

    var id;
    var object;
    var amount;
    var arrival_date;
    var automatic;
    var balance_transaction;
    var created;
    var currency;
    var description;
    var destination;
    var failure_balance_transaction;
    var failure_code;
    var failure_message;
    var livemode;
    var method;
    var source_type;
    var statement_descriptor;
    var status;
    var type;

    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");

}

chilkatExample();

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