Métodos de cobro

Métodos de cobro de la empresa, con país, moneda, mínimos y máximos.

Dato	Valor
Método y ruta	`GET /v1/collection-methods`
Servidor	`https://widget.fital.xyz`
`operationId`	`listCollectionMethods`
Acceso	Llave con el scope `collections:read`
Firma de petición	No aplica
Idempotencia	No aplica

Sólo lista los métodos que puede usar tu empresa. available: false significa que el método existe pero hoy no se puede usar.
payer_fields lista lo que el método pide en payer al crear el cobro, y POST /v1/collections lo aplica: required, options con los valores admitidos y phone_prefix. Vacío significa que no pide nada.

Encabezados de la petición

Encabezado	Obligatorio	Descripción
`Authorization`	Sí	`Bearer` y tu llave.
`X-Fital-Scenario`	No	Sólo simuladores: elige la respuesta que quieres practicar.

Respuestas correctas

200 Correcto

Campo	Tipo	Obligatorio	Descripción
`data`	lista de objeto	Sí	Métodos de cobro disponibles para la empresa.
`data[].available`	booleano	Sí	true si se puede usar ahora.
`data[].country`	texto o `null`	Sí	País del método.
`data[].currency`	texto o `null`	Sí	Moneda del método.
`data[].max_amount`	texto o `null`	Sí	Monto máximo.
`data[].method`	texto o `null`	Sí	Nombre a usar en `method`.
`data[].min_amount`	texto o `null`	Sí	Monto mínimo.
`data[].payer_fields`	lista de objeto	Sí	Lo que el método pide en `payer` al crear el cobro.
`data[].payer_fields[].name`	texto	Sí	Clave dentro de `payer`. `firstName`: Nombre, o razón social. `lastName`: Apellido. `email`: Correo. `phone`: Teléfono con su prefijo internacional. `documentType`: Tipo de documento. `documentNumber`: Número de documento.
`data[].payer_fields[].options`	lista de texto o `null`	Sí	Valores admitidos. null si es texto libre.
`data[].payer_fields[].phone_prefix`	texto o `null`	Sí	Prefijo del país, como `+57`. null si no aplica.
`data[].payer_fields[].required`	booleano	Sí	true si el cobro se rechaza sin este dato.

Valores de `data[].payer_fields[].name`

Valor	Significado
`firstName`	Nombre, o razón social.
`lastName`	Apellido.
`email`	Correo.
`phone`	Teléfono con su prefijo internacional.
`documentType`	Tipo de documento.
`documentNumber`	Número de documento.

El contrato lo declara como texto: trata la lista como extensible.

{
  "data": [
    {
      "available": true,
      "country": "MX",
      "currency": "MXN",
      "max_amount": "50000.00",
      "method": "spei",
      "min_amount": "10.00",
      "payer_fields": [
        {
          "name": "firstName",
          "options": null,
          "phone_prefix": null,
          "required": true
        },
        {
          "name": "email",
          "options": null,
          "phone_prefix": null,
          "required": true
        },
        {
          "name": "documentType",
          "options": [
            "RFC",
            "CURP"
          ],
          "phone_prefix": null,
          "required": false
        },
        {
          "name": "phone",
          "options": null,
          "phone_prefix": "+52",
          "required": false
        }
      ]
    }
  ]
}

Encabezados de la respuesta

Encabezado	Contenido
`X-Request-Id`	Identificador de la petición. Cítalo con soporte.
`Retry-After`	Segundos a esperar, con `429` y a veces con `503`.

Errores

Todos usan la forma de Errores: error.code, message, request_id, details, retryable y docs_url. Decide por code.

