Árbol del API · Catálogos › paymentMethodOptions

Formas de cobro

paymentMethodOptions

Tipo

Query

Devuelve

[PaymentMethodOption!]!

Permiso de la llave

Selects y autocompletes GraphQL

Estable

Lista las formas de cobro habilitadas en la empresa, en el orden que ella definió, y dice cuáles son con tarjeta.

value es el paymentMethodId de un cobro nuevo en createCollection. Las formas de cobro que la empresa deshabilitó no llegan.

Un cobro con una forma de cobro con card: true lleva además una terminal bancaria en terminalId: pídelas con bankTerminals.

paymentMethodOptions(
  excludeUnspecified: Boolean
): [PaymentMethodOption!]!

# formas-de-cobro.graphql
query FormasDeCobro {
  paymentMethodOptions(excludeUnspecified: true) {
    value
    label
    card
  }
}

jq -n --rawfile q formas-de-cobro.graphql \
  '{query: $q}' |
curl https://mi-empresa.advantacloud.com/graphql \
  -H "Authorization: Bearer $ADVANTA_API_KEY" \
  -H "Content-Type: application/json" \
  --data @-

import { readFile } from "node:fs/promises";

const query = await readFile("formas-de-cobro.graphql", "utf8");

const res = await fetch("https://mi-empresa.advantacloud.com/graphql", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.ADVANTA_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ query }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);

const { data, errors } = await res.json();
if (errors) throw new Error(errors[0].extensions?.code ?? errors[0].message);
console.log(data.paymentMethodOptions);

import os, requests

URL = "https://mi-empresa.advantacloud.com/graphql"
HEADERS = {"Authorization": f"Bearer {os.environ['ADVANTA_API_KEY']}"}
QUERY = open("formas-de-cobro.graphql").read()

r = requests.post(URL, headers=HEADERS, timeout=30, json={
    "query": QUERY,
})
r.raise_for_status()
body = r.json()
if "errors" in body:
    raise RuntimeError(body["errors"][0]["message"])
print(body["data"]["paymentMethodOptions"])

<?php
$ch = curl_init('https://mi-empresa.advantacloud.com/graphql');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('ADVANTA_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'query' => file_get_contents('formas-de-cobro.graphql'),
    ]),
]);
$respuesta = curl_exec($ch);
$estatus = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($respuesta === false || $estatus !== 200) {
    throw new RuntimeException("HTTP $estatus " . curl_error($ch));
}
$body = json_decode($respuesta, true);
if (!empty($body['errors'])) {
    throw new RuntimeException($body['errors'][0]['message']);
}
$resultado = $body['data']['paymentMethodOptions'];

Respuesta 200 OK · 3 formas de cobro

{
  "data": {
    "paymentMethodOptions": [
      {
        "value": "1",
        "label": "EFE | Efectivo",
        "card": false
      },
      {
        "value": "3",
        "label": "TRA | Transferencia electrónica",
        "card": false
      },
      {
        "value": "4",
        "label": "TDC | Tarjeta de crédito",
        "card": true
      }
    ]
  }
}

Ver en el explorador

Argumentos

Argumento	Tipo	Descripción
`excludeUnspecified`Boolean	Boolean	`true`: quita las formas de cobro con la clave SAT `99` («Por definir»).

Lo que devuelve

[PaymentMethodOption!]!

Campos principales de PaymentMethodOption:

Campo	Tipo	Descripción
`value`ID!	ID!	Identificador de la forma de cobro; es el que se envía en `paymentMethodId`.
`label`String!	String!	Clave y nombre de la forma de cobro, p. ej. `EFE \| Efectivo`.
`card`Boolean!	Boolean!	`true` si es un cobro con tarjeta, que lleva terminal bancaria.

Ver todos los campos de PaymentMethodOption

Permisos

Llave API Integraciones

Selects y autocompletes GraphQL

La llave ve los registros de toda la empresa del subdominio.

Sin el permiso Sin error

La consulta responde sin error, pero la lista llega vacía.

Así lo conserva el API para las integraciones que ya lo usan: revisa los permisos de la llave si una lista llega vacía sin razón.

Errores

Código	Cuándo ocurre	Qué hacer
HTTP 401	Falta el header `Authorization` o la llave no existe en la empresa del subdominio. La respuesta no trae cuerpo.	Revisa la llave y el subdominio. No reintentes.
HTTP 422	Falla interna o dato rechazado al guardar. El cuerpo es `{"error": …}`, sin `data`.	Si no cambiaste nada, reintenta con espera exponencial.

Los errores de la consulta llegan con HTTP 200 en errors, con su código en extensions.code. Revisa siempre errors, no sólo el estatus HTTP. Errores y reintentos.

Relacionadas

Schema del 26 oct 2026 · Ver cambios¿Algo no cuadra? Repórtalo en ayuda.advanta.mx