GET
/
card-details
curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/card-details \
  --header 'Authorization: Bearer <token>'
{
  "type": "card-detail",
  "id": "42424242",
  "card_type": "credit",
  "scheme": "visa",
  "scheme_icon_url": "https://api.sandbox.example.gr4vy.app/assets/card-scheme-definitions/visa.svg",
  "country": "US",
  "required_fields": {
    "first_name": true,
    "last_name": true,
    "email_address": true,
    "phone_number": true,
    "address": {
      "city": true,
      "country": true,
      "postal_code": true,
      "state": true,
      "house_number_or_name": true,
      "line1": true
    },
    "tax_id": true
  }
}

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.

Query Parameters

​
currency
string
required

Filters the results to only the items which support this currency code. A currency is formatted as 3-letter ISO currency code.

Example:

"USD"

​
amount
integer

Used by the Flow engine to filter the results based on the transaction amount.

Example:

500

​
bin
string

The first 8 digits (the BIN) of the card.

Required string length: 8
Example:

"42424242"

​
country
string

Filters the results to only the items which support this country code. A country is formatted as 2-letter ISO country code.

Example:

"US"

​
intent
enum<string>

The intent of the transaction.

Available options:
authorize,
capture
Example:

"capture"

​
is_subsequent_payment
boolean

Used by the Flow engine to filter available options based on the value of the is_subsequent_payment flag.

Example:

true

​
merchant_initiated
boolean

Used by the Flow engine to filter available options based on the value of the merchant_initiated flag.

Example:

true

​
metadata
string

Used by the Flow engine to filter available options based on various client-defined parameters. If present, this must be a string representing a valid JSON dictionary.

Example:

"{\"restricted_items\": \"True\"}"

​
payment_method_id
string

Filters for transactions that have a payment method with an ID that matches exactly with the provided value.

Example:

"46973e9d-88a7-44a6-abfe-be4ff0134ff4"

​
payment_source
enum<string>

Used by the Flow engine to filter available options based on the payment source.

Available options:
ecommerce,
moto,
recurring,
installment,
card_on_file
Example:

"recurring"

Response

200
application/json

Returns information about a card.

Details about a card.