HTTP	Código	Cuándo sale	`retryable`
400	`invalid_request` (sólo cuenta de prueba)	El encabezado `X-Fital-Scenario` trae un escenario desconocido.	`false`
401	`invalid_api_key`	La llave falta, está mal formada, venció o fue revocada, o la empresa está suspendida.	`false`
401	`wrong_environment`	La llave es de otro ambiente.	`false`
403	`forbidden_scope`	La llave no tiene el scope de esta operación. `details.required_scope` lo nombra.	`false`
403	`ip_not_allowed`	La IP de origen no está activa en la lista de esa llave.	`false`
403	`kyb_required`	La empresa no tiene KYB aprobado o aún no está inscrita.	`false`
403	`account_not_active`	La cuenta no está activa.	`false`
429	`rate_limited`	Superaste un límite de peticiones. Llega con `Retry-After`.	`true`
500	`internal_error`	Fallo nuestro. El resultado de la petición no se conoce.	`true`
503	`service_unavailable`	El servicio no está disponible por ahora. El resultado de la petición no se conoce.	`true`

Ejemplos de error

400 invalid_request:

{
  "error": {
    "code": "invalid_request",
    "message": "Petición inválida",
    "request_id": "0123456789abcdef0123456789abcdef",
    "details": {
      "fields": {
        "limit": "Entre 1 y 100"
      }
    },
    "retryable": false,
    "docs_url": "https://merchants.fital.xyz/docs/errores/#invalid_request"
  }
}

401 invalid_api_key:

{
  "error": {
    "code": "invalid_api_key",
    "message": "Credencial inválida",
    "request_id": "0123456789abcdef0123456789abcdef",
    "details": {},
    "retryable": false,
    "docs_url": "https://merchants.fital.xyz/docs/errores/#invalid_api_key"
  }
}

403 forbidden_scope:

{
  "error": {
    "code": "forbidden_scope",
    "message": "La llave no tiene permiso para esta operación",
    "request_id": "0123456789abcdef0123456789abcdef",
    "details": {
      "required_scope": "collections:read"
    },
    "retryable": false,
    "docs_url": "https://merchants.fital.xyz/docs/errores/#forbidden_scope"
  }
}

429 rate_limited:

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiadas peticiones",
    "request_id": "0123456789abcdef0123456789abcdef",
    "details": {},
    "retryable": true,
    "docs_url": "https://merchants.fital.xyz/docs/errores/#rate_limited"
  }
}

500 internal_error:

{
  "error": {
    "code": "internal_error",
    "message": "Error interno",
    "request_id": "0123456789abcdef0123456789abcdef",
    "details": {},
    "retryable": true,
    "docs_url": "https://merchants.fital.xyz/docs/errores/#internal_error"
  }
}

503 service_unavailable:

{
  "error": {
    "code": "service_unavailable",
    "message": "Servicio no disponible",
    "request_id": "0123456789abcdef0123456789abcdef",
    "details": {},
    "retryable": true,
    "docs_url": "https://merchants.fital.xyz/docs/errores/#service_unavailable"
  }
}

Reintentos

Es una lectura: repetirla no tiene efecto.

429 rate_limited: Espera lo que indique Retry-After y repite.
500 internal_error: Repite con espera exponencial.
503 service_unavailable: Repite con espera exponencial. Respeta Retry-After si viene.

Ver Reintentos y Límites.

Muestras

Variables de estas muestras: simulador público, sin cuenta

Define esto en tu terminal. Con estos valores las muestras corren tal cual contra el simulador público:

export FITAL_API="https://widget.fital.xyz/explorar/v1"
export FITAL_KEY="sk_test_sandbox_publica"

En la cuenta de prueba o en producción cambia la base, la llave y el secreto, y sustituye los id de ejemplo por los tuyos. Ver Ambientes.

op-listar-metodos-de-cobro.sh

curl -sS "$FITAL_API/collection-methods" \
  -H "Authorization: Bearer $FITAL_KEY"

Guías

Ver esta página en Markdown

Encabezados de la peticiónCopiar enlace

Respuestas correctasCopiar enlace

200 CorrectoCopiar enlace

Valores de data[].payer_fields[].nameCopiar enlace

Encabezados de la respuestaCopiar enlace

ErroresCopiar enlace

Ejemplos de errorCopiar enlace

ReintentosCopiar enlace

MuestrasCopiar enlace

GuíasCopiar enlace

En esta página