Recibe los pagos de tus clientes a través del Botón de Pagos Mercantil, el cual le permite transacciones con tarjetas de crédito Diners Club, Visa y Mastercard nacionales e internacionales y Tarjeta de Débito Mercantil desde el móvil o página web.
Soporte para los API de Mercantil Banco C.A.
production
development
https://apimbu.mercantilbanco.com/mercantil-banco/prod
Paths
/pay
post /pay
clientId
X-IBM-Client-Id
(apiKey located in header)
Id de autorizacion utilizado en el Header entregado por Mercantil Banco.
Payment Request
Required in body
object
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
200 OK
400
400 Bad Resquest
Example Request
Example Response
POST https://apimbu.mercantilbanco.com/mercantil-banco/prod/v1/payment/pay
Try this operation
Definitions
Información asociada a la identificación del comercio
{
"properties": {
"integratorId": {
"type": "integer",
"format": "int32",
"description": "Código de integrador asignado por Mercantil Banco, si es un integrador de comercios el valor debe ser 1",
"example": "1"
},
"merchantId": {
"type": "integer",
"format": "int32",
"description": "Código de comercio entregado por Mercantil junto a la clave de cifrado que utilizará para cifrar la data sensible",
"example": "150332"
},
"terminalId": {
"type": "string",
"description": "Código de terminal asignado por Mercantil Banco, si el Mercantil Banco no le suministra código de terminal debe colocar el valor 1",
"example": "1"
}
},
"additionalProperties": false,
"required": [
"integratorId",
"merchantId",
"terminalId"
]
}
Información asociada a identificar el dispositivo utilizado por el cliente pagador
{
"properties": {
"ipaddress": {
"type": "string",
"description": "IP Address del cliente pagador",
"example": "10.0.0.1"
},
"browser_agent": {
"type": "string",
"description": "User Agent en caso de que el cliente realizo el pago vía browser",
"example": "Chrome 18.1.3"
},
"mobile": {
"$ref": "#/definitions/Mobile",
"description": "Información asociada a los datos del dispositivo móvil (cliente pagador)"
}
},
"additionalProperties": false,
"required": [
"ipaddress"
]
}
Información asociada a la geolocalización del dispositivo móvil (cliente pagador)
{
"properties": {
"lat": {
"type": "number",
"format": "double",
"example": 37.422476,
"description": "Geo localizacion latitud"
},
"lng": {
"type": "number",
"format": "double",
"description": "Geo localizacion longitud",
"example": 122.08425
}
},
"additionalProperties": false,
"required": [
"lat",
"lng"
]
}
Información asociada a los datos del dispositivo móvil (cliente pagador)
{
"properties": {
"manufacturer": {
"type": "string",
"description": "Marca del dispositivo móvil (cliente pagador)",
"example": "Samsung"
},
"model": {
"type": "string",
"description": "Modelo del dispositivo móvil (cliente pagador)",
"example": "S9"
},
"os_version": {
"type": "string",
"description": "Sistema operativo Modelo del dispositivo móvil (cliente pagador)",
"example": "Oreo 9.1"
},
"location": {
"$ref": "#/definitions/Location",
"description": "Información asociada a la geolocalización del dispositivo móvil (cliente pagador)"
}
},
"additionalProperties": false,
"required": [
"manufacturer",
"model",
"os_version",
"location"
]
}
Información asociada a la transacción financiera
{
"properties": {
"trx_type": {
"type": "string",
"description": "Tipo de transacción, constante \"compra\"",
"example": "compra"
},
"payment_method": {
"type": "string",
"description": "Método de pago TDD para tarjeta de débito y TDC para tarjeta de crédito",
"example": "tdd"
},
"card_number": {
"type": "string",
"description": "Número de tarjeta de débito o crédito dependiendo del método de pago",
"example": "501878200066287386"
},
"customer_id": {
"type": "string",
"example": "V18366876",
"description": "Cédula de identidad del cliente (el tipo de identificación debe siempre ir al inicio sin guiones ni caracteres especiales"
},
"invoice_number": {
"type": "string",
"description": "Número de factura, este datos es utilizado para relacionar la operación del cliente con los pago",
"example": "3564544"
},
"account_type": {
"type": "string",
"description": "Tipo de cuenta a debitar, solo aplica para método de pago TDD, los valores posibles son: CC para cuenta corriente CA para cuenta de ahorros",
"example": "CA"
},
"twofactor_auth": {
"type": "string",
"description": "Clave telefónica del cliente, la clave telefónica el cliente pagador puede gestionarla desde Mercantil en línea",
"example": "F5zai+S5sgmbdNPDEVRlVg=="
},
"expiration_date": {
"type": "string",
"description": "Fecha de expiración de la tarjeta en formato AAAA/MM, año de 4 dígitos y mes de dos dígitos",
"example": "2020/11"
},
"cvv": {
"type": "string",
"description": "CVV de la tarjeta de débito y crédito, este dato esta en la parte posterior de las tarjetas físicas",
"example": "BCqzVtesja27ClW0fi4EfA=="
},
"currency": {
"type": "string",
"description": "Tipo de moneda, constante ves",
"example": "VES"
},
"amount": {
"type": "number",
"format": "float",
"description": "Monto de la transacciones. El separador decimal es \".\" Ejemplo si el monto en ves es 2525,33 el valor a ser colocado en este campo es 2525.33",
"example": 2525.33
}
},
"additionalProperties": false,
"required": [
"trx_type",
"payment_method",
"card_number",
"customer_id",
"invoice_number",
"account_type",
"twofactor_auth",
"expiration_date",
"cvv",
"currency",
"amount"
]
}
Información asociada a la transacción financiera
{
"properties": {
"processing_date": {
"type": "string",
"description": "Fecha en que fue realizada la transacción",
"example": "2019-09-12 03:07:53 VET"
},
"trx_status": {
"type": "string",
"description": "Estatus de la transacción",
"example": "approved"
},
"trx_type": {
"type": "string",
"description": "Tipo de transacción, constante \"compra\"",
"example": "compra"
},
"payment_method": {
"type": "string",
"description": "Método de pago TDD para tarjeta de débito y TDC para tarjeta de crédito",
"example": "tdd"
},
"payment_reference": {
"type": "string",
"description": "Número de referencia de la transacción",
"example": "0057718281656"
},
"invoice_number": {
"type": "string",
"description": "Número de factura, este datos es utilizado para relacionar la operación del cliente con los pago",
"example": "113466"
},
"amount": {
"type": "number",
"format": "float",
"description": "Monto de la transacciones.",
"example": 30.11
},
"currency": {
"type": "string",
"description": "Tipo de moneda, constante ves",
"example": "ves"
},
"trx_internal_status": {
"type": "string",
"description": "Estatus interno de la transacción, si es diferente a 00 hay un error interno y se debe reportar para su evaluación.",
"example": "00"
}
},
"additionalProperties": false,
"required": [
"processing_date",
"trx_status",
"trx_type",
"payment_method",
"payment_reference",
"invoice_number",
"amount",
"currency",
"trx_internal_status"
]
}
Objeto que aglomera todos los objetos retornados por la transaccion.
{
"properties": {
"merchant_identify": {
"$ref": "#/definitions/Merchant_Identify",
"description": "Objeto que contiene informacion del comercio",
"example": ""
},
"transaction_response": {
"$ref": "#/definitions/Transaction_Response",
"description": "Objeto que contiene informacion de la transacción a realizar",
"example": ""
}
},
"additionalProperties": false,
"required": [
"transaction_response",
"merchant_identify"
]
}
Objeto que contiene los Objetos Merchant_Identify, Client_Identify y Transaction
{
"properties": {
"merchant_identify": {
"$ref": "#/definitions/Merchant_Identify",
"description": "Objeto que contiene informacion del comercio",
"example": ""
},
"client_identify": {
"$ref": "#/definitions/Client_Identify",
"description": "Objeto que contiene informacion del cliente",
"example": ""
},
"transaction": {
"$ref": "#/definitions/Transaction",
"description": "Objeto que contiene informacion de la transacción a realizar",
"example": ""
}
},
"additionalProperties": false,
"required": [
"client_identify",
"transaction",
"merchant_identify"
]
}
Contiene la lista de errores del API
{
"properties": {
"error_code": {
"type": "string",
"description": "Codigo de error",
"example": "0210"
},
"description": {
"type": "string",
"description": "Descripcion del Error",
"example": "Numero de Factura Procesado Previamente"
}
},
"additionalProperties": false,
"required": [
"error_code",
"description"
]
}
Response de Error cuando hay alguna falla en la transacción.
{
"properties": {
"processing_date": {
"type": "string",
"description": "Fecha en que fue realizada la transacción",
"example": "2019-09-12 03:07:53 VET"
},
"merchant_identify": {
"type": "string"
},
"error_list": {
"$ref": "#/definitions/Error_List"
}
},
"additionalProperties": false,
"required": [
"processing_date",
"error_list",
"merchant_identify"
]
}
Comments
intt_mercantil01
Wed, 11/03/2021 - 15:05
Permalink
Buenas tardes estoy
Buenas tardes estoy actualmente integrando el api para pagos tienen algun archivo de usuarios que se pueda utilizar de manera de pruebas.
DELGADO GARCÍA ... (not verified)
Tue, 11/16/2021 - 16:22
Permalink
Buenas tardes, he tratado de
Buenas tardes, he tratado de pagar mi prorroga de pasaporte con mi tarjeta de debito mercantil y me arroja el siguiente mensaje" usuario bloqueado por superar el max. autenticaciones erradas", por favor desbloquear
DELGADO GARCÍA ...
Mon, 11/22/2021 - 20:27
Permalink
Por favor equipo Mercantil mi
Por favor equipo Mercantil mi tarjeta se encuentra bloqueada desde hace varios dias y necesito a la brevedad que la desbloqueen ya que debo realizar pago en el SAIME, usuario bloqueado por superar el max. autenticaciones erradas", por favor desbloquear
CEPROALARM
Thu, 01/06/2022 - 13:25
Permalink
Pruebas para tarjeta de crédito
Es un gusto saludar
estoy actualmente integrando el api para pagos y estoy necesitando las pruebas para el pago de tarjetas de créditos