Payment Accounts

List customer payment accounts

View as Markdown
Returns the payment-processor accounts this customer is linked to — the processor's own customer reference, the default payment method Tabs has on record, and whether that processor is your merchant account's default. A customer can be linked on more than one processor at a time, so this always returns a list. It is empty when the customer is not linked anywhere. Filter with `processorType` to ask about one processor, or `onlyDefault=true` for just your merchant account's default processor. Either filter returns the link even if that processor is not finished setting up on your merchant account; the unfiltered list only covers processors that are ready to charge.

Authentication

Authorizationstring
API Key authentication via header

Path parameters

idstringRequired
Customer Id

Query parameters

processorTypeenumOptional

Return only the account on this processor. STRIPE is the only supported value. Omit to return every processor the customer is linked on.

Allowed values:
onlyDefaultbooleanOptional
Return only the account on your merchant account's default processor.

Response

The customer's payment accounts, filtered by the supplied query.
payloadobject
Response payload, will be empty when success is false
successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobjectOptional
json element with any error messages or warnings

Errors

400
Bad Request Error
404
Not Found Error
500
Internal Server Error