Servicio web PaymentOrder/Update

Methodo:

POST

Punto de entrada:

https://api.cobroinmediato.tech/api-payment/V4/Charge/PaymentOrder/Update

La operación PaymentOrder/Update es un servicio web de la API REST.

Permite actualizar las solicitudes de pago creadas con el servicio web Charge/CreatePaymentOrder .

Para consultar la documentación de referencia de la respuesta, visite: PaymentOrder .

Parámetros de la solicitud

El servicio web REST PaymentOrder/Update admite los siguientes parámetros:

paymentOrderId

Referencia única de la solicitud de pago generada por la plataforma.

Formato

amount

Monto del pago en su unidad monetaria más pequeña (el centavo por el peso argentino).

Ejemplo: 30050 por 300.50 ARS.

Formato

currency

Moneda de pago. Código del alfabeto en mayúsculas según ISO 4217 alfa-3.

Ejemplo: "ARS" para 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

orderId

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

Formato

channelType

Camino: channelOptions.channelType

Tipo de solicitud de pago a crear. El valor predeterminado es URL.

Formato

Valores posibles

Los valores posibles son:

Valor	DESCRIPCIÓN
MAIL	La solicitud de pago se envía al comprador por e-mail
URL	Solo se lleva a cabo la creación de la URL de pago devuelta en la respuesta
SMS	La solicitud de pago se envía al comprador por SMS
WHATSAPP	La solicitud de pago se envía al WhatsApp del comprador

bcc

Camino: channelOptions.mailOptions.bcc

BCC (“Blind Carbon Copy” o “con copia oculta”). Lista de los destinatarios adicionales de la solicitud de pago. Estos destinatarios no son visibles para el destinatario principal (recipient). Use el carácter punto y coma ";" como separador entre direcciónes.

Formato

body

Camino: channelOptions.mailOptions.body

Permite personalizar el cuerpo del e-mail enviado. Si el parámetro se deja vacío, se aplicará la plantilla predeterminada.

Formato

Contenido

Para personalizar el cuerpo del e-mail, puede utilizar las siguientes variables:

Valor	DESCRIPCIÓN
%url%	URL de la solicitud de pago. Si falta esta variable, el enlace de pago se agregará automáticamente al final del mensaje.
%amount%	Monto y moneda del pago
%start_date%	Fecha de creación de la solicitud de pago
%end_date%	Fecha de vencimiento de la solicitud de pago
%shop_name%	Nombre de su tienda como se define en el Back Office
%reference%	Referencia del pedido
%shop_url%	URL de su tienda
%shop_contact%	Dirección de e-mail del “administrador de la tienda” como se define en el Back Office

Ejemplo:

recipient

Camino: channelOptions.mailOptions.recipient

Destinatario del e-mail.

Formato

subject

Camino: channelOptions.mailOptions.subject

Permite personalizar el asunto del e-mail. Este parámetro es obligatorio a menos que indique un nombre de plantilla válido en el parámetro channelOptions.mailOptions.template .

Formato

Contenido

Para personalizar el asunto del e-mail, utilice las siguientes variables:

Valor	DESCRIPCIÓN
%url%	URL de la solicitud de pago, es importante colocarla en el cuerpo del e-mail
%amount%	Monto y moneda del pago
%start_date%	Fecha de creación de la solicitud de pago
%end_date%	Fecha de vencimiento de la solicitud de pago
%shop_name%	Nombre de su tienda como se define en el Back Office
%reference%	Referencia del pedido
%shop_url%	URL de su tienda
%shop_contact%	Dirección de e-mail del “administrador de la tienda” como se define en el Back Office

Ejemplo:

template

Camino: channelOptions.mailOptions.template

Nombre de la plantilla a utilizar para generar el e-mail. Para que funcione, es necesario que la plantilla exista en el Back Office.

Cada plantilla de e-mail está asociada a un idioma (o configuración regional). Para utilizar una plantilla, asegúrese de indicar el idioma correcto en el parámetro locale .

