Skip to main content
GET
C#
This endpoint requires the payment-methods.read or embed scope.

Authorizations

Authorization
string
header
required

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

Headers

x-gr4vy-merchant-account-id
string | null

The ID of the merchant account to use for this request.

Example:

"default"

Query Parameters

buyer_id
string<uuid> | null

The ID of the buyer to query payment methods for.

Example:

"fe26475d-ec3e-4884-9553-f7356683f7f9"

buyer_external_identifier
string | null

The external identifier of the buyer to query payment methods for.

Example:

"buyer-12345"

sort_by

The field to sort the payment methods by.

Allowed value: "last_used_at"
Example:

"last_used_at"

order_by
enum<string>
default:desc

The direction to sort the payment methods in.

Available options:
asc,
desc
Example:

"desc"

country
string | null

The country code to filter payment methods by. This only applies to payment methods with a country value.

Pattern: ^[A-Z]{2}$
Example:

"US"

currency
string | null

The currency code to filter payment methods by. This only applies to payment methods with a currency value.

Pattern: ^[A-Z]{3}$
Example:

"USD"

Response

Successful Response

items
PaymentMethodSummary · object[]
required

A list of items returned for this request.