--- swagger: "2.0" info: x-ibm-name: services-payment-information title: Services Payment Information version: 1.0.0 description: Información de Servicios que se pueden pagar a través de Santander México contact: name: IRVING RAFAEL MARTINEZ SOTO email: imartinezs@santander.com.mx termsOfService: "" schemes: - https basePath: /services-payment-information/v1.0 consumes: - application/json produces: - application/json securityDefinitions: clientID: type: apiKey in: header name: X-IBM-Client-Id description: Identifica al cliente (client-id) para hacer peticiones a la API security: - clientID: [] x-ibm-configuration: testable: true enforced: true phase: realized paths: /directServices/{serviceId}: get: responses: 200: description: OK schema: $ref: '#/definitions/direct_payments' 400: description: Sucede cuando el servidor no puede o no procesará la solicitud debido a un error aparente del cliente schema: $ref: '#/definitions/errors' 401: description: Sucede cuando se requiere autenticación y ha fallado o aún no se ha proporcionado. schema: $ref: '#/definitions/errors' 403: description: Sucede cuando el usuario puede haber iniciado sesión pero no tiene los permisos necesarios para el recurso. schema: $ref: '#/definitions/errors' 404: description: Sucede cuando la solicitud con los criterios especificados no existe en la base de datos. schema: $ref: '#/definitions/errors' 408: description: Sucede cuando el servicio de negocios agotó el tiempo de espera para la respuesta. schema: $ref: '#/definitions/errors' 500: description: Sucede cuando se encontró una condición inesperada y ningún mensaje más específico es adecuado. schema: $ref: '#/definitions/errors' 501: description: Sucede cuando carece de la capacidad de satisfacer la solicitud. Esto implica la disponibilidad futura. schema: $ref: '#/definitions/errors' tags: - get - Pago Unico - Pago Servicios summary: Recurso para consultar un convenio de pago directo de servicios description: |- Recurso para buscar un convenio de pago directo de servicios mediante el identificador serviceId Parametro “serviceId” con formato xxxx (4 dígitos) parameters: - $ref: '#/parameters/Accept-Language' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/X-Santander-Device' - $ref: '#/parameters/X-Santander-Session-Id' - $ref: '#/parameters/Content-Type' - $ref: '#/parameters/X-IBM-Client-Id' - name: serviceId type: string required: true in: path description: Identificador del servicion. Formato xxxx (4 dígitos) /automaticServices/{serviceId}: get: responses: 200: description: OK schema: $ref: '#/definitions/automatic_payments' 400: description: Sucede cuando el servidor no puede o no procesará la solicitud debido a un error aparente del cliente schema: $ref: '#/definitions/errors' 401: description: Sucede cuando se requiere autenticación y ha fallado o aún no se ha proporcionado. schema: $ref: '#/definitions/errors' 403: description: Sucede cuando el usuario puede haber iniciado sesión pero no tiene los permisos necesarios para el recurso. schema: $ref: '#/definitions/errors' 404: description: Sucede cuando la solicitud con los criterios especificados no existe en la base de datos. schema: $ref: '#/definitions/errors' 408: description: Sucede cuando el servicio de negocios agotó el tiempo de espera para la respuesta. schema: $ref: '#/definitions/errors' 500: description: Sucede cuando se encontró una condición inesperada y ningún mensaje más específico es adecuado. schema: $ref: '#/definitions/errors' 501: description: Sucede cuando carece de la capacidad de satisfacer la solicitud. Esto implica la disponibilidad futura. schema: $ref: '#/definitions/errors' tags: - get - Pago Unico - Pago Servicios summary: API para consultar un convenio de pago automático de servicios. description: |- Recurso para buscar un convenio de pago automático de servicios mediante el identificador serviceId Parametro “serviceId” con formato xxxxx (5 dígitos) parameters: - $ref: '#/parameters/Accept-Language' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/X-Santander-Device' - $ref: '#/parameters/X-Santander-Session-Id' - $ref: '#/parameters/Content-Type' - $ref: '#/parameters/X-IBM-Client-Id' - name: serviceId type: string required: true in: path description: Identificador del servicio. Formato "xxxxx" (5 dígitos) /directServices: get: responses: 200: description: OK schema: $ref: '#/definitions/direct_payments' 400: description: Sucede cuando el servidor no puede o no procesará la solicitud debido a un error aparente del cliente schema: $ref: '#/definitions/errors' 401: description: Sucede cuando se requiere autenticación y ha fallado o aún no se ha proporcionado. schema: $ref: '#/definitions/errors' 403: description: Sucede cuando el usuario puede haber iniciado sesión pero no tiene los permisos necesarios para el recurso. schema: $ref: '#/definitions/errors' 404: description: Sucede cuando la solicitud con los criterios especificados no existe en la base de datos. schema: $ref: '#/definitions/errors' 408: description: Sucede cuando el servicio de negocios agotó el tiempo de espera para la respuesta. schema: $ref: '#/definitions/errors' 500: description: Sucede cuando se encontró una condición inesperada y ningún mensaje más específico es adecuado. schema: $ref: '#/definitions/errors' 501: description: Sucede cuando carece de la capacidad de satisfacer la solicitud. Esto implica la disponibilidad futura. schema: $ref: '#/definitions/errors' tags: - get - Pago Unico - Pago Servicios summary: API para listar los convenios de pago directo de servicios mediante diferentes parámetros. description: 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) parameters: - $ref: '#/parameters/Accept-Language' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/X-Santander-Device' - $ref: '#/parameters/X-Santander-Session-Id' - $ref: '#/parameters/Content-Type' - $ref: '#/parameters/X-IBM-Client-Id' - name: description type: string required: false in: query description: Descripcion del servicio - name: internetPaymentAllow type: string required: false in: query description: 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) /automaticServices: get: responses: 200: description: OK schema: $ref: '#/definitions/automatic_payments' 400: description: Sucede cuando el servidor no puede o no procesará la solicitud debido a un error aparente del cliente schema: $ref: '#/definitions/errors' 401: description: Sucede cuando se requiere autenticación y ha fallado o aún no se ha proporcionado. schema: $ref: '#/definitions/errors' 403: description: Sucede cuando el usuario puede haber iniciado sesión pero no tiene los permisos necesarios para el recurso. schema: $ref: '#/definitions/errors' 404: description: Sucede cuando la solicitud con los criterios especificados no existe en la base de datos. schema: $ref: '#/definitions/errors' 408: description: Sucede cuando el servicio de negocios agotó el tiempo de espera para la respuesta. schema: $ref: '#/definitions/errors' 500: description: Sucede cuando se encontró una condición inesperada y ningún mensaje más específico es adecuado. schema: $ref: '#/definitions/errors' 501: description: Sucede cuando carece de la capacidad de satisfacer la solicitud. Esto implica la disponibilidad futura. schema: $ref: '#/definitions/errors' tags: - Get - Pago Automático - Domiciliacion pagos - Pago automático servicios summary: API para listar los convenios de pago automático de servicios mediante diferentes parámetros. description: 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) parameters: - $ref: '#/parameters/Accept-Language' - $ref: '#/parameters/X-Santander-Device' - $ref: '#/parameters/X-Santander-Session-Id' - $ref: '#/parameters/Content-Type' - $ref: '#/parameters/X-IBM-Client-Id' - $ref: '#/parameters/Authorization' - name: description type: string required: false in: query description: Descripcion del servicio - name: channel type: string required: false in: query description: Permite filtrar los convenios de pago automático de servicios mediante su canal. Puede tomar los valores 1 (Sucursales), 2(Supernet) y 3(Centel) - name: accountType type: string required: false in: query description: 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) definitions: errors: 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 direct_payment: 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 description: Convenio de pago referenciado directo direct_payments: type: array items: $ref: '#/definitions/direct_payment' description: Lista de los convenios de pagos directos automatic_payment: 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 description: Convenio de pago automático automatic_payments: type: array items: $ref: '#/definitions/automatic_payment' description: Lista de convenios de pago automático de servicios. tags: [] parameters: Accept-Language: name: Accept-Language type: string required: false in: header description: Esta API responderá en el encabezado Content-Language el idioma utilizado en la respuesta. Authorization: name: Authorization type: string required: true in: header description: 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. X-Santander-Device: name: X-Santander-Device type: string required: false in: header description: 'Cabecera para identificar el dispositivo que solicita el API, por ejemplo: Navegador móvil, Tablet, Reloj, etc. Web Browser como predeterminado para Mac / PC.' Content-Type: name: Content-Type type: string required: false in: header description: Cabecera para identificar el content type utilizado en la petición. X-IBM-Client-Id: name: X-IBM-Client-Id type: string required: true in: header description: Cabecera para identificar que aplicación (client-id) solicita el API. X-Santander-Session-Id: name: X-Santander-Session-Id type: string required: false in: header description: Cabecera para identificar la sesión de la aplicación consumidora x-ibm-endpoints: - endpointUrl: https://api.santander.com.mx/santander-mexico/public type: - production ...