Crear nuevo cargo

POST 
/cargo

Crear nuevo cargo

Request

application/json

Body

Crear nuevo cargo

monto numberrequired

Possible values: >= 1 and <= 999999999999999

Monto de la transacción

pais string

Possible values: >= 3 characters and <= 3 characters

Default value: MEX

Identificador de país de tres caracteres

moneda string

Possible values: >= 3 characters and <= 3 characters

Default value: MXN

Identificador de moneda de tres caracteres de acuerdo al estándar ISO 4217

descripcion string

Possible values: <= 250 characters

Descripción breve de la transacción

capturar boolean

Default value: true

Permite hacer sólo la autorización de un cargo sin capturar

incluir_riesgo boolean

Permite obtener una respuesta extendida del análisis de riesgo

metodo_pago string

Possible values: [tarjeta, credito, transferencia]

Default value: tarjeta

Define el tipo de pago que será usado en la transacción, en cargos con tarjeta bancaria deberá ser ('tarjeta'), cargos con transferencia bancaria deberá ser ('transferencia') cargos con crédito claro shop deberá ser ('credito')

tarjeta

object

Objeto tarjeta, requerido si metodo_pago = tarjeta

token stringrequired

Token de tarjeta obtenido del servicio de tarjeta

credito

object

Objeto credito, requerido si metodo_pago = credito

formato stringrequired

Possible values: [claroshop]

Tipo de crédito

sucursal integer

Número de sucursal

transferencia

object

Objeto transferencia, requerido si metodo_pago = transferencia

formato stringrequired

Formato del tipo de transferencia.

concepto string

Concepto de la transferencia.

fecha_inicio date-time

Fecha y hora de inicio de la vigencia de la referencia

fecha_fin date-time

Fecha y hora de vigencia de la vigencia de la referencia

pedido

object

Objeto Pedido

id_externo string

Possible values: >= 5 characters and <= 48 characters

Identificador de orden del comercio

creacion date-time

Fecha de creación del objeto

direccion_envio

object

linea1 string

Possible values: <= 120 characters

Línea de dirección 1

linea2 string

Possible values: <= 120 characters

Línea de dirección 2

linea3 string

Possible values: <= 120 characters

Línea de dirección 3

cp string

Possible values: >= 3 characters and <= 10 characters

Código postal

telefono

object

tipo string

Possible values: [no_definido, movil, casa, oficina, facturacion, mensajeria, temporal]

De acuerdo al catálogo tipo teléfono

codigo_pais string

Codigo telefónico de un país

codigo_area string

Codigo telefónico de área

prefijo string

Valor opcional, prefijo utilizado por algunos países

numero number

Teléfono del cliente

extension number

Extensión

municipio string

Possible values: <= 60 characters

Municipio o delegación

ciudad string

Possible values: <= 60 characters

Ciudad

estado string

Possible values: >= 3 characters and <= 3 characters

Identificador de estado de tres caracteres de acuerdo al estándar ISO 3166-2

pais string

Possible values: >= 3 characters and <= 3 characters

Identificador de país de tres caracteres de acuerdo al estándar ISO 3166-1

referencia_1 string

Possible values: <= 120 characters

Referencia adicional, ejemplo: nombre de entre calle 1

referencia_2 string

Possible values: <= 120 characters

Referencia adicional, ejemplo: nombre de entre calle 2

longitud number

Possible values: >= -90 and <= 90

Coordenadas de longitud de localización del domicilio

latitud number

Possible values: >= -90 and <= 90

Coordenadas de latitud de localización del domicilio

nombre string

Nombre o nombres del cliente

apellido_paterno string

Apellido paterno del cliente

apellido_materno string

Apellido materno del cliente

peso number

Peso total del pedido (en Kg.)

articulos

object[]

Arreglo de Objetos Articulo

