Hold a payout

PUT

payouts

{id}

hold

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

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "response_type": "object",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "paykey": "<string>",
    "description": "<string>",
    "payment_rail": "ach",
    "customer_details": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Ron Swanson",
      "customer_type": "individual",
      "email": "ron@swanson.com",
      "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"
    },
    "amount": "10000",
    "currency": "USD",
    "payment_date": "2023-12-25",
    "device": {
      "ip_address": "192.168.1.1"
    },
    "external_id": "<string>",
    "config": {},
    "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",
    "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": [
      {
        "reason": "insufficient_funds",
        "source": "watchtower",
        "message": "Payment successfully created and awaiting validation.",
        "code": null,
        "changed_at": "2023-11-07T05:31:56Z",
        "status": "created"
      }
    ],
    "metadata": {},
    "funding_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  }
}

Authorizations

Authorization

string

header

required

Use your Straddle API Key in the Authorization header as Bearer <token> to authorize API requests.

Headers

Straddle-Account-Id

string

For use by platforms to specify an account id and set scope of a request.

Request-Id

string

Optional client generated identifier to trace and debug a request.

Correlation-Id

string

Optional client generated identifier to trace and debug a series of requests.

Path Parameters

string

required

Body

reason

string

required

Details about why the payout status was updated.

Response

200

text/plain

meta

object

required

Metadata about the API request, including an identifier and timestamp.

response_type

enum<string>

required

Indicates the structure of the returned content.

"object" means the data field contains a single JSON object.
"array" means the data field contains an array of objects.
"error" means the data field contains an error object with details of the issue.
"none" means no data is returned.

Available options:

object,

array,

error,

none

data

object

required

data.id

string

required

Unique identifier for the payout.

data.paykey

string

required

Value of the paykey used for the payout.

data.description

string

required

An arbitrary description for the payout.

data.amount

integer

required

The amount of the payout in cents.

Example:

"10000"

data.currency

string

default:USD

required

The currency of the payout. Only USD is supported.

data.payment_date

string

required

The desired date on which the payment should be occur. For payouts, this means the date you want the funds to be sent from your bank account.

data.device

object

required

Information about the device used when the customer authorized the payout.

data.external_id

string

required

Unique identifier for the payout in your database. This value must be unique across all payouts.

data.config

object

required

Configuration for the payout.

data.status

enum<string>

default:created

required

The current status of the payout.

Available options:

created,

scheduled,

failed,

cancelled,

on_hold,

pending,

paid,

reversed

data.status_details

object

required

Details about the current status of the payout.

data.status_history

object[]

required

History of the status changes for the payout.

data.funding_ids

string[]

required

Funding Ids

data.payment_rail

enum<string>

The payment rail used for the payout.

Available options:

ach

data.customer_details

object

Information about the customer associated with the payout.

data.paykey_details

object

Information about the paykey used for the payout.

data.created_at

string | null

The time the payout was created.

data.updated_at

string | null

The time the payout was last updated.

data.processed_at

string | null

The time the payout was processed by Straddle and originated to the payment rail.

data.effective_at

string | null

The actual date on which the payment occurred. For payouts, this is the date the funds were sent from your bank account.

data.metadata

object | null

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the payout in a structured format.

Suggest edits Raise issue

Lookup a payout

Release a payout

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

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "response_type": "object",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "paykey": "<string>",
    "description": "<string>",
    "payment_rail": "ach",
    "customer_details": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Ron Swanson",
      "customer_type": "individual",
      "email": "ron@swanson.com",
      "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"
    },
    "amount": "10000",
    "currency": "USD",
    "payment_date": "2023-12-25",
    "device": {
      "ip_address": "192.168.1.1"
    },
    "external_id": "<string>",
    "config": {},
    "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",
    "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": [
      {
        "reason": "insufficient_funds",
        "source": "watchtower",
        "message": "Payment successfully created and awaiting validation.",
        "code": null,
        "changed_at": "2023-11-07T05:31:56Z",
        "status": "created"
      }
    ],
    "metadata": {},
    "funding_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  }
}

Fundamentals

SDKs

Customers

Bridge

Paykeys

Charges

Payouts

Funding

Payments

Embed

Authorizations

Headers

Path Parameters

Body

Response