Register a merchant
Versión de API 0.0.1API-Version?stringOptional. Omit or send latest to resolve 0.0.1.
"0.0.1""0.0.1""latest"application/json- body
commercial_name*string1 <= length <= 255business_activity*persona*fiscal_profile*Merchant, contact, fiscal profile and address created atomically.
application/json- response
id*stringuuidcommercial_name*string1 <= length <= 255business_activity*persona*fiscal_profile*Ejemplos de solicitud
Elige un lenguaje y copia la solicitud para enviarla a la demostración pública. Usa únicamente datos ficticios.
curl -X POST 'https://api.dotpay.mx/merchants' \ -H 'Content-Type: application/json' \ -d '{ "commercial_name": "Tienda de Prueba", "business_activity": { "system": "dotpay-synthetic-mcc", "edition": "test-v1", "code": "0001" }, "persona": { "full_name": "Luz Ejemplo", "email": "luz@example.com", "phone_number": "5550000100", "country_code": "+52" }, "fiscal_profile": { "taxpayer_type": "persona_moral", "registered_name": "Comercio de Prueba", "rfc": "ZZZ000101ZZ0", "address": { "country": "MX", "postal_code": "01234", "catalog_version": "synthetic-v1", "entry_id": "09:001:0001", "street": "Calle de Prueba", "exterior_number": "S/N", "interior_number": null } }}'{ "commercial_name": "Tienda de Prueba", "business_activity": { "system": "dotpay-synthetic-mcc", "edition": "test-v1", "code": "0001", "label": "Tienda de prueba" }, "persona": { "id": "8281f3c6-012a-493d-be40-bec195ab6a4e", "full_name": "Luz Ejemplo", "email": "luz@example.com", "phone_number": "5550000100", "country_code": "+52" }, "fiscal_profile": { "id": "46c150b5-dc6c-4ab8-aa9e-1062ec9abdc4", "taxpayer_type": "persona_moral", "registered_name": "Comercio de Prueba", "rfc": "ZZZ000101ZZ0", "address": { "id": "f13380f4-1269-49a6-8302-85b262bff5a0", "country": "MX", "postal_code": "01234", "catalog_version": "synthetic-v1", "entry_id": "09:001:0001", "street": "Calle de Prueba", "exterior_number": "S/N", "interior_number": null, "state": { "id": "09", "label": "Entidad de prueba" }, "municipality": { "id": "001", "label": "Municipio de prueba" }, "city": null, "settlement": { "id": "0001", "label": "Colonia Álamo de prueba" } } }, "id": "8b7f8b7d-3ac0-4ce2-b85f-578f3113022d"}Detalles del protocolo
- ID de operación
createMerchant- Método y ruta
POST /merchants- Acceso
- Acceso público sin autenticación.
Los parámetros, campos obligatorios, restricciones de validación, esquemas de respuesta y ejemplos de error se generan a partir del contrato del backend. Las tablas muestran las cabeceras de solicitud y respuesta declaradas para esta operación.
Consultar la especificación OpenAPI 3.1 completaCabeceras de solicitud
Omite una cabecera opcional para usar el valor predeterminado de su esquema. Para fijar la versión de API, configura la cabecera de versión en tu solicitud.
| Cabecera | Requisito | Esquema |
|---|---|---|
API-VersionOptional. Omit or send latest to resolve 0.0.1. | Opcional | {"type":"string","enum":["0.0.1","latest"],"default":"0.0.1"} |
| Estado | Cabecera | Esquema |
|---|---|---|
201 | Cache-Control | {"type":"string","const":"no-store"} |
201 | API-VersionPresent after successful version negotiation. | {"type":"string","const":"0.0.1"} |
201 | Vary | {"type":"string"}Ejemplo: |
201 | Location | {"type":"string"}Ejemplo: |
400 | Cache-Control | {"type":"string","const":"no-store"} |
400 | API-VersionPresent after successful version negotiation. | {"type":"string","const":"0.0.1"} |
400 | Vary | {"type":"string"}Ejemplo: |
406 | Cache-Control | {"type":"string","const":"no-store"} |
406 | API-VersionPresent after successful version negotiation. | {"type":"string","const":"0.0.1"} |
406 | Vary | {"type":"string"}Ejemplo: |
415 | Cache-Control | {"type":"string","const":"no-store"} |
415 | API-VersionPresent after successful version negotiation. | {"type":"string","const":"0.0.1"} |
415 | Vary | {"type":"string"}Ejemplo: |
500 | Cache-Control | {"type":"string","const":"no-store"} |
500 | API-VersionPresent after successful version negotiation. | {"type":"string","const":"0.0.1"} |
500 | Vary | {"type":"string"}Ejemplo: |
503 | Cache-Control | {"type":"string","const":"no-store"} |
503 | API-VersionPresent after successful version negotiation. | {"type":"string","const":"0.0.1"} |
503 | Vary | {"type":"string"}Ejemplo: |
Comercios
Perfiles de comercios, consulta de RFC y búsqueda de giros comerciales.
Actualizar un comercio
Full replacement preserves all IDs. The last successful write wins. An unchanged geographic selection or activity code may retain its original edition after a catalog refresh. Changed selections must be active.