Skip to main content
POST
cURL

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

amount
integer<int32> | null
required

The refund amount in cents. Must be greater than 0 and no more than the original charge amount.

Example:

5000

description
string | null

Optional reason recorded on the refund payout. Appended to the system-generated description Refund for Charge ID: {id}.

external_id
string | null

Optional unique identifier for this refund, used to correlate with your internal records. Defaults to a new value if not specified.

payment_date
string<date> | null

The date on which to submit the refund for processing. Defaults to today if not specified.

metadata
object | null

Optional key-value pairs for storing additional structured data. Keys and values must be strings.

Response

Created

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