POST

PaymentGateways.List

Return payment gateway rows for the account (Settings → Payments table). Reads payment_detail where user_id = owner and is_deleted = 0 when that column exists, same account scope as dashboard listing_of_payment_detail_table. Does not return keys, passwords, or details JSON. Page size is capped at 25. Default order is id DESC. Use returned id as payment_detail_id on Documents.Add or payment_gatway on PaymentForms.Add.

Permissions

User must be logged in with a valid bearer token.
Returned or changed records are limited by the user permissions, team access, folder access, and account settings.

Action

Returns PaymentGateways rows as JSON.
Supports the documented filters and paging fields.
List responses are capped at 25 rows per call.

Push Service

No push is sent because this function only reads data or returns helper information.

Automation

No automation is run for this function.

Special Instructions

This is the Payments settings list (payplus, kesher, Tranzila, airwallex, biz1, ...), not PaymentForms.List.
Secrets stored in payment_detail.details are never returned.
Use data[i].id as payment_detail_id (Documents.Add) or payment_gatway (PaymentForms.Add).

Required Parameters

No body parameters are required for this function.

Optional Parameters

Name	Type	Sample	What it gives
`search` post	string	`payplus`	Search name and payment_method. Aliases: filter_data, search[value], name.
`payment_method` post	string	`payplus`	Filter by gateway type, e.g. payplus, kesher, Tranzila, airwallex, biz1. Alias: payment.
`mode` post	int	`1`	Filter by mode: 1 Live, 0 Test.
`default_only` post	int	`1`	When 1, return only the default gateway (default_payment=1). Alias: default_payment=1.
`start` post	int	`0`	First row offset for paging. Alias: offset.
`limit` post	int	`25`	Maximum rows to return. Values above 25 are capped. Aliases: length, per_page.
`order_by` post	string	`id`	Order column: id, name, payment_method, mode, default_payment. Default id.
`order_dir` post	string	`desc`	Order direction: asc or desc. Default desc.

Authentication

Send the bearer token returned by Login in the request header.

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/PaymentGateways.List",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "limit": "25"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/PaymentGateways.List",
    "url_domain": "https:\/\/{domain}\/app\/PaymentGateways.List"
}

Endpoint

POST /app/PaymentGateways.List
POST https://{user}.bull36.com/app/PaymentGateways.List
POST https://{domain}/app/PaymentGateways.List

Sample Output

{
    "success": 1,
    "count": 4,
    "recordsTotal": 4,
    "recordsFiltered": 4,
    "total_record": 4,
    "start": 0,
    "limit": 25,
    "data": [
        {
            "id": 313,
            "payment_gateway_id": 313,
            "payment_detail_id": 313,
            "payment_gatway": 313,
            "name": "payplus",
            "payment_method": "payplus",
            "payment": "payplus",
            "mode": 1,
            "mode_label": "Live",
            "default_payment": 0,
            "is_default": false,
            "default_paybridge": 0,
            "is_default_paybridge": false
        }
    ]
}

Count Only

Use the matching count route with the same filters when the UI only needs total rows for paging.

{
    "url": "\/app\/PaymentGateways.Count",
    "url_user": "https:\/\/{user}.bull36.com\/app\/PaymentGateways.Count",
    "url_domain": "https:\/\/{domain}\/app\/PaymentGateways.Count",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": [],
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "count": "Use the matching count route when available, or count returned rows.",
        "max_limit": 25
    }
}

Count JavaScript

const token = 'YOUR TOKEN';
const body = new URLSearchParams();

const res = await fetch('https://{domain}/app/PaymentGateways.Count', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` },
  body
});
const data = await res.json();
console.log(data.count);

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams({ limit: '25' });
const res = await fetch('/app/PaymentGateways.List', {
  method: 'POST',
  headers: { Authorization: 'Bearer ' + token },
  body
});
const data = await res.json();
console.log(data.count, data.data);
// Use data.data[i].id as payment_detail_id on Documents.Add

Error Example

{
    "success": "0",
    "error": "bearer_token_required",
    "message": "Authorization bearer token is required. Send header: Authorization: Bearer YOUR TOKEN"
}