Array [

id_pedido string

Identificador de orden del comercio

nombre_producto string

Nombre de producto

descripcion_producto string

Descripción del producto

sku string

Id único de producto en el comercio, código interno (SKU: stock keeping unit)

ean_upc string

Id de producto de acuerdo a códigos internacionales (UPC: universal product code, EAN: European article number, GS1/GTIN, otros)

tipo_producto string

Possible values: [digital, servicio, electronico, software, suscripcion, cupon, tarjeta_regalo, moda, otro]

De acuerdo a referencia de Catálogo Tipo de Producto

cantidad integer

Número de piezas del mismo producto

precio_unitario number

Precio unitario del producto

precio_total number

Precio total incluyendo todas las piezas

otros string

Possible values: <= 255 characters

Campo para detalles adicionales del producto disponible para el comercio, máximo 255 caracteres

es_digital boolean

Indica si el producto es digital y su entrega puede ser inmediata (descarga / envío de código / etc…)

]

total_articulos integer

Total de artículos en pedido

fecha_creacion date-time

Fecha de levantamiento de pedido en el Comercio

fecha_entrega date-time

Fecha estimada de entrega

empresa_envio string

Possible values: [noventamin, correosmex, dhl, estafeta, fedex, aeroflash, paquetexpress, redpack, senda, ups, propia, otro]

numero_guia string

Possible values: <= 250 characters

Número de guía de pedido

es_regalo boolean

Indicará si el pedido es considerado un regalo

monto_articulos number

Monto total con impuestos del costo de articulos

monto_envio number

Monto total sin impuestos del envío

total_monto number

Monto total con impuestos del pedido

device_fingerprint string

Id de dispositivo de cliente

ip_cliente ipv4

Ip del cliente o comprador

datos_comercio

object

key number

Possible values: >= 1 and <= 99

Key de campo personalizado

value string

Possible values: non-empty and <= 250 characters

Valor de campo personalizado

cliente

object

id string

Id de cliente previamente registrado en T1pagos, si se incluye el id, podrán omitirse todos los demás datos del objeto cliente

id_externo string

Identificador único de cliente en plataforma del comercio

creacion_externa date-time

Fecha y hora de creación del usuario en el comercio

nombre string

Nombre o nombres del cliente

apellido_paterno string

Apellido paterno del cliente

apellido_materno string

Apellido materno del cliente

email emailrequired

Correo electrónico del cliente

telefono

object

tipo string

Possible values: [no_definido, movil, casa, oficina, facturacion, mensajeria, temporal]

De acuerdo al catálogo tipo teléfono

codigo_pais string

Codigo telefónico de un país

codigo_area string

Codigo telefónico de área

prefijo string

Valor opcional, prefijo utilizado por algunos países

numero number

Teléfono del cliente

extension number

Extensión

direccion

object

linea1 string

Possible values: <= 120 characters

Línea de dirección 1

linea2 string

Possible values: <= 120 characters

Línea de dirección 2

linea3 string

Possible values: <= 120 characters

Línea de dirección 3

cp string

Possible values: >= 3 characters and <= 10 characters

Código postal

telefono

object

tipo string

Possible values: [no_definido, movil, casa, oficina, facturacion, mensajeria, temporal]

De acuerdo al catálogo tipo teléfono

codigo_pais string

Codigo telefónico de un país

codigo_area string

Codigo telefónico de área

prefijo string

Valor opcional, prefijo utilizado por algunos países

numero number

Teléfono del cliente

extension number

Extensión

municipio string

Possible values: <= 60 characters

Municipio o delegación

ciudad string

Possible values: <= 60 characters

Ciudad

estado string

Possible values: >= 3 characters and <= 3 characters

Identificador de estado de tres caracteres de acuerdo al estándar ISO 3166-2

pais string

Possible values: >= 3 characters and <= 3 characters

Identificador de país de tres caracteres de acuerdo al estándar ISO 3166-1

referencia_1 string

Possible values: <= 120 characters

