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

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response object

Example (from schema)

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

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "details": {},
  "response": [
    {
      "creditcard_id": 1,
      "external_key": null,
      "type": "visa",
      "token": "ly1j7wmginqp",
      "expdate": "2023-05-01",
      "write_datetime": "2019-07-25 10:24:52",
      "write_ipaddr": "10.80.1.1",
      "mask_number": "x1111",
      "mask_and_bin_number": "411111xxx1111",
      "name": "John LLC",
      "expdate_month": "5",
      "expdate_year": "2023",
      "expdate_formatted": "May 2023",
      "type_name": "Visa",
      "url_updatelink": "http://dev1.chargeover.test/r/paymethod/i/ru0895x81ht1",
      "address": null,
      "city": null,
      "postcode": null,
      "country": "United States",
      "customer_id": 2
    },
    {
      "creditcard_id": 2,
      "external_key": null,
      "type": "mast",
      "token": "4ei8py0h1x06",
      "expdate": "2022-05-01",
      "write_datetime": "2019-07-25 10:25:37",
      "write_ipaddr": "10.80.1.1",
      "mask_number": "x4444",
      "mask_and_bin_number": "555555xxx4444",
      "name": "John LLC",
      "expdate_month": "5",
      "expdate_year": "2022",
      "expdate_formatted": "May 2022",
      "type_name": "MasterCard",
      "url_updatelink": "http://dev1.chargeover.test/r/paymethod/i/ru0895x81ht1",
      "address": null,
      "city": null,
      "postcode": null,
      "country": "United States",
      "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...