> ## Documentation Index > Fetch the complete documentation index at: https://docs.conductor.is/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a credit card refund > Retrieves a credit card refund by ID. **IMPORTANT:** If you need to fetch multiple specific credit card refunds by ID, use the list endpoint instead with the `ids` parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster. ## OpenAPI ````yaml GET /quickbooks-desktop/credit-card-refunds/{id} openapi: 3.1.0 info: title: Conductor API version: 0.0.1 servers: - url: https://api.conductor.is/v1 security: - BearerAuth: [] paths: /quickbooks-desktop/credit-card-refunds/{id}: get: summary: Retrieve a credit card refund description: >- Retrieves a credit card refund by ID. **IMPORTANT:** If you need to fetch multiple specific credit card refunds by ID, use the list endpoint instead with the `ids` parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster. parameters: - in: path name: id description: >- The QuickBooks-assigned unique identifier of the credit card refund to retrieve. schema: type: string description: >- The QuickBooks-assigned unique identifier of the credit card refund to retrieve. example: 123ABC-1234567890 required: true - in: header name: Conductor-End-User-Id description: The ID of the End-User to receive this request. schema: type: string description: The ID of the End-User to receive this request. example: end_usr_1234567abcdefg x-stainless-naming: typescript: method_argument: conductorEndUserId mcp: method_argument: conductorEndUserId required: true responses: '200': description: Returns the specified credit card refund. headers: Conductor-Request-Id: schema: type: string description: The unique identifier for this API request. example: req_1234567abcdefg required: true content: application/json: schema: $ref: '#/components/schemas/qbd_credit_card_refund' security: - BearerAuth: [] x-codeSamples: - lang: JavaScript source: >- import Conductor from 'conductor-node'; const conductor = new Conductor({ apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted }); const creditCardRefund = await conductor.qbd.creditCardRefunds.retrieve('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg', }); console.log(creditCardRefund.id); - lang: Python source: |- import os from conductor import Conductor conductor = Conductor( api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted ) credit_card_refund = conductor.qbd.credit_card_refunds.retrieve( id="123ABC-1234567890", conductor_end_user_id="end_usr_1234567abcdefg", ) print(credit_card_refund.id) components: schemas: qbd_credit_card_refund: type: object properties: id: type: string description: >- The unique identifier assigned by QuickBooks to this credit card refund. This ID is unique across all transaction types. example: 123ABC-1234567890 objectType: type: string const: qbd_credit_card_refund description: The type of object. This value is always `"qbd_credit_card_refund"`. example: qbd_credit_card_refund createdAt: type: string description: >- 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.000Z' updatedAt: type: string description: >- 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.000Z' revisionNumber: type: string description: >- 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: type: object properties: id: type: - string - 'null' description: >- The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. example: 80000001-1234567890 fullName: type: - string - 'null' description: >- The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false description: >- The customer or customer-job associated with this credit card refund. example: id: 80000001-1234567890 fullName: Acme Corporation refundFromAccount: type: - object - 'null' properties: id: type: - string - 'null' description: >- The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. example: 80000001-1234567890 fullName: type: - string - 'null' description: >- The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false description: >- 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: type: - object - 'null' properties: id: type: - string - 'null' description: >- The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. example: 80000001-1234567890 fullName: type: - string - 'null' description: >- The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false description: >- 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: type: string format: date description: >- The date of this credit card refund, in ISO 8601 format (YYYY-MM-DD). example: '2024-10-01' refNumber: type: - string - 'null' description: >- 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: type: string description: >- The total monetary amount of this credit card refund, represented as a decimal string. example: '1000.00' currency: type: - object - 'null' properties: id: type: - string - 'null' description: >- The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. example: 80000001-1234567890 fullName: type: - string - 'null' description: >- The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false description: >- The credit card refund's currency. For built-in currencies, the name and code are standard ISO 4217 international values. For user-defined currencies, all values are editable. example: id: 80000001-1234567890 fullName: USD exchangeRate: type: - number - 'null' description: >- 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: type: - string - 'null' description: >- 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: oneOf: - $ref: '#/components/schemas/qbd_address' - type: 'null' description: The address that is printed on the credit card refund. paymentMethod: type: - object - 'null' properties: id: type: - string - 'null' description: >- The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. example: 80000001-1234567890 fullName: type: - string - 'null' description: >- The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false description: >- The credit card refund's payment method (e.g., cash, check, credit card). example: id: 80000001-1234567890 fullName: Credit Card memo: type: - string - 'null' description: A memo or note for this credit card refund. example: Refund to customer for duplicate credit card charge creditCardTransaction: oneOf: - $ref: '#/components/schemas/qbd_credit_card_transaction' - type: 'null' description: >- The credit card transaction data for this credit card refund's payment when using QuickBooks Merchant Services (QBMS). externalId: type: - string - 'null' description: >- 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: type: array items: $ref: '#/components/schemas/qbd_credit_transaction' description: The credit transactions refunded by this credit card refund. customFields: type: array items: $ref: '#/components/schemas/qbd_custom_field' description: >- The custom fields for the credit card refund object, added as user-defined data extensions, not included in the standard QuickBooks object. required: - id - objectType - createdAt - updatedAt - revisionNumber - customer - refundFromAccount - receivablesAccount - transactionDate - refNumber - totalAmount - currency - exchangeRate - totalAmountInHomeCurrency - address - paymentMethod - memo - creditCardTransaction - externalId - refundAppliedToTransactions - customFields additionalProperties: false title: The Credit Card Refund object x-conductor-object-type: transaction summary: >- A credit card refund transaction issues money back to a customer's credit card, typically reversing a previously recorded credit card payment. It reduces the customer's outstanding accounts receivable balance and withdraws funds from the specified refund source account (Undeposited Funds by default). Use this when refunding credit card payments rather than creating a credit memo or issuing a cash refund. qbd_address: type: object properties: line1: type: - string - 'null' description: >- The first line of the address (e.g., street, PO Box, or company name). example: Conductor Labs Inc. line2: type: - string - 'null' description: >- The second line of the address, if needed (e.g., apartment, suite, unit, or building). example: 540 Market St. line3: type: - string - 'null' description: The third line of the address, if needed. example: Suite 100 line4: type: - string - 'null' description: The fourth line of the address, if needed. example: '' line5: type: - string - 'null' description: The fifth line of the address, if needed. example: '' city: type: - string - 'null' description: The city, district, suburb, town, or village name of the address. example: San Francisco state: type: - string - 'null' description: The state, county, province, or region name of the address. example: CA postalCode: type: - string - 'null' description: The postal code or ZIP code of the address. example: '94110' country: type: - string - 'null' description: The country name of the address. example: United States note: type: - string - 'null' description: >- A note written at the bottom of the address in the form in which it appears, such as the invoice form. example: Conductor HQ required: - line1 - line2 - line3 - line4 - line5 - city - state - postalCode - country - note additionalProperties: false title: The Address object x-conductor-object-type: nested qbd_credit_card_transaction: type: object properties: request: oneOf: - $ref: '#/components/schemas/qbd_credit_card_transaction_request' - type: 'null' description: >- The transaction request data originally supplied for this credit card transaction when using QuickBooks Merchant Services (QBMS). response: oneOf: - $ref: '#/components/schemas/qbd_credit_card_transaction_response' - type: 'null' description: >- The transaction response data for this credit card transaction when using QuickBooks Merchant Services (QBMS). required: - request - response additionalProperties: false title: The Credit Card Transaction object x-conductor-object-type: nested qbd_credit_transaction: type: object properties: transactionId: type: string description: >- The ID of the credit transaction being refunded by this credit card refund. example: 123ABC-1234567890 transactionType: type: string enum: - ar_refund_credit_card - bill - bill_payment_check - bill_payment_credit_card - build_assembly - charge - check - credit_card_charge - credit_card_credit - credit_memo - deposit - estimate - inventory_adjustment - invoice - item_receipt - journal_entry - liability_adjustment - paycheck - payroll_liability_check - purchase_order - receive_payment - sales_order - sales_receipt - sales_tax_payment_check - transfer - vendor_credit - ytd_adjustment description: The type of transaction for this credit transaction. example: invoice transactionDate: type: - string - 'null' format: date description: >- The date of this credit transaction, in ISO 8601 format (YYYY-MM-DD). example: '2024-10-01' refNumber: type: - string - 'null' description: >- The case-sensitive user-defined reference number for this credit transaction, 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: CREDIT-1234 creditRemaining: type: - string - 'null' description: >- The remaining balance of this credit transaction that has not yet been applied to other transactions or refunded to the customer. Represented as a decimal string. example: '25.11' refundAmount: type: string description: >- The monetary amount to refund from the linked credit transaction within this credit transaction, represented as a decimal string. example: '15.00' creditRemainingInHomeCurrency: type: - string - 'null' description: >- The remaining balance of this credit transaction converted to the home currency of the QuickBooks company file. Represented as a decimal string. example: '25.11' refundAmountInHomeCurrency: type: - string - 'null' description: >- The monetary amount to refund from the linked credit transaction in this credit transaction, converted to the home currency of the QuickBooks company file. Represented as a decimal string. example: '15.00' required: - transactionId - transactionType - transactionDate - refNumber - creditRemaining - refundAmount - creditRemainingInHomeCurrency - refundAmountInHomeCurrency additionalProperties: false title: The Credit Transaction object x-conductor-object-type: nested qbd_custom_field: type: object properties: ownerId: type: string description: >- The identifier of the owner of the custom field, which QuickBooks internally calls a "data extension". For public custom fields visible in the UI, such as those added by the QuickBooks user, this is always "0". For private custom fields that are only visible to the application that created them, this is a valid GUID identifying the owning application. Internally, Conductor always fetches all public custom fields (those with an `ownerId` of "0") for all objects. example: '0' name: type: string description: >- The name of the custom field, unique for the specified `ownerId`. For public custom fields, this name is visible as a label in the QuickBooks UI. example: Customer Rating type: type: string enum: - amount_type - date_time_type - integer_type - percent_type - price_type - quantity_type - string_1024_type - string_255_type description: The data type of this custom field. example: string_1024_type value: type: string description: >- The value of this custom field. The maximum length depends on the field's data type. example: Premium required: - ownerId - name - type - value additionalProperties: false title: The Custom Field object x-conductor-object-type: nested qbd_credit_card_transaction_request: type: object properties: number: type: string description: >- The credit card number. Must be masked with lower case "x" and no dashes. example: xxxxxxxxxxxx1234 expirationMonth: type: number description: The month when the credit card expires. example: 12 expirationYear: type: number description: The year when the credit card expires. example: 2024 name: type: - string - 'null' description: The cardholder's name on the card. example: John Doe address: type: - string - 'null' description: The card's billing address. example: 1234 Main St, Anytown, USA, 12345 postalCode: type: - string - 'null' description: The card's billing address ZIP or postal code. example: '12345' commercialCardCode: type: - string - 'null' description: >- The commercial card code identifies the type of business credit card being used (purchase, corporate, or business) for Visa and Mastercard transactions only. When provided, this code may qualify the transaction for lower processing fees compared to the standard rates that apply when no code is specified. example: corporate transactionMode: type: - string - 'null' enum: - card_not_present - card_present - null description: >- Indicates whether this credit card transaction came from a card swipe (`card_present`) or not (`card_not_present`). example: card_not_present transactionType: type: - string - 'null' enum: - authorization - capture - charge - refund - voice_authorization - null description: >- The QBMS transaction type from which the current transaction data originated. example: charge required: - number - expirationMonth - expirationYear - name - address - postalCode - commercialCardCode - transactionMode - transactionType additionalProperties: false title: The Credit Card Transaction Request object x-conductor-object-type: nested qbd_credit_card_transaction_response: type: object properties: statusCode: type: number description: >- The status code returned in the original QBMS transaction response for this credit card transaction. example: 0 statusMessage: type: string description: >- The status message returned in the original QBMS transaction response for this credit card transaction. example: Success creditCardTransactionId: type: string description: >- The ID returned from the credit card processor for this credit card transaction. example: '1234567890' merchantAccountNumber: type: string description: >- The QBMS account number of the merchant who is running this transaction using the customer's credit card. example: '1234567890' authorizationCode: type: - string - 'null' description: >- The authorization code returned from the credit card processor to indicate that this charge will be paid by the card issuer. example: '1234567890' avsStreetStatus: type: - string - 'null' enum: - fail - not_available - pass - null description: >- Indicates whether the street address supplied in the transaction request matches the customer's address on file at the card issuer. example: pass avsZipStatus: type: - string - 'null' enum: - fail - not_available - pass - null description: >- Indicates whether the customer postal ZIP code supplied in the transaction request matches the customer's postal code recognized at the card issuer. example: pass cardSecurityCodeMatch: type: - string - 'null' enum: - fail - not_available - pass - null description: >- Indicates whether the card security code supplied in the transaction request matches the card security code recognized for that credit card number at the card issuer. example: pass reconBatchId: type: - string - 'null' description: >- An internal ID returned by QuickBooks Merchant Services (QBMS) from the transaction request, needed for the QuickBooks reconciliation feature. example: '1234567890' paymentGroupingCode: type: - number - 'null' description: >- An internal code returned by QuickBooks Merchant Services (QBMS) from the transaction request, needed for the QuickBooks reconciliation feature. example: 2 paymentStatus: type: string enum: - completed - unknown description: >- Indicates whether this credit card transaction is known to have been successfully processed by the card issuer. example: completed transactionAuthorizedAt: type: string description: >- The date and time when the credit card processor authorized this credit card transaction. example: '2024-01-01T12:34:56.000Z' transactionAuthorizationStamp: type: - number - 'null' description: >- An internal value for this credit card transaction, needed for the QuickBooks reconciliation feature. example: 2 clientTransactionId: type: - string - 'null' description: >- A value returned from QBMS transactions for future use by the QuickBooks Reconciliation feature. example: '1234567890' required: - statusCode - statusMessage - creditCardTransactionId - merchantAccountNumber - authorizationCode - avsStreetStatus - avsZipStatus - cardSecurityCodeMatch - reconBatchId - paymentGroupingCode - paymentStatus - transactionAuthorizedAt - transactionAuthorizationStamp - clientTransactionId additionalProperties: false title: The Credit Card Transaction Response object x-conductor-object-type: nested securitySchemes: BearerAuth: type: http scheme: bearer description: >- Your Conductor secret key using Bearer auth (e.g., `"Authorization: Bearer {{YOUR_SECRET_KEY}}"`). ```` Built with [Mintlify](https://mintlify.com).