Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
Refund

Creates a Refund resource.

Creates a Refund resource.

post/refunds

Request body

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

accountIdstring
currencystring nullable

Currency the refund was made in

paymentRefstring nullable

Transaction number that appears on email receipts sent for this refund

txnDatestring nullable

The date and time the refund was created

totalAmountinteger

Total amount refunded

balanceinteger nullable
customerIdstring nullable
createdstring date-time nullable

The date and time the refund was created

modifiedstring date-time nullable
srcIdstring

Unique identifier for each refund

reasonstring nullable

Reason for refund

statusstring nullable

Status of refund e.g. "pending" e.g. "succeeded" e.g. "failed"

Example request

{
  "id": "quickbooks-66",
  "integration": "quickbooks",
  "accountId": "35",
  "currency": "USD",
  "paymentRef": "USD",
  "txnDate": "2021-06-24",
  "totalAmount": 8750,
  "customerId": "15",
  "created": "2021-06-24T22:35:07+00:00",
  "modified": "2021-06-24T22:35:07+00:00",
  "srcId": "66",
  "reason": "bad item",
  "status": "succeeded"
}

Response

Refund resource created

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

accountIdstring
currencystring nullable

Currency the refund was made in

paymentRefstring nullable

Transaction number that appears on email receipts sent for this refund

txnDatestring nullable

The date and time the refund was created

totalAmountinteger

Total amount refunded

balanceinteger nullable
customerIdstring nullable
createdstring date-time nullable

The date and time the refund was created

modifiedstring date-time nullable
srcIdstring

Unique identifier for each refund

reasonstring nullable

Reason for refund

statusstring nullable

Status of refund e.g. "pending" e.g. "succeeded" e.g. "failed"

Example response

{
  "id": "quickbooks-66",
  "integration": "quickbooks",
  "accountId": "35",
  "currency": "USD",
  "paymentRef": "USD",
  "txnDate": "2021-06-24",
  "totalAmount": 8750,
  "customerId": "15",
  "created": "2021-06-24T22:35:07+00:00",
  "modified": "2021-06-24T22:35:07+00:00",
  "srcId": "66",
  "reason": "bad item",
  "status": "succeeded"
}