Sample - Stripe API
POST/v1/test_helpers/issuing/settlements

Create a test-mode settlement

Allows the user to create an Issuing settlement.

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

10 body fields
binstringrequired
The Bank Identification Number reflecting this settlement record.
clearing_dateintegerrequired
The date that the transactions are cleared and posted to user's accounts.
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).
expandarray<string>optional
Specifies which fields in the response should be expanded.
interchange_fees_amountintegeroptional
The total interchange received as reimbursement for the transactions.
net_total_amountintegerrequired
The total net amount required to settle with the network.
networkstringoptional
The card network for this settlement. One of ["visa", "maestro", "mastercard"]
Allowed:maestrovisa
network_settlement_identifierstringoptional
The Settlement Identification Number assigned by the network.
transaction_amountintegeroptional
The total transaction amount reflected in this settlement.
transaction_countintegeroptional
The total number of transactions reflected in this settlement.

2 status codes
200Successful response.
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

Any other status is an error: Error response.