Skip to main content
GET
List Payment Methods

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

paymentMethodId
string<uuid>
required

Payment method identifier

Example:

"f1a2b3c4-d5e6-7890-abcd-ef1234567890"

customerId
string<uuid>
required

Customer identifier

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

type
enum<string>
required

Payment method type

Available options:
CASH,
PIX,
CREDIT_CARD,
DEBIT_CARD
Example:

"CREDIT_CARD"

isDefault
boolean
required

Whether this is the default method

Example:

true

createdAt
string<date-time>
required

Created at

Example:

"2026-01-01T00:00:00.000Z"

updatedAt
string<date-time>
required

Updated at

Example:

"2026-01-01T00:00:00.000Z"

externalProvider
string | null

Payment gateway provider

Example:

"in_memory"

externalProviderId
string | null

Identifier in the payment gateway

Example:

"pm_abc123def456"

card
object | null

Card details

createdBy
string<uuid> | null

Created by

Example:

null

updatedBy
string<uuid> | null

Updated by

Example:

null