Servicio Web Charge/CreateShipmentTransaction
Le Web Service REST Charge/CreateShipmentTransaction permet de créer une nouvelle transaction d'expédition à partir de la transaction initiale.
Consultez le guide d'intégration : Réaliser un paiement à l'expédition.
Parámetros de entrada
amount
Monto del pago en su fracción monetaria más pequeña (el céntimo para el sol peruano).
Ejemplo: 30050 para 300,50 PEN.
Formato
uuid
Referencia única de la transacción generada por la plataforma de pago.
Formato
comment
Comentario libre.
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
Transmitir los datos para el análisis de riesgos
Las transacciones se someten sistemáticamente a un análisis de riesgo para determinar si se necesita una autentificación 3D-Secure o si presentan un riesgo demasiado elevado para aceptarlas. Para que el análisis sea lo más pertinente posible, usted debe transmitir un máximo de informaciones en su formulario de pago.
Para detallar el análisis, usted puede utilizar los campos descritos a continuación. Se devuelven estos campos en la notificación de fin de pago.
Para ilustrar, aquí hay un ejemplo con el número de teléfono : cybersource_mdd_13.
{
"amount": 180,
"currency": "PEN",
"customer": {
"email": "[sample@example.com|mailto:sample@example.com]"
},
"metadata": {
"cybersource_mdd_13": "0606060606"
},
"orderId": "myOrderId-417842"
}
Valores posibles
Los valores posibles son:
Nombre del campo | DESCRIPCIÓN | Opcional / Recomendado | Formato |
---|---|---|---|
cybersource_mdd_12 | Email que el cliente ingresó en el registro o el que coloca durante el proceso de compra. | R | String (255) |
cybersource_mdd_13 | Numero de telefono utilizado. | R | String (255) |
cybersource_mdd_14 | Información del cliente que realiza la compra, en el campo se registrará el tipo concatenado con el número de identidad.
01-DNI 02-CARNET DE EXTRANJERIA 03-PASAPORTE 10-RUC 10 20-RUC 20 15-RUC 15 17-RUC 17 30-PTT Ejm :
| R | String (255) |
cybersource_mdd_15 | Identificador único del cliente de cara al comercio. | O | String (255) |
cybersource_mdd_16 | ¿Registro mediante Redes Soc u otras?
SI NO | O | String (255) |
cybersource_mdd_17 | Cliente Frecuente.
SI NO | O | String (255) |
cybersource_mdd_18 | Número de días transcurridos desde primera compra del cliente. | O | Float |
cybersource_mdd_19 | Número de días transcurridos desde última compra del cliente. | O | Float |
cybersource_mdd_20 | Número de cupón de descuento. | O | String (255) |
cybersource_mdd_21 | Número de Giftcard. | O | String (255) |
cybersource_mdd_22 | Indica si el cliente se ha registrado en la web del comercio y bajo qué modalidad Registrado.
01=Invitado 02=Empleado 03=Registro directo | O | String (255) |
cybersource_mdd_23 | Ticket promedio del cliente (sin incluir la compra actual). | O | Float |
cybersource_mdd_24 | Riesgo de la transacción.
BAJO MEDIO ALTO | O | String (255) |
cybersource_mdd_27 | Información del beneficiario de la compra, en el campo se registrará el tipo concatenado con el número de identidad .
01-DNI 02-CARNET DE EXTRANJERIA 03-PASAPORTE 10-RUC 10 20-RUC 20 15-RUC 15 17-RUC 17 30-PTT Ejm :
| R | String (255) |
cybersource_mdd_28 | Aplica a ventas telefónicas, identificado único de la persona que atendió al cliente durante el proceso de venta (Asistidas). | R | String (255) |
cybersource_mdd_29 | Número de items que compra el cliente por pedido. | O | Float |
cybersource_mdd_30 | Enviado/Pendiente.
Enviado Pendiente | R | String (255) |
cybersource_mdd_31 | Número de horas entre la compra y la entrega del producto / servicio. | R | Float |
cybersource_mdd_32 | Número de días que se encuentra esa dirección registrada en sistemas. | R | Float |
cybersource_mdd_33 | Número de pedidos realizados a esa dirección registrada en sistemas. | O | Float |
cybersource_mdd_34 | Número de compras realizadas en los últimos 6 meses según historial del cliente. | O | Float |
cybersource_mdd_35 | Identificador único del establecimiento del comercio. Aplica para delivery de productos/servicios y recoge en el establecimiento. | R | String (255) |
cybersource_mdd_36 | Nombre del establecimiento del comercio. Aplica para delivery de productos/servicios y recoge en el establecimiento. | R | String (255) |
cybersource_mdd_37 | Indica si la compra se enviará mediante delivery a la dirección del cliente o será recogida en el local del comercio Delivery / recoge en tienda.
DELIVERY RECOJO EN TIENDA | R | String (255) |
cybersource_mdd_38 | Cuenta de destino para la recarga de billeteras de criptomonedas y otros instrumentos financieros. | R | String (255) |
cybersource_mdd_39 | Banco al cual pertenece la cuenta de destino.
2= BCP, 3= IBK PRIVADA, 5= IBK, 7= CITI, 9= SBP, 10= LOY, 11= BBVA, 18= BN, 23= COMERCIO, 35=PICHINCHA, 38= BIF, 41=SBP, 43= CSF, 49=MIBANCO | R | String (255) |
cybersource_mdd_40 | Número de placa de auto. | R | String (255) |
cybersource_mdd_41 | Indicar si el cliente ha adquirido o está recargando un número PREPAGO o POSTPAGO. Aplica para empresas de telefonía.
PREPAGO POSTPAGO | R | String (255) |
cybersource_mdd_42 | Identificador único del usuario final del servicio, de cara al comercio. En el caso de telcos, ese el número de celular a recargar. | R | String (255) |
cybersource_mdd_43 | Número telefónico ingresado por el cliente al registrarse en la web/app del comercio. | R | String (255) |
cybersource_mdd_44 | Código de Reserva. | R | String (255) |
cybersource_mdd_45 | Número de código de fidelidad del viajero frecuente. | R | String (255) |
cybersource_mdd_46 | Canal de venta ticket..
OTA APP WEB | R | String (255) |
cybersource_mdd_47 | Round Trip or One Way Trip
OW RT | R | String (255) |
cybersource_mdd_48 | Delta entre fecha de salida y fecha de regreso. Solo para vuelos de ida y vuelta (en días). | O | String (255) |
cybersource_mdd_49 | Número de adultos viajando. | O | String (255) |
cybersource_mdd_50 | Ciudad donde se inicia el viaje comprado por el cliente. | R | Código IATA |
cybersource_mdd_51 | Ciudad donde finaliza el viaje comprado por el cliente. | R | Código IATA |
cybersource_mdd_52 | Compra de millas/km.
SI NO | R | String (255) |
cybersource_mdd_53 | Vuelo internacional.
SI NO | R | String (255) |
cybersource_mdd_54 | Clase Tarifa. Letra que corresponde a la clase del billete.
Ejm : W, Y, N. | O | String (255) |
cybersource_mdd_55 | Fecha de inicio del primer vuelo. | R | DateTime (25) |
cybersource_mdd_56 | Aeropuerto Origen | O | Código IATA |
cybersource_mdd_57 | Aeropuerto Destino | O | Código IATA |
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
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 |
---|---|
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
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
address
Camino: customer.shippingDetails.address
Dirección de entrega.
Atención: Los caracteres > y < no están permitidos.
Formato
address2
Camino: customer.shippingDetails.address2
Segunda línea de la dirección de facturación.
Atención: Los caracteres > y < no están permitidos.
Formato
category
Camino: customer.shippingDetails.category
Tipo de cliente.
Formato
Valores posibles
valores | Descripción |
---|---|
PRIVATE | Cliente de tipo Particular |
COMPANY | Cliente de tipo Empresa |
city
Camino: customer.shippingDetails.city
Ciudad de entrega.
Formato
country
Camino: customer.shippingDetails.country
País de entrega (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 |
deliveryCompanyName
Camino: customer.shippingDetails.deliveryCompanyName
Nombre de la empresa emisora del producto.
Formato
district
Camino: customer.shippingDetails.district
Barrio de la dirección de facturación.
Formato
firstName
Camino: customer.shippingDetails.firstName
Nombre del destinatario.
Formato
identityCode
Camino: customer.shippingDetails.identityCode
Identificación nacional. Identifica de manera única a cada ciudadano en un país.
Formato
lastName
Camino: customer.shippingDetails.lastName
Nombre del comprador.
Formato
legalName
Camino: customer.shippingDetails.legalName
Razón social en caso de entrega a una empresa.
Formato
phoneNumber
Camino: customer.shippingDetails.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
shippingMethod
Camino: customer.shippingDetails.shippingMethod
Modo de entrega.
Formato
Valores posibles
VALOR | Descripción |
---|---|
RECLAIM_IN_SHOP | Retiro en tienda. |
RELAY_POINT | Uso de una red de puntos de retiro de terceros (Kiala, Alveol, etc.). |
RECLAIM_IN_STATION | Retiro en un aeropuerto, una estación o una agencia de viajes. |
PACKAGE_DELIVERY_COMPANY | Entrega por transportista (Colissimo, UPS, etc.). |
ETICKET | Emisión de un ticket electrónico, descarga de producto virtual. |
CARD_HOLDER_ADDRESS | Entrega al comprador. Reservado para su uso futuro. |
VERIFIED_ADDRESS | Entrega a una dirección verificada. Reservado para su uso futuro. |
NOT_VERIFIED_ADDRESS | Entrega a una dirección no verificada. Reservado para su uso futuro. |
SHIP_TO_STORE | Entrega en tienda. Reservado para su uso futuro. |
DIGITAL_GOOD | Entrega digital. Reservado para su uso futuro. |
ETRAVEL_OR_ETICKET | Boleto electronico. Reservado para su uso futuro. |
OTHER | Otros Reservado para su uso futuro. |
PICKUP_POINT | Retiro en un punto de relevo. Reservado para su uso futuro. |
AUTOMATED_PICKUP_POINT | Recoger en el punto de relevo automático. Reservado para su uso futuro. |
shippingSpeed
Camino: customer.shippingDetails.shippingSpeed
Plazo de entrega.
Formato
Valores posibles
Ejemplos de valores posibles:
VALOR | Descripción |
---|---|
STANDARD | Entrega estándar |
EXPRESS | Entrega en 24 horas |
PRIORITY | Entrega prioritaria (Click & Collect) |
state
Camino: customer.shippingDetails.state
Región de la dirección de facturación.
Formato
streetNumber
Camino: customer.shippingDetails.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
zipCode
Camino: customer.shippingDetails.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 céntimo para el sol peruano).
Ejemplo: 30050 para 300,50 PEN.
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 para el suelo peruano).
Ejemplo: 30050 para 300,50 PEN.
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 sol peruano).
Ejemplo: 30050 para 300,50 PEN.
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 del producto expresada en su unidad monetaria más pequeña (el céntimo para el sol peruano).
Ejemplo: 30050 para 300,50 PEN.
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 | Montant de la transaction. Sa valeur doit être un entier positif (ex: 1234 pour 12,34 PEN). |
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
manualValidation
Camino: transactionOptions.cardOptions.manualValidation
Modo de validación de la transacción.
Formato
Valores posibles
. Los valores posibles son:
VALOR | Descripción |
---|---|
NO | Validación automática por la plataforma de pago. |
YES | Validación manual por el vendedor. |
null | Configuración por defecto de la tienda seleccionada (configurable en el |
captureDelay
Camino: transactionOptions.cardOptions.captureDelay
Fecha límite para aplicar en la fecha de captura.
Descripción
Indica el número de días antes de la captura.
Si no se transmite este parámetro, se utiliza el valor predeterminado definido en el
Este último es configurable en el
Si el tiempo de entrega es mayor a 365 días en la solicitud de pago, se reposiciona automáticamente a 365 días.
Formato
Referencia de la respuesta
El Web Service devuelve el siguiente objeto:
Respuesta | Contexto |
---|---|
Transaction | Objeto que contiene la información de la transacción. |
Vea la referencia de la respuesta para más información.