Get All Payment Methods

Production

https://{{subdomain}}.daftara.com/v2/api/entity

GET

/site_payment_gateway/list/1

Returns a paginated list of the account's payment methods. This is a v2 native-entity endpoint served from the /v2/api/entity base and authenticated with a Bearer token.

The trailing path segment (1) is the data level — how deeply related records are loaded — not a page number. On this endpoint the data level has no visible effect, so /site_payment_gateway/list and /site_payment_gateway/list/1 return the same result. Pagination is controlled by the page and per_page query parameters.

Parameter	Purpose
`page`	Page number (default `1`).
`per_page`	Items per page (default `20`).
`filter[<field>]`	Filter by an exact field value, e.g. `filter[active]=1` returns only active methods.

The response is a standard paginated envelope. Each item in data is a payment-method record that also embeds its related treasury and branch objects.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Responses

🟢200Success

application/json

A paginated list of payment methods.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://.daftara.com/v2/api/entity/site_payment_gateway/list/1?page=undefined&per_page=undefined' \
--header 'Accept: application/json' \
--header 'apikey: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
    "current_page": 1,
    "data": [
        {
            "id": 0,
            "payment_gateway": "string",
            "label": "string",
            "username": "string",
            "option1": "string",
            "option2": "string",
            "option3": "string",
            "default": 0,
            "active": 0,
            "manually_added": 0,
            "disable_for_client": 0,
            "created": "string",
            "modified": "string",
            "settings": "string",
            "treasury_id": 0,
            "branch_id": 0,
            "treasury": {
                "id": 0,
                "staff_id": 0,
                "branch_id": 0,
                "name": "string",
                "type": "string",
                "type_name": "string",
                "type_account_number": "string",
                "active": 0,
                "is_primary": 0,
                "description": "string",
                "created": "string",
                "modified": "string",
                "currency_code": "string",
                "metainfo": "string"
            },
            "branch": {
                "id": 0,
                "name": "string",
                "status": 0,
                "created": "string",
                "modified": "string",
                "code": "string"
            }
        }
    ],
    "per_page": 20,
    "total": 0,
    "last_page": 0,
    "from": 0,
    "to": 0,
    "first_page_url": "string",
    "last_page_url": "string",
    "next_page_url": "string",
    "prev_page_url": "string",
    "path": "string",
    "links": [
        {}
    ]
}

Delete Branch

Get Single Payment Method