mobilePaymentOptions

Requires a customer (portal or buyer app) session.

Returns available payment methods for checkout. COD is always present; one ONLINE entry is added per eligible gateway (enabled, verified, and able to settle the store's currency). Zero eligible gateways means COD only.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query MobilePaymentOptions {
  mobilePaymentOptions {
    label
    method
    provider
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query MobilePaymentOptions {\n  mobilePaymentOptions {\n    label\n    method\n    provider\n  }\n}"
}
EOF

Response:

{
  "data": {
    "mobilePaymentOptions": [
      {
        "label": "string",
        "method": "COD",
        "provider": "string"
      }
    ]
  }
}

mobilePaymentOptions: [MobilePaymentOption!]!

Type

MobilePaymentOption object

A payment method available at checkout (COD or ONLINE via a PSP).