GET
/
buyers
/
payment-methods
curl --request GET \
  --url https://api.{id}.gr4vy.app/buyers/payment-methods \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "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",
      "method": "card",
      "mode": "card",
      "scheme": "visa",
      "id": "ef9496d8-53a5-4aad-8ca2-00eb68334389",
      "merchant_account_id": "default",
      "additional_schemes": [
        "eftpos-australia"
      ],
      "cit_last_used_at": "2013-07-16T19:23:00.000+00:00",
      "cit_usage_count": 50,
      "has_replacement": false,
      "last_used_at": "2013-07-16T19:23:00.000+00:00",
      "usage_count": 100
    }
  ]
}

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.

Examples:

"default"

Query Parameters

​
buyer_id
string | null

The ID of the buyer to query payment methods for.

Examples:

"fe26475d-ec3e-4884-9553-f7356683f7f9"

​
buyer_external_identifier
string | null

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

Examples:

"buyer-12345"

​
sort_by

The field to sort the payment methods by.

Allowed value: "last_used_at"
Examples:

"last_used_at"

​
order_by
enum<string>
default:desc

The direction to sort the payment methods in.

Available options:
asc,
desc
Examples:

"desc"

​
country
string | null

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

Examples:

"US"

​
currency
string | null

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

Examples:

"USD"

Response

200
application/json
Successful Response

The response is of type object.