Sign in

v1

latestOpenAPI 3.1.02026-07-2277219695.0 KB
Refunds

Create a refund

Creates a new refund object.

post/refunds

Headers

SHIPPO-API-VERSIONstring
Example:2018-02-08

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

Request body

asyncboolean
transactionstring required

Example request

{
  "transaction": "915d94940ea54c3a80cbfa328722f5a1"
}

Response

Refund

object_createdstring date-time

Date and time of object creation.

object_idstring

Unique identifier of the given object.

object_ownerstring

Username of the user who created the object.

object_updatedstring date-time

Date and time of last object update.

status'QUEUED' | 'PENDING' | 'SUCCESS' | 'ERROR'

Indicates the status of the Refund.

testboolean

Indicates whether the object has been created in test mode.

transactionstring

Object ID of the Transaction to be refunded.

Example response

{
  "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
  "object_owner": "shippotle@shippo.com",
  "status": "SUCCESS",
  "transaction": "915d94940ea54c3a80cbfa328722f5a1"
}