support
Volver a la documentación
Buscar
Categoria
Tags
parámetros principalesdesplegar todo
currency
requerido
orderId
recomendado
formAction
información sobre tu cliente
customer
reference
recomendado
email
requerido
billingDetails
title
category
firstName
lastName
phoneNumber
streetNumber
address
address2
district
zipCode
city
state
country
language
cellPhoneNumber
identityCode
identityType
legalName
shoppingCart
insuranceAmount
shippingAmount
taxAmount
cartItemInfo
[1]
productLabel
productType
productRef
productQty
productAmount
productVat
ipAddress
opciones generales de la transacción
contrib
ipnTargetUrl
fingerPrintId
metadata
[1]
:
strongAuthentication
formTokenVersion
opciones relacionadas con la tarjeta
transactionOptions
cardOptions
paymentSource
mid
retry
Información sobre el sub-vendedor
subMerchantDetails
companyType
legalNumber
name
requerido
url
phoneNumber
address1
address2
zip
city
country
mcc
mid
softDescriptor
state
facilitatorId
Pruébame
Documentación

Web service Charge/CreateToken

L'appel aux Web Services requiert une authentification HTTP Basic Authentication. Plus d'infos : "Phase d'authentification".

POSThttps://api.cobroinmediato.tech/api-payment/V4/Charge/CreateToken

Le Web Service REST Charge/CreateToken permet de créer un alias sans paiement.

Consultez le guide d'intégration Création d'un alias sans paiement.

Parámetros de entrada

contrib

Nombre de la solución de e-comercio utilizada en el sitio web comercial y su número de versión.

Formato

currency

Moneda del pago. Código alfabético un mayúsculas según ISO 4217 alpha-3.

Ejemplo: "ARS" por el peso argentino.

Formato

Valores posibles

. Los valores posibles son:

Moneda CODIFICACIÓN ISO 4217 Unidad fraccionaria
Peso argentino (032) ARS 2
Dólar estadounidense (840) USD 2

formAction

formAction te permite definir el tipo de comportamiento deseado al crear el token.

Formato

Valores posibles

. Los valores posibles son:

VALOR Descripción
REGISTER Creación de un alias (token) para el método de pago. No permite crear un alias asociado a un IBAN.
CUSTOMER_WALLET Agrega la lista de alias asociados con la referencia del comprador en el formulario. El campo customer.reference es obligatorio para este caso de uso.
null Si el valor es nulo o no está definido, se aplica REGISTER.

REGISTER:

El Web Service devuelve un objeto.

C'est le comportement par défaut. L'appel à Charge/CreateToken créé un alias.

CUSTOMER_WALLET:

El Web Service devuelve un objeto.

Ce paramètre permet d'ajouter la liste des alias au formulaire d'enregistrement de carte. Nécessite la référence acheteur customer.reference.

ipnTargetUrl

Puede sobrescribir la URL de notificación instantánea (también llamada IPN) en el formulario si utiliza una única tienda para diferentes canales de venta, diferentes tipos de pago, diferentes idiomas, etc.

Formato

orderId

Referencia de pedido definida por el vendedor. No admite los caracteres UTF-8.

Formato

metadata

Valores personalizados adjuntos a la transacción, en formato json.

Ejemplo de llamada

Por ejemplo, para transmitir un valor personalizado, agregue a su solicitud:

{
    "metadata": {
        "MyValueKey": "1234"
    }
}

Este valor se devolverá en el objeto de transacción recién creado.

También puede utilizar los metadatos " orderInfo ", " orderInfo2 " y " orderInfo3 " para transmitir la información adicional sobre el pedido.

Estos datos se muestran en el Back Office Vendedor, en la información de la transacción (pestaña Extra ).

Formato

fingerPrintId

Este campo lo utilizan los vendedores que implementan el analizador de riesgos en su página de pago. Permite transmitir el identificador de la sesión (o fingerPrint Id) a la plataforma de pago para finalizar el análisis de riesgo.

Los analizadores compatibles son:

  • NOTO
  • Cybersource
  • MonitorPlus
  • ClearSale

Puede contener mayúsculas, minúsculas, números o guiones ([AZ] [az], 0-9, _, -).

Formato

strongAuthentication

strongAuthentication permet d'indiquer la préférence du marchand au sujet de l'authentification de l'acheteur.

  • Sin interacción del titular ( frictionless ).
  • Con interacción del titular (autentificación fuerte o challenge ).
  • Sin preferencia del vendedor.

Siempre es el emisor quien decide el modo de autentificación del comprador.

Se requerirá siempre una autentificación fuerte al registrar una tarjeta, cualquiera que sea la preferencia del vendedor.

Casos de uso Valores posibles
CHALLENGE : Con interacción del titular
  • ENABLED : Valor obsoleto
  • CHALLENGE_REQUESTED : Permite solicitar una autenticación fuerte para la transacción.
  • CHALLENGE_MANDATE : Permite solicitar una autenticación fuerte para la transacción por razones reglamentarias.
FRICTIONLESSSin interacción del titular

Opción "Frictionless 3DS2" obligatoria
  • DISABLED: Permite solicitaruna exenciónde autenticación fuerte.

    Si la tienda no dispone de la opción "Frictionless 3DS2", la elección de preferencia se delega al emisor de la tarjeta (No Preference).

    Si el emisor acepta la solicitud de frictionless, la transacción no está cubierta por la transferencia de responsabilidad en caso de disputa del titular de de tarjeta.

    Sin preferencia del vendedor
    • NO_PREFERENCE : Indica al DS que el vendedor no tiene preferencia. El pago quedará garantizado si el emisor decide realizar una autenticación sin interacción (frictionless).
    • AUTO : Se delega la elección de la preferencia al emisor de la tarjeta (No Preference).

    Formato

    customer.reference

    Identificador del comprador en el sitio web comercial.

    Formato

    customer.email

    E-mail del comprador.

    • Especificaciones de la estructura del correo electrónico: RFC-2822

    Formato

    customer.ipAddress

    Dirección IP del comprador.

    Formato

    address

    Camino: customer.billingDetails.address

    Dirección de facturación.

    Atención: Los caracteres > y < no están permitidos.

    Formato

    address2

    Camino: customer.billingDetails.address2

    Información adicional sobre la dirección de facturación.

    Atención: Los caracteres > y < no están permitidos.

    Formato

    category

    Camino: customer.billingDetails.category

    Tipo de cliente.

    Formato

    Valores posibles

    valores Descripción
    PRIVATE Cliente de tipo Particular
    COMPANY Cliente de tipo Empresa

    cellPhoneNumber

    Camino: customer.billingDetails.cellPhoneNumber

    Teléfono móvil del comprador.

    Acepta todos los formatos:

    Ejemplos:

    • 0623456789
    • +33623456789
    • 0033623456789
    • (+34) 824 65 43 21
    • 87 77 12 34

    Según el medio de pago, algunas restricciones pueden modificar el formato. Para más información, consulte la documentación técnica específica del medio de pago.

    Formato

    city

    Camino: customer.billingDetails.city

    Ciudad de facturación.

    Formato

    country

    Camino: customer.billingDetails.country

    País del comprador (en letras mayúsculas, según la norma ISO 3166-1 alfa-2).

    Formato

    Valores posibles

    Ejemplos de valores posibles:

    País Código
    Argentina AR
    Brasil BR
    Colombia CO
    COSTA RICA CR
    ECUADOR EC
    GUATEMALA GT
    MÉXICO MX
    NICARAGUA NI
    PERÚ PE
    SALVADOR SV
    ESTADOS UNIDOS DE AMÉRICA US
    URUGUAY UY

    district

    Camino: customer.billingDetails.district

    Barrio de la dirección de facturación.

    Formato

    firstName

    Camino: customer.billingDetails.firstName

    Nombre del comprador.

    Formato

    identityCode

    Camino: customer.billingDetails.identityCode

    Identificación nacional. Identifica de manera única a cada ciudadano en un país.

    Formato

    identityType

    Camino: customer.billingDetails.identityType

    Tipo del documento de identidad.

    Valores posibles:

    País TIPO DESCRIPCIÓN
    ARGENTINA DNI Documento Nacional de Identidad
    BRASIL CNPJ Cadastro Nacional da Pessoa Jurídica
    CPF Cadastro de Pessoas Físicas
    COLOMBIA CC Cédula de ciudadania
    TI Tarjeta de Identidad
    CE Cédula de Extranjeria
    NI Número de Identificación Tributaria
    PS Pasaporte
    Peru DNI_PER Documento National de Identidad
    por Partida de Nacimiento
    No Pasaporte
    LMI Libreta Militar
    NAN Otro

    Formato

    language

    Camino: customer.billingDetails.language

    Código del idioma del comprador según la norma ISO 639-1.

    Permite especificar el idioma en el que se envían los e-mails de confirmación de pago.

    Formato

    Valores posibles

    Ejemplos de valores posibles:

    Idioma Código
    Alemán (Alemania) DE
    Inglés (Reino Unido) EN
    Inglés (Estados Unidos) EN
    Chino (tradicional) ZH
    Español (España) ES
    Español (Chile) ES
    Francés (Francia) FR
    Italiano (Italia) IT
    Japonés (Japón) JP
    Holandés (Países Bajos) NL
    Polaco (Polonia) PL
    Portugués (Brasil) PT
    Portugués (Portugal) PT
    Ruso (Rusia) RU

    lastName

    Camino: customer.billingDetails.lastName

    Nombre del comprador.

    Formato

    legalName

    Camino: customer.billingDetails.legalName

    Razón social.

    Formato

    phoneNumber

    Camino: customer.billingDetails.phoneNumber

    Número de teléfono del comprador.

    Acepta todos los formatos:

    Ejemplos:

    • 0123456789
    • +33123456789
    • 0033123456789
    • (00.571) 638.14.00
    • 40 41 42 42

    Según el medio de pago, algunas restricciones pueden modificar el formato. Para más información, consulte la documentación técnica específica del medio de pago.

    Formato

    state

    Camino: customer.billingDetails.state

    Región (estado) de la dirección de facturación. Es recomendable pero no obligatorio transmitir el valor ISO-3166-2.

    Formato

    streetNumber

    Camino: customer.billingDetails.streetNumber

    Número de calle de la dirección de facturación.

    Carácteres aceptados:

    • Caracteres alfabéticos (de la "A" a la "Z" y desde la "a" hasta la "z")
    • Espacio

    Formato

    title

    Camino: customer.billingDetails.title

    Tratamiento del comprador.

    Ejemplos:

    • Sr.
    • Sr.
    • Sra.

    Formato

    zipCode

    Camino: customer.billingDetails.zipCode

    Código postal de la dirección de facturación.

    Formato

    insuranceAmount

    Camino: customer.shoppingCart.insuranceAmount

    Monto del seguro para todo el pedido expresado en su fracción monetaria más pequeña (el centavo para el peso argentino).

    Ejemplo: 30050 para 300,50 ARS.

    Formato

    shippingAmount

    Camino: customer.shoppingCart.shippingAmount

    Monto de los gastos de envío de todo el pedido expresado en su unidad monetaria más pequeña (el céntimo de peso argentino).

    Ejemplo: 30050 para 300,50 ARS.

    Formato

    taxAmount

    Camino: customer.shoppingCart.taxAmount

    Monto de los impuestos de todo el orden expresado en su unidad monetaria más pequeña (el céntimo para el peso argentino).

    Ejemplo: 30050 para 300,50 ARS.

    Formato

    cartItemInfo

    Camino: customer.shoppingCart.cartItemInfo

    cardItemInfo es una lista que contiene objetos Customer/ShoppingCartItemInfo.

    Permite describir cada artículo del carrito.

    Formato

    productAmount

    Camino: customer.shoppingCart.cartItemInfo.productAmount

    Monto del producto expresada en su fracción monetaria más pequeña (el centavo para el peso argentino).

    Ejemplo: 30050 para 300,50 ARS.

    Formato

    productLabel

    Camino: customer.shoppingCart.cartItemInfo.productLabel

    Nombre del producto.

    Formato

    productQty

    Camino: customer.shoppingCart.cartItemInfo.productQty

    Cantidad de producto.

    Formato

    productRef

    Camino: customer.shoppingCart.cartItemInfo.productRef

    Referencia del producto.

    Formato

    productType

    Camino: customer.shoppingCart.cartItemInfo.productType

    Tipo de producto.

    Valores posibles

    VALOR Descripción
    FOOD_AND_GROCERY Alimentos y productos comestibles.
    AUTOMOTIVE Automotriz / Motocicleta
    ENTERTAINMENT Entretenimiento / Cultura
    HOME_AND_GARDEN Casa y jardín
    HOME_APPLIANCE Equipo de la casa
    AUCTION_AND_GROUP_BUYING Subastas y compras a granel
    FLOWERS_AND_GIFTS Flores y regalos
    COMPUTER_AND_SOFTWARE Computadoras y software
    HEALTH_AND_BEAUTY Salud y belleza
    SERVICE_FOR_INDIVIDUAL Servicios a domicilio
    SERVICE_FOR_BUSINESS Servicios de negocios
    SPORTS Deportes
    CLOTHING_AND_ACCESSORIES Ropa y accesorios
    TRAVEL Viajes
    HOME_AUDIO_PHOTO_VIDEO Sonido, imagen y video
    TELEPHONY Telefonía

    Formato

    productVat

    Camino: customer.shoppingCart.cartItemInfo.productVat

    Tipo de producto.

    Monto del impuesto sobre el producto (en la unidad más pequeña de la moneda).

    Valores posibles

    VALOR Descripción
    Un número entero Monto de la transacción. Su valor debe ser un entero positivo (por ejemplo: 1234 para 12,34 ARS).
    Un número decimal, inferior a 100 Porcentaje aplicado sobre el importe. Ejemplos: 20,0 o 19,6532

    Para expresar un porcentaje aplicado al monto del producto en cuestión, el valor debe tener un máximo de 4 dígitos después del punto decimal. El decimal es obligatorio para expresar un porcentaje. La posición decimal está marcada por el carácter ".".

    Formato

    mid

    Camino: transactionOptions.cardOptions.mid

    Número de contrato del vendedor. Si este campo es completado, asegúrese de utilizar el contrato correcto en función de la red de la tarjeta.

    Un contrato de VISANET no puede utilizarse para una transacción de MASTERCARD.

    Formato

    paymentSource

    Camino: transactionOptions.cardOptions.paymentSource

    Origen del pago.

    Formato

    Valores posibles

    . Los valores posibles son:

    VALOR Descripción
    EC E-Commerce: el comprador ingresa los datos del medio de pago. Este valor permite tener una autentificación fuerte al momento del pago.
    MOTO MAIL OR TELEPHONE ORDER: Ingreso realizado por un operador. Los datos del medio de pago se envían por correo postal o electrónico. Requiere un contrato de tipo VAD.
    CC Call Center: pago realizado a través de un centro de atención telefónico. Requiere un contrato de tipo VAD.
    OTHER Otro canal de venta. Valor de salida devuelto para los pagos realizados desde el Back Office Vendedor, los pagos por archivo, los pagos recurrentes, los pagos de proximidad.
    Absent ou null El valor predeterminado es “EC”.

    retry

    Camino: transactionOptions.cardOptions.retry

    Número de nuevos intentos disponibles en caso de rechazo del pago (3 por defecto).

    Formato

    companyType

    Camino: subMerchantDetails.companyType

    Tipo de empresa del subvendedor. Transmitido por el facilitador de pago.

    Pueden aplicarse reglas diferentes según el adquiriente. A menudo este campo permite indicar el tipo de Legal Number del comprador.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Para los pagos en Argentina, los siguientes campos de datos del subvendedor (los campos subMerchantDetails) son obligatorios.

    Fiserv

    Valores posibles :

    • NATIONAL_IDENTITY
    • SINGLE_TAX_IDENTIFICATION
    • SINGLE_CODE_OF_LABOR_IDENTIFICATION
    • BOOK_ENLISTMENT
    • CIVIC_NOTEBOOK
    • PASSPORT

    Más información: Fiserv.

    PRISMA

    Valores posibles :

    • CUIT: Código Único de Identificación Tributaria
    • CUIL: Código Único de Identificación Laboral
    • DNI: Documento Nacional de Identidad

    Más información: Prisma.

    Formato

    legalNumber

    Camino: subMerchantDetails.legalNumber

    Número legal del subvendedor según el campo companyType. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Para los pagos en Argentina, los siguientes campos de datos del subvendedor (los campos subMerchantDetails) son obligatorios.

    Este campo es obligatorio para el adquirente Prisma. (Más información: Prisma ).

    Formato

    name

    Camino: subMerchantDetails.name

    Razón social del subvendedor. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Para los pagos en Argentina, los siguientes campos de datos del subvendedor (los campos subMerchantDetails) son obligatorios.

    Formato

    url

    Camino: subMerchantDetails.url

    URL del subvendedor. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Para los pagos en Argentina, los siguientes campos de datos del subvendedor (los campos subMerchantDetails) son obligatorios.

    Formato

    phoneNumber

    Camino: subMerchantDetails.phoneNumber

    Número de teléfono del subvendedor. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Para los pagos en Argentina, los siguientes campos de datos del subvendedor (los campos subMerchantDetails) son obligatorios.

    Formato

    address1

    Camino: subMerchantDetails.address1

    Dirección del subvendedor. Transmitido por el facilitador de pago.

    Este campo es obligatorio para el adquirente Prisma. (Más información: Prisma ).

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Para los pagos en Argentina, los siguientes campos de datos del subvendedor (los campos subMerchantDetails) son obligatorios.

    Formato

    address2

    Camino: subMerchantDetails.address2

    Complemento de la dirección del subvendedor. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Para los pagos en Argentina, los siguientes campos de datos del subvendedor (los campos subMerchantDetails) son obligatorios.

    Formato

    zip

    Camino: subMerchantDetails.zip

    Código postal del subvendedor. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Para los pagos en Argentina, los siguientes campos de datos del subvendedor (los campos subMerchantDetails) son obligatorios.

    Formato

    city

    Camino: subMerchantDetails.city

    Ciudad del subvendedor. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Para los pagos en Argentina, los siguientes campos de datos del subvendedor (los campos subMerchantDetails) son obligatorios.

    Formato

    country

    Camino: subMerchantDetails.country

    Código del país de la dirección del subvendedor (norma ISO 3166 alpha-2). Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Para los pagos en Argentina, los siguientes campos de datos del subvendedor (los campos subMerchantDetails) son obligatorios.

    Formato

    mcc

    Camino: subMerchantDetails.mcc

    Código MCC del subvendedor. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Para los pagos en Argentina, los siguientes campos de datos del subvendedor (los campos subMerchantDetails) son obligatorios.

    Este campo es obligatorio para el adquirente Prisma. (Más información: Prisma ).

    Formato

    mid

    Camino: subMerchantDetails.mid

    Número de afiliación (MID) del subvendedor. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Para los pagos en Argentina, los siguientes campos de datos del subvendedor (los campos subMerchantDetails) son obligatorios.

    Campo obligatorio para los adquirentes Fiserv y Procesos. (Más información: Fiserv.)

    Formato

    softDescriptor

    Camino: subMerchantDetails.softDescriptor

    Descripción (soft-descriptor) del subvendedor que aparece en el extracto de operaciones bancarias del comprador. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Para los pagos en Argentina, los siguientes campos de datos del subvendedor (los campos subMerchantDetails) son obligatorios.

    • Para el adquirente Prisma , este campo es obligatorio y debe respetar el siguiente formato:

    "CÓD.AGRUPADOR ASIGNADO POR PRISMA" * "NÚMERO FANTASÍA VENDEDOR".

    El campo Softdescriptor se debe construir bajo el siguiente criterio:

    Estructura:

    Subcampo 1 : Nombre abreviado del Payment Facilitator o Marketplace, su longitud puede ser de 3, 7 o 12 posiciones. Este nombre debe coincidir con el valor informado en Anexo 1 campo 'Nombre del Payment Facilitator / Marketplace tal cual será enviado en Autorización'

    Subcampo 2 : Informar valor fijo '*' en la posición 4, 8 o 13 según corresponda

    Subcampo 3 : Informar el nombre del establecimiento esponsoreado desde la posición 5, 9 0 14 según corresponda.

    La longitud máxima sumando los subcampos 1, 2 y 3 no podrá superar las 25 posiciones

    Long. total: 25 caracteres incluyendo el cód. de agrupador.

    Caracteres aceptados: [A-Z];[0-9];[*].

    Ejemplos:

    • "TPP*ELECTONICA TUCUMAN"
    • "MPP*MARTIN GONZALEZ"

    Más información: Prisma.

    • Para el adquirente Fiserv , este campo es obligatorio y debe respetar el siguiente formato:

    "Pfac" * "subMerchantDetails.name".

    El Pfac que ha elegido el vendedor permite construir este campo obligatorio concatenándolo con el campo subMerchantDetails.name.

    Más información: Fiserv.

    Formato

    state

    Camino: subMerchantDetails.state

    Región de la dirección del subvendedor. Transmitido por el facilitador de pago.

    Este campo es obligatorio para el adquirente Prisma. (Más información: Prisma ).

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Para los pagos en Argentina, los siguientes campos de datos del subvendedor (los campos subMerchantDetails) son obligatorios.

    Formato

    facilitatorId

    Camino: subMerchantDetails.facilitatorId

    Identificador del facilitador de pago. Transmitido por el facilitador de pago.

    Este campo es obligatorio para el adquirente Prisma. (Más información: Prisma ).

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Para los pagos en Argentina, los siguientes campos de datos del subvendedor (los campos subMerchantDetails) son obligatorios.

    Formato

    formTokenVersion

    formTokenVersion define la versión del formToken enviada por el Web Service.

    Este parámetro se utiliza en el marco del SDK móvil. Permite asegurarse de que la versión del formToken devuelta está siempre sincronizada con la aplicación móvil implementada en el teléfono del comprador.

    El valor por defecto es 4.

    Formato

    Referencia de la respuesta

    Respuesta Contexto
    Charge/PaymentForm El objeto contiene un hash para utilizar con el formulario incrustado para crear una nueva transacción.

    Consulte la referencia de cada respuesta para más información.