GET
/
quickbooks-desktop
/
payment-methods
import Conductor from 'conductor-node';

const client = new Conductor({
  apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});

async function main() {
  // Automatically fetches more pages as needed.
  for await (const paymentMethod of client.qbd.paymentMethods.list({
    conductorEndUserId: 'end_usr_1234567abcdefg',
  })) {
    console.log(paymentMethod.id);
  }
}

main();
{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/payment-methods",
  "data": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_payment_method",
      "createdAt": "2021-10-01T17:34:56.000Z",
      "updatedAt": "2021-10-01T20:45:30.000Z",
      "revisionNumber": "1721172183",
      "name": "Cash",
      "isActive": true,
      "paymentMethodType": "cash"
    }
  ],
  "nextCursor": "12345678-abcd-abcd-example-1234567890ab",
  "remainingCount": 10,
  "hasMore": true
}

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"

Query Parameters

​
ids
string[]

Filter for specific payment methods by their QuickBooks-assigned unique identifier(s).

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

NOTE: If any of the values you specify in this parameter are not found, the request will return an error.

Example:
["80000001-1234567890"]
​
names
string[]

Filter for specific payment methods by their name(s), case-insensitive. Like id, name is a unique identifier for a payment method.

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

NOTE: If any of the values you specify in this parameter are not found, the request will return an error.

Example:
["Cash"]
​
limit
integer
default:150

The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the cursor parameter. Each response will include a nextCursor value that can be passed to subsequent requests to retrieve the next page of results.

Required range: 1 <= x <= 150
Example:

150

​
cursor
string

The pagination token to fetch the next set of results when paginating with the limit parameter. Do not include this parameter on the first call. Use the nextCursor value returned in the previous response to request subsequent results.

Example:

"12345678-abcd-abcd-example-1234567890ab"

​
status
enum<string>
default:active

Filter for payment methods that are active, inactive, or both.

Available options:
active,
all,
inactive
Example:

"active"

​
updatedAfter
string

Filter for payment methods updated on or after this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 00:00:00 of that day.

Example:

"2021-01-01T12:34:56.000Z"

​
updatedBefore
string

Filter for payment methods updated on or before this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 23:59:59 of that day.

Example:

"2021-02-01T12:34:56.000Z"

​
nameContains
string

Filter for payment methods whose name contains this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameStartsWith or nameEndsWith.

Example:

"ABC"

​
nameStartsWith
string

Filter for payment methods whose name starts with this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameContains or nameEndsWith.

Example:

"ABC"

​
nameEndsWith
string

Filter for payment methods whose name ends with this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameContains or nameStartsWith.

Example:

"ABC"

​
nameFrom
string

Filter for payment methods whose name is alphabetically greater than or equal to this value.

Example:

"A"

​
nameTo
string

Filter for payment methods whose name is alphabetically less than or equal to this value.

Example:

"Z"

​
paymentMethodType
enum<string>

Filter for payment methods of this type.

Available options:
american_express,
cash,
check,
debit_card,
discover,
e_check,
gift_card,
master_card,
other,
other_credit_card,
visa
Example:

"cash"

Response

200 - application/json
Returns a list of payment methods.

The response is of type object.