Skip to content
straddle API Docs
Get started
API Reference
Payouts

Upload a proof-of-authorization document for a payout.

payouts.upload_authorization_document(id, **kwargs) -> PayoutV1 { data, meta, response_type }
POST/v1/payouts/{id}/authorization

Uploads a document as proof of authorization for a payout. Uploading again adds another entry to documents rather than replacing the previous one.

ParametersExpand Collapse
id: String
file: FileInput

The document file to upload as proof of authorization for this payout.

correlation_id: String
idempotency_key: String
request_id: String
straddle_account_id: String
ReturnsExpand Collapse
class PayoutV1 { data, meta, response_type }
data: { id, amount, config, 24 more}
id: String

Unique identifier for the payout.

formatuuid
amount: Integer

The amount of the payout in cents.

formatint32
config: { auto_hold, auto_hold_message, sandbox_outcome}

Configuration for the payout.

auto_hold: bool

Defines whether to automatically place this charge on hold after being created.

auto_hold_message: String

The reason the payout is being automatically held on creation.

sandbox_outcome: :standard | :paid | :on_hold_daily_limit | 10 more

Payment will simulate processing if not Standard.

One of the following:
:standard
:paid
:on_hold_daily_limit
:cancelled_for_fraud_risk
:cancelled_for_balance_check
:failed_insufficient_funds
:reversed_insufficient_funds
:failed_customer_dispute
:reversed_customer_dispute
:failed_closed_bank_account
:reversed_closed_bank_account
:failed_not_authorized
:reversed_not_authorized
currency: String

The currency of the payout. Only USD is supported.

description: String

An arbitrary description for the payout.

device: DeviceInfoV1 { ip_address }

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

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.

formatipv4
external_id: String

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

funding_ids: Array[String]

Funding Ids

has_resubmit: bool

Has the payout been resubmitted.

is_refund: bool

Is the payout a refund of an original charge.

is_resubmit: bool

Is the payout a resubmit of an original payout.

paykey: String

Value of the paykey used for the payout.

payment_date: Date

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.

formatdate
status: :created | :scheduled | :failed | 6 more

The current status of the payout.

One of the following:
:created
:scheduled
:failed
:cancelled
:on_hold
:pending
:paid
:reversed
:validating
status_details: StatusDetailsV1 { changed_at, message, reason, 2 more }

Details about the current status of the payout.

changed_at: Time

The time the status change occurred.

formatdate-time
message: String

A human-readable description of the current status.

reason: :insufficient_funds | :closed_bank_account | :invalid_bank_account | 24 more

A machine-readable identifier for the specific status, useful for programmatic handling.

One of the following:
: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
:cancel_request
:failed_verification
:require_review
:blocked_by_system
:watchtower_review
:validating
:auto_hold
source: :watchtower | :bank_decline | :customer_dispute | 2 more

Identifies the origin of the status change (e.g., bank_decline, watchtower). This helps in tracking the cause of status updates.

One of the following:
:watchtower
:bank_decline
:customer_dispute
:user_action
:system
code: String

The status code if applicable.

status_history: Array[{ changed_at, message, reason, 3 more}]

History of the status changes for the payout.

changed_at: Time

The time the status change occurred.

formatdate-time
message: String

A human-readable description of the status.

reason: :insufficient_funds | :closed_bank_account | :invalid_bank_account | 24 more

A machine-readable identifier for the specific status, useful for programmatic handling.

One of the following:
: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
:cancel_request
:failed_verification
:require_review
:blocked_by_system
:watchtower_review
:validating
:auto_hold
source: :watchtower | :bank_decline | :customer_dispute | 2 more

Identifies the origin of the status change (e.g., bank_decline, watchtower). This helps in tracking the cause of status updates.

One of the following:
:watchtower
:bank_decline
:customer_dispute
:user_action
:system
status: :created | :scheduled | :failed | 6 more

The current status of the charge or payout.

One of the following:
:created
:scheduled
:failed
:cancelled
:on_hold
:pending
:paid
:reversed
:validating
code: String

The status code if applicable.

trace_ids: Hash[Symbol, String]

Trace Ids.

created_at: Time

The time the payout was created.

formatdate-time
customer_details: CustomerDetailsV1 { id, customer_type, email, 2 more }

Information about the customer associated with the payout.

id: String

Unique identifier for the customer

formatuuid
customer_type: :individual | :business

The type of customer

One of the following:
:individual
:business
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

documents: Array[{ document_id, document_name, document_size, 2 more}]

Documents uploaded for this payout (e.g. proof of authorization), in the order they were uploaded.

document_id: String

Unique identifier for this document.

formatuuid
document_name: String

The file name of this document as uploaded.

document_size: Integer

The size of this document in bytes.

formatint64
document_type: :payment_authorization
uploaded_at: Time

The UTC timestamp when this document was uploaded.

formatdate-time
effective_at: Time

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

formatdate-time
metadata: Hash[Symbol, String]

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

paykey_details: PaykeyDetailsV1 { id, customer_id, label, balance }

Information about the paykey used for the payout.

id: String

Unique identifier for the paykey.

formatuuid
customer_id: String

