Skip to main content

Querying for credit cards

GET 
/api/v3/creditcard

Available query parameter values for filtering:

  • creditcard_id
  • customer_id
  • external_key
  • token

Request​

Query Parameters

    where string

    customer_id:EQUALS:1000

    order string

    creditcard_id:ASC

    limit string

    2

    offset string

    8

Responses​

Object was fetched successfully

Schema

    code integer
    status string
    message stringnullable
    details objectnullable

    response

    object[]

  • Array [

    • customer_id integer

    The customer id #

    creditcard_id integer

    The credit card ID #

    external_key string

    Unique external key value

    type string

    Credit card type

    type_name string

    Credit card type user-friendly name

    token string

    Credit card token

    name string

    Name on credit card

    mask_number string

    Last 4 digits of the credit card

    mask_and_bin_number string

    First 6 digits and last 4 digits of the credit card

    expdate string

    Expiration date (in YYYY-MM-DD format)

    expdate_year string

    Expiration year (4-digits, YYYY) (only required if you do not provide expdate)

    expdate_month string

    Expiration month (2-digits, MM) (only required if you do not provide expdate)

    expdate_formatted string

    Expiration date (formatted)

    address string

    Billing street address

    city string

    Billing city

    state string

    Billing state

    postcode string

    Billing postal code

    country string

    Billing country

    url_updatelink string
    write_datetime string

    Date/time the credit card was stored

    write_ipaddr string

    IP address that created the card

    mod_datetime string

    Date/time the credit card was modified

  • ]

Loading...