Querying for pay method tokens

GET 
/api/v3/tokenized

Available query parameter values for filtering:

• customer_id
• customer_external_key
• customer_token

Request

Query Parameters

where string

customer_id:EQUALS:1000

order string

customer_id:ASC

limit string

2

offset string

8

Responses

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object[]

Array [

tokenized_id integer

Tokenized ID #

customer_id integer

Customer ID #

name string

Descriptive name for token (e.g. "Visa x4111")

type string

Type of token (usually "customer")

paymethod_hint string

(Optional) Either "crd" (credit card) or "ach" (ACH/bank accounts)

expdate date

(Optional; only required for First Data/Payeezy) Expiration date (YYYY-MM-DD) of the tokenized credit card

type_hint string

(Optional; only required for First Data/Payeezy) A credit card type (one of "visa", "mast", "disc", or "amex")

token string

The token value

gateway string

(Optional; only required if providing tokens for multiple gateways) A hint for which gateway this is a token for

write_datetime string

Date/time the tokenized payment method was stored

mod_datetime string

Date/time the tokenized payment method was edited

]

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": [
    {
      "tokenized_id": 0,
      "customer_id": 0,
      "name": "string",
      "type": "string",
      "paymethod_hint": "string",
      "expdate": "2024-07-29",
      "type_hint": "string",
      "token": "string",
      "gateway": "string",
      "write_datetime": "string",
      "mod_datetime": "string"
    }
  ]
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "details": {},
  "response": [
    {
      "tokenized_id": 1,
      "type": "customer",
      "name": null,
      "token": "cus_5tSkoQ6mDrXOMQ",
      "expdate": null,
      "type_hint": null,
      "paymethod_hint": null,
      "customer_id": 2
    }
  ]
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

Loading...