Si no se encuentra la plantilla se devolverá un error. Si definió un valor en los parámetros subject y body , se ignorará la plantilla.

Formato

message

Camino: channelOptions.smsOptions.message

Mensaje a enviar por SMS.

Formato

phoneNumber

Camino: channelOptions.smsOptions.phoneNumber

Número de teléfono al que enviar el SMS.

Formato

phoneNumber

Camino: channelOptions.whatsAppOptions.phoneNumber

Número de teléfono al que enviar el mensaje de WhatsApp.

Formato

ivrPaymentOrderId

Camino: channelOptions.ivrOptions.ivrPaymentOrderId

Este campo es rellenado automáticamente por la plataforma Si el comerciante tiene restricciones funcionales específicas, este campo puede sobrecargarse excepcionalmente con su propia referencia numérica para garantizar su unicidad.

Formato

formAction

permite definir el tipo de comportamiento que desea al crear la transacción.

Valores posibles

Los valores posibles son:

Valor	DESCRIPCIÓN
PAYMENT	Creación de una transacción simple. Comportamiento predeterminado.
REGISTER	Creación del token sin pago. El valor del monto transmitido debe ser 0.
REGISTER_PAY	Creación del token durante un pago.
REGISTER_UPDATE	Cambio de información asociada al token.
REGISTER_UPDATE_PAY	Cambio de información asociada al token durante un pago
ASK_REGISTER_PAY	Pago con propuesta al titular para crear un token.
null	Si el valor es nulo o no definido, se aplica el valor PAYMENT .

Formato

dataCollectionForm

Uso del formulario de recolección de datos. Si se establece en true , se mostrará antes del formulario de pago.

Formato

expirationDate

Hora y fecha de expiración del pago, en formato ISO-8601.

Formato

locale

Configuración regional (o local) en formato cc_XX en donde:

cc representa el código de idioma (dos caracteres en minúsculas según la norma ISO-639 (ejemplo: “de” para el alemán, “en” para el inglés o “fr” para el francés).
XX representa el código del país (dos letras mayúsculas de acuerdo con la norma ISO-3166), ejemplos: "DE" para Alemania, "FR" para Francia o "US" para Estados Unidos).

Permite definir el idioma de las páginas de pago y del e-mail de confirmación. Si el parámetro no está definido, se utilizará el idioma de la tienda.

Formato

merchantComment

Comentario asociado a la solicitud de pago. Permite, por ejemplo, indicar una referencia sobre el emisor de la solicitud de pago.

Formato

paymentReceiptEmail

Dirección de e-mail del comprador a la que se enviará el ticket de pago. Esta característica solo puede funcionar si la regla de notificación "E-mail de confirmación para el comprador" está activada en el Back Office.

Formato

taxAmount

Importe 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 por 300.50 ARS.

Formato

taxRate

Usado por ciertos medios de pago en Latinoamérica. Permite transmitir el tipo de impuesto aplicado a todo el pedido. El valor debe ser el porcentaje a aplicar (21 para el 21%)

Formato

allowDCFAmountUpdate

allowDCFAmountUpdate permite definir si el monto puede modificarse en el formulario de recogida de datos Este campo puede ser utilizado únicamente si el campo dataCollectionForm tiene el valor true .

Formato

Valores posibles

Los valores posibles son:

Valor	DESCRIPCIÓN
NONE	El monto no puede modificarse Comportamiento predeterminado.
LOWER	El importe sólo puede modificarse a la baja.
GREATER	El monto sólo puede aumentarse.
LOWER_AND_GREATER	El monto puede aumentar o disminuir.
null	Si el valor es nulo o no definido, se aplica NONE.

Formato

metadata

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

Ejemplo de llamada

Por ejemplo, para transmitir un valor personalizado, como el color de ojos de su comprador, agregue a su solicitud:

{
    "metadata": {
        "eyesColor": "blue"
    }
}

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

También puede utilizar los metadatos “ info1 ”, “ info2 ” y “ info3 ” para transmitir la información adicional sobre el pedido.

