Flavours Partner API
Payment method

Detail Payment Method

GET
/api/v2/payment-methods/{methodKey}

Get details of a specific payment method by its key.

Authorization

API-TOKEN
API-TOKEN<token>

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

In: header

Path Parameters

methodKey*string

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"

Request Body

application/json

includes*array<>

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.flavours.sa/dev/api/v2/payment-methods/hic" \  -H "X-API-Version: 2.3.0" \  -H "Content-Type: application/json" \  -d '{    "includes": [      "sed"    ]  }'
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Payment method details retrieved successfully."
  },
  "data": {
    "key": "CASH",
    "name": "Cash",
    "is_online": false,
    "logo_img": null,
    "created_at": 1792593342864,
    "updated_at": 1792593342864,
    "scopes": [
      "SCOPE_ORDER"
    ],
    "settings_count": "2",
    "configs_count": 2
  }
}
{
  "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
}

Delete Payment Method DELETE

Delete a payment method by its key.

List Payment Methods GET

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.