Referencia adicional, ejemplo: nombre de entre calle 1

referencia_2 string

Possible values: <= 120 characters

Referencia adicional, ejemplo: nombre de entre calle 2

longitud number

Possible values: >= -90 and <= 90

Coordenadas de longitud de localización del domicilio

latitud number

Possible values: >= -90 and <= 90

Coordenadas de latitud de localización del domicilio

PlanPagos

object

Objeto Plan de Pagos

plan string

Possible values: [normal, msi, mci, diferido, diferido_msi, diferido_mci]

Clave del plan a aplicar de Catálgo Tipo de Plan de Pago

parcialidades integer

Possible values: <= 24, [3, 6, 9, 12, 15, 18, 24]

Número de parcialidades a dividir el pago si aplica

diferido integer

Número de meses de diferimiento para iniciar el/los pago/s

redime_puntos boolean

Redimir puntos en compra con tarjetas participantes (consultar antes de enviar)

Responses

200

Cargo exitoso

application/json

Schema

Schema

status string

Possible values: [success, fail, error]

Estatus de la petición

http_code integer

Possible values: [200, 400, 401, 404, 409, 412, 500]

Código http de respuesta en el header

datetime date-time

Fecha y hora de creación del plan

timestamp integer

Tiempo Unix o POSIX

data

object

cargo

object

id string

Identificador de la transacción

monto number

Monto de la transacción

autorizacion_id string

Identificador de autorización del procesador de pago

tipo string

Possible values: [cargo, credito]

Tipo de transacción (“cargo”)

capturado boolean

Indica si la transacción esta capturada

conciliado boolean

Indica si la transacción esta conciliada

monto_capturado number

Monto de capturado de la transaccion

monto_reembolsado number

Monto de reembolsado de la transaccion

fecha_conciliacion date-time

Fecha y hora de la conciliacion

fecha date-time

Fecha y hora de creación de la transacción

orden_id string

Identificador del orden del comercio

cliente_id string

Identificador de cliente del comercio

estatus string

Possible values: [completada, rechazada, pendiente]

Estatus de la transacción

codigo string

Código de procesamiento de acuerdo al catálogo de errores de procesamiento.

descripcion string

Descripción del código obtenido al procesar el cargo.

riesgo

object

score integer

Valor numérico de la evaluación de riesgo obtenida

decision string

Possible values: [aceptar, rechazar, revisar, sin_resultado, sin_respuesta, error_en_peticion]

description

procesador string

Procesador antifraude que tomó la decisión en la transacción

tarjeta

object

Objeto tipo Tarjeta

token string

Token de Tarjeta

pan string

Possible values: >= 14 characters and <= 19 characters

Número de tarjeta sanitizado

terminacion number

Terminación o últimos cuatro dígitos

nombre string

Nombre como aparece en la tarjeta

expiracion_mes integer

Possible values: >= 1 and <= 12

Mes de expiración de tarjeta

expiracion_anio integer

Año de expiración de tarjeta

direccion

object

creacion date-time

Fecha de creación del objeto

linea1 string

Possible values: <= 120 characters

Línea de dirección 1

linea2 string

Possible values: <= 120 characters

Línea de dirección 2

linea3 string

Possible values: <= 120 characters

Línea de dirección 3

cp string

Possible values: >= 3 characters and <= 10 characters

Código postal

telefono

object

tipo string

Possible values: [no_definido, movil, casa, oficina, facturacion, mensajeria, temporal]

De acuerdo al catálogo tipo teléfono

codigo_pais string

Codigo telefónico de un país

codigo_area string

Codigo telefónico de área

prefijo string

Valor opcional, prefijo utilizado por algunos países

numero number

Teléfono del cliente

extension number

Extensión

municipio string

Possible values: <= 60 characters

Municipio o delegación

ciudad string

Possible values: <= 60 characters

Ciudad

estado string

Possible values: >= 3 characters and <= 3 characters

Identificador de estado de tres caracteres de acuerdo al estándar ISO 3166-2

pais string

Possible values: >= 3 characters and <= 3 characters

Identificador de país de tres caracteres de acuerdo al estándar ISO 3166-1

referencia_1 string

Possible values: <= 120 characters

Referencia adicional, ejemplo: nombre de entre calle 1

referencia_2 string

Possible values: <= 120 characters

Referencia adicional, ejemplo: nombre de entre calle 2

longitud number

Possible values: >= -90 and <= 90

Coordenadas de longitud de localización del domicilio

latitud number

Possible values: >= -90 and <= 90

Coordenadas de latitud de localización del domicilio

iin number

Primeros seis dígitos de una tarjeta, equivale a BIN

marca string

Possible values: [visa, mastercard, discover, amex, diners_club, jcb, switch, solo, dankort, maestro, forbrugsforeningen, laser]

De acuerdo al catálogo Marca de Tarjeta

cliente_id string

Id de cliente en plataforma T1pagos

default boolean

Determina si la tarjeta es la utilizada por dafault para el cliente asignado

cargo_unico boolean

Determina si la tarjeta sólo se puede utilizar para un único cargo

creacion date-time

actualizacion date-time

cliente

object

id string

Possible values: <= 64 characters

Identificador único de cliente

creacion date-time

Fecha de creación del objeto

actualizacion date-time

Fecha de última edición

id_externo string

Possible values: non-empty and <= 64 characters

Identificador único de cliente en plataforma del comercio

creacion_externa date-time

Fecha y hora de creación del usuario en el comercio

nombre string

Possible values: >= 3 characters and <= 30 characters

Nombre o nombres del cliente

apellido_paterno string

Possible values: >= 3 characters and <= 30 characters

Apellido paterno del cliente

apellido_materno string

Possible values: >= 3 characters and <= 30 characters

Apellido materno del cliente

sexo string

Possible values: [masculino, femenino]

Sexo del cliente

email emailrequired

Possible values: <= 250 characters

Correo electrónico del cliente

telefono

object

tipo string

Possible values: [no_definido, movil, casa, oficina, facturacion, mensajeria, temporal]

De acuerdo al catálogo tipo teléfono

codigo_pais string

Codigo telefónico de un país

codigo_area string

Codigo telefónico de área

prefijo string

Valor opcional, prefijo utilizado por algunos países

numero number

Teléfono del cliente

extension number

Extensión

nacimiento date-time

Fecha de nacimiento

direccion

object

creacion date-time

Fecha de creación del objeto

linea1 string

Possible values: <= 120 characters

Línea de dirección 1

linea2 string

Possible values: <= 120 characters

Línea de dirección 2

linea3 string

Possible values: <= 120 characters

Línea de dirección 3

cp string

Possible values: >= 3 characters and <= 10 characters

Código postal

telefono

object

tipo string

Possible values: [no_definido, movil, casa, oficina, facturacion, mensajeria, temporal]

De acuerdo al catálogo tipo teléfono

codigo_pais string

Codigo telefónico de un país

codigo_area string

Codigo telefónico de área

prefijo string

Valor opcional, prefijo utilizado por algunos países

numero number

Teléfono del cliente

extension number

Extensión

municipio string

Possible values: <= 60 characters

Municipio o delegación

ciudad string

Possible values: <= 60 characters

Ciudad

estado string

Possible values: >= 3 characters and <= 3 characters

Identificador de estado de tres caracteres de acuerdo al estándar ISO 3166-2

pais string

Possible values: >= 3 characters and <= 3 characters

Identificador de país de tres caracteres de acuerdo al estándar ISO 3166-1

referencia_1 string

Possible values: <= 120 characters

Referencia adicional, ejemplo: nombre de entre calle 1

referencia_2 string

Possible values: <= 120 characters

Referencia adicional, ejemplo: nombre de entre calle 2

