Get card details

Gets details about a particular card based on the BIN. Use the currency, amount, and other fields to apply any Flow rules that may put requirements on the card.

GET /card-details

Get card details

C#

using RestSharp;


var options = new RestClientOptions("https://api.sandbox.{id}.gr4vy.app/card-details");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

200

{
  "type": "card-detail",
  "id": "123456",
  "card_type": "credit",
  "scheme": "visa",
  "additional_schemes": [
    "eftpos-australia"
  ],
  "additional_schemes_details": [
    {
      "icon_url": "https://cdn.example.gr4vy.app/assets/icons/card-schemes/eftpos-australia.svg",
      "scheme": "eftpos-australia"
    }
  ],
  "scheme_icon_url": "https://cdn.example.gr4vy.app/assets/icons/card-schemes/mastercard.svg",
  "country": "US",
  "required_fields": {
    "address": {
      "postal_code": true
    },
    "cvv": true
  }
}

Retrieves details about a card using card’s BIN or a stored payment_method_id. This endpoint requires the 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

currency · string · required

The three-letter ISO currency code.

Example:

"USD"

bin · string | null

The bank identification number (BIN) of the card.

Required string length: 6 - 8

Pattern: ^\d+$

Example:

"411111"

payment_method_id · string<uuid> | null

The ID of the payment method to check, instead of the bin.

Example:

"123e4567-e89b-12d3-a456-426614174000"

country · string | null

The two-letter ISO country code.

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

Example:

"US"

amount · integer | null

The payment amount in the smallest currency unit.

Example:

1299

intent · string | null · default: authorize

The transaction intent.

Example:

"authorize"

is_subsequent_payment · boolean | null

Whether this is a subsequent payment.

Example:

false

merchant_initiated · boolean | null

Whether the transaction is merchant-initiated

Example:

false

metadata · string | null

Additional metadata for the transaction in JSON format

Example:

"{\"source\": \"web\"}"

payment_source · string | null

The source of the transaction payment The way payment method information made it to this transaction.

Example:

"web"

Response

200

application/json

Successful Response

type · string · default: card-detail

Always card-detail.

Allowed value: "card-detail"

Example:

"card-detail"

id · string | null

The Bank Identification Number (BIN) of the card.

Required string length: 6 - 8

Pattern: ^\d+$

Example:

"123456"

card_type · string | null

The type of the card.

Example:

"credit"

scheme · string | null

The card scheme/network.

Example:

"visa"

additional_schemes · string[] | null

Additional schemes of the card besides the primary scheme.

Example:

["eftpos-australia"]

additional_schemes_details · AdditionalSchemeDetail · object[] | null

Per-scheme details (name and icon URL) for each additional scheme. Mirrors additional_schemes — null when additional_schemes is null.

Show child attributes

Example:

[
  {
    "icon_url": "https://cdn.example.gr4vy.app/assets/icons/card-schemes/eftpos-australia.svg",
    "scheme": "eftpos-australia"
  }
]

scheme_icon_url · string | null

URL to the card scheme's icon.

Example:

"https://cdn.example.gr4vy.app/assets/icons/card-schemes/mastercard.svg"

country · string | null

The country code associated with the card.

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

Example:

"US"

required_fields · RequiredFields · object

Fields that are required for this card type.

Show child attributes

Example:

{
  "address": { "postal_code": true },
  "cvv": true
}