getCard

Circle Mint

Core Functionality

Balances

Payouts

Wires

CBIT

PIX

Transfers

Addresses

Deposits

Accounts API

Wallets

Transfers

API Overview

Health

Management

Encryption

Subscriptions

Stablecoins

Channels

Payments API

Payments

Pull Crypto Payments

Crypto Payment Intents

Cards

Payment Tokens

Settlements

Chargebacks

Balances

Checkout Sessions

Payouts API

Payouts

Crypto Address Book

Crypto Exchange Rates

Get a card

GEThttps://api.circle.com/v1/cards/{id}

Path parameters

uuid

Required

Universally unique identifier (UUID v4) of a resource.

Response

200GetCardResponse

Response Body

object

data

object

Show 17 properties

string

Required

Unique system generated identifier for the entity.

status

string

Required

Status of the account. A pending status indicates that the linking is in-progress; complete indicates the account was linked successfully; failed indicates it failed.

billingDetails

object

Required

Show 7 properties

name

string

Required

Full name of the card or bank account holder.

city

string

Required

City portion of the address.

country

string

Required

Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.

line1

string

Required

Line one of the street address.

line2

string

Line two of the street address.

district

string

State / County / Province / Region portion of the address. If the country is US or Canada, then district is required and should use the two-letter code for the subdivision.

postalCode

string

Required

Postal / ZIP code of the address.

expMonth

integer

Required

Two digit number representing the card's expiration month.

expYear

integer

Required

Four digit number representing the card's expiration year.

network

string

Required

The network of the card.

last4

string

Required

The last 4 digits of the card.

bin

string

The bank identification number (BIN), the first 6 digits of the card.

issuerCountry

string

The country code of the issuer bank. Follows the ISO 3166-1 alpha-2 standard.

fundingType

string

The funding type of the card. Possible values are credit, debit, prepaid, and unknown.

fingerprint

string

Required

A UUID that uniquely identifies the account number. If the same account is used more than once, each card object will have a different id, but the fingerprint will stay the same.

errorCode

string

Indicates the failure reason of the card verification. Only present on cards with failed verification. Possible values are [verification_failed, verification_fraud_detected, verification_denied, verification_not_supported_by_issuer, verification_stopped_by_issuer, card_failed, card_invalid, card_address_mismatch, card_zip_mismatch, card_cvv_invalid, card_expired, card_limit_violated, card_not_honored, card_cvv_required, credit_card_not_allowed, card_account_ineligible, card_network_unsupported]'

verification

object

Required

Indicates the status of the card for verification purposes.

Show 2 properties

avs

string

Required

Status of the AVS check. Raw AVS response, expressed as an upper-case letter. not_requested indicates check was not made. pending is pending/processing.

cvv

string

Required

Enumerated status of the check. not_requested indicates check was not made. pass indicates value is correct. fail indicates value is incorrect. unavailable indicates card issuer did not do the provided check. pending indicates check is pending/processing.

riskEvaluation

object

Results of risk evaluation. Only present if the payment is denied by Circle's risk service.

Show 2 properties

metadata

object

Required

Show 2 properties

createDate

string

Required

ISO-8601 UTC date/time format.

updateDate

string

Required

ISO-8601 UTC date/time format.

401NotAuthorized

404NotFound

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
4    "status": "pending",
5    "billingDetails": {
6      "name": "Satoshi Nakamoto",
7      "city": "Boston",
8      "country": "US",
9      "line1": "100 Money Street",
10      "line2": "Suite 1",
11      "district": "MA",
12      "postalCode": "01234"
13    },
14    "expMonth": 1,
15    "expYear": 2020,
16    "network": "VISA",
17    "last4": "0123",
18    "bin": "401230",
19    "issuerCountry": "US",
20    "fundingType": "credit",
21    "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2",
22    "errorCode": "verification_failed",
23    "verification": {
24      "avs": "D",
25      "cvv": "not_requested"
26    },
27    "riskEvaluation": {
28      "decision": "approved",
29      "reason": "3000"
30    },
31    "metadata": {
32      "email": "[email protected]",
33      "phoneNumber": "+14155555555"
34    },
35    "createDate": "2020-04-10T02:13:30.000Z",
36    "updateDate": "2020-04-10T02:13:30.000Z"
37  }
38}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy