v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Update a settlement

Updates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

post/v1/issuing/settlements/{settlement}

Path parameters

settlementstring required

Response

Successful response.

binstring required

The Bank Identification Number reflecting this settlement record.

clearing_dateinteger required

The date that the transactions are cleared and posted to user's accounts.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

currencystring currency required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

idstring required

Unique identifier for the object.

interchange_fees_amountinteger required

The total interchange received as reimbursement for the transactions.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

net_total_amountinteger required

The total net amount required to settle with the network.

network'maestro' | 'mastercard' | 'visa' required

The card network for this settlement report. One of ["visa", "maestro", "mastercard"]

network_fees_amountinteger required

The total amount of fees owed to the network.

network_settlement_identifierstring required

The Settlement Identification Number assigned by the network.

object'issuing.settlement' required

String representing the object's type. Objects of the same type share the same value.

settlement_servicestring required

One of international or uk_national_net.

status'complete' | 'pending' required

The current processing status of this settlement.

transaction_amountinteger required

The total transaction amount reflected in this settlement.

transaction_countinteger required

The total number of transactions reflected in this settlement.