longitud number

Possible values: >= -90 and <= 90

Coordenadas de longitud de localización del domicilio

latitud number

Possible values: >= -90 and <= 90

Coordenadas de latitud de localización del domicilio

estado string

Possible values: [activo, inactivo, suspendido]

Estado del Cliente

procesador

object

adquiriente string

codigo string

mensaje string

prueba boolean

Indica si la transacción es una prueba

Example (from schema)

{
  "status": "success",
  "http_code": 200,
  "datetime": "2024-05-22T21:56:52.831Z",
  "timestamp": 0,
  "data": {
    "cargo": {
      "id": "string",
      "monto": 0,
      "autorizacion_id": "string",
      "tipo": "cargo",
      "capturado": false,
      "conciliado": false,
      "monto_capturado": 0,
      "monto_reembolsado": 0,
      "fecha_conciliacion": "2024-05-22T21:56:52.831Z",
      "fecha": "2024-05-22T21:56:52.831Z",
      "orden_id": "string",
      "cliente_id": "string",
      "estatus": "completada",
      "codigo": "string",
      "descripcion": "string",
      "riesgo": {
        "score": 0,
        "decision": "aceptar",
        "procesador": "string"
      },
      "tarjeta": {
        "token": "string",
        "pan": "411111******1111",
        "terminacion": 0,
        "nombre": "string",
        "expiracion_mes": 0,
        "expiracion_anio": 0,
        "direccion": {
          "creacion": "2024-05-22T21:56:52.831Z",
          "linea1": "string",
          "linea2": "string",
          "linea3": "string",
          "cp": "string",
          "telefono": {
            "tipo": "no_definido",
            "codigo_pais": "string",
            "codigo_area": "string",
            "prefijo": "string",
            "numero": "5566778899",
            "extension": 0
          },
          "municipio": "string",
          "ciudad": "string",
          "estado": "string",
          "pais": "string",
          "referencia_1": "string",
          "referencia_2": "string",
          "longitud": 0,
          "latitud": 0
        },
        "iin": 0,
        "marca": "visa",
        "cliente_id": "string",
        "default": true,
        "cargo_unico": true,
        "creacion": "2024-05-22T21:56:52.831Z",
        "actualizacion": "2024-05-22T21:56:52.831Z"
      },
      "cliente": {
        "id": "176f76a82670428898001dd5f031a57e",
        "creacion": "2024-05-22T21:56:52.831Z",
        "actualizacion": "2024-05-22T21:56:52.831Z",
        "id_externo": "string",
        "creacion_externa": "2024-05-22T21:56:52.831Z",
        "nombre": "string",
        "apellido_paterno": "string",
        "apellido_materno": "string",
        "sexo": "masculino",
        "email": "usuario@t1pagos.com",
        "telefono": {
          "tipo": "no_definido",
          "codigo_pais": "string",
          "codigo_area": "string",
          "prefijo": "string",
          "numero": "5566778899",
          "extension": 0
        },
        "nacimiento": "2024-05-22T21:56:52.831Z",
        "direccion": {
          "creacion": "2024-05-22T21:56:52.831Z",
          "linea1": "string",
          "linea2": "string",
          "linea3": "string",
          "cp": "string",
          "telefono": {
            "tipo": "no_definido",
            "codigo_pais": "string",
            "codigo_area": "string",
            "prefijo": "string",
            "numero": "5566778899",
            "extension": 0
          },
          "municipio": "string",
          "ciudad": "string",
          "estado": "string",
          "pais": "string",
          "referencia_1": "string",
          "referencia_2": "string",
          "longitud": 0,
          "latitud": 0
        },
        "estado": "activo"
      },
      "procesador": {
        "adquiriente": "eglobal/prosa/amex",
        "codigo": "00",
        "mensaje": "aprobada"
      },
      "prueba": true
    }
  }
}

400

Error en petición

application/json

Schema

Schema

