List Payment Methods

List all payment methods with pagination and filtering options. For the customer role this returns the market's digital-menu gateway payment methods — only TAP_PAYMENT and FLAVOURS_PAYMENT (is_digital && is_active configs, scoped to SCOPE_ORDER), dropped when the market has no Tap credentials; offline methods such as CASH/MADA never appear. Pay Later is exposed separately via branch.setting.payment.has_postpay. filter[market_id] is required for customers.

Authorization

API-TOKEN

API-TOKEN<token>

Your partner API key. Send it in the API-TOKEN header on every request.

In: header

Query Parameters

page?|

Page number for pagination. Must be at least 1.

per_page?|

Number of items per page. Must be at least 1.

search?|

Search in the payment method name.

sort?|

Sort field and direction (e.g., name, -created_at, is_adopted, -is_adopted).

key_by?|

Key the results by this field.

includes*array<>

filter?object

filter.payment_methods_keys*array<>

Must match an existing stored value.

filter.market_id?|

Market whose payment methods to read. Required for the customer role (which has no fixed market); ignored for staff (their own market is used). Must match an existing stored value.

filter.type_key?|

Restrict to payment methods allowed by this order type (its order_type_methods for the caller market). An order type with no method rows allows all methods. Also scopes the isPreset include. Must match an existing stored value.

filter.is_adopted?|

Filter to methods the caller market has (true) or has not (false) configured.

filter.is_active?|

Filter to methods whose config for the caller market is active (true) or not active (false), reading payment_method_configs.is_active.

filter.is_digital?|

Filter to methods whose config for the caller market is flagged for the digital menu (is_digital and is_active). Applied automatically for the customer role.

filter.is_online?|

filter.scope?|

Value in"SCOPE_ORDER" | "SCOPE_RENEWAL"

Header Parameters

X-API-Version*string

API contract version to target. See the Changelog for what changed in each version.

Default"2.0.0"

Value in"2.3.0" | "2.2.0" | "2.1.0" | "2.0.0"

Response Body

`application/json`

curl -X GET "https://api.flavours.sa/dev/api/v2/payment-methods?page=1&per_page=20&search=cash&sort=-created_at&key_by=key&includes=enim&filter.payment_methods_keys=ipsam&filter.type_key=DINING&filter.is_adopted=true&filter.is_active=true&filter.is_digital=true&filter.is_online=false&filter.scope=SCOPE_ORDER" \
  -H "X-API-Version: 2.3.0"

curl -X GET "https://api.flavours.sa/dev/api/v2/payment-methods?page=1&per_page=20&search=cash&sort=-created_at&key_by=key&includes=enim&filter.payment_methods_keys=ipsam&filter.type_key=DINING&filter.is_adopted=true&filter.is_active=true&filter.is_digital=true&filter.is_online=false&filter.scope=SCOPE_ORDER" \  -H "X-API-Version: 2.3.0"