Estos datos aparecerán en la pestaña Extra del detalle de la transacción desde su Back Office Vendedor.

Formato

customer.reference

Identificador del comprador en el sitio del vendedor.

Formato

customer.email

Dirección de correo electrónico del comprador.

Formato

address

Camino: customer.billingDetails.address

Direccion 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

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

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

Apellido 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 en formato 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

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

Apellido 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 comprobada. 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	Otro: Reservado para su uso futuro.
PICKUP_POINT	Retiro en punto de retiro. 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

Cantidad del seguro para todo el pedido expresada en su unidad monetaria más pequeña (el centavo para el peso argentino).

Ejemplo: 30050 por 300.50 ARS.

Formato

shippingAmount

Camino: customer.shoppingCart.shippingAmount

Importe 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 por 300.50 ARS.

Formato

taxAmount

Camino: customer.shoppingCart.taxAmount

Importe 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 por 300.50 ARS.

Formato

cartItemInfo

Camino: customer.shoppingCart.cartItemInfo

cardItemInfo es una lista que contiene objetos Customer/ShoppingCartItemInfo.

Para más información, consulte las propiedades de customer.shoppingCart.*

Formato

productAmount

Camino: customer.shoppingCart.cartItemInfo.productAmount

Cantidad del producto expresada en su unidad monetaria más pequeña (el centavo para el peso argentino).

Ejemplo: 30050 por 300.50 ARS.

Formato

productLabel

Camino: customer.shoppingCart.cartItemInfo.productLabel

Nombre del producto.

Formato

productQty

Camino: customer.shoppingCart.cartItemInfo.productQty

Cantidad del producto.

Formato

productRef

Camino: customer.shoppingCart.cartItemInfo.productRef

Referencia del producto.

Formato

productType

Camino: customer.shoppingCart.cartItemInfo.productType

Tipo de producto.

Formato

Valores posibles

Valor	DESCRIPCIÓN
FOOD_AND_GROCERY	Alimentos y productos comestibles
AUTOMOTIVE	Automóviles / Motos
ENTERTAINMENT	Entretenimiento / Cultura
HOME_AND_GARDEN	Casa y jardín
HOME_APPLIANCE	Equipamiento del hogar
AUCTION_AND_GROUP_BUYING	Subastas y compras conjuntas
FLOWERS_AND_GIFTS	Flores y regalos
COMPUTER_AND_SOFTWARE	Computadores y software
HEALTH_AND_BEAUTY	Salud y belleza
SERVICE_FOR_INDIVIDUAL	Servicios a personas
SERVICE_FOR_BUSINESS	Servicios a empresas
SPORTS	Deportes
CLOTHING_AND_ACCESSORIES	Ropa y accesorios
TRAVEL	Viajes
HOME_AUDIO_PHOTO_VIDEO	Sonido, imagen y video
TELEPHONY	Telefonía

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 al monto. Ejemplos: 20.0 o 19.6532

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

paymentMethodToken

Token (o alias) asociado a un medio de pago.

Solo se admiten los tokens asociados a una tarjeta bancaria.

Formato

strongAuthentication

strongAuthentication permite indicar la preferencia del vendedor respecto a la autenticación fuerte del comprador.

Con 3DS2, ya no es posible deshabilitar 3DS. Sin embargo, el vendedor podrá pedir una exención en su solicitud de pago (lo que se conoce como "preferencia del vendedor").

En ese caso, si la solicitud es aceptada por el emisor, el comprador no tendrá que autenticarse (sin challenge), pero el vendedor asumirá la responsabilidad en caso de impago (no hay transferencia de responsabilidad al emisor).

En todos los casos, es el banco emisor el que determina si es necesario interactuar con el comprador (challenge).

La autenticación fuerte es necesaria cuando se registra una tarjeta, independientemente de la preferencia del comerciante.

Valores posibles

Los valores posibles son:

