Skip to main content
PATCH
/
v1
/
paykeys
/
{id}
/
unblock
cURL
curl --request PATCH \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --url https://sandbox.straddle.com/v1/paykeys/<uuid>/unblock \
  --header 'Content-Type: application/json'
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({message: '<string>'})
};

fetch('https://{environment}.straddle.com/v1/paykeys/{id}/unblock', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
import requests

url = "https://{environment}.straddle.com/v1/paykeys/{id}/unblock"

payload = { "message": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
require 'uri'
require 'net/http'

url = URI("https://{environment}.straddle.com/v1/paykeys/{id}/unblock")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"message\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "label": "<string>",
    "status": "active",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "paykey": "<string>",
    "config": {},
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "institution_name": "Bank of America",
    "status_details": {
      "message": "Bank account sucesfully validated",
      "changed_at": "2023-11-07T05:31:56Z",
      "code": "<string>"
    },
    "expires_at": "2023-11-07T05:31:56Z",
    "bank_data": {
      "routing_number": "021000021",
      "account_number": "****1234"
    },
    "metadata": {},
    "balance": {
      "account_balance": 123,
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "external_id": "<string>",
    "unblock_eligible": true
  }
}
{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "error": {
    "status": 123,
    "type": "<string>",
    "title": "<string>",
    "detail": "<string>",
    "items": [
      {
        "detail": "<string>",
        "reference": "<string>"
      }
    ]
  }
}
{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "error": {
    "status": 123,
    "type": "<string>",
    "title": "<string>",
    "detail": "<string>",
    "items": [
      {
        "detail": "<string>",
        "reference": "<string>"
      }
    ]
  }
}
{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "error": {
    "status": 123,
    "type": "<string>",
    "title": "<string>",
    "detail": "<string>",
    "items": [
      {
        "detail": "<string>",
        "reference": "<string>"
      }
    ]
  }
}
{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "error": {
    "status": 123,
    "type": "<string>",
    "title": "<string>",
    "detail": "<string>",
    "items": [
      {
        "detail": "<string>",
        "reference": "<string>"
      }
    ]
  }
}
{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "error": {
    "status": 123,
    "type": "<string>",
    "title": "<string>",
    "detail": "<string>",
    "items": [
      {
        "detail": "<string>",
        "reference": "<string>"
      }
    ]
  }
}

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

message
string | null

Optional message describing the reason for unblocking.

Response

OK

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