List payment methods for a buyer

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() {};

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

// handle response

{
  "items": [
    {
      "method": "abitab",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "merchant_account_id": "<string>",
      "cit_usage_count": 123,
      "has_replacement": true,
      "usage_count": 123,
      "type": "payment-method",
      "approval_url": "https://gr4vy.app/redirect/12345",
      "country": "US",
      "currency": "USD",
      "details": {
        "bin": "<string>",
        "card_type": "credit",
        "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"
    }
  ]
}

GET

buyers

payment-methods

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() {};

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

// handle response

{
  "items": [
    {
      "method": "abitab",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "merchant_account_id": "<string>",
      "cit_usage_count": 123,
      "has_replacement": true,
      "usage_count": 123,
      "type": "payment-method",
      "approval_url": "https://gr4vy.app/redirect/12345",
      "country": "US",
      "currency": "USD",
      "details": {
        "bin": "<string>",
        "card_type": "credit",
        "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"
    }
  ]
}

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

country

string | null

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

Example:

"US"

currency

string | null

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

Example:

"USD"

Response

Successful Response

items

PaymentMethodSummary · object[]

required

A list of items returned for this request.

Show child attributes

items.method

enum<string>

required

The type of this payment method.

Available options:

abitab,

affirm,

afterpay,

alipay,

alipayhk,

applepay,

arcuspaynetwork,

bacs,

bancontact,

bank,

banked,

bcp,

becs,

bitpay,

blik,

boleto,

boost,

card,

cashapp,

chaseorbital,

clearpay,

click-to-pay,

dana,

dcb,

dlocal,

ebanx,

efecty,

eps,

everydaypay,

gcash,

gem,

gemds,

gift-card,

giropay,

givingblock,

gocardless,

googlepay,

googlepay_pan_only,

gopay,

grabpay,

ideal,

kakaopay,

kcp,

khipu,

klarna,

latitude,

latitudeds,

laybuy,

linepay,

linkaja,

maybankqrpay,

mercadopago,

multibanco,

multipago,

nequi,

netbanking,

network-token,

nupay,

oney_10x,

oney_12x,

oney_3x,

oney_4x,

oney_6x,

ovo,

oxxo,

p24,

pagoefectivo,

payid,

paymaya,

paypal,

paypalpaylater,

payto,

payvalida,

picpay,

pix,

plaid,

pse,

rabbitlinepay,

razorpay,

rapipago,

redpagos,

scalapay,

sepa,

servipag,

shopeepay,

singteldash,

smartpay,

sofort,

spei,

stitch,

stripedd,

stripetoken,

tapi,

tapifintechs,

thaiqr,

touchngo,

truemoney,

trustly,

trustlyeurope,

upi,

venmo,

vipps,

waave,

webpay,

wechat,

yape,

zippay

items.id

string<uuid>

required

The ID for the payment method.

items.merchant_account_id

string

required

The ID of the merchant account this buyer belongs to.

items.cit_usage_count

integer

required

The number of times this payment method has been used in transactions for client initiated transactions.

items.has_replacement

boolean

required

Whether this card has a pending replacement that hasn't been applied yet.

items.usage_count

integer

required

The number of times this payment method has been used in transactions.

items.type

string

default:payment-method

Always payment-method.

Allowed value: "payment-method"

items.approval_url

string | null

The optional URL that the buyer needs to be redirected to to further authorize their payment.

Example:

"https://gr4vy.app/redirect/12345"

items.country

string | null

The 2-letter ISO code of the country this payment method can be used for. If this value is null the payment method may be used in multiple countries.

Example:

"US"

items.currency

string | null

The ISO-4217 currency code that this payment method can be used for. If this value is null the payment method may be used for multiple currencies.

Example:

"USD"

items.details

PaymentMethodDetailsCard · object

Details for credit or debit card payment method.

Show child attributes

items.details.bin

string | null

Required string length: 6 - 8

items.details.card_type

enum<string> | null

Available options:

credit,

debit,

prepaid

items.details.card_issuer_name

string | null

items.expiration_date

string | null

The expiration date for the payment method.

Required string length: 5

Example:

"12/30"

items.fingerprint

string | null

The unique hash derived from the payment method identifier (e.g. card number).

Example:

"a50b85c200ee0795d6fd33a5c66f37a4564f554355c5b46a756aac485dd168a4"

items.label

string | null

A label for the card or the account. For a paypal payment method this is the user's email address. For a card it is the last 4 digits of the card.

Maximum string length: 320

Example:

"1234"

items.last_replaced_at

string<date-time> | null

The date and time when this card was last replaced by the account updater.

Example:

"2013-07-16T19:23:00.000+00:00"

items.mode

enum<string> | null

The mode to use with this payment method.

Available options:

card,

redirect,

applepay,

googlepay,

checkout-session,

click-to-pay,

gift-card,

bank

Example:

"card"

items.scheme

enum<string> | null

The scheme of the card. Only applies to card payments.

Available options:

accel,

amex,

bancontact,

carte-bancaire,

cirrus,

culiance,

dankort,

diners-club,

discover,

eftpos-australia,

elo,

hipercard,

jcb,

maestro,

mastercard,

mir,

nyce,

other,

pulse,

rupay,

star,

uatp,

unionpay,

visa

Example:

"visa"

items.additional_schemes

enum<string>[] | null

Additional schemes of the card besides the primary scheme. Only applies to card payment methods.

Available options:

accel,

amex,

bancontact,

carte-bancaire,

cirrus,

culiance,

dankort,

diners-club,

discover,

eftpos-australia,

elo,

hipercard,

jcb,

maestro,

mastercard,

mir,

nyce,

other,

pulse,

rupay,

star,

uatp,

unionpay,

visa

Example:

["eftpos-australia"]

items.cit_last_used_at

string<date-time> | null

The timestamp when this payment method was last used in a transaction for client initiated transactions.

Example:

"2013-07-16T19:23:00.000+00:00"

items.last_used_at

string<date-time> | null

The timestamp when this payment method was last used in a transaction.

Example:

"2013-07-16T19:23:00.000+00:00"

Delete a gift card

List all payment methods

⌘I

Introduction

Transactions

Buyers

Checkout Sessions

Payment links

Payment options

Payouts

Refunds

Sessions

Settlement records

Disputes

Instruments

Vault

Connections

Errors

Other

List payment methods for a buyer

Authorizations

Headers

Query Parameters

Response