Skip to main content
POST
/
v1
/
charges
cURL
curl --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --url https://sandbox.straddle.com/v1/charges \
  --header 'Content-Type: application/json' \
  --data '{
  "paykey": "<string>",
  "description": "Monthly subscription fee",
  "amount": "10000",
  "currency": "<string>",
  "payment_date": "2019-12-27",
  "consent_type": "internet",
  "device": {
    "ip_address": "192.168.1.1"
  },
  "external_id": "<string>",
  "config": {
    "balance_check": "required"
  }
}'
{
  "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": "Monthly subscription fee",
    "payment_rail": "ach",
    "paykey_details": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "label": "Bank of America ****1234",
      "balance": 123
    },
    "customer_details": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Ron Swanson",
      "customer_type": "individual",
      "email": "ron@swanson.com",
      "phone": "+1234567890"
    },
    "amount": 10000,
    "currency": "USD",
    "payment_date": "2023-12-25",
    "consent_type": "internet",
    "device": {
      "ip_address": "192.168.1.1"
    },
    "external_id": "<string>",
    "config": {
      "balance_check": "enabled",
      "sandbox_outcome": "standard"
    },
    "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",
    "status": "created",
    "status_details": {
      "message": "Payment successfully created and awaiting validation.",
      "reason": "insufficient_funds",
      "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.",
        "code": null,
        "changed_at": "2023-11-07T05:31:56Z",
        "status": "created"
      }
    ],
    "metadata": {},
    "funding_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  }
}
In ACH terminology, Straddle charges are ACH debit transactions that pull money from customer bank accounts. Learn more about ACH debits and authorization requirements to ensure compliant payment collection.

Authorizations

​
Authorization
string
header
required

Headers

​
Straddle-Account-Id
string<uuid>
​
Request-Id
string
​
Correlation-Id
string
​
Idempotency-Key
string
Required string length: 10 - 40

Body

​
paykey
string
required
​
description
string
required
Example:
​
amount
integer
required
Example:
​
currency
string
default:USD
required
​
payment_date
string<date>
required
​
consent_type
enum<string>
required
Available options:
internet,
signed
​
device
object
required
​
external_id
string
required
​
config
object
required
​
metadata
object | null

Response

​
meta
object
required
​
response_type
enum<string>
required
Available options:
object,
array,
error,
none
​
data
object
required