Skip to main content
POST
Reserve funds for an accepted deal

Authorizations

Authorization
string
header
required

Production keys begin with darwin_. Isolated sandbox keys begin with darwin_test_. Create keys in Developer settings.

Headers

Idempotency-Key
string
required

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

Required string length: 1 - 200

Path Parameters

dealId
string
required

Body

application/json
paymentMode
enum<string>
default:DARWIN_MANAGED
Available options:
DARWIN_MANAGED,
APPLICATION_MANAGED

Response

The reservation or exact funding requirement.

state
enum<string>
required
Available options:
ready,
requires_funding,
payment_authorization_required,
recurring_approval_required,
recurring_scheduled
transaction
object
required
fundingAmountMinor
integer
Required range: x >= 0
fundingRail
string | null