Skip to main content
POST
/
v1
/
payouts
cURL
curl --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --url https://sandbox.straddle.com/v1/payouts \
  --header 'Content-Type: application/json' \
  --data '{
  "paykey": "<string>",
  "description": "Vendor invoice payment",
  "amount": "10000",
  "currency": "<string>",
  "payment_date": "2019-12-27",
  "device": {
    "ip_address": "192.168.1.1"
  },
  "external_id": "<string>"
}'
{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "response_type": "object",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "paykey": "<string>",
    "description": "<string>",
    "amount": "10000",
    "currency": "USD",
    "payment_date": "2023-12-25",
    "device": {
      "ip_address": "192.168.1.1"
    },
    "external_id": "<string>",
    "config": {
      "sandbox_outcome": "standard"
    },
    "status": "created",
    "status_details": {
      "message": "Payment successfully created and awaiting validation.",
      "reason": "OK",
      "source": "system",
      "changed_at": "2023-11-07T05:31:56Z",
      "code": null
    },
    "status_history": [
      {
        "reason": "insufficient_funds",
        "source": "watchtower",
        "message": "Payment successfully created and awaiting validation.",
        "changed_at": "2023-11-07T05:31:56Z",
        "status": "created",
        "code": null
      }
    ],
    "funding_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "trace_ids": {},
    "payment_rail": "ach",
    "customer_details": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Ron Swanson",
      "customer_type": "individual",
      "email": "[email protected]",
      "phone": "+1234567890"
    },
    "paykey_details": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "label": "Bank of America ****1234",
      "balance": "100.00"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "processed_at": "2023-11-07T05:31:56Z",
    "effective_at": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}

Authorizations

​
Authorization
string
header
required

Use your Straddle API Key in the Authorization header as Bearer to authorize API requests.

Headers

​
Straddle-Account-Id
string<uuid>

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.

​
Idempotency-Key
string

Optional client generated value to use for idempotent requests.

Required string length: 10 - 40

Body

​
paykey
string
required

Value of the paykey used for the payout.

​
description
string | null
required

An arbitrary description for the payout.

Example:

"Vendor invoice payment"

​
amount
integer<int32>
required

The amount of the payout in cents.

Example:

"10000"

​
currency
string
default:USD
required

The currency of the payout. Only USD is supported.

​
payment_date
string<date>
required

The desired date on which the payout should be occur. For payouts, this means the date you want the funds to be sent from your bank account.

​
device
object
required

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

​
external_id
string
required

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

​
config
object
​
metadata
object

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

Response

Created

​
meta
object
required

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

​
response_type
enum<string>
required

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.
Available options:
object,
array,
error,
none
​
data
object
required