Cancel a charge

Cancel a charge to prevent it from being originated for processing. The status of the charge must be created, scheduled, or on_hold.

PUT /v1/charges/{id}/cancel

cURL

cURL

curl --request PUT \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --url https://sandbox.straddle.com/v1/charges/<uuid>/cancel \
  --header 'Content-Type: application/json'

200

{
  "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",
    "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",
      "auto_hold": true,
      "auto_hold_message": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "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",
    "paykey_details": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "label": "Bank of America ****1234",
      "balance": "100.00"
    },
    "customer_details": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Ron Swanson",
      "customer_type": "individual",
      "email": "[e-mail]",
      "phone": "[phone]"
    },
    "processed_at": "2023-11-07T05:31:56Z",
    "effective_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "related_payments": {}
  }
}

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

Path Parameters

id · string<uuid> · required

Body

application/jsontext/jsonapplication/*+json

reason · string | null

Details about why the charge status was updated.

Response

200

text/plain

OK

meta · object · required

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

Show child attributes

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

Show child attributes