PUT /transactions/{id}/refund.json
PUT
/transactions/{id}/refund.json
Path parameters
-
id integer(int64) Required
Numeric ID of the instance
Minimum value is
1
.
Body Required
-
amount number Required
Amount
Default value is
0
. -
baseAmount number | null
Base amount
-
createdAt string(date-time)
Created at
-
createdSource string | null Required
Created source
Values are
manual
orcatchup
. Default value ismanual
. -
dropshipmentId integer(int32) | null
Dropshipment
-
externalId string Required
External
-
fulfillmentId integer(int32) | null
Fulfillment
-
id integer(int32)
Id
-
name string Required
Name
-
processingFee number | null Required
Processing fee
Default value is
0
. -
purchasedAt string(date-time) | null
Purchased at
-
refundAmount number Required
Refund amount
Default value is
0
. -
returnShipmentId integer(int32) | null
Return shipment
-
saleReturnId integer(int32) | null
Sale return
-
shippingIntegrationId integer(int32) | null
Shipping integration
-
shippingRateCacheId integer(int32) | null
Shipping rate cache
-
source string | null Required
Source
Values are
jetti
,shippo
,shippyPro
,shipStation
,postmen
, orshippingIntegration
. Default value isjetti
. -
status string | null Required
Status
Values are
pending
,complete
,error
, orcancelled
. Default value ispending
. -
stripeId string | null
Stripe
-
stripeRefundId string | null
Stripe refund
-
transferId integer(int32) | null
Transfer
-
type string Required
Type
Values are
stripe
,shippo
,postmen
,shippyPro
, orshipStation
. -
updatedAt string(date-time)
Updated at
PUT /transactions/{id}/refund.json
curl \
-X PUT http://api.example.com/v1/transactions/{id}/refund.json \
-H "Content-Type: application/json" \
-d '{"amount":0,"baseAmount":42.0,"createdAt":"2023-05-04T09:42:00+00:00","createdSource":"manual","dropshipmentId":42,"externalId":"string","fulfillmentId":42,"id":42,"name":"string","processingFee":0,"purchasedAt":"2023-05-04T09:42:00+00:00","refundAmount":0,"returnShipmentId":42,"saleReturnId":42,"shippingIntegrationId":42,"shippingRateCacheId":42,"source":"jetti","status":"pending","stripeId":"string","stripeRefundId":"string","transferId":42,"type":"stripe","updatedAt":"2023-05-04T09:42:00+00:00"}'
Request example
{
"amount": 0,
"baseAmount": 42.0,
"createdAt": "2023-05-04T09:42:00+00:00",
"createdSource": "manual",
"dropshipmentId": 42,
"externalId": "string",
"fulfillmentId": 42,
"id": 42,
"name": "string",
"processingFee": 0,
"purchasedAt": "2023-05-04T09:42:00+00:00",
"refundAmount": 0,
"returnShipmentId": 42,
"saleReturnId": 42,
"shippingIntegrationId": 42,
"shippingRateCacheId": 42,
"source": "jetti",
"status": "pending",
"stripeId": "string",
"stripeRefundId": "string",
"transferId": 42,
"type": "stripe",
"updatedAt": "2023-05-04T09:42:00+00:00"
}
Response examples (200)
{
"amount": 0,
"baseAmount": 42.0,
"createdAt": "2023-05-04T09:42:00+00:00",
"createdSource": "manual",
"dropshipmentId": 42,
"externalId": "string",
"fulfillmentId": 42,
"id": 42,
"name": "string",
"processingFee": 0,
"purchasedAt": "2023-05-04T09:42:00+00:00",
"refundAmount": 0,
"returnShipmentId": 42,
"saleReturnId": 42,
"shippingIntegrationId": 42,
"shippingRateCacheId": 42,
"source": "jetti",
"status": "pending",
"stripeId": "string",
"stripeRefundId": "string",
"transferId": 42,
"type": "stripe",
"updatedAt": "2023-05-04T09:42:00+00:00"
}