Skip to main content
PATCH
/
setup_requests
/
{setup_request_id}
Update a setup request
curl --request PATCH \
  --url https://api.withacclaim.com/v1/setup_requests/{setup_request_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Updated setup request for customer",
  "payer_id": "pyr_AbC123XyZ",
  "payment_method": {},
  "expires_at": "2025-12-31T23:59:59Z",
  "ip_address": "192.168.1.1",
  "user_agent": "Mozilla/5.0...",
  "metadata": {
    "custom_field": "value",
    "source": "api"
  }
}
'
{
  "id": "trq_XyZ789AbC",
  "status": "RequiresPaymentMethod",
  "payer_id": "pyr_AbC123XyZ",
  "payment_method": {},
  "session_identifier": "trq_XyZ789AbC_abc123...",
  "description": "Tokenize payment method for customer",
  "failure_code": "validation_failed",
  "failure_message": "Payment method validation failed",
  "expires_at": "2025-12-31T23:59:59Z",
  "completed_at": "2025-10-08T18:25:00Z",
  "ip_address": "192.168.1.1",
  "user_agent": "Mozilla/5.0...",
  "metadata": {
    "custom_field": "value",
    "source": "api"
  },
  "created_at": "2025-10-08T18:20:31Z",
  "updated_at": "2025-10-08T18:25:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.withacclaim.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
setup_request_id
string
required

ID of the setup request.

Body

application/json
​
description
string | null

Optional description of the setup request

Maximum string length: 255
Example:

"Updated setup request for customer"

​
payer_id
string | null

ID of the payer to associate with this setup request

Example:

"pyr_AbC123XyZ"

​
payment_method
object

Payment method data (e.g., payment_token, payment_method type)

​
expires_at
string<date-time> | null

When the setup request expires (ISO 8601 date-time string)

Example:

"2025-12-31T23:59:59Z"

​
ip_address
string | null

IP address of the client making the request

Example:

"192.168.1.1"

​
user_agent
string | null

User agent of the client making the request

Example:

"Mozilla/5.0..."

​
metadata
object

Optional metadata as key-value pairs

Example:
{ "custom_field": "value", "source": "api" }

Response

Setup request updated successfully.

​
id
string
Example:

"trq_XyZ789AbC"

​
status
enum<string>

Current status of the setup request

Available options:
RequiresPaymentMethod,
RequiresAction,
Processing,
Succeeded,
Failed,
Canceled
Example:

"RequiresPaymentMethod"

​
payer_id
string | null

ID of the payer associated with this setup request

Example:

"pyr_AbC123XyZ"

​
payment_method
object

Payment method associated with this setup request

​
session_identifier
string

External session identifier for this setup request

Example:

"trq_XyZ789AbC_abc123..."

​
description
string | null

Optional description of the setup request

Example:

"Tokenize payment method for customer"

​
failure_code
string | null

Error code if the setup request failed

Example:

"validation_failed"

​
failure_message
string | null

Human-readable error message if the setup request failed

Example:

"Payment method validation failed"

​
expires_at
string<date-time> | null

When the setup request expires

Example:

"2025-12-31T23:59:59Z"

​
completed_at
string<date-time> | null

When the setup request was completed

Example:

"2025-10-08T18:25:00Z"

​
ip_address
string | null

IP address of the client making the setup request

Example:

"192.168.1.1"

​
user_agent
string | null

User agent string of the client making the setup request

Example:

"Mozilla/5.0..."

​
metadata
object

Optional metadata as key-value pairs

Example:
{ "custom_field": "value", "source": "api" }
​
created_at
string<date-time>
Example:

"2025-10-08T18:20:31Z"

​
updated_at
string<date-time>
Example:

"2025-10-08T18:25:00Z"

Last modified on May 24, 2026