Saltar al contenido
DotPay Developers
DocumentaciónReferencia de API
Comercios

Register a merchant

Versión de API 0.0.1
Demostración pública con datos ficticios
Cualquier persona puede consultar o modificar los perfiles de comercios compartidos sin iniciar sesión. Los catálogos son de solo lectura. Usa únicamente datos ficticios, incluidos los contactos, los RFC y las direcciones.
POST
/merchants
API-Version?string

Optional. Omit or send latest to resolve 0.0.1.

Predeterminado"0.0.1"
Valor en"0.0.1""latest"
application/json
  1. body
commercial_name*string
Longitud1 <= length <= 255
business_activity*
persona*
fiscal_profile*

Cuerpo de la respuesta

Merchant, contact, fiscal profile and address created atomically.

application/json
  1. response
id*string
Formatouuid
commercial_name*string
Longitud1 <= length <= 255
business_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
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    }  }}'
Respuesta de ejemplo
{  "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 completa

Cabeceras 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.

Cabeceras de solicitud
CabeceraRequisitoEsquema
API-Version

Optional. Omit or send latest to resolve 0.0.1.

Opcional{"type":"string","enum":["0.0.1","latest"],"default":"0.0.1"}
Cabeceras de respuesta por estado HTTP
EstadoCabeceraEsquema
201Cache-Control{"type":"string","const":"no-store"}
201API-Version

Present after successful version negotiation.

{"type":"string","const":"0.0.1"}
201Vary{"type":"string"}

Ejemplo: "API-Version"

201Location{"type":"string"}

Ejemplo: "/merchants/8b7f8b7d-3ac0-4ce2-b85f-578f3113022d"

400Cache-Control{"type":"string","const":"no-store"}
400API-Version

Present after successful version negotiation.

{"type":"string","const":"0.0.1"}
400Vary{"type":"string"}

Ejemplo: "API-Version"

406Cache-Control{"type":"string","const":"no-store"}
406API-Version

Present after successful version negotiation.

{"type":"string","const":"0.0.1"}
406Vary{"type":"string"}

Ejemplo: "API-Version"

415Cache-Control{"type":"string","const":"no-store"}
415API-Version

Present after successful version negotiation.

{"type":"string","const":"0.0.1"}
415Vary{"type":"string"}

Ejemplo: "API-Version"

500Cache-Control{"type":"string","const":"no-store"}
500API-Version

Present after successful version negotiation.

{"type":"string","const":"0.0.1"}
500Vary{"type":"string"}

Ejemplo: "API-Version"

503Cache-Control{"type":"string","const":"no-store"}
503API-Version

Present after successful version negotiation.

{"type":"string","const":"0.0.1"}
503Vary{"type":"string"}

Ejemplo: "API-Version"