Store a pay method token

POST 
/api/v3/tokenized

Store an already tokenized credit card in ChargeOver.

Request

application/json

Body

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

Responses

201

Object was created successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object

id integer

Example (from schema)

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

Example 1

{
  "code": 201,
  "status": "OK",
  "message": "",
  "details": {},
  "response": {
    "id": 1234
  }
}

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...