Fundamentals
Customers
Charges
Payouts
Embed
- Organizations
- Accounts
- Representatives
- Linked Bank Accounts
- Capability Requests
Lookup a charge
Use this endpoint to retrieve a charge by its unique id
.
Authorizations
Use your Straddle API Key in the Authorization header as Bearer <token> to authorize API requests.
Headers
For use by platforms to specify an account id and set scope of a request.
Optional client generated identifier to trace and debug a request.
Optional client generated identifier to trace and debug a series of requests.
Path Parameters
Response
The amount of the charge in cents.
Configuration options for the charge.
Defines whether to check the customer's balance before processing the charge.
required
, enabled
, disabled
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.
internet
, signed
The currency of the charge. Only USD is supported.
An arbitrary description for the charge.
Information about the device used when the customer authorized the payment.
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.
Unique identifier for the charge in your database. This value must be unique across all charges.
Unique identifier for the charge.
Value of the paykey
used for the charge.
The desired date on which the payment should be occur. For charges, this means the date you want the customer to be debited on.
The current status of the charge.
created
, scheduled
, failed
, cancelled
, on_hold
, pending
, paid
, reversed
Additional details about the current status of the charge.
The time the status change occurred.
A human-readable description of the current status.
A machine-readable identifier for the specific status, useful for programmatic handling.
insufficient_funds
, closed_bank_account
, invalid_bank_account
, invalid_routing
, disputed
, payment_stopped
, owner_deceased
, frozen_bank_account
, risk_review
, fraudulent
, duplicate_entry
, invalid_paykey
, payment_blocked
, amount_too_large
, too_many_attempts
, internal_system_error
, user_request
, ok
, other_network_return
, payout_refused
Identifies the origin of the status change (e.g., bank_decline
, watchtower
). This helps in tracking the cause of status updates.
watchtower
, bank_decline
, customer_dispute
, user_action
, system
The time the status change occurred.
A human-readable description of the status.
A machine-readable identifier for the specific status, useful for programmatic handling.
insufficient_funds
, closed_bank_account
, invalid_bank_account
, invalid_routing
, disputed
, payment_stopped
, owner_deceased
, frozen_bank_account
, risk_review
, fraudulent
, duplicate_entry
, invalid_paykey
, payment_blocked
, amount_too_large
, too_many_attempts
, internal_system_error
, user_request
, ok
, other_network_return
, payout_refused
Identifies the origin of the status change (e.g., bank_decline
, watchtower
). This helps in tracking the cause of status updates.
watchtower
, bank_decline
, customer_dispute
, user_action
, system
The current status of the charge
or payout
.
created
, scheduled
, failed
, cancelled
, on_hold
, pending
, paid
, reversed
The status code if applicable.
Timestamp of when the charge was created.
Information about the customer associated with the charge.
Timestamp of when the charge was effective in the customer's bank account, otherwise known as the date on which the customer is debited.
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.
Unique identifier for the customer associated with the paykey.
Unique identifier for the paykey.
Human-readable label used to represent this paykey in a UI.
The most recent balance of the bank account associated with the paykey in dollars.
The payment rail that the charge will be processed through.
ach
Timestamp of when the charge was processed by Straddle and originated to the payment rail.
Timestamp of when the charge was last updated.
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.
object
, array
, error
, none