GET
/
quickbooks-desktop
/
credit-card-refunds
/
{id}
JavaScript
import Conductor from 'conductor-node';

const conductor = new Conductor({
  apiKey: 'sk_conductor_...',
});

const creditCardRefund = await conductor.qbd.creditCardRefunds.retrieve('123ABC-1234567890', {
  conductorEndUserId: 'end_usr_1234567abcdefg',
});

console.log(creditCardRefund.id);
{
  "id": "123ABC-1234567890",
  "objectType": "qbd_credit_card_refund",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "customer": {
    "id": "80000001-1234567890",
    "fullName": "Acme Corporation"
  },
  "refundFromAccount": {
    "id": "80000001-1234567890",
    "fullName": "Undeposited Funds"
  },
  "receivablesAccount": {
    "id": "80000001-1234567890",
    "fullName": "Accounts-Receivable"
  },
  "transactionDate": "2024-10-01",
  "refNumber": "REFUND-1234",
  "totalAmount": "1000.00",
  "currency": {
    "id": "80000001-1234567890",
    "fullName": "USD"
  },
  "exchangeRate": 1.2345,
  "totalAmountInHomeCurrency": "1234.56",
  "address": {
    "line1": "Conductor Labs Inc.",
    "line2": "540 Market St.",
    "line3": "Suite 100",
    "line4": "",
    "line5": "",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94110",
    "country": "United States",
    "note": "Conductor HQ"
  },
  "paymentMethod": {
    "id": "80000001-1234567890",
    "fullName": "Credit Card"
  },
  "memo": "Refund to customer for duplicate credit card charge",
  "creditCardTransaction": {
    "request": {
      "number": "xxxxxxxxxxxx1234",
      "expirationMonth": 12,
      "expirationYear": 2024,
      "name": "John Doe",
      "address": "1234 Main St, Anytown, USA, 12345",
      "postalCode": "12345",
      "commercialCardCode": "corporate",
      "transactionMode": "card_not_present",
      "transactionType": "charge"
    },
    "response": {
      "statusCode": 0,
      "statusMessage": "Success",
      "creditCardTransactionId": "1234567890",
      "merchantAccountNumber": "1234567890",
      "authorizationCode": "1234567890",
      "avsStreetStatus": "pass",
      "avsZipStatus": "pass",
      "cardSecurityCodeMatch": "pass",
      "reconBatchId": "1234567890",
      "paymentGroupingCode": 2,
      "paymentStatus": "completed",
      "transactionAuthorizedAt": "2024-01-01T12:34:56Z",
      "transactionAuthorizationStamp": 2,
      "clientTransactionId": "1234567890"
    }
  },
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "refundAppliedToTransactions": [
    {
      "transactionId": "123ABC-1234567890",
      "transactionType": "invoice",
      "transactionDate": "2024-10-01",
      "refNumber": "CREDIT-1234",
      "creditRemaining": "25.11",
      "refundAmount": "15.00",
      "creditRemainingInHomeCurrency": "25.11",
      "refundAmountInHomeCurrency": "15.00"
    }
  ],
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers

​
Conductor-End-User-Id
string
required

The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").

Example:

"end_usr_1234567abcdefg"

Path Parameters

​
id
string
required

The QuickBooks-assigned unique identifier of the credit card refund to retrieve.

Example:

"123ABC-1234567890"

Response

200 - application/json

Returns the specified credit card refund.

​
id
string
required

The unique identifier assigned by QuickBooks to this credit card refund. This ID is unique across all transaction types.

Example:

"123ABC-1234567890"

​
objectType
string
required

The type of object. This value is always "qbd_credit_card_refund".

Allowed value: "qbd_credit_card_refund"
Example:

"qbd_credit_card_refund"

​
createdAt
string
required

The date and time when this credit card refund was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

Example:

"2025-01-01T12:34:56+00:00"

​
updatedAt
string
required

The date and time when this credit card refund was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

Example:

"2025-02-01T12:34:56+00:00"

​
revisionNumber
string
required

The current QuickBooks-assigned revision number of this credit card refund object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

Example:

"1721172183"

​
customer
object
required

The customer or customer-job associated with this credit card refund.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Acme Corporation"
}
​
refundFromAccount
object | null
required

The account providing funds for this credit card refund. This is typically the Undeposited Funds account used to hold customer payments.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Undeposited Funds"
}
​
receivablesAccount
object | null
required

The Accounts-Receivable (A/R) account to which this credit card refund is assigned, used to track the amount owed. If not specified, QuickBooks Desktop will use its default A/R account.

IMPORTANT: If this credit card refund is linked to other transactions, this A/R account must match the receivablesAccount used in all linked transactions. For example, when refunding a credit card payment, the A/R account must match the one used in each linked credit transaction being refunded.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Accounts-Receivable"
}
​
transactionDate
string<date>
required

The date of this credit card refund, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-10-01"

​
refNumber
string | null
required

The case-sensitive user-defined reference number for this credit card refund, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user.

Example:

"REFUND-1234"

​
totalAmount
string
required

The total monetary amount of this credit card refund, represented as a decimal string.

Example:

"1000.00"

​
currency
object | null
required

The credit card refund's currency. For built-in currencies, the name and code are standard international values. For user-defined currencies, all values are editable.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "USD"
}
​
exchangeRate
number | null
required

The market exchange rate between this credit card refund's currency and the home currency in QuickBooks at the time of this transaction. Represented as a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).

Example:

1.2345

​
totalAmountInHomeCurrency
string | null
required

The total monetary amount of this credit card refund converted to the home currency of the QuickBooks company file. Represented as a decimal string.

Example:

"1234.56"

​
address
object | null
required

The address that is printed on the credit card refund.

​
paymentMethod
object | null
required

The credit card refund's payment method (e.g., cash, check, credit card).

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Credit Card"
}
​
memo
string | null
required

A memo or note for this credit card refund.

Example:

"Refund to customer for duplicate credit card charge"

​
creditCardTransaction
object | null
required

The credit card transaction data for this credit card refund's payment when using QuickBooks Merchant Services (QBMS).

​
externalId
string | null
required

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.

Example:

"12345678-abcd-1234-abcd-1234567890ab"

​
refundAppliedToTransactions
The Credit Transaction object · object[]
required

The credit transactions refunded by this credit card refund.

​
customFields
The Custom Field object · object[]
required

The custom fields for the credit card refund object, added as user-defined data extensions, not included in the standard QuickBooks object.