Iniciar una solicitud de pago
El sitio web comercial inicia una solicitud de pago con una llamada al Web Service Charge/CreatePayment.
POST https://api.payty.com/api-payment/V4/Charge/CreatePayment
Como respuesta, el servidor del vendedor recupera un formToken, un objeto encriptado que define el contexto de pago (monto, devisa, número de pedido, datos del comprador, etc.).
Para mostrar el formulario inteligente (smartForm), puede elegir entre 3 modos:
- En modo lista, utilice la clase kr-smart-form.
<body> <!-- new class kr-smart-form --> <div class="kr-smart-form" kr-form-token="[GENERATED FORMTOKEN]"> (...) </div> </body>
- En modo pop-in, utilice la clase kr-smart-form y el parámetro kr-popin.
<body> <!-- new class kr-smart-form --> <div class="kr-smart-form" kr-popin kr-form-token="[GENERATED FORMTOKEN]"> (...) </div> </body>
- En modo lista con tarjeta incrustada, utilice la clase kr-smart-form y el parámetro kr-card-form-expanded.
<body> <!-- new class kr-smart-form --> <div class="kr-smart-form" kr-card-form-expanded kr-form-token="[GENERATED FORMTOKEN]"> (...) </div> </body>
Microsoft ha dejado Internet Explorer 11 obsoleto desde junio de 2022.
La integración del formulario inteligente (smartForm) no es compatible con este navegador.
Para forzar los modos de pago, utilice los campos paymentMethodsal crear el formToken.
- Si desea mostrar solamente el medio de pago PSE:
"paymentMethods": ["PSE"]
- Si desea mostrar los métodos de pago PSE y el pago por tarjeta:
"paymentMethods": ["PSE", "CARDS"]
Utilice los siguientes campos para hacer una solicitud:
| Nombre del campo | Descripción |
|---|---|
| formAction | Tipo de comportamiento que desea al crear la transacción. Su valor debe ser PAYMENT. |
| amount | Monto para pagar, expresado en su fracción monetaria más pequeña (el céntimo para el euro). Este campo es necesario. |
| currency | Moneda del pago. Código ISO 4217 alpha-3. Ejemplo:
“COP” por Peso Colombiano Este campo es necesario. |
| paymentMethods | Lista de formas de pago para ofrecer al comprador Ejemplo: “PSE” para forzar este medio de pago. |
| orderId | Referencia del pedido. Se recomienda este campo. |
| customer.email | Dirección de e-mail para el envío del ticket de pago al comprador. Este campo es obligatorio para evitar la página intermedia. |
| customer.billingDetails.identityType | Tipo de documento de identidad. Este campo es obligatorio para evitar la página intermedia. |
| customer.billingDetails.identityCode | Número nacional de identificación Este campo es obligatorio para evitar la página intermedia. |
| customer.billingDetails.firstName | Nombre del comprador. Este campo es obligatorio para evitar la página intermedia. |
| customer.billingDetails.lastName | Apellido del comprador. Este campo es obligatorio para evitar la página intermedia. |
| customer.billingDetails.phoneNumber | Número de teléfono del comprador. Este campo es obligatorio para evitar la página intermedia. |
| customer.billingDetails.address | Dirección del comprador. Este campo es obligatorio para evitar la página intermedia. |
| customer.billingDetails.zipCode | Código postal Este campo es obligatorio para evitar la página intermedia. |
| customer.billingDetails.city | Ciudad Este campo es obligatorio para evitar la página intermedia. |
Ejemplo de solicitud:
https://api.payty.com/api-payment/V4/Charge/CreatePayment
{
"amount":"50000",
"currency":"COP",
"orderId":"demo-633fdc95431a",
"customer":{
"email":"main@example.com",
"billingDetails":{
"identityType":"CC",
"identityCode":"01-93-N9l6477D",
"firstName":"Pedro",
"lastName":"González",
"phoneNumber":"(+57)1 346 2000",
"address":"Avenida de la paz",
"zipCode":"110221",
"city":"Bogotá"
}
};Ejemplo de respuesta:
{
"shopId":"58061531",
"orderCycle":"CLOSED",
"orderStatus":"PAID",
"serverDate":"2023-03-08T13:56:11+00:00",
"orderDetails":{
"orderTotalAmount":50000,
"orderEffectiveAmount":50000,
"orderCurrency":"COP",
"mode":"TEST",
"orderId":"demo-633fdc95431a",
"metadata":null,
"_type":"V4/OrderDetails"
},
"customer":{
"billingDetails":{
"address":"Avenida de la paz",
"category":null,
"cellPhoneNumber":null,
"city":"Bogotá",
"country":null,
"district":null,
"firstName":"Pedro",
"identityCode":"123456789",
"identityType":"CC",
"language":"ES",
"lastName":"González",
"phoneNumber":"(+57)1 346 2000",
"state":null,
"streetNumber":null,
"title":null,
"zipCode":"110221",
"legalName":null,
"_type":"V4/Customer/BillingDetails"
},
"email":"main@example.com",
"extraDetails":{
"browserAccept":null,
"fingerPrintId":null,
"ipAddress":"90.1.199.248",
"browserUserAgent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/110.0.0.0 Safari/537.36",
"_type":"V4/Customer/ExtraDetails"
},
"transactions":[
{
"shopId":"58061531",
"uuid":"73e37c63f24047d3b482efd00083f1b3",
"amount":50000,
"currency":"COP",
"paymentMethodType":"PSE",
"paymentMethodToken":null,
"status":"PAID",
"detailedStatus":"CAPTURED",
"operationType":"DEBIT",
"effectiveStrongAuthentication":"DISABLED",
"creationDate":"2023-03-08T13:56:09+00:00",
"errorCode":null,
"errorMessage":null,
"detailedErrorCode":null,
"detailedErrorMessage":null,
"metadata":null,
"transactionDetails":{
"liabilityShift":null,
"effectiveAmount":50000,
"effectiveCurrency":"COP",
"creationContext":"CHARGE",
"cardDetails":{
"paymentSource":"EC",
"manualValidation":"NO",
"expectedCaptureDate":"2023-03-08T13:56:09+00:00",
"effectiveBrand":"PSE",
"pan":"pago-aceptado@lyra-network.com",
"expiryMonth":null,
"expiryYear":null,
"country":null,
"issuerCode":1040,
"issuerName":"BANCO AGRARIO",
"effectiveProductCode":null,
"legacyTransId":"928234",
"legacyTransDate":"2023-03-08T13:55:56+00:00",
"paymentMethodSource":"NEW",
"authorizationResponse":{
"amount":50000,
"currency":"COP",
"authorizationDate":"2023-03-08T13:56:09+00:00",
"authorizationNumber":"2ec3mwIqb4000",
"authorizationResult":"0",
"authorizationMode":"FULL",
"_type":"V4/PaymentMethod/Details/Cards/CardAuthorizationResponse"
},
"captureResponse":{
"refundAmount":null,
"refundCurrency":null,
"captureDate":"2023-03-08T13:56:09+00:00",
"captureFileNumber":"1",
"effectiveRefundAmount":null,
"effectiveRefundCurrency":null,
"_type":"V4/PaymentMethod/Details/Cards/CardCaptureResponse"
},
( ...)
"paymentMethodDetails":{
"id":"pago-aceptado@lyra-network.com",
"paymentSource":"EC",
"manualValidation":"NO",
"expectedCaptureDate":"2023-03-08T13:56:09+00:00",
"effectiveBrand":"PSE",
"expiryMonth":null,
"expiryYear":null,
"country":null,
"issuerCode":1040,
"issuerName":"BANCO AGRARIO",
"effectiveProductCode":null,
"legacyTransId":"928234",
"legacyTransDate":"2023-03-08T13:55:56+00:00",
"paymentMethodSource":"NEW",
"authorizationResponse":{
"amount":50000,
"currency":"COP",
"authorizationDate":"2023-03-08T13:56:09+00:00",
"authorizationNumber":"2ec3mwIqb4000",
"authorizationResult":"0",
"authorizationMode":"FULL",
"_type":"V4/PaymentMethod/Details/Cards/CardAuthorizationResponse"
},
( ...)
"_type":"V4/PaymentTransaction"
}
],
( ...)
"_type":"V4/Payment"
}
}