v1

latestOpenAPI 3.1.0Proprietary2026-07-24462215.9 KB

Settlement Accounts

Update Settlement Account

Update an existing settlement account. All request body fields are optional — send only the fields you want to update. The current default settlement account cannot be marked as inactive. To mark it as inactive, first set another settlement account as the default.

patch/v3/settlement-account/{settlementAccountId}

Path parameters

settlementAccountIdstring required

Example:SA-123456789

The ID of the settlement account to update

Headers

MIDstring required

Example:SABCDEF_SCT8YW_NA

Merchant or sub-merchant MID

Request body

status'active' | 'inactive'

Settlement account status

accountAliasstring

Human-readable alias for the settlement account

isVerifiedboolean

Marks the account as verified. When set to true, the verification timestamp is recorded.

verifiedBystring

Identifier of who verified the account

setAsDefaultboolean

When true, makes this the default settlement account for its type and unsets the default flag on all other accounts of the same type.

Response

Settlement account updated successfully

statusstring

messagestring