Equotix One API
  1. Payment Method
Equotix One API
  • Getting Started
    • Introduction
    • Authentication
    • API Example
    • Rate Limits
    • API Terms of Use
  • Extension
    • Dashboard
      • Announcement
        • extension/dashboard/announcement/get
    • Module
      • Invoice Copy
        • extension/module/invoice/get
    • Report
      • Channel Payout
        • extension/report/channel_payout/get
    • Total
      • Promotion
        • extension/total/promotion/get
        • extension/total/promotion/getCategory
        • extension/total/promotion/getHistory
      • Tax
        • extension/module/tax/get
  • Integration
    • Channel
      • integration/channel/get
    • Extension
      • integration/extension/get
    • Profile
      • integration/profile/get
  • Inventory
    • Addition
      • inventory/addition/add
      • inventory/addition/edit
      • inventory/addition/delete
      • inventory/addition/get
    • Brand
      • inventory/brand/add
      • inventory/brand/edit
      • inventory/brand/delete
      • inventory/brand/get
    • Category
      • inventory/category/add
      • inventory/category/edit
      • inventory/category/delete
      • inventory/category/get
    • Deduction
      • inventory/deduction/add
      • inventory/deduction/edit
      • inventory/deduction/delete
      • inventory/deduction/get
    • Flow
      • inventory/flow/get
    • Item
      • inventory/item/add
      • inventory/item/edit
      • inventory/item/delete
      • inventory/item/get
      • inventory/item/editStock
    • Location
      • inventory/location/add
      • inventory/location/edit
      • inventory/location/delete
      • inventory/location/get
    • Purchase Order
      • inventory/purchase_order/add
      • inventory/purchase_order/edit
      • inventory/purchase_order/delete
      • inventory/purchase_order/get
    • Reservation
      • inventory/reservation/add
      • inventory/reservation/edit
      • inventory/reservation/delete
      • inventory/reservation/get
    • Stock Take Job
      • inventory/stock_take_job/get
    • Supplier
      • inventory/supplier/add
      • inventory/supplier/edit
      • inventory/supplier/delete
      • inventory/supplier/get
    • Transfer Job
      • inventory/transfer_job/get
    • Transfer
      • inventory/transfer/add
      • inventory/transfer/edit
      • inventory/transfer/delete
      • inventory/transfer/get
  • Sale
    • Credit Note
      • sale/credit_note/add
      • sale/credit_note/edit
      • sale/credit_note/delete
      • sale/credit_note/get
      • sale/credit_note/getHistory
      • sale/credit_note/addHistory
    • Customer Group
      • sale/customer_group/add
      • sale/customer_group/edit
      • sale/customer_group/delete
      • sale/customer_group/get
    • Customer
      • sale/customer/add
      • sale/customer/edit
      • sale/customer/delete
      • sale/customer/get
      • sale/customer/addReward
      • sale/customer/getReward
    • Order
      • sale/order/add
      • sale/order/edit
      • sale/order/delete
      • sale/order/get
      • sale/order/getHistory
      • sale/order/addHistory
  • Setting
    • Channel Group
      • setting/channel_group/add
      • setting/channel_group/edit
      • setting/channel_group/delete
      • setting/channel_group/get
    • Company
      • setting/company/get
    • Credit Note Status
      • setting/credit_note_status/add
      • setting/credit_note_status/edit
      • setting/credit_note_status/delete
      • setting/credit_note_status/get
    • Currency
      • setting/currency/get
    • Language
      • setting/language/get
    • Order Status
      • setting/order_status/add
      • setting/order_status/edit
      • setting/order_status/delete
      • setting/order_status/get
    • Payment Method
      • setting/payment_method/add
        POST
      • setting/payment_method/edit
        POST
      • setting/payment_method/delete
        POST
      • setting/payment_method/get
        POST
    • User Group
      • setting/user_group/get
    • User
      • setting/user/get
  1. Payment Method

setting/payment_method/get

POST
/setting/payment_method/get
This returns the list of payment methods available in the Equotix One account.

Request

Body Params application/json
domain
string 
required
The domain you are assigned to authenticate your Equotix One account.
api_key
string 
required
The email address assigned to the user account in your Equotix One.
auth_timestamp
integer 
required
The unix timestamp used to sign this API request.
auth_signature
string 
required
The calculated signature for this API request.
payment_method_id
integer 
optional
The payment method ID to search for specifically.
filter_date_modified
string 
optional
Filter the list of payment methods modified after the spcified date.
filter_deleted
boolean 
optional
Filter the list of payment methods to include deleted records.
filter_channel_group_id
string 
optional
Filter the list of payment methods by channel group ID, comma separated values.
page
integer 
optional
Page number of the results.
sort
string 
optional
The key for the ordering of the results. Accepts "name", "sort_order", "date_modified"
order
string 
optional
The direction for the ordering of the results. Accepts "ASC", "DESC"
limit
integer 
optional
The number of results per page. Accepts 1 to 100.
Example
{
  "domain": "string",
  "api_key": "string",
  "auth_timestamp": 0,
  "auth_signature": "string",
  "payment_method_id": 0,
  "filter_date_modified": "string",
  "filter_deleted": true,
  "filter_channel_group_id": "string",
  "page": 0,
  "sort": "string",
  "order": "string",
  "limit": 0
}

Responses

🟢200Success
application/json
Body
error
array[string]
optional
Returns only if there is an error.
total
integer 
optional
The total number of results available.
payment_methods
array [object {9}] 
optional
The list of payment methods.
payment_method_id
integer 
required
The payment method ID.
channel_group_id
integer 
required
The channel group ID assigned to the payment method.
name
string 
required
The payment method name.
order_status_id
integer 
required
The payment method default order status ID.
credit_note_status_id
integer 
required
The payment method default credit note status ID.
configuration
object 
required
The payment method additional configuration key-value pair.
sort_order
integer 
required
The payment method sort order.
date_modified
string 
required
The date time this payment method was last modified.
deleted
boolean 
optional
Indicates if the payment method has been deleted. Only returned if filter_deleted is "1".
Example
{
  "error": [
    "string"
  ],
  "total": 0,
  "payment_methods": [
    {
      "payment_method_id": 0,
      "channel_group_id": 0,
      "name": "string",
      "order_status_id": 0,
      "credit_note_status_id": 0,
      "configuration": {},
      "sort_order": 0,
      "date_modified": "string",
      "deleted": true
    }
  ]
}
Previous
setting/payment_method/delete
Next
setting/user_group/get
Built with