Sign in
Setup API

List

Retrieve a paginated list of Setup API records. Supports filtering, sorting, and search.

get/api/cp/setup/api

Query parameters

typestring

Filter by Type

mode'sandbox' | 'live' | 'dev' | 'test'

Filter by Mode

Response

Successful response

idinteger

Id

account_idinteger

Account Id (references account.id)

typestring

Type

mode'sandbox' | 'live' | 'dev' | 'test'

Mode

emailstring email

Email

hoststring

Host

usernamestring

Username

passwordstring password

Password

signaturestring

Signature

api_idinteger

Api Id

public_keystring

Public Key

private_keystring

Private Key

key1string

Key 1

key2string

Key 2

key3string

Key 3

key4string

Key 4

currencystring

Currency

verify_transactioninteger

Verify Transaction

payment_typesstring

Payment Types

company_idinteger

Company Id

sandbox_idinteger

Sandbox Id

deduct_payment_feesinteger

Deduct Payment Fees

surchargenumber

Surcharge

surcharge_percentnumber

Surcharge Percent

Example response

[
  {
    "id": 12345,
    "account_id": 1,
    "type": "example_type",
    "mode": "sandbox",
    "email": "user@example.com",
    "host": "example_host",
    "username": "john_doe",
    "password": "********",
    "signature": "Sample signature text content",
    "api_id": 1,
    "public_key": "example_public_key",
    "private_key": "example_private_key",
    "key1": "example_key1",
    "key2": "example_key2",
    "key3": "example_key3",
    "key4": "example_key4",
    "currency": "USD",
    "verify_transaction": 1,
    "payment_types": "example_payment_types",
    "company_id": 1,
    "sandbox_id": 1,
    "deduct_payment_fees": 1,
    "surcharge": 99.99,
    "surcharge_percent": 1.5
  }
]

Changes