Skip to main content
PUT
/
v1
/
paykeys
/
{id}
/
cancel
cURL
curl --request PUT \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --url https://sandbox.straddle.com/v1/paykeys/<uuid>/cancel \
  --header 'Content-Type: application/json'
{
  "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",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "label": "<string>",
    "source": "bank_account",
    "institution_name": "Bank of America",
    "status": "active",
    "status_details": {
      "message": "Bank account sucesfully validated",
      "reason": "insufficient_funds",
      "source": "watchtower",
      "code": "<string>",
      "changed_at": "2023-11-07T05:31:56Z"
    },
    "expires_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "paykey": "<string>",
    "bank_data": {
      "routing_number": "021000021",
      "account_number": "****1234",
      "account_type": "checking"
    },
    "metadata": {},
    "config": {
      "sandbox_outcome": "standard",
      "processing_method": "inline"
    },
    "balance": {
      "account_balance": 123,
      "updated_at": "2023-11-07T05:31:56Z",
      "status": "pending"
    },
    "external_id": "<string>"
  }
}

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

Path Parameters

​
id
string<uuid>
required

Body

​
reason
string | null

Response

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