Descargar la especificación OpenAPI
spherepay.yaml — OpenAPI 3.0, ~470 KB. El archivo se sirve directamente desde el sitio de documentación y refleja la superficie API publicada más reciente.Qué contiene la especificación
- Cada endpoint público bajo
/v2/— clientes, transferencias, cuentas bancarias, billeteras, cuentas virtuales (Onramper Accounts), offloader wallets, representantes empresariales, documentos, due diligence mejorada. - Esquemas completos de solicitud y respuesta para cada endpoint, incluidas uniones discriminadas para formas de cuenta bancaria específicas de divisas (USD vs. EUR vs. BRL).
- Sobres de error estándar y mapeos de códigos de estado.
- Ejemplos para los cuerpos de solicitud más comunes.
Usos comunes
Generar un cliente API
Alimenta el YAML en openapi-generator o Speakeasy para producir un SDK tipado en TypeScript, Python, Go, Java, Ruby y otros.
Importar en Postman o Insomnia
Postman → Import → sube el archivo. Obtendrás una colección con todos los endpoints, lista para autenticar con tu clave API.
Validar solicitudes en CI
Usa Spectral o cualquier linter compatible con OpenAPI para validar los payloads de solicitud de tu aplicación contra la especificación antes de que lleguen a producción.
Simular la API localmente
Herramientas como Prism levantan un servidor de simulación local desde la especificación, para que puedas desarrollar contra el contrato de SpherePay sin gastar tráfico de sandbox.
Versionamiento
La especificación rastrea la API/v2/ en vivo. Los cambios que rompen la compatibilidad se anuncian en Notas de la versión antes de que cambie la especificación; los campos deprecados se mantienen en la especificación con deprecated: true hasta su eliminación.
Si necesitas fijar una versión histórica específica de la especificación, revisa el historial de Git de este archivo en el repositorio de documentación.