Skip to content
Sanmopia Modernization

Snapshot verified branch settlement account for a settlement statement

Switch to Zen Mode
POST
/branch-settlement-account-statement-snapshots
curl --request POST \
  --url https://example.com/branch-settlement-account-statement-snapshots \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "snapshotId": "example", "settlementStatementId": "example", "branchOfficeProfileId": "example", "settlementAccountId": "example", "expectedSettlementAccountRevision": 1, "idempotencyKey": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
SnapshotBranchSettlementAccountForStatementRequest
object
snapshotId
required
string
>= 1 characters
settlementStatementId
required
string
>= 1 characters
branchOfficeProfileId
required
string
>= 1 characters
settlementAccountId
required
string
>= 1 characters
expectedSettlementAccountRevision
required
integer
>= 1
idempotencyKey
required
string
>= 1 characters
key
additional properties

Responses

Section titled “Responses”

201

Section titled “201”

Immutable branch settlement account snapshot captured for statement

Media typeapplication/json
BranchSettlementAccountStatementSnapshotResponse
object
snapshotId
required
string
>= 1 characters
settlementStatementId
required
string
>= 1 characters
branchOfficeProfileId
required
string
>= 1 characters
branchOfficeProfileRevision
required
integer
>= 1
settlementAccountId
required
string
>= 1 characters
settlementAccountRevision
required
integer
>= 1
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
snapshotForStatementAt
required
string format: date-time
snapshotForStatementByActorId
required
string
>= 1 characters
idempotencyKey
required
string
>= 1 characters
key
additional properties

401

Section titled “401”

Supabase bearer token is required

403

Section titled “403”

Actor cannot settle for the branch

409

Section titled “409”

Settlement account revision is stale or idempotency key conflicts

503

Section titled “503”

Branch office profile store is unavailable