Skip to content
Sanmopia Modernization

Replace a purpose-scoped branch settlement account

Switch to Zen Mode
POST
/branch-settlement-account-replacements
curl --request POST \
  --url https://example.com/branch-settlement-account-replacements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "commandId": "example", "revisionId": "example", "branchOfficeProfileId": "example", "expectedRevision": 1, "settlementAccountId": "example", "purpose": "statement_remittance", "bankName": "example", "accountHolder": "example", "maskedAccountReference": "example", "verificationState": "unverified", "effectiveFrom": "2026-04-15", "effectiveUntil": "2026-04-15", "reason": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ReplaceBranchSettlementAccountRequest
object
commandId
required
string
>= 1 characters
revisionId
required
string
>= 1 characters
branchOfficeProfileId
required
string
>= 1 characters
expectedRevision
required
integer
settlementAccountId
required
string
>= 1 characters
purpose
required
string
Allowed values: statement_remittance branch_deposit membership_fee refund
bankName
required
string
>= 1 characters
accountHolder
required
string
>= 1 characters
maskedAccountReference
required
string
>= 1 characters /\*/
verificationState
required
string
Allowed values: unverified verification_requested verified rejected expired
effectiveFrom
required
string format: date
effectiveUntil
required
string | null format: date
reason
required
string
>= 1 characters
key
additional properties

Responses

Section titled “Responses”

201

Section titled “201”

Branch settlement account revision committed

Media typeapplication/json
BranchOfficeProfileRevisionResponse
object
revisionId
required
string
>= 1 characters
branchOfficeProfileId
required
string
>= 1 characters
revisionNumber
required
integer
>= 1
factGroup
required
string
Allowed values: profile lifecycle settlement_account membership_fee_policy credential_rotation
actorId
required
string
>= 1 characters
reason
required
string
>= 1 characters
effectiveAt
required
string format: date-time
key
additional properties

401

Section titled “401”

Supabase bearer token is required

403

Section titled “403”

Actor cannot replace the branch settlement account

409

Section titled “409”

Expected revision is stale or account facts are invalid

503

Section titled “503”

Branch office profile store is unavailable