TradeVowConnectRequest API access
Family I/v1/settlements

Settlement APIs

Coordinate settlement instructions, conditions and payment evidence in the transaction context without assuming TradeVow always moves or holds funds.

Designed for: Banks, payment providers, wallet and stablecoin providers, buyers, sellers and funders

MethodEndpoint
POST
/v1/transactions/{transaction_id}/settlement-instructions

Register authorised settlement instructions and payment route.

GET
/v1/transactions/{transaction_id}/settlement-readiness

Read conditions and blockers for settlement initiation.

POST
/v1/settlements/{settlement_id}/conditions

Create or update an authorised settlement condition.

POST
/v1/settlements/{settlement_id}/payment-events

Publish initiated, processing, failed or confirmed payment evidence.

GET
/v1/settlements/{settlement_id}

Read the permitted settlement journey and evidence state.

Postman example

Publish payment confirmation

POST {{base_url}}/v1/settlements/{{settlement_id}}/payment-events
X-TradeVow-API-Key: {{api_key}}
Content-Type: application/json
Idempotency-Key: {{$guid}}
X-Correlation-ID: {{$guid}}

Domain rules

  • Settlement instructions require stronger authorisation and idempotency controls.
  • Payment provider status remains a sourced event, not an unexplained balance change.
  • Confirmation records amount, currency, provider reference and occurrence time.
  • TradeVow coordinates evidence even where funds move entirely outside TradeVow.

Related events

settlement.instruction_createdsettlement.condition_satisfiedsettlement.payment_initiatedsettlement.payment_failedsettlement.payment_confirmed