Valor	Descripción 3DS1	Descripción 3DS2
ENABLED	Habilita (de ser posible) la autenticación fuerte.	En desuso. Este valor se interpretará como CHALLENGE_REQUESTED.
DISABLED	Deshabilita (de ser posible) la autenticación fuerte. Requiere la opción "3DS1 Selectivo". Utilizando este valor, usted se expone a rechazos "Soft decline". No se tomará en cuenta la desactivación si los medios de pago requieren necesariamente una autenticación fuerte. Es el caso de las tarjetas MAESTRO.	Permite solicitar una autenticación sin interacción (frictionless). Requiere la opción "Frictionless 3DS2". Para los pagos realizados en euro, si el monto es inferior a 30€, se transmite una solicitud de frictionless a DS. Si el emisor acepta la solicitud de frictionless, el vendedor pierde la garantía de pago. Para pagos realizados en euros, si el importe es superior a 30 €, se ignora el valor transmitido por el vendedor y se delega la gestión de la autenticación del titular de la tarjeta a la plataforma. Para los pagos realizados en una moneda distinta al euro, se envía una solicitud de autenticación frictionless al DS. Si la tienda no cuenta con la opción “Frictionless 3DS2”, se ignora el valor transmitido por el vendedor y se delega la gestión de la autenticación del titular de la tarjeta a la plataforma.
CHALLENGE_REQUESTED	Habilita (de ser posible) la autenticación fuerte.	Permite solicitar una autenticación fuerte para la transacción.
CHALLENGE_MANDATE	Habilita (de ser posible) la autenticación fuerte.	Permite indicar que, por razones reglamentarias, se requiere una autenticación fuerte para la transacción.
NO_PREFERENCE	Habilita (de ser posible) la autenticación fuerte.	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	Habilita (de ser posible) la autenticación fuerte.	Se delega la elección de la preferencia al emisor de la tarjeta (No Preference).

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 predeterminada de la tienda (definida en el Back Office Vendedor).

captureDelay

Camino: transactionOptions.cardOptions.captureDelay

Fecha límite para la fecha de captura.

DESCRIPCIÓN

Indica el número de días antes de la captura.

Si no se envía este parámetro, se utilizará el valor predeterminado definido en Back Office Vendedor

Todas las personas autorizadas pueden definir este valor en el Back Office Vendedor.

Si el tiempo de entrega es superior a 365 días en la solicitud de pago, se reposicionará automáticamente en 365 días.

Formato

Referencia de la respuesta

Respuesta	Contexto
PaymentOrder	Objeto que contiene los detalles de la solicitud de pago actualizada.

Categoria

Tags

Servicio web PaymentOrder/Update

Parámetros de la solicitud

paymentOrderId

Formato

amount

Formato

currency

Formato

Valores posibles

orderId

Formato

channelType

Camino: channelOptions.channelType

Formato

Valores posibles

bcc

Camino: channelOptions.mailOptions.bcc

Formato

body

Camino: channelOptions.mailOptions.body

Formato

Contenido

recipient

Camino: channelOptions.mailOptions.recipient

Formato

subject

Camino: channelOptions.mailOptions.subject

Formato

Contenido

template

Camino: channelOptions.mailOptions.template

Formato

message

Camino: channelOptions.smsOptions.message

Formato

phoneNumber

Camino: channelOptions.smsOptions.phoneNumber

Formato

phoneNumber

Camino: channelOptions.whatsAppOptions.phoneNumber

Formato

ivrPaymentOrderId

Camino: channelOptions.ivrOptions.ivrPaymentOrderId

Formato

formAction

Valores posibles

Formato

dataCollectionForm

Formato

expirationDate

Formato

locale

Formato

merchantComment

Formato

paymentReceiptEmail

Formato

taxAmount

Formato

taxRate

Formato

allowDCFAmountUpdate

Formato

Valores posibles

Formato

metadata

Ejemplo de llamada

Formato

customer.reference

Formato

customer.email

Formato

address

Camino: customer.billingDetails.address

Formato

address2

Camino: customer.billingDetails.address2

Formato