{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Payment method list retrieved successfully."
  },
  "data": {
    "current_page": 1,
    "data": [
      {
        "key": "CASH",
        "name": "Cash",
        "is_online": false,
        "logo_img": null,
        "created_at": 1792593342864,
        "updated_at": 1792593342864,
        "scopes": [
          "SCOPE_ORDER"
        ]
      },
      {
        "key": "MADA",
        "name": "Mada",
        "is_online": false,
        "logo_img": "https://localhost:8000/img/payment-methods/MADA.png",
        "created_at": 1792593342864,
        "updated_at": 1792593342864,
        "scopes": [
          "SCOPE_ORDER"
        ]
      },
      {
        "key": "VISA",
        "name": "Visa",
        "is_online": false,
        "logo_img": "https://localhost:8000/img/payment-methods/VISA.png",
        "created_at": 1792593342864,
        "updated_at": 1792593342864,
        "scopes": [
          "SCOPE_ORDER"
        ]
      },
      {
        "key": "MASTERCARD",
        "name": "MasterCard",
        "is_online": false,
        "logo_img": "https://localhost:8000/img/payment-methods/MASTERCARD.png",
        "created_at": 1792593342864,
        "updated_at": 1792593342864,
        "scopes": [
          "SCOPE_ORDER"
        ]
      },
      {
        "key": "NOON_PAYMENT",
        "name": "Noon Payment",
        "is_online": true,
        "logo_img": "https://localhost:8000/img/payment-methods/NOON_PAYMENT.png",
        "created_at": 1792593342864,
        "updated_at": 1792593342864,
        "scopes": [
          "SCOPE_ORDER"
        ]
      },
      {
        "key": "HUNGERSTATION",
        "name": "HungerStation",
        "is_online": false,
        "logo_img": "https://localhost:8000/img/payment-methods/HUNGERSTATION.png",
        "created_at": 1792593342864,
        "updated_at": 1792593342864,
        "scopes": [
          "SCOPE_ORDER"
        ]
      },
      {
        "key": "JAHEZ",
        "name": "Jahez",
        "is_online": false,
        "logo_img": "https://localhost:8000/img/payment-methods/JAHEZ.png",
        "created_at": 1792593342864,
        "updated_at": 1792593342864,
        "scopes": [
          "SCOPE_ORDER"
        ]
      },
      {
        "key": "TOYOU",
        "name": "ToYou",
        "is_online": false,
        "logo_img": "https://localhost:8000/img/payment-methods/TOYOU.png",
        "created_at": 1792593342864,
        "updated_at": 1792593342864,
        "scopes": [
          "SCOPE_ORDER"
        ]
      },
      {
        "key": "THE_CHEFZ",
        "name": "The Chefz",
        "is_online": false,
        "logo_img": "https://localhost:8000/img/payment-methods/THE_CHEFZ.png",
        "created_at": 1792593342864,
        "updated_at": 1792593342864,
        "scopes": [
          "SCOPE_ORDER"
        ]
      },
      {
        "key": "SHGARDI",
        "name": "Shgardi",
        "is_online": false,
        "logo_img": "https://localhost:8000/img/payment-methods/SHGARDI.png",
        "created_at": 1792593342864,
        "updated_at": 1792593342864,
        "scopes": [
          "SCOPE_ORDER"
        ]
      },
      {
        "key": "N_GO",
        "name": "N.Go",
        "is_online": false,
        "logo_img": "https://localhost:8000/img/payment-methods/N_GO.png",
        "created_at": 1792593342864,
        "updated_at": 1792593342864,
        "scopes": [
          "SCOPE_ORDER"
        ]
      },
      {
        "key": "TKYR",
        "name": "Tkyr",
        "is_online": false,
        "logo_img": "https://localhost:8000/img/payment-methods/TKYR.png",
        "created_at": 1792593342864,
        "updated_at": 1792593342864,
        "scopes": [
          "SCOPE_ORDER"
        ]
      },
      {
        "key": "COFE",
        "name": "Cofe",
        "is_online": false,
        "logo_img": "https://localhost:8000/img/payment-methods/COFE.png",
        "created_at": 1792593342864,
        "updated_at": 1792593342864,
        "scopes": [
          "SCOPE_ORDER"
        ]
      },
      {
        "key": "PAY_LATER",
        "name": "Pay Later",
        "is_online": false,
        "logo_img": "https://localhost:8000/img/payment-methods/PAY_LATER.png",
        "created_at": 1792593342864,
        "updated_at": 1792593342864,
        "scopes": [
          "SCOPE_ORDER"
        ]
      },
      {
        "key": "TAP_PAYMENT",
        "name": "Tap Payment",
        "is_online": true,
        "logo_img": "https://localhost:8000/img/payment-methods/TAP_PAYMENT.png",
        "created_at": 1792593342864,
        "updated_at": 1792593342864,
        "scopes": [
          "SCOPE_ORDER",
          "SCOPE_RENEWAL"
        ]
      },
      {
        "key": "MANUAL_TRANSFER",
        "name": "Manual Transfer",
        "is_online": false,
        "logo_img": "https://localhost:8000/img/payment-methods/MANUAL_TRANSFER.png",
        "created_at": 1792593342864,
        "updated_at": 1792593342864,
        "scopes": [
          "SCOPE_RENEWAL"
        ]
      },
      {
        "key": "FLAVOURS_PAYMENT",
        "name": "Flavours Payment",
        "is_online": true,
        "logo_img": "https://localhost:8000/img/payment-methods/FLAVOURS_PAYMENT.png",
        "created_at": 1792593342864,
        "updated_at": 1792593342864,
        "scopes": [
          "SCOPE_ORDER",
          "SCOPE_RENEWAL"
        ]
      }
    ],
    "first_page_url": "https://localhost:8000/api/v2/payment-methods?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://localhost:8000/api/v2/payment-methods?page=1",
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "page": null,
        "active": false
      },
      {
        "url": "https://localhost:8000/api/v2/payment-methods?page=1",
        "label": "1",
        "page": 1,
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "page": null,
        "active": false
      }
    ],
    "next_page_url": null,
    "path": "https://localhost:8000/api/v2/payment-methods",
    "per_page": 20,
    "prev_page_url": null,
    "to": 17,
    "total": 17
  }
}

{
  "meta": {
    "code": 401,
    "status": "error",
    "message": "Unauthenticated."
  },
  "data": null
}

{
  "meta": {
    "code": 403,
    "status": "error",
    "message": "Unauthorized."
  },
  "data": null
}

{
  "meta": {
    "code": 404,
    "status": "error",
    "message": "Resource not found."
  },
  "data": null
}

{
  "meta": {
    "code": 500,
    "status": "error",
    "message": "Internal server error."
  },
  "data": null
}

Authorization

Query Parameters

Header Parameters

Response Body

200application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`