List payment methods for a buyer

List all the stored payment methods for a specific buyer.

GET /buyers/payment-methods

C#

C#

using Gr4vy;
using Gr4vy.Models.Components;
using Gr4vy.Models.Requests;

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

ListBuyerPaymentMethodsRequest req = new ListBuyerPaymentMethodsRequest() {
    BuyerId = "fe26475d-ec3e-4884-9553-f7356683f7f9",
    BuyerExternalIdentifier = "buyer-12345",
    SortBy = ListBuyerPaymentMethodsSortBy.LastUsedAt,
    Country = "US",
    Currency = "USD",
};

var res = await sdk.Buyers.PaymentMethods.ListAsync(req);

// handle response

200

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "merchant_account_id": "<string>",
      "cit_usage_count": 123,
      "has_replacement": true,
      "usage_count": 123,
      "scheme_transaction_id": "123456789012345",
      "scheme_transaction_id_scheme": "visa",
      "type": "payment-method",
      "approval_url": "https://gr4vy.app/redirect/12345",
      "country": "US",
      "currency": "USD",
      "details": {
        "bin": "<string>",
        "card_issuer_name": "<string>"
      },
      "expiration_date": "12/30",
      "fingerprint": "a50b85c200ee0795d6fd33a5c66f37a4564f554355c5b46a756aac485dd168a4",
      "label": "1234",
      "last_replaced_at": "2013-07-16T19:23:00.000+00:00",
      "mode": "card",
      "scheme": "visa",
      "additional_schemes": [
        "eftpos-australia"
      ],
      "cit_last_used_at": "2013-07-16T19:23:00.000+00:00",
      "last_used_at": "2013-07-16T19:23:00.000+00:00",
      "transaction_link_id": "123456789012345"
    }
  ]
}

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

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 · Sort By · string Sort By · string Sort By · string Sort By · string

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

200

application/json

Successful Response

items · PaymentMethodSummary · object[] · required

A list of items returned for this request.

Show child attributes