Hold a payout

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

data

object

required

data.amount

integer

required

The amount of the payout in cents.

data.currency

string

default:

USD

required

The currency of the payout. Only USD is supported.

data.description

string

required

An arbitrary description for the payout.

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.id

string

required

Unique identifier for the payout.

data.paykey

string

required

Value of the paykey used for the payout.

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.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.config

object

Configuration for the payout.

data.created_at

string | null

The time the payout was created.

data.customer_details

object

Information about the customer associated with the payout.

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.

data.paykey_details

object

Information about the paykey used for the payout.

data.payment_rail

enum<string>

The payment rail used for the payout.

Available options:

ach

data.processed_at

string | null

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

data.updated_at

string | null

The time the payout was last updated.

Fundamentals

Customers

Bridge

Paykeys

Charges

Payouts

Funding

Embed

Authorizations

Headers

Path Parameters

Body

Response