Unique identifier for the customer associated with the paykey.

formatuuid
label: String

Human-readable label that combines the bank name and masked account number to help easility represent this paykey in a UI

balance: Integer

The most recent balance of the bank account associated with the paykey in dollars.

formatint32
payment_rail: :ach

The payment rail used for the payout.

processed_at: Time

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

formatdate-time

Related payments.

The ID of the related payment.

formatuuid

The type of payment.

One of the following:
One of the following:
updated_at: Time

The time the payout was last updated.

formatdate-time
meta: ResponseMetadata { api_request_id, api_request_timestamp }

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

api_request_id: String

Unique identifier for this API request, useful for troubleshooting.

formatuuid
api_request_timestamp: Time

Timestamp for this API request, useful for troubleshooting.

formatdate-time
response_type: :object | :array | :error | :none

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.
One of the following:
:object
:array
:error
:none

Upload a proof-of-authorization document for a payout.

require "straddle"

straddle = Straddle::Client.new(
  api_key: "My API Key",
  environment: "production" # defaults to "sandbox"
)

payout_v1 = straddle.payouts.upload_authorization_document(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  file: StringIO.new("Example data")
)

puts(payout_v1)
{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "amount": 10000,
    "config": {
      "auto_hold": true,
      "auto_hold_message": "auto_hold_message",
      "sandbox_outcome": "standard"
    },
    "currency": "currency",
    "description": "description",
    "device": {
      "ip_address": "192.168.1.1"
    },
    "external_id": "external_id",
    "funding_ids": [
      "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    ],
    "has_resubmit": true,
    "is_refund": true,
    "is_resubmit": true,
    "paykey": "paykey",
    "payment_date": "2019-12-27",
    "status": "created",
    "status_details": {
      "changed_at": "2019-12-27T18:11:19.117Z",
      "message": "Payment successfully created and awaiting validation.",
      "reason": "insufficient_funds",
      "source": "system",
      "code": null
    },
    "status_history": [
      {
        "changed_at": "2019-12-27T18:11:19.117Z",
        "message": "Payment successfully created and awaiting validation.",
        "reason": "insufficient_funds",
        "source": "watchtower",
        "status": "created",
        "code": null
      }
    ],
    "trace_ids": {
      "foo": "string"
    },
    "created_at": "2019-12-27T18:11:19.117Z",
    "customer_details": {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "customer_type": "individual",
      "email": "ron@swanson.com",
      "name": "Ron Swanson",
      "phone": "+1234567890"
    },
    "documents": [
      {
        "document_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "document_name": "document_name",
        "document_size": 0,
        "document_type": "payment_authorization",
        "uploaded_at": "2019-12-27T18:11:19.117Z"
      }
    ],
    "effective_at": "2019-12-27T18:11:19.117Z",
    "metadata": {
      "foo": "string"
    },
    "paykey_details": {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "label": "Bank of America ****1234",
      "balance": 0
    },
    "payment_rail": "ach",
    "processed_at": "2019-12-27T18:11:19.117Z",
    "related_payments": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "payment_type": "charge",
        "relationship": "original"
      }
    ],
    "updated_at": "2019-12-27T18:11:19.117Z"
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}
Returns Examples
{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "amount": 10000,
    "config": {
      "auto_hold": true,
      "auto_hold_message": "auto_hold_message",
      "sandbox_outcome": "standard"
    },
    "currency": "currency",
    "description": "description",
    "device": {
      "ip_address": "192.168.1.1"
    },
    "external_id": "external_id",
    "funding_ids": [
      "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    ],
    "has_resubmit": true,
    "is_refund": true,
    "is_resubmit": true,
    "paykey": "paykey",
    "payment_date": "2019-12-27",
    "status": "created",
    "status_details": {
      "changed_at": "2019-12-27T18:11:19.117Z",
      "message": "Payment successfully created and awaiting validation.",
      "reason": "insufficient_funds",
      "source": "system",
      "code": null
    },
    "status_history": [
      {
        "changed_at": "2019-12-27T18:11:19.117Z",
        "message": "Payment successfully created and awaiting validation.",
        "reason": "insufficient_funds",
        "source": "watchtower",
        "status": "created",
        "code": null
      }
    ],
    "trace_ids": {
      "foo": "string"
    },
    "created_at": "2019-12-27T18:11:19.117Z",
    "customer_details": {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "customer_type": "individual",
      "email": "ron@swanson.com",
      "name": "Ron Swanson",
      "phone": "+1234567890"
    },
    "documents": [
      {
        "document_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "document_name": "document_name",
        "document_size": 0,
        "document_type": "payment_authorization",
        "uploaded_at": "2019-12-27T18:11:19.117Z"
      }
    ],
    "effective_at": "2019-12-27T18:11:19.117Z",
    "metadata": {
      "foo": "string"
    },
    "paykey_details": {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "label": "Bank of America ****1234",
      "balance": 0
    },
    "payment_rail": "ach",
    "processed_at": "2019-12-27T18:11:19.117Z",
    "related_payments": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "payment_type": "charge",
        "relationship": "original"
      }
    ],
    "updated_at": "2019-12-27T18:11:19.117Z"
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}