Web service Charge/CreateToken
Le Web Service REST Charge/CreateToken permet de créer un alias sans paiement.
Seules les cartes bancaires sont supportées. Cette méthode ne permet pas de créer un alias à partir d'un IBAN.
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: "EUR" para el euro.
Formato
Valores posibles
. Los valores posibles son:
| Moneda | CODIFICACIÓN ISO 4217 | Unidad fraccionaria |
|---|---|---|
| Dólar australiano (036) | AUD | 2 |
| Dólar canadiense (124) | CAD | 2 |
| Franco suizo (756) | CHF | 2 |
| Corona danesa (208) | DKK | 2 |
| Euro (978) | EUR | 2 |
| Libra esterlina (826) | GBP | 2 |
| Yen (392) | JPY | 0 |
| Corona noruega (578) | NOK | 2 |
| Corona sueca (752) | SEK | 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
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.
Al registrar una tarjeta, se requiere una autenticación sólida, independientemente de la preferencia del comerciante.
| Casos de uso | Valores posibles |
|---|---|
| CHALLENGE : Con interacción del titular |
|
| |
| |
| FRICTIONLESSSin interacción del titular Opción "Frictionless 3DS2" obligatoria |
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 |
|
|
Tabla de exenciones (valor DISABLED)
| una exención | Descripción |
|---|---|
| Transacción de bajo monto. | Para el pago en euros puede solicitaruna exenciónde autentificación fuerte.
|
| LRM (Low Risk Merchant) |
El objetivo del programa LRM (Low Risk Merchant) de CB es responder a las necesidades de los vendedores de bajo riesgo y con un alto volumen de negocios (120.000 transacciones con tarjeta por año). Vous pouvez demander une exemption à l'authentification forte : |
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
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 |
|---|---|
| AUSTRIA | AT |
| Brasil | BR |
| CÓRCEGA | FR |
| COSTA DE MARFIL | CI |
| FRANCIA | FR |
| GUADALUPE | GP |
| INDIA | IN |
| MARTINICA | MQ |
| NUEVA CALEDONIA | NC |
| SAN PEDRO Y MIQUELÓN | PM |
| POLINESIA FRANCESA | PF |
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.
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
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 unidad monetaria más pequeña (el centimo del euro).
Ejemplo: 30050 para 300,50 EUR.
Formato
shippingAmount
Camino: customer.shoppingCart.shippingAmount
Monto de los gastos de entrega para todo el pedido expresado en su unidad monetaria más pequeña (el centimo para el euro).
Ejemplo: 30050 para 300,50 EUR.
Formato
taxAmount
Camino: customer.shoppingCart.taxAmount
Monto de los impuestos para toda la orden expresados en su unidad monetaria más pequeña (el centimo para el euro).
Ejemplo: 30050 para 300,50 EUR.
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
Cantidad de ingresos expresados en su unidad monetaria más pequeña (el centimo para el euro).
Ejemplo: 30050 para 300,50 EUR.
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 EUR). |
| 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.
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 |
| Absent ou null | El valor predeterminado es “EC”. |
retry
Camino: transactionOptions.cardOptions.retry
Cantidad de nuevos intentos disponibles en caso de rechazo del pago (1 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.
Formato
legalNumber
Camino: subMerchantDetails.legalNumber
Número legal del subvendedor según el campo companyType. Transmitido por el facilitador de pago.
Formato
name
Camino: subMerchantDetails.name
Razón social del subvendedor. Transmitido por el facilitador de pago.
Formato
url
Camino: subMerchantDetails.url
URL del subvendedor. Transmitido por el facilitador de pago.
Formato
phoneNumber
Camino: subMerchantDetails.phoneNumber
Número de teléfono del subvendedor. Transmitido por el facilitador de pago.
Formato
address1
Camino: subMerchantDetails.address1
Dirección del subvendedor. Transmitido por el facilitador de pago.
Formato
address2
Camino: subMerchantDetails.address2
Complemento de la dirección del subvendedor. Transmitido por el facilitador de pago.
Formato
zip
Camino: subMerchantDetails.zip
Código postal del subvendedor. Transmitido por el facilitador de pago.
Formato
city
Camino: subMerchantDetails.city
Ciudad del subvendedor. Transmitido por el facilitador de pago.
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.
Formato
mcc
Camino: subMerchantDetails.mcc
Código MCC del subvendedor. Transmitido por el facilitador de pago.
Formato
mid
Camino: subMerchantDetails.mid
Número de afiliación (MID) del subvendedor. Transmitido por el facilitador de pago.
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.
Formato
state
Camino: subMerchantDetails.state
Región de la dirección del subvendedor. Transmitido por el facilitador de pago.
Formato
facilitatorId
Camino: subMerchantDetails.facilitatorId
Identificador del facilitador de pago. Transmitido por el facilitador de pago.
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.