Información de Servicios que se pueden pagar a través de Santander México
Rutas
/directServices/{serviceId}
Recurso para consultar un convenio de pago directo de servicios
Recurso para buscar un convenio de pago directo de servicios mediante el identificador serviceId
Parametro “serviceId” con formato xxxx (4 dígitos)
Identifica al cliente (client-id) para hacer peticiones a la API
Esta API responderá en el encabezado Content-Language el idioma utilizado en la respuesta.
Cabecera para Token de acceso, formato OAuth2. Para obtener el token se debe utilizar el API "SECURITY OAUTH" contenida en el producto "P-SECURITY", con parametro scope = "services.read audit.write". Posteriormente se debe introducir el token obtenido precedido de la palabra "Bearer" y un espacio.
Cabecera para identificar el dispositivo que solicita el API, por ejemplo: Navegador móvil, Tablet, Reloj, etc. Web Browser como predeterminado para Mac / PC.
Cabecera para identificar la sesión de la aplicación consumidora
Cabecera para identificar el content type utilizado en la petición.
Cabecera para identificar que aplicación (client-id) solicita el API.
Identificador del servicion. Formato xxxx (4 dígitos)
Sucede cuando el servidor no puede o no procesará la solicitud debido a un error aparente del cliente
Sucede cuando se requiere autenticación y ha fallado o aún no se ha proporcionado.
Sucede cuando el usuario puede haber iniciado sesión pero no tiene los permisos necesarios para el recurso.
Sucede cuando la solicitud con los criterios especificados no existe en la base de datos.
Sucede cuando el servicio de negocios agotó el tiempo de espera para la respuesta.
Sucede cuando se encontró una condición inesperada y ningún mensaje más específico es adecuado.
Sucede cuando carece de la capacidad de satisfacer la solicitud. Esto implica la disponibilidad futura.
/automaticServices/{serviceId}
API para consultar un convenio de pago automático de servicios.
Recurso para buscar un convenio de pago automático de servicios mediante el identificador serviceId
Parametro “serviceId” con formato xxxxx (5 dígitos)
Identifica al cliente (client-id) para hacer peticiones a la API
Esta API responderá en el encabezado Content-Language el idioma utilizado en la respuesta.
Cabecera para Token de acceso, formato OAuth2. Para obtener el token se debe utilizar el API "SECURITY OAUTH" contenida en el producto "P-SECURITY", con parametro scope = "services.read audit.write". Posteriormente se debe introducir el token obtenido precedido de la palabra "Bearer" y un espacio.
Cabecera para identificar el dispositivo que solicita el API, por ejemplo: Navegador móvil, Tablet, Reloj, etc. Web Browser como predeterminado para Mac / PC.
Cabecera para identificar la sesión de la aplicación consumidora
Cabecera para identificar el content type utilizado en la petición.
Cabecera para identificar que aplicación (client-id) solicita el API.
Identificador del servicio. Formato "xxxxx" (5 dígitos)
Sucede cuando el servidor no puede o no procesará la solicitud debido a un error aparente del cliente
Sucede cuando se requiere autenticación y ha fallado o aún no se ha proporcionado.
Sucede cuando el usuario puede haber iniciado sesión pero no tiene los permisos necesarios para el recurso.
Sucede cuando la solicitud con los criterios especificados no existe en la base de datos.
Sucede cuando el servicio de negocios agotó el tiempo de espera para la respuesta.
Sucede cuando se encontró una condición inesperada y ningún mensaje más específico es adecuado.
Sucede cuando carece de la capacidad de satisfacer la solicitud. Esto implica la disponibilidad futura.
/directServices
API para listar los convenios de pago directo de servicios mediante diferentes parámetros.
Recurso que permite filtrar los convenios de pagos directos según los parámetrso opcionales “description” (descripción del servicio) y “internetPaymentAllow” (puede tomar los valores S, para pagos permitidos vía internet, o N en caso contrario)
Identifica al cliente (client-id) para hacer peticiones a la API
Esta API responderá en el encabezado Content-Language el idioma utilizado en la respuesta.
Cabecera para Token de acceso, formato OAuth2. Para obtener el token se debe utilizar el API "SECURITY OAUTH" contenida en el producto "P-SECURITY", con parametro scope = "services.read audit.write". Posteriormente se debe introducir el token obtenido precedido de la palabra "Bearer" y un espacio.
Cabecera para identificar el dispositivo que solicita el API, por ejemplo: Navegador móvil, Tablet, Reloj, etc. Web Browser como predeterminado para Mac / PC.
Cabecera para identificar la sesión de la aplicación consumidora
Cabecera para identificar el content type utilizado en la petición.
Cabecera para identificar que aplicación (client-id) solicita el API.
Descripcion del servicio
Filtra los convenios de pago directo de servicios que se pueden ejecutar vía internet (valor S para pagos permitidos vía internet o valor N en caso contrario)
Sucede cuando el servidor no puede o no procesará la solicitud debido a un error aparente del cliente
Sucede cuando se requiere autenticación y ha fallado o aún no se ha proporcionado.
Sucede cuando el usuario puede haber iniciado sesión pero no tiene los permisos necesarios para el recurso.
Sucede cuando la solicitud con los criterios especificados no existe en la base de datos.
Sucede cuando el servicio de negocios agotó el tiempo de espera para la respuesta.
Sucede cuando se encontró una condición inesperada y ningún mensaje más específico es adecuado.
Sucede cuando carece de la capacidad de satisfacer la solicitud. Esto implica la disponibilidad futura.
/automaticServices
API para listar los convenios de pago automático de servicios mediante diferentes parámetros.
Recurso que permite filtrar los convenios de pagos automáticos (domiciliados) según los parámetos opcionales “channel” (Puede tomar los valores 1 (Sucursales), 2(Supernet) y 3(Centel)), “accountType” (Puede tomar los valores 1 (Débito) y 2 (Crédito)) y description (descripción del servicio)
Identifica al cliente (client-id) para hacer peticiones a la API
Esta API responderá en el encabezado Content-Language el idioma utilizado en la respuesta.
Cabecera para identificar el dispositivo que solicita el API, por ejemplo: Navegador móvil, Tablet, Reloj, etc. Web Browser como predeterminado para Mac / PC.
Cabecera para identificar la sesión de la aplicación consumidora
Cabecera para identificar el content type utilizado en la petición.
Cabecera para identificar que aplicación (client-id) solicita el API.
Cabecera para Token de acceso, formato OAuth2. Para obtener el token se debe utilizar el API "SECURITY OAUTH" contenida en el producto "P-SECURITY", con parametro scope = "services.read audit.write". Posteriormente se debe introducir el token obtenido precedido de la palabra "Bearer" y un espacio.
Descripcion del servicio
Permite filtrar los convenios de pago automático de servicios mediante su canal. Puede tomar los valores 1 (Sucursales), 2(Supernet) y 3(Centel)
Permite filtrar los convenios de pago automático de servicios mediante el tipo de cuenta. Puede tomar los valores 1 (Débito) y 2 (Crédito)
Sucede cuando el servidor no puede o no procesará la solicitud debido a un error aparente del cliente
Sucede cuando se requiere autenticación y ha fallado o aún no se ha proporcionado.
Sucede cuando el usuario puede haber iniciado sesión pero no tiene los permisos necesarios para el recurso.
Sucede cuando la solicitud con los criterios especificados no existe en la base de datos.
Sucede cuando el servicio de negocios agotó el tiempo de espera para la respuesta.
Sucede cuando se encontró una condición inesperada y ningún mensaje más específico es adecuado.
Sucede cuando carece de la capacidad de satisfacer la solicitud. Esto implica la disponibilidad futura.
Definiciones
{
"properties": {
"code": {
"type": "string",
"example": "SomethingBadHappened",
"description": "Código"
},
"message": {
"type": "string",
"example": "Something bad happened :(",
"description": "Mensaje"
},
"level": {
"type": "string",
"example": "warning",
"description": "Nivel"
},
"description": {
"type": "string",
"description": "Descripción resumida del error con consejos sobre cómo resolverlo.",
"example": ""
},
"moreInfo": {
"type": "string",
"example": "http:\/\/developer.ibm.com\/product\/errors\/1234",
"description": "Más información"
}
},
"required": [
"code",
"message",
"level",
"description",
"moreInfo"
]
}
Convenio de pago referenciado directo
{
"properties": {
"serviceRefenceType": {
"type": "string",
"description": "Tipo de la referencia del servicio",
"example": "Alfanumérico"
},
"serviceDescription": {
"properties": [],
"type": "string",
"description": "Descripción del servicio",
"example": "GOB EDO VERACRUZ (IMPUESTOS VARIOS)"
},
"serviceId": {
"properties": [],
"type": "string",
"description": "Identificador del servicio",
"example": "0983"
},
"accountNumber": {
"properties": [],
"type": "string",
"description": "Número de cuenta",
"example": "65501771947"
},
"serviceReferenceMaxLengt": {
"properties": [],
"type": "string",
"description": "Longitud máxima de la referencia del servicio",
"example": "20"
},
"serviceReferenceMinLength": {
"properties": [],
"type": "string",
"description": "Longitud mínima de la referencia del servicio",
"example": "05"
},
"serviceFee": {
"properties": [],
"type": "string",
"description": "Comisión del servicio",
"example": "20.00"
},
"serviceCurrency": {
"properties": [],
"type": "string",
"description": "Divisa en la que se paga el servicio",
"example": "MXP"
},
"internetPaymetAllow": {
"properties": [],
"type": "string",
"description": "Indica si es posible el pago vía internet",
"example": "Si"
}
},
"additionalProperties": false
}
Lista de los convenios de pagos directos
{
"type": "array",
"items": {
"$ref": "#\/definitions\/direct_payment"
}
}
Convenio de pago automático
{
"properties": {
"serviceId": {
"type": "string",
"description": "Identificador del servicio",
"example": "10331"
},
"serviceDescription": {
"properties": [],
"type": "string",
"description": "Descripción del servicio",
"example": "SERVICIOS PAGO AGUA POTABLE"
},
"serviceShortDescription": {
"properties": [],
"type": "string",
"description": "Descripción corta del servicio",
"example": "CAPAS"
},
"serviceLongDescription": {
"properties": [],
"type": "string",
"description": "Descripción larga del servicio",
"example": "COMISION AGUA POTABLE ALCANTARILLADO SAN"
},
"taxId": {
"properties": [],
"type": "string",
"description": "RFC (Registro Federal de contribuyentes)",
"example": "CAP9510013B8"
},
"paymentPeriodicity": {
"properties": [],
"type": "string",
"description": "Periodicidad de pago permitida",
"example": "MENS\/BIMESTRAL"
},
"channel": {
"properties": [],
"type": "string",
"description": "Canal. Puede tomar los valores 1 (Sucursales), 2(Supernet) y 3(Centel))",
"example": "3"
},
"accountType": {
"properties": [],
"type": "string",
"description": "Tipo de cuenta. Puede tomar los valores 1 (Débito) y 2 (Crédito)",
"example": "1"
},
"accountTypeDescription": {
"properties": [],
"type": "string",
"description": "Descripción del tipo de cuenta. Valor decodificado del parámetro \"accountType\"",
"example": "Débito"
},
"channelDescription": {
"properties": [],
"type": "string",
"description": "Descripción del canal. Valor decodificado del parámetro \"channel\"",
"example": "SuperNet"
}
},
"additionalProperties": false
}
Lista de convenios de pago automático de servicios.
{
"type": "array",
"items": {
"$ref": "#\/definitions\/automatic_payment"
}
}