Hold a charge

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 | null

Details about why the charge status was updated.

Response

200 - text/plain

data

object

required

data.amount

integer

required

The amount of the charge in cents.

data.config

object

required

Configuration options for the charge.

The channel or mechanism through which the payment was authorized. Use internet for payments made online or through a mobile app and signed for signed agreements where there is a consent form or contract. Use signed_agreement for PDF signatures.

Available options:

internet,

signed

data.currency

string

default:

USD

required

The currency of the charge. Only USD is supported.

data.description

string

required

An arbitrary description for the charge.

data.device

object

required

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

data.external_id

string

required

Unique identifier for the charge in your database. This value must be unique across all charges.

data.id

string

required

Unique identifier for the charge.

data.paykey

string

required

Value of the paykey used for the charge.

data.payment_date

string

required

The desired date on which the payment should be occur. For charges, this means the date you want the customer to be debited on.

data.status

enum<string>

default:

created

required

The current status of the charge.

Available options:

created,

scheduled,

failed,

cancelled,

on_hold,

pending,

paid,

reversed

data.status_details

object

required

Additional details about the current status of the charge.

data.status_history

object[]

required

data.created_at

string | null

Timestamp of when the charge was created.

data.customer_details

object

Information about the customer associated with the charge.

data.effective_at

string | null

Timestamp of when the charge was effective in the customer's bank account, otherwise known as the date on which the customer is debited.

data.metadata

object | null

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

data.paykey_details

object

Information about the paykey used for the charge.

data.payment_rail

enum<string>

The payment rail that the charge will be processed through.

Available options:

ach

data.processed_at

string | null

Timestamp of when the charge was processed by Straddle and originated to the payment rail.

data.updated_at

string | null

Timestamp of when the charge was last updated.

Fundamentals

Customers

Bridge

Paykeys

Charges

Payouts

Funding

Embed

Authorizations

Headers

Path Parameters

Body

Response