GOgoshippo
Refunds

Create a refund

Changed on

Creates a new refund object.

post/refunds

Request

  • Base URL
    https://api.goshippo.com
  • URL
    https://api.goshippo.com/refunds
  • Auth
    API key in header Authorization

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.

SHIPPO-ACCOUNT-IDstring

Optional. The object ID of a Managed Shippo Account. Platform accounts set this to make the request on behalf of one of their managed accounts. See the Platform accounts 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"
}

Changes