Editar una solicitud de pago
Casos de uso
El vendedor desea modificar el contenido de una solicitud de pago (monto, mensaje, etc.).
El Web Service Charge/PaymentOrder/Update permite modificar solamente las solicitudes de pago creadas con el Web Service Charge/CreatePaymentOrder.
Solo las solicitudes de pago en curso (estado RUNNING ) se pueden modificar No se puede modificar el canal de difusión.
Testear
Testee el Web Service Charge/PaymentOrder/Cancel desde nuestro playground:.
Solicitud
Campos obligatorios
Cantidad con moneda.
Referencia de la orden de pago:paymentOrderId.
. Canal de distribución (excepto el enlace URL):
- Por e-mail:
Objeto JSON que define los parámetros de la solicitud de pago. | |
E-mail del comprador. |
Ejemplo de solicitud
Edite los siguientes datos:
- Monto: $200.00.
- Referencia del pedido: "myOrderId-999999".
- Canal de difusión: MAIL.
/doc/es-AR/rest/V4.0/api/kb/authentication.html
https://github.com/lyra/rest-php-examples/blob/master/www/minimalEmbeddedForm.php#L9-L44
https://api.cobroinmediato.tech/api-payment/V4/Charge/PaymentOrder/Update
{ "paymentOrderId": "d63e7f507a6f4dfa86cb40a833ecfd85", "amount": 20000, "currency": "ARS", "orderId": "myOrderId-999999", "channelOptions": { "channelType": "MAIL", "mailOptions": { "recipient": "customer@example.com" } } }
{ "paymentOrderId": "d63e7f507a6f4dfa86cb40a833ecfd85", "amount": 200050, "currency": "PEN", "orderId": "myOrderId-999999", "channelOptions": { "channelType": "MAIL", "mailOptions": { "recipient": "sample@example.com" } }, "paymentReceiptEmail": "sample@example.com", "expirationDate": "2020-05-20T20:13:26+02:00", "locale": "es_PE", "dataCollectionForm": "true" }
{ "paymentOrderId": "d63e7f507a6f4dfa86cb40a833ecfd85", "amount": 200050, "currency": "ARS", "orderId": "myOrderId-999999", "channelOptions": { "channelType": "MAIL", "mailOptions": { "recipient": "sample@example.com" } }, "paymentReceiptEmail": "sample@example.com", "expirationDate": "2020-05-20T20:13:26+02:00", "locale": "es_AR", "dataCollectionForm": "true" }
{ "paymentOrderId": "d63e7f507a6f4dfa86cb40a833ecfd85", "amount": 200050, "currency": "COP", "orderId": "myOrderId-999999", "channelOptions": { "channelType": "MAIL", "mailOptions": { "recipient": "sample@example.com" } }, "paymentReceiptEmail": "sample@example.com", "expirationDate": "2020-05-20T20:13:26+02:00", "locale": "es_CO", "dataCollectionForm": "true" }
Respuesta
Ejemplo de respuesta
{ "webService": "Charge/PaymentOrder/Update", "version": "V4", "applicationVersion": "5.5.0", "status": "SUCCESS", "answer": { "paymentOrderId": "d63e7f507a6f4dfa86cb40a833ecfd85", "paymentURL": "https://secure.cobroinmediato.tech/t/328zq5so", "paymentOrderStatus": "RUNNING", "creationDate": "2020-03-31T15:06:49+00:00", "updateDate": "2020-04-29T12:55:50+00:00", "amount": 20000, "currency": "ARS", "locale": "en_GB", "strongAuthentication": "AUTO", "orderId": "myOrderId-999999", "channelDetails": { "channelType": "MAIL", "mailDetails": { "subject": "Your payment order", "body": "<b>Message sent by DEMO STORE</b> <p>Dear customer,</p> <p>This e-mail is a payment order of ARS 2,000.50 valid until 01/04/2020. To confirm, please click on the link below : </p> <p>https://secure.cobroinmediato.tech/t/w5izg024</p> <p>In case of problems, or if this message is not correctly displayed, please contact support@demostore.com.</p>", "template": null, "recipient": "sample@example.com", "bcc": null, "_type": "V4/MailDetails" }, "smsDetails": null, "whatsAppDetails": null, "_type": "V4/ChannelDetails" }, "paymentReceiptEmail": "sample@example.com", "taxRate": null, "taxAmount": null, "expirationDate": "2020-05-20T18:13:26+00:00", "transactionDetails": { "cardDetails": { "manualValidation": "NO", "captureDelay": 0, "_type": "V4/CardDetails" }, "_type": "V4/PaymentOrderTransactionDetails" }, "dataCollectionForm": true, "merchantComment": null, "message": "<b>Message sent by DEMO STORE</b> <p>Dear customer,</p> <p>This e-mail is a payment order of ARS 2,000.50 valid until 01/04/2020. To confirm, please click on the link below : </p> <p>https://secure.cobroinmediato.tech/t/w5izg024</p> <p>In case of problems, or if this message is not correctly displayed, please contact support@demostore.com.</p>", "_type": "V4/PaymentOrder" }, "ticket": null, "serverDate": "2020-04-29T12:55:50+00:00", "applicationProvider": "COIN", "metadata": null, "_type": "V4/WebService/Response" } }
Manejo de errores
Tabla de errores
Código | Descripción |
---|---|
El formato del campo amount no es válido o el campo no se ha transmitido. | |
El formato del campo currency no es válido o el campo no se ha transmitido. | |
El parámetro strongAuthentication es inválido. | |
el objeto smsOptions está ausente. | |
El parámetro channelOptions.whatsAppOptions.phoneNumber está ausente. | |
El parámetro channelOptions.smsOptions.phoneNumber está ausente. | |
el objeto whatsAppOptions está ausente. | |
el objeto mailOptions está ausente. | |
El parámetro channelOptions.mailOptions.recipient está ausente. | |
El parámetro locale es inválido. | |
El parámetro taxRate es inválido. | |
El parámetro taxAmount es inválido. | |
El formato del campo paymentOrderId no es válido o el campo no se ha transmitido. | |
Moneda desconocida. | |
El contrato admite esta divisa. | |
La solicitud de pago no existe. | |
No se puede establecer conexión con la puerta de enlace WhatsApp. | |
El número de teléfono del destinatario no está asociado a una cuenta de WhatsApp. | |
Falta la configuración de WhatsApp. | |
Plantilla de WhatsApp disponible para la configuración regional solicitada. | |
No se puede modificar una solicitud de pago pagada. | |
No se puede modificar una solicitud de pago expirada. | |
La fecha de vencimiento de la solicitud de pago no puede ser anterior a la fecha actual ni exceder los 90 días. | |
El modo (TEST o PRODUCTION) de la solicitud de pago no corresponde al de la solicitud. | |
No hay ningún formulario de recolección de datos para esta tienda. | |
No se puede modificar el canal de difusión. | |
No se puede utilizar el formulario de recolección de datos para la moneda solicitada. | |
La plantilla especificada en la solicitud no existe para la configuración regional solicitada. |