Transactions

Reserve funds for an accepted deal

Creates an idempotent reservation for the accepted maximum cap. Choose Darwin-managed payment or the application-managed Shared Payment Token preview. Performance settlement releases any unused amount.

post/deals/{dealId}/transactions

Request

  • Base URL: https://api.darwin.so/api/v1
  • URL: https://api.darwin.so/api/v1/deals/{dealId}/transactions
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

dealIdstring required

Headers

Idempotency-Keystring required

A caller-generated key, unique to this operation and payload.

Request body

paymentMode'DARWIN_MANAGED' | 'APPLICATION_MANAGED'

Response

The reservation or exact funding requirement.

state'ready' | 'requires_funding' | 'payment_authorization_required' | 'recurring_approval_required' | 'recurring_scheduled' required
fundingAmountMinorinteger
fundingRailstring nullable
clientSecretstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.