Charges
Lookup a charge
Update a charge
Create a charge
Hold a charge
Release a charge
Cancel a charge
Get a charge by id.
ModelsExpand Collapse
ChargeV1 = object { data, meta, response_type }
data: object { id, amount, config, 19 more }
id: string
Unique identifier for the charge.
amount: number
The amount of the charge in cents.
config: object { balance_check, sandbox_outcome }
Configuration options for the charge.
balance_check: "required" or "enabled" or "disabled"
Defines whether to check the customer's balance before processing the charge.
sandbox_outcome: optional "standard" or "paid" or "on_hold_daily_limit" or 8 more
Payment will simulate processing if not Standard.
consent_type: "internet" or "signed"
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 for PDF signatures.
created_at: string
Timestamp of when the charge was created.
currency: string
The currency of the charge. Only USD is supported.
description: string
An arbitrary description for the charge.
Information about the device used when the customer authorized the payment.
ip_address: string
The IP address of the device used when the customer authorized the charge or payout. Use 0.0.0.0 to represent an offline consent interaction.
external_id: string
Unique identifier for the charge in your database. This value must be unique across all charges.
funding_ids: array of string
Funding Ids
paykey: string
Value of the paykey used for the charge.
payment_date: string
The desired date on which the payment should be occur. For charges, this means the date you want the customer to be debited on.
status: "created" or "scheduled" or "failed" or 5 more
The current status of the charge.
Additional details about the current status of the charge.
changed_at: string
The time the status change occurred.
message: string
A human-readable description of the current status.
reason: "insufficient_funds" or "closed_bank_account" or "invalid_bank_account" or 17 more
A machine-readable identifier for the specific status, useful for programmatic handling.
source: "watchtower" or "bank_decline" or "customer_dispute" or 2 more
Identifies the origin of the status change (e.g., bank_decline, watchtower). This helps in tracking the cause of status updates.
code: optional string
The status code if applicable.
status_history: array of object { changed_at, message, reason, 3 more }
Status history.
changed_at: string
The time the status change occurred.
message: string
A human-readable description of the status.
reason: "insufficient_funds" or "closed_bank_account" or "invalid_bank_account" or 17 more
A machine-readable identifier for the specific status, useful for programmatic handling.
source: "watchtower" or "bank_decline" or "customer_dispute" or 2 more
Identifies the origin of the status change (e.g., bank_decline, watchtower). This helps in tracking the cause of status updates.
status: "created" or "scheduled" or "failed" or 5 more
The current status of the charge or payout.
code: optional string
The status code if applicable.
updated_at: string
Timestamp of when the charge was last updated.
Information about the customer associated with the charge.
id: string
Unique identifier for the customer
customer_type: "individual" or "business"
The type of customer
email: string
The customer's email address
name: string
The name of the customer
phone: string
The customer's phone number in E.164 format
effective_at: optional string
Timestamp of when the charge was effective in the customer's bank account, otherwise known as the date on which the customer is debited.
metadata: optional map[string]
Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the charge in a structured format.
Information about the paykey used for the charge.
id: string
Unique identifier for the paykey.
customer_id: string
Unique identifier for the customer associated with the paykey.
label: string
Human-readable label that combines the bank name and masked account number to help easility represent this paykey in a UI
balance: optional number
The most recent balance of the bank account associated with the paykey in dollars.
payment_rail: optional "ach"
The payment rail that the charge will be processed through.
processed_at: optional string
Timestamp of when the charge was processed by Straddle and originated to the payment rail.
Metadata about the API request, including an identifier and timestamp.
api_request_id: string
Unique identifier for this API request, useful for troubleshooting.
api_request_timestamp: string
Timestamp for this API request, useful for troubleshooting.
response_type: "object" or "array" or "error" or "none"
Indicates the structure of the returned content.
- "object" means the
datafield contains a single JSON object. - "array" means the
datafield contains an array of objects. - "error" means the
datafield contains an error object with details of the issue. - "none" means no data is returned.