Skip to main content
POST
/
payments
/
v1
/
holds
Create hold
curl --request POST \
  --url https://api.case.dev/payments/v1/holds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "<string>",
  "amount": 123,
  "currency": "usd",
  "release_conditions": [
    {
      "type": "manual_approval",
      "approvers": [
        "<string>"
      ],
      "document_id": "<string>",
      "date": "<string>"
    }
  ],
  "on_release_action": "<string>",
  "on_release_config": {},
  "memo": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "metadata": {}
}
'

Authorizations

​
Authorization
string
header
required

API key starting with sk_case_

Body

application/json
​
account_id
string
required

Account to hold funds in

​
amount
integer
required

Amount in cents to hold

​
currency
string
default:usd
​
release_conditions
object[]
​
on_release_action
string

Action to take when released

​
on_release_config
object
​
memo
string
​
expires_at
string<date-time>
​
metadata
object

Response

200

Hold created