Sign in

v33

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-1770249709.0 KB
Charge

Hold a charge

Place a charge on hold to prevent it from being originated for processing. The status of the charge must be created or scheduled.

put/v1/charges/{id}/hold

Path parameters

idstring uuid required

Headers

Straddle-Account-Idstring uuid

For use by platforms to specify an account id and set scope of a request.

Request-Idstring

Optional client generated identifier to trace and debug a request.

Correlation-Idstring

Optional client generated identifier to trace and debug a series of requests.

Idempotency-Keystring

Optional client generated value to use for idempotent requests.

Request body

reasonstring nullable

Details about why the charge status was updated.

Response

OK

response_type'object' | 'array' | 'error' | 'none' 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.

Example response

{
  "data": {
    "description": "Monthly subscription fee",
    "paykey_details": {
      "label": "Bank of America ****1234"
    },
    "customer_details": {
      "name": "Ron Swanson",
      "email": "ron@swanson.com",
      "phone": "+1234567890"
    },
    "amount": 10000,
    "device": {
      "ip_address": "192.168.1.1"
    },
    "status_details": {
      "message": "Payment successfully created and awaiting validation."
    },
    "status_history": [
      {
        "message": "Payment successfully created and awaiting validation."
      }
    ]
  }
}