Obtener los detalles de una solicitud de pago
Pruebe el servicio web Charge/PaymentOrder/Get desde nuestro playground: Charge/PaymentOrder/Get .
Casos de uso
El vendedor desea conocer el estado de una solicitud de pago o simplemente obtener los detalles de una solicitud de pago.
El servicio web Charge/PaymentOrder/Get permite consultar solamente las solicitudes de pago creadas con el servicio web Charge/CreatePaymentOrder .
Solicitud
| Parámetro | Obligatorio | DESCRIPCIÓN |
|---|---|---|
| paymentOrderId | Sí | ID de la solicitud de pago. |
Ejemplo de solicitud
{
"paymentOrderId": "d63e7f507a6f4dfa86cb40a833ecfd85"
}
/**
* I initialize the PHP SDK
*/
require_once __DIR__ . '/vendor/autoload.php';
require_once __DIR__ . '/keys.php';
require_once __DIR__ . '/helpers.php';
/**
* Initialize the SDK
* see keys.php
*/
$client = new Lyra\Client();
/**
* I create a formToken
*/
$store = array("amount" => 250,
"currency" => "EUR",
"orderId" => uniqid("MyOrderId"),
"customer" => array(
"email" => "sample@example.com"
));
$response = $client->post("V4/Charge/CreatePayment", $store);
/* I check if there are some errors */
if ($response['status'] != 'SUCCESS') {
/* an error occurs, I throw an exception */
display_error($response);
$error = $response['answer'];
throw new Exception("error " . $error['errorCode'] . ": " . $error['errorMessage']);
}
/* everything is fine, I extract the formToken */
$formToken = $response["answer"]["formToken"];
?>
/**
* I initialize the PHP SDK
*/
require_once __DIR__ . '/vendor/autoload.php';
require_once __DIR__ . '/keys.php';
require_once __DIR__ . '/helpers.php';
/**
* Initialize the SDK
* see keys.php
*/
$client = new Lyra\Client();
/**
* I create a formToken
*/
$store = array("amount" => 250,
"currency" => "EUR",
"orderId" => uniqid("MyOrderId"),
"customer" => array(
"email" => "sample@example.com"
));
$response = $client->post("V4/Charge/CreatePayment", $store);
/* I check if there are some errors */
if ($response['status'] != 'SUCCESS') {
/* an error occurs, I throw an exception */
display_error($response);
$error = $response['answer'];
throw new Exception("error " . $error['errorCode'] . ": " . $error['errorMessage']);
}
/* everything is fine, I extract the formToken */
$formToken = $response["answer"]["formToken"];
?>
Respuesta
El objeto answer contendrá los siguientes parámetros:
| Parámetro | DESCRIPCIÓN |
|---|---|
| paymentOrderId | ID de la solicitud de pago. |
| paymentURL | URL de pago. |
| paymentOrderStatus | Estado de la solicitud de pago. |
| creationDate | Fecha y hora de creación de la solicitud de pago. |
| updateDate | Fecha y hora de modificación de la solicitud de pago. |
| channelDetails.channelType | Canal de transmisión de la solicitud de pago. |
| channelDetails.mailDetails.recipient | Dirección de e-mail del destinatario. Solo está presente si el valor de channelDetails.channelType está establecido en MAIL . |
| channelDetails.mailDetails.subject | Asunto del e-mail enviado. Solo está presente si el valor de channelDetails.channelType está establecido en MAIL . |
| channelDetails.mailDetails.body | Cuerpo del e-mail enviado. Solo está presente si el valor de channelDetails.channelType está establecido en MAIL . |
| channelDetails.mailDetails.template | Nombre de la plantilla utilizada. Solo está presente si el valor de channelDetails.channelType está establecido en MAIL . |
| channelDetails.mailDetails.bcc | Lista de los destinatarios en copia oculta. Solo está presente si el valor de channelDetails.channelType está establecido en MAIL . |
| channelDetails.smsDetails.phoneNumber | Número de teléfono del destinatario con el prefijo internacional. Solo está presente si el valor de channelDetails.channelType está establecido en SMS . |
| channelDetails.smsDetails.message | Cuerpo del mensaje enviado. Solo está presente si el valor de channelDetails.channelType está establecido en SMS . |
| channelDetails.whatsAppDetails.phoneNumber | Número de teléfono del destinatario con el prefijo internacional. Solo está presente si el valor de channelDetails.channelType está establecido en WHATSAPP . |
| message | Mensaje que incluye el enlace de pago, redactado en el idioma de la configuración regional. |
| amount | Monto a pagar, expresado en la unidad más pequeña de la moneda utilizada. |
| currency | Moneda del pago. Código ISO 4217 alpha-3. |
| locale | Código que representa el nombre del idioma, compuesto por el código del idioma (ISO 639-1) seguido del código del país (ISO 3166 alpha-2), separados por el carácter "_". |
| strongAuthentication | Preferencia del vendedor respecto a la autenticación fuerte. |
| orderId | Referencia del pedido. |
| paymentReceiptEmail | Dirección de e-mail para el envío del ticket de pago al comprador. |
| taxAmount | Monto de los impuestos para todo el pedido, expresado en su unidad monetaria más pequeña. |
| taxRate | Tipo de impuesto aplicado a todo el pedido. |
| expirationDate | Fecha de vencimiento de la solicitud en formato ISO-8601. |
| dataCollectionForm | Uso del formulario de recogida de datos. |
| merchantComment | Comentario. |
| transactionDetails.cardDetails.manualValidation | Modo de validación de la transacción. |
| transactionDetails.cardDetails.captureDelay | Plazo de captura. |
| description | Descripción asociada a la referencia transmitida en el campo orderId . |
Ejemplo de respuesta
{
"webService": "Charge/PaymentOrder/Get",
"version": "V4",
"applicationVersion": "5.5.0",
"status": "SUCCESS",
"answer": {
"paymentOrderId": "fd8f6060f824427ba687d0161e46af8f",
"paymentURL": "https://secure.cobroinmediato.tech/t/328zq5so",
"paymentOrderStatus": "RUNNING",
"creationDate": "2020-03-31T15:06:49+00:00",
"updateDate": null,
"amount": 200050,
"currency": "ARS",
"locale": "fr_FR",
"strongAuthentication": "AUTO",
"orderId": "myOrderId-999999",
"channelDetails": {
"channelType": "MAIL",
"mailDetails": {
"subject": "Votre ordre de paiement",
"body": "<b>Message envoyé par DEMO STORE</b> <p>Bonjour, </p> <p>Cet e-mail comporte un ordre de paiement d'un montant de 2000.50 ARS valable jusqu'au 20/04/2020. Pour confirmer le paiement, veuillez cliquer sur le lien suivant : </p> <p>https://secure.cobroinmediato.tech/t/328zq5so</p> <p>En cas de problème, ou si ce message ne s'affiche pas correctement, merci de contacter 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-04-20T18:13:26+00:00",
"transactionDetails": {
"cardDetails": {
"manualValidation": "NO",
"captureDelay": 0,
"_type": "V4/CardDetails"
},
"_type": "V4/PaymentOrderTransactionDetails"
},
"dataCollectionForm": false,
"merchantComment": null,
"message": "<b>Message envoyé par DEMO STORE</b> <p>Bonjour, </p> <p>Cet e-mail comporte un ordre de paiement d'un montant de 2000.50 ARS valable jusqu'au 20/04/2020. Pour confirmer le paiement, veuillez cliquer sur le lien suivant : </p> <p>https://secure.cobroinmediato.tech/t/328zq5so</p> <p>En cas de problème, ou si ce message ne s'affiche pas correctement, merci de contacter support@demostore.com.</p>",
"_type": "V4/PaymentOrder"
},
"ticket": null,
"serverDate": "2020-04-01T08:20:46+00:00",
"applicationProvider": "COIN",
"metadata": null,
"_type": "V4/WebService/Response"
}
{
"webService": "Charge/CreatePaymentOrder",
"version": "V4",
"applicationVersion": "5.5.0",
"status": "SUCCESS",
"answer": {
"paymentOrderId": "fd8f6060f824427ba687d0161e46af8f",
"paymentURL": "https://secure.cobroinmediato.tech/t/328zq5so",
"paymentOrderStatus": "RUNNING",
"creationDate": "2020-03-31T15:06:49+00:00",
"updateDate": null,
"amount": 200050,
"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-04-20T18:13:26+00:00",
"transactionDetails": {
"cardDetails": {
"manualValidation": "NO",
"captureDelay": 0,
"_type": "V4/CardDetails"
},
"_type": "V4/PaymentOrderTransactionDetails"
},
"dataCollectionForm": false,
"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-01T08:20:46+00:00",
"applicationProvider": "COIN",
"metadata": null,
"_type": "V4/WebService/Response"
}
}
{
"webService": "Charge/PaymentOrder/Get",
"version": "V4",
"applicationVersion": "5.5.0",
"status": "SUCCESS",
"answer": {
"paymentOrderId": "fd8f6060f824427ba687d0161e46af8f",
"paymentURL": "https://secure.cobroinmediato.tech/t/328zq5so",
"paymentOrderStatus": "RUNNING",
"creationDate": "2020-03-31T15:06:49+00:00",
"updateDate": null,
"amount": 200050,
"currency": "ARS",
"locale": "es_ES",
"strongAuthentication": "AUTO",
"orderId": "myOrderId-999999",
"channelDetails": {
"channelType": "MAIL",
"mailDetails": {
"subject": "Su solicitud de pago",
"body": "<b>Mensaje enviado por DEMO STORE</b> <p>Hola, </p> <p>Este correo electrónico contiene una solicitud de pago por un importe de 2.000, 50 PEN, válida hasta el 01/04/2020. Para confirmar el pago, haga clic en el enlace siguiente : </p> <p>https://secure.cobroinmediato.tech/t/w5izg024</p> <p>En caso de problemas, o si este mensaje no se muestra correctamente, por favor contacte 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-04-20T18:13:26+00:00",
"transactionDetails": {
"cardDetails": {
"manualValidation": "NO",
"captureDelay": 0,
"_type": "V4/CardDetails"
},
"_type": "V4/PaymentOrderTransactionDetails"
},
"dataCollectionForm": false,
"merchantComment": null,
"message": "<b>Mensaje enviado por DEMO STORE</b> <p>Hola, </p> <p>Este correo electrónico contiene una solicitud de pago por un importe de 2.000, 50 PEN, válida hasta el 01/04/2020. Para confirmar el pago, haga clic en el enlace siguiente : </p> <p>https://secure.cobroinmediato.tech/t/w5izg024</p> <p>En caso de problemas, o si este mensaje no se muestra correctamente, por favor contacte support@demostore.com.</p>",
"_type": "V4/PaymentOrder"
},
"ticket": null,
"serverDate": "2020-04-01T08:20:46+00:00",
"applicationProvider": "COIN",
"metadata": null,
"_type": "V4/WebService/Response"
}
}
{
"webService": "Charge/PaymentOrder/Get",
"version": "V4",
"applicationVersion": "5.5.0",
"status": "SUCCESS",
"answer": {
"paymentOrderId": "fd8f6060f824427ba687d0161e46af8f",
"paymentURL": "https://secure.cobroinmediato.tech/t/328zq5so",
"paymentOrderStatus": "RUNNING",
"creationDate": "2020-03-31T15:06:49+00:00",
"updateDate": null,
"amount": 200050,
"currency": "ARS",
"locale": "es_ES",
"strongAuthentication": "AUTO",
"orderId": "myOrderId-999999",
"channelDetails": {
"channelType": "MAIL",
"mailDetails": {
"subject": "Su solicitud de pago",
"body": "<b>Mensaje enviado por DEMO STORE</b> <p>Hola, </p> <p>Este correo electrónico contiene una solicitud de pago por un importe de 2.000, 50 COP, válida hasta el 01/04/2020. Para confirmar el pago, haga clic en el enlace siguiente : </p> <p>https://secure.cobroinmediato.tech/t/w5izg024</p> <p>En caso de problemas, o si este mensaje no se muestra correctamente, por favor contacte 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-04-20T18:13:26+00:00",
"transactionDetails": {
"cardDetails": {
"manualValidation": "NO",
"captureDelay": 0,
"_type": "V4/CardDetails"
},
"_type": "V4/PaymentOrderTransactionDetails"
},
"dataCollectionForm": false,
"merchantComment": null,
"message": "<b>Mensaje enviado por DEMO STORE</b> <p>Hola, </p> <p>Este correo electrónico contiene una solicitud de pago por un importe de 2.000, 50 COP, válida hasta el 01/04/2020. Para confirmar el pago, haga clic en el enlace siguiente : </p> <p>https://secure.cobroinmediato.tech/t/w5izg024</p> <p>En caso de problemas, o si este mensaje no se muestra correctamente, por favor contacte support@demostore.com.</p>",
"_type": "V4/PaymentOrder"
},
"ticket": null,
"serverDate": "2020-04-01T08:20:46+00:00",
"applicationProvider": "COIN",
"metadata": null,
"_type": "V4/WebService/Response"
}
}
{
"webService": "Charge/PaymentOrder/Get",
"version": "V4",
"applicationVersion": "5.5.0",
"status": "SUCCESS",
"answer": {
"paymentOrderId": "fd8f6060f824427ba687d0161e46af8f",
"paymentURL": "https://secure.cobroinmediato.tech/t/328zq5so",
"paymentOrderStatus": "RUNNING",
"creationDate": "2020-03-31T15:06:49+00:00",
"updateDate": null,
"amount": 200050,
"currency": "ARS",
"locale": "es_ES",
"strongAuthentication": "AUTO",
"orderId": "myOrderId-999999",
"channelDetails": {
"channelType": "MAIL",
"mailDetails": {
"subject": "Su solicitud de pago",
"body": "<b>Mensaje enviado por DEMO STORE</b> <p>Hola, </p> <p>Este correo electrónico contiene una solicitud de pago por un importe de 2.000, 50 ARS, válida hasta el 01/04/2020. Para confirmar el pago, haga clic en el enlace siguiente : </p> <p>https://secure.cobroinmediato.tech/t/w5izg024</p> <p>En caso de problemas, o si este mensaje no se muestra correctamente, por favor contacte 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-04-20T18:13:26+00:00",
"transactionDetails": {
"cardDetails": {
"manualValidation": "NO",
"captureDelay": 0,
"_type": "V4/CardDetails"
},
"_type": "V4/PaymentOrderTransactionDetails"
},
"dataCollectionForm": false,
"merchantComment": null,
"message": "<b>Mensaje enviado por DEMO STORE</b> <p>Hola, </p> <p>Este correo electrónico contiene una solicitud de pago por un importe de 2.000, 50 ARS, válida hasta el 01/04/2020. Para confirmar el pago, haga clic en el enlace siguiente : </p> <p>https://secure.cobroinmediato.tech/t/w5izg024</p> <p>En caso de problemas, o si este mensaje no se muestra correctamente, por favor contacte support@demostore.com.</p>",
"_type": "V4/PaymentOrder"
},
"ticket": null,
"serverDate": "2020-04-01T08:20:46+00:00",
"applicationProvider": "COIN",
"metadata": null,
"_type": "V4/WebService/Response"
}
}
{
"webService": "Charge/PaymentOrder/Get",
"version": "V4",
"applicationVersion": "5.5.0",
"status": "SUCCESS",
"answer": {
"paymentOrderId": "fd8f6060f824427ba687d0161e46af8f",
"paymentURL": "https://secure.cobroinmediato.tech/t/328zq5so",
"paymentOrderStatus": "RUNNING",
"creationDate": "2020-03-31T15:06:49+00:00",
"updateDate": null,
"amount": 200050,
"currency": "ARS",
"locale": "pt_BR",
"strongAuthentication": "AUTO",
"orderId": "myOrderId-999999",
"channelDetails": {
"channelType": "MAIL",
"mailDetails": {
"subject": "Su solicitud de pago",
"body": "<b>Mensagem enviada por DEMO STORE</b> <p>Caro cliente, </p> <p>Este e-mail contém uma ordem de pagamento no valor de 2.000, 50 BRL válida até 01/04/2020. Para confirmar o pagamento, favor clicar sobre o link seguinte : </p> <p>https://secure.cobroinmediato.tech/t/w5izg024</p> <p>Em caso de problema ou se esta mensagem não é exibida corretamente, favor contactar 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-04-20T18:13:26+00:00",
"transactionDetails": {
"cardDetails": {
"manualValidation": "NO",
"captureDelay": 0,
"_type": "V4/CardDetails"
},
"_type": "V4/PaymentOrderTransactionDetails"
},
"dataCollectionForm": false,
"merchantComment": null,
"message": "<b>Mensagem enviada por DEMO STORE</b> <p>Caro cliente, </p> <p>Este e-mail contém uma ordem de pagamento no valor de 2.000, 50 BRL válida até 01/04/2020. Para confirmar o pagamento, favor clicar sobre o link seguinte : </p> <p>https://secure.cobroinmediato.tech/t/w5izg024</p> <p>Em caso de problema ou se esta mensagem não é exibida corretamente, favor contactar support@demostore.com.</p>",
"_type": "V4/PaymentOrder"
},
"ticket": null,
"serverDate": "2020-04-01T08:20:46+00:00",
"applicationProvider": "COIN",
"metadata": null,
"_type": "V4/WebService/Response"
}
}
Manejo de errores
El servicio web Charge/PaymentOrder/Get enviará un error en los siguientes casos:
| Código | DESCRIPCIÓN |
|---|---|
| INT_902 | El formato del campo paymentOrderId no es válido o el campo no se ha transmitido. |
| PSP_1000 | La solicitud de pago no existe. |