status string

Possible values: [error, fail]

Estatus de la petición

error

object

code integer

type string

message string
http_code integer

Código http de respuesta en el header

datetime date-time

Fecha y hora de creación.

timestamp integer

Tiempo Unix o POSIX

data object

Datos del error obtenido, sólo estará presente en errores HTTP 400

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "type": "string",
    "message": "string"
  },
  "http_code": 0,
  "datetime": "2024-05-22T21:56:52.833Z",
  "timestamp": 0,
  "data": {}
}

401

No autorizado

application/json

Schema

Schema

status string

Possible values: [error, fail]

Estatus de la petición

error

object

code integer

type string

message string
http_code integer

Código http de respuesta en el header

datetime date-time

Fecha y hora de creación.

timestamp integer

Tiempo Unix o POSIX

data object

Datos del error obtenido, sólo estará presente en errores HTTP 400

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "type": "string",
    "message": "string"
  },
  "http_code": 0,
  "datetime": "2024-05-22T21:56:52.834Z",
  "timestamp": 0,
  "data": {}
}

404

No se ha encontrado el recurso solicitado

application/json

Schema

Schema

status string

Possible values: [error, fail]

Estatus de la petición

error

object

code integer

type string

message string
http_code integer

Código http de respuesta en el header

datetime date-time

Fecha y hora de creación.

timestamp integer

Tiempo Unix o POSIX

data object

Datos del error obtenido, sólo estará presente en errores HTTP 400

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "type": "string",
    "message": "string"
  },
  "http_code": 0,
  "datetime": "2024-05-22T21:56:52.834Z",
  "timestamp": 0,
  "data": {}
}

409

Recurso duplicado

application/json

Schema

Schema

status string

Possible values: [error, fail]

Estatus de la petición

error

object

code integer

type string

message string
http_code integer

Código http de respuesta en el header

datetime date-time

Fecha y hora de creación.

timestamp integer

Tiempo Unix o POSIX

data object

Datos del error obtenido, sólo estará presente en errores HTTP 400

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "type": "string",
    "message": "string"
  },
  "http_code": 0,
  "datetime": "2024-05-22T21:56:52.834Z",
  "timestamp": 0,
  "data": {}
}

412

Error por precondicion

application/json

Schema

Schema

status string

Possible values: [error, fail]

Estatus de la petición

error

object

code integer

type string

message string
http_code integer

Código http de respuesta en el header

datetime date-time

Fecha y hora de creación.

timestamp integer

Tiempo Unix o POSIX

data object

Datos del error obtenido, sólo estará presente en errores HTTP 400

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "type": "string",
    "message": "string"
  },
  "http_code": 0,
  "datetime": "2024-05-22T21:56:52.836Z",
  "timestamp": 0,
  "data": {}
}

4XX

Error en petición

application/json

Schema

Schema

status string

Possible values: [error, fail]

Estatus de la petición

error

object

code integer

type string

message string
http_code integer

Código http de respuesta en el header

datetime date-time

Fecha y hora de creación.

timestamp integer

Tiempo Unix o POSIX

data object

Datos del error obtenido, sólo estará presente en errores HTTP 400

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "type": "string",
    "message": "string"
  },
  "http_code": 0,
  "datetime": "2024-05-22T21:56:52.837Z",
  "timestamp": 0,
  "data": {}
}

5XX

Error interno

application/json

Schema

Schema

status string

Possible values: [error, fail]

Estatus de la petición

error

object

code integer

type string

message string
http_code integer

Código http de respuesta en el header

datetime date-time

Fecha y hora de creación.

timestamp integer

Tiempo Unix o POSIX

data object

Datos del error obtenido, sólo estará presente en errores HTTP 400

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "type": "string",
    "message": "string"
  },
  "http_code": 0,
  "datetime": "2024-05-22T21:56:52.837Z",
  "timestamp": 0,
  "data": {}
}

Loading...