Skip to main content
POST
/
refunds
cURL
curl  https://api.goshippo.com/refunds/ \
-H "Authorization: ShippoToken <API_TOKEN>" \
-d transaction="4503427478ea45a899e9b54abc4c5803"
{
  "object_created": "2023-11-07T05:31:56Z",
  "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
  "object_owner": "shippotle@shippo.com",
  "object_updated": "2023-11-07T05:31:56Z",
  "status": "SUCCESS",
  "test": true,
  "transaction": "915d94940ea54c3a80cbfa328722f5a1"
}

Documentation Index

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

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

Authorizations

​
Authorization
string
header
default:ShippoToken
required

API key authentication using the ShippoToken scheme. Format: Authorization: ShippoToken <API_TOKEN> Example: Authorization: ShippoToken shippo_live_abc123

Headers

​
SHIPPO-API-VERSION
string
default:2018-02-08

Optional string used to pick a non-default API version to use. See our API version guide.

Example:

"2018-02-08"

Body

application/json

Refund details

​
transaction
string
required
Example:

"915d94940ea54c3a80cbfa328722f5a1"

​
async
boolean
Example:

false

Response

Refund

​
object_created
string<date-time>

Date and time of object creation.

​
object_id
string

Unique identifier of the given object.

Example:

"adcfdddf8ec64b84ad22772bce3ea37a"

​
object_owner
string

Username of the user who created the object.

Example:

"shippotle@shippo.com"

​
object_updated
string<date-time>

Date and time of last object update.

​
status
enum<string>

Indicates the status of the Refund.

Available options:
QUEUED,
PENDING,
SUCCESS,
ERROR
Example:

"SUCCESS"

​
test
boolean

Indicates whether the object has been created in test mode.

​
transaction
string

Object ID of the Transaction to be refunded.

Example:

"915d94940ea54c3a80cbfa328722f5a1"