Árbol del API · Catálogos › paymentTypeOptions

Formas de cobro sin marca de tarjeta

paymentTypeOptions

Tipo

Query

Devuelve

[CatalogOption!]!

Permiso de la llave

Selects y autocompletes GraphQL

Estable

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

Es el mismo catálogo que paymentMethodOptions, con los mismos value y en el mismo orden, pero sin la marca de tarjeta (card). Si además necesitas saber cuáles son con tarjeta, usa paymentMethodOptions; es la que conviene para registrar un cobro con createCollection.

paymentTypeOptions(
  excludeUnspecified: Boolean
): [CatalogOption!]!

# formas-de-pago.graphql
query FormasDePago {
  paymentTypeOptions {
    value
    label
  }
}

jq -n --rawfile q formas-de-pago.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-pago.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.paymentTypeOptions);

import os, requests

URL = "https://mi-empresa.advantacloud.com/graphql"
HEADERS = {"Authorization": f"Bearer {os.environ['ADVANTA_API_KEY']}"}
QUERY = open("formas-de-pago.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"]["paymentTypeOptions"])

<?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-pago.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']['paymentTypeOptions'];

Respuesta 200 OK · 4 formas de cobro

{
  "data": {
    "paymentTypeOptions": [
      {
        "value": "1",
        "label": "EFE | Efectivo"
      },
      {
        "value": "3",
        "label": "TRA | Transferencia electrónica"
      },
      {
        "value": "4",
        "label": "TDC | Tarjeta de crédito"
      },
      {
        "value": "9",
        "label": "PPD | Por definir"
      }
    ]
  }
}

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

[CatalogOption!]!

Campos principales de CatalogOption:

Campo	Tipo	Descripción
`value`ID!	ID!	Identificador de la opción; es el que envías en el argumento o campo que pide ese catálogo.
`label`String!	String!	Texto para mostrar. Casi siempre es la clave y el nombre separados por una barra vertical, p. ej. `MAY \| Mayoreo`.

Ver todos los campos de CatalogOption

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