Get a list of pending requests

GET 
/api/v3/_chargeoverjs

Get a list of pending ChargeOver.js requests.

Each object will contain a JSON-encoded payload of data submitted via ChargeOver.js.

Request

Responses

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object[]

Array [

chargeoverjs_id integer

Store ID #

token string

ChargeOver.js token

action string

ChargeOver.js action

payload string

ChargeOver.js payload

]

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": [
    {
      "chargeoverjs_id": 0,
      "token": "string",
      "action": "string",
      "payload": "string"
    }
  ]
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "response": [
    {
      "action": "customer.create",
      "payload": "{\"customer\":{\"company\":\"Test Company, LLC\",\"bill_addr1\":\"56 Cowles Road\",\"bill_addr2\":\"\",\"bill_addr3\":\"\",\"bill_city\":\"Mt Pleasant\",\"bill_state\":\"MI\",\"bill_postcode\":\"48858\",\"bill_country\":\"United States\",\"custom_1\":\"\",\"custom_2\":\"\",\"custom_3\":\"\"},\"user\":{\"name\":\"John Doe\",\"phone\":\"888-924-2347\",\"email\":\"test@ChargeOver.com\"}}",
      "token": "9w5jdiqz1pf7h8ga",
      "chargeoverjs_id": 1
    }
  ]
}

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
}

404

Object not found

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response booleannullable

Example (from schema)

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

Example 1

{
  "code": 404,
  "status": "Error",
  "message": "This object does not exist.",
  "details": {},
  "response": null
}

Loading...