curl --request PUT \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --url https://sandbox.straddle.com/v1/payouts/<uuid>/hold \
  --header 'Content-Type: application/json' \
  --data '{
  "reason": "<string>"
}'

import Straddle from '@straddlecom/straddle';

const client = new Straddle({
  apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const payoutV1 = await client.payouts.hold('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { reason: 'reason' });

  console.log(payoutV1.data);
}

main();

import os
from straddle import Straddle

client = Straddle(
    api_key=os.environ.get("STRADDLE_API_KEY"),  # This is the default and can be omitted
)
payout_v1 = client.payouts.hold(
    id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    reason="reason",
)
print(payout_v1.data)

require "straddle"

straddle = Straddle::Client.new(
  api_key: ENV["STRADDLE_API_KEY"], # This is the default and can be omitted
  environment: "production" # defaults to "sandbox"
)

payout_v1 = straddle.payouts.hold("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", reason: "reason")

puts(payout_v1)

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "paykey": "<string>",
    "description": "<string>",
    "amount": "10000",
    "currency": "USD",
    "payment_date": "2023-12-25",
    "device": {
      "ip_address": "192.168.1.1"
    },
    "external_id": "<string>",
    "config": {
      "auto_hold": true,
      "auto_hold_message": "<string>"
    },
    "status": "created",
    "status_details": {
      "message": "Payment successfully created and awaiting validation.",
      "reason": "OK",
      "source": "system",
      "changed_at": "2023-11-07T05:31:56Z",
      "code": null
    },
    "status_history": [
      {
        "message": "Payment successfully created and awaiting validation.",
        "changed_at": "2023-11-07T05:31:56Z",
        "status": "created",
        "code": null
      }
    ],
    "funding_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "trace_ids": {},
    "is_refund": true,
    "is_resubmit": true,
    "has_resubmit": true,
    "payment_rail": "ach",
    "customer_details": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Ron Swanson",
      "email": "[email protected]",
      "phone": "+1234567890"
    },
    "paykey_details": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "label": "Bank of America ****1234",
      "balance": "100.00"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "processed_at": "2023-11-07T05:31:56Z",
    "effective_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "related_payments": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ]
  }
}

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "error": {
    "status": 123,
    "type": "<string>",
    "title": "<string>",
    "detail": "<string>",
    "items": [
      {
        "detail": "<string>",
        "reference": "<string>"
      }
    ]
  }
}

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "error": {
    "status": 123,
    "type": "<string>",
    "title": "<string>",
    "detail": "<string>",
    "items": [
      {
        "detail": "<string>",
        "reference": "<string>"
      }
    ]
  }
}

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "error": {
    "status": 123,
    "type": "<string>",
    "title": "<string>",
    "detail": "<string>",
    "items": [
      {
        "detail": "<string>",
        "reference": "<string>"
      }
    ]
  }
}

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "error": {
    "status": 123,
    "type": "<string>",
    "title": "<string>",
    "detail": "<string>",
    "items": [
      {
        "detail": "<string>",
        "reference": "<string>"
      }
    ]
  }
}

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "error": {
    "status": 123,
    "type": "<string>",
    "title": "<string>",
    "detail": "<string>",
    "items": [
      {
        "detail": "<string>",
        "reference": "<string>"
      }
    ]
  }
}