Flavours API Documentation
  • Authorization
  • Includables
  • Pagination
  • Sorting
  • Me
  • Branches
  • Orders
  • Customers
  • Products
  • Product Categories
  • Discounts
  • Payment Methods
    • ListGET
    • DetailGET
  • Table
  • Webhook
logoPowered by Apidog

    List

    Developing
    GET/payment-methods

    Validation

    Field Type Rule Description
    page integer nullable min:1 Read more on the Pagination page
    per_page integer nullable min:1 Read more on the Pagination page
    sort string nullable Read more on the Sorting page
    includes array nullable Read more on the Includables page
    filter.is_online boolean nullable

    Request

    Authorization: Bearer Token
    Provide your bearer token in the
    Authorization
    header when making requests to protected resources.
    Example
    Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379
    Query Params
    page
    integer 
    optional
    Example:
    1
    per_page
    integer 
    optional
    Example:
    20
    sort
    string 
    optional
    includes
    array[string]
    optional
    Example:
    [""]
    filter[is_online]
    integer 
    optional

    Request samples

    Responses

    OK(200)
    HTTP Code: 200
    Content Type : JSONapplication/json
    Data Schema
    meta
    object 
    required
    code
    integer 
    required
    status
    string 
    required
    message
    string 
    required
    data
    object 
    required
    current_page
    integer 
    required
    data
    array [object {4}] 
    required
    first_page_url
    string 
    required
    from
    integer 
    required
    last_page
    integer 
    required
    last_page_url
    string 
    required
    links
    array [object {3}] 
    required
    next_page_url
    null 
    required
    path
    string 
    required
    per_page
    integer 
    required
    prev_page_url
    null 
    required
    to
    integer 
    required
    total
    integer 
    required
    Example
    {
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Data Loaded Successfully"
  },
  "data": {
    "current_page": 1,
    "data": [
      {
        "key": "CASH",
        "name": "Cash",
        "is_online": false,
        "logo_img": "http://localhost:8000/img/payment-methods/CASH.png"
      },
      {
        "key": "COFE",
        "name": "Cofe",
        "is_online": false,
        "logo_img": "http://api-dev.flavours.sa/img/payment-methods/COFE.png"
      },
      {
        "key": "HUNGERSTATION",
        "name": "HungerStation",
        "is_online": false,
        "logo_img": "http://api-dev.flavours.sa/img/payment-methods/HUNGERSTATION.png"
      },
      {
        "key": "JAHEZ",
        "name": "Jahez",
        "is_online": false,
        "logo_img": "http://api-dev.flavours.sa/img/payment-methods/JAHEZ.png"
      },
      {
        "key": "MADA",
        "name": "Mada",
        "is_online": false,
        "logo_img": "http://api-dev.flavours.sa/img/payment-methods/MADA.png"
      },
      {
        "key": "MARSOOL",
        "name": "Marsool",
        "is_online": false,
        "logo_img": "https://api-v2.flavours.sa/img/payment-methods/MARSOOL.png"
      },
      {
        "key": "MASTERCARD",
        "name": "MasterCard",
        "is_online": false,
        "logo_img": "http://api-dev.flavours.sa/img/payment-methods/MASTERCARD.png"
      },
      {
        "key": "N_GO",
        "name": "N.Go",
        "is_online": false,
        "logo_img": "http://api-dev.flavours.sa/img/payment-methods/N_GO.png"
      },
      {
        "key": "NOON_PAYMENT",
        "name": "Noon Payment",
        "is_online": true,
        "logo_img": "http://api-dev.flavours.sa/img/payment-methods/NOON_PAYMENT.png"
      },
      {
        "key": "PAY_LATER",
        "name": "Pay Later",
        "is_online": false,
        "logo_img": null
      },
      {
        "key": "SHGARDI",
        "name": "Shgardi",
        "is_online": false,
        "logo_img": "http://api-dev.flavours.sa/img/payment-methods/SHGARDI.png"
      },
      {
        "key": "TAP_PAYMENT",
        "name": "Tap Payment",
        "is_online": true,
        "logo_img": "http://localhost:8000/img/payment-methods/TAP_PAYMENT.png"
      },
      {
        "key": "THE_CHEFZ",
        "name": "The Chefz",
        "is_online": false,
        "logo_img": "http://api-dev.flavours.sa/img/payment-methods/THE_CHEFZ.png"
      },
      {
        "key": "TKYR",
        "name": "Tkyr",
        "is_online": false,
        "logo_img": "http://api-dev.flavours.sa/img/payment-methods/TKYR.png"
      },
      {
        "key": "TOYOU",
        "name": "ToYou",
        "is_online": false,
        "logo_img": "http://api-dev.flavours.sa/img/payment-methods/TOYOU.png"
      },
      {
        "key": "VISA",
        "name": "Visa",
        "is_online": false,
        "logo_img": "http://api-dev.flavours.sa/img/payment-methods/VISA.png"
      }
    ],
    "first_page_url": "http://localhost:8000/api/v2/payment-methods?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http://localhost:8000/api/v2/payment-methods?page=1",
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "http://localhost:8000/api/v2/payment-methods?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "active": false
      }
    ],
    "next_page_url": null,
    "path": "http://localhost:8000/api/v2/payment-methods",
    "per_page": 20,
    "prev_page_url": null,
    "to": 16,
    "total": 16
  }
}
    Last modified: a month ago
    Next
    GETDetail