Sample - Stripe API
POST/v1/issuing/settlements/{settlement}

Update a settlement

Updates an Issuing settlement with the values supplied in the request. Omitted fields remain unchanged, while metadata lets you attach or remove string key-value pairs and expand controls expanded response fields.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
settlementstringrequired
The unique identifier of the settlement to update. Must not exceed 5000 characters.

Optional settlement update fields; omitted fields remain unchanged.

expandarray<string>optional
Specifies which fields in the response should be expanded.
metadataobjectoptional
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

2 status codes
200Returns the updated Issuing settlement containing its network, currency, amounts, processing status, metadata, and settlement identifiers.
binstringrequired
The Bank Identification Number reflecting this settlement record.
clearing_dateintegerrequired
The date that the transactions are cleared and posted to user's accounts.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
currencystringrequired
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
idstringrequired
Unique identifier for the object.
interchange_fees_amountintegerrequired
The total interchange received as reimbursement for the transactions.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectrequired
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
net_total_amountintegerrequired
The total net amount required to settle with the network.
networkstringrequired
The card network for this settlement report. One of ["visa", "maestro", "mastercard"]
Allowed:maestromastercardvisa
network_fees_amountintegerrequired
The total amount of fees owed to the network.
network_settlement_identifierstringrequired
The Settlement Identification Number assigned by the network.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:issuing.settlement
settlement_servicestringrequired
One of `international` or `uk_national_net`.
statusstringrequired
The current processing status of this settlement.
Allowed:completepending
transaction_amountintegerrequired
The total transaction amount reflected in this settlement.
transaction_countintegerrequired
The total number of transactions reflected in this settlement.
defaultError response.
errorobjectrequired

Error handling

settlement must identify the settlement to update and must not exceed 5000 characters. Each value in expand must be a string of no more than 5000 characters, and metadata values must be strings; post an empty value to unset an individual key.