GET

/payment-methods

curl --request GET \
  --url https://api.sandbox.{gr4vy_id}.gr4vy.app/payment-methods \
  --header 'Authorization: <authorization>'
{
  "items": [
    {
      "approval_target": "any",
      "approval_url": "https://api.example.app.gr4vy.com/payment-methods/ffc88ec9-e1ee-45ba-993d-b5902c3b2a8c/approve",
      "buyer": {
        "billing_details": {
          "address": {
            "city": "London",
            "country": "GB",
            "house_number_or_name": "10",
            "line1": "10 Oxford Street",
            "line2": "New Oxford Court",
            "organization": "Gr4vy",
            "postal_code": "789123",
            "state": "Greater London",
            "state_code": "GB-LND"
          },
          "email_address": "john@example.com",
          "first_name": "John",
          "last_name": "Lunn",
          "phone_number": "+1234567890",
          "tax_id": {
            "kind": "gb.vat",
            "value": "12345678931"
          },
          "type": "billing-details"
        },
        "created_at": "2013-07-16T19:23:00.000+00:00",
        "display_name": "John L.",
        "external_identifier": "user-789123",
        "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
        "merchant_account_id": "default",
        "type": "buyer",
        "updated_at": "2013-07-16T19:23:00.000+00:00"
      },
      "country": "US",
      "created_at": "2013-07-16T19:23:00.000+00:00",
      "currency": "USD",
      "details": {
        "bin": "412345",
        "card_type": "credit"
      },
      "expiration_date": "07/24",
      "external_identifier": "user-789123",
      "has_replacement": "boolean",
      "id": "77a76f7e-d2de-4bbc-ada9-d6a0015e6bd5",
      "label": "john@example.com",
      "last_replaced_at": "2023-07-26T19:23:00.000+00:00",
      "merchant_account_id": "default",
      "method": "card",
      "mode": "card",
      "scheme": "visa",
      "status": "succeeded",
      "type": "payment-method",
      "updated_at": "2013-07-16T19:23:00.000+00:00"
    }
  ],
  "limit": "1",
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "null"
}

This endpoint requires the payment-methods.read scope.

Authorizations

Authorizationheaderrequired
string

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

Query Parameters

buyer_id
string

Filters the results to only the items for which the buyer has an id that matches this value.

buyer_external_identifier
string

Filters the results to only the items for which the buyer has an external_identifier that matches this value.

status
enum<string>

Filters the results to only the payment methods for which the status matches this value.

Available options:
processing,
buyer_approval_required,
succeeded,
failed
limit
Default: "20"
integer

Defines the maximum number of items to return for this request.

cursor
string

A cursor that identifies the page of results to return. This is used to paginate the results of this API.

For the first page of results, this parameter can be left out. For additional pages, use the value returned by the API in the next_cursor field. Similarly the previous_cursor can be used to reverse backwards in the list.

Response

200 - application/json
items
object[]

A list of stored payment methods.

limit
Default: "20"
integer

The limit applied to request. This represents the number of items that are at maximum returned by this request.

next_cursor
string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

previous_cursor
string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.