A continuación, se muestran todos los casos de uso contemplados por la API de Pagos y los diferentes flujos de liquidación y procesamiento del pago.
Creación de Pago Autorizado
La creación de pago autorizado, también llamada captura de pago, consiste en el procesamiento y efectivización del pago en el momento del envío de la solicitud. Este es el flujo comúnmente utilizado en una amplia variedad de negocios en la actualidad.
Sin embargo, para crear un pago utilizando este flujo, es necesario enviar el parámetro capture como true (verdadero).
A continuación, te muestro un ejemplo de solicitud para capturar un pago:
{
"amount": 1035,
"payment": {
"type": "credit",
"installments": 1,
"capture": true,
"softdescriptor": "PAG*TESTE",
"card": {
"holder": "TESTE HOLDER",
"number": "5201561050025011",
"expiry_month": "09",
"expiry_year": "2024",
"brand": "mastercard",
"cvv": "123"
}
},
"customer": {
"name": "Comprador Teste",
"document": "99999999999",
"email": "[email protected]",
"phone": "11999999999",
"birthdate": "1969-12-31",
"billing_address": {
"street": "Rua teste",
"number": "1",
"district": "Bairro teste",
"complement": "Complemento teste",
"zipcode": "99999999",
"city": "São Paulo",
"state": "SP",
"country": "BRA"
}
}
}
Creación de Pago Preautorizado
La creación de pago preautorizado, también conocida como pre-captura de pago, implica el procesamiento previo del pago, la reserva del dinero del cliente y la efectivización parcial o completa del pago posterior a la pre-captura del pago.
A continuación, te muestro un esquema de la pre-captura de pago:
Aquí tienes una esquematización de la pre-captura de pago:
Generalmente, esta modalidad de pago se utiliza para operaciones que requieren garantía de pago o seguridad del pago, como hotelería y alquiler de servicios y productos.
Vale la pena mencionar que la pre-captura será cancelada automáticamente si no se realiza la captura en 5 días posteriores a la creación del pago preautorizado.
A continuación, te muestro un ejemplo de solicitud para la pre-captura de pago:
{
"amount": 1035,
"payment": {
"type": "credit",
"installments": 1,
"capture": false,
"softdescriptor": "PAG*TESTE",
"card": {
"vault": "2beaeb98-391d-41d9-8685-61464f3c0789"
}
},
"customer": {
"name": "Comprador Teste",
"document": "99999999999",
"email": "[email protected]",
"phone": "11999999999",
"birthdate": "1969-12-31",
"billing_address": {
"street": "Rua teste",
"number": "1",
"district": "Bairro teste",
"complement": "Complemento teste",
"zipcode": "99999999",
"city": "São Paulo",
"state": "SP",
"country": "BRA"
}
}
}
Además, tenga en cuenta el valor capturado, no puede superar el valor pre-capturado original de la creación del pago.
Crear Pago con Cofre de Tarjeta
La creación de pago con cofre de tarjeta consiste en el uso de un cofre de una tarjeta para realizar la preautorización o autorización de pagos sin enviar los datos de la tarjeta, solo utilizando su cofre.
Este método de creación de pagos es interesante para establecimientos que necesiten la opción de compra con un solo clic en su plataforma.
Sin embargo, para crear el pago utilizando este método, es necesario realizar la tokenización previa de los datos de la tarjeta a través del punto final de Creación de Cofre de Tarjeta.
A continuación, aquí tienes un ejemplo de solicitud para la captura de pago con un cofre de tarjeta:
{
"amount": 1035,
"payment": {
"type": "credit",
"installments": 1,
"capture": true,
"softdescriptor": "PAG*TESTE",
"card": {
"vault": "2beaeb98-391d-41d9-8685-61464f3c0789"
}
},
"customer": {
"name": "Comprador Teste",
"document": "99999999999",
"email": "[email protected]",
"phone": "11999999999",
"birthdate": "1969-12-31",
"billing_address": {
"street": "Rua teste",
"number": "1",
"district": "Bairro teste",
"complement": "Complemento teste",
"zipcode": "99999999",
"city": "São Paulo",
"state": "SP",
"country": "BRA"
}
}
}
Vale la pena mencionar que es posible realizar pagos de pre-captura y captura utilizando el cofre.
Crear Pago con División
La creación de un pago con split consiste en el proceso de cambio y modificación de la liquidación, es decir, no está directamente relacionado con el cambio del flujo de autorización y efectivación del arreglo de pagos creado. De esta manera, puedes utilizar un pago con split tanto en una preautorización como en una autorización.
Esta modalidad de creación de pago es interesante para operaciones comerciales que requieren la división del pago entre dos o más destinatarios. Por ejemplo, al vender un producto en línea, puedes dividir una parte del pago para el transportista del pedido y otra parte para el proveedor del pedido, lo que te permite cambiar el flujo de liquidación en el momento de la creación del pago.
A continuación, una esquematización del flujo de proceso realizado:
Aquí tienes una esquematización del split de pago:
Vale la pena mencionar que esta operación no puede realizarse para empresas no registradas en la plataforma, es decir, no puedes definir a qué cuenta bancaria se realizará el split.
Consideraciones sobre el Split de Pagos
Por otro lado, es necesario tener en cuenta algunas consideraciones sobre la creación del pago con split:
- Considera como
PRIMARIO, el participante principal o de origen del pago; - Considera como
SECUNDARIO, participantes secundarios del split del pago; - Ten en cuenta que solo es posible crear un split con solo un participante primario;
- El participante primario no puede recibir menos del 1% del pago;
- La suma de los valores divididos en el split no puede ser diferente del valor neto de la transacción;
A continuación, aquí tienes un ejemplo de solicitud para la creación de pagos con split de pago:
{
"amount": 1035,
"payment": {
"type": "credit",
"installments": 1,
"capture": true,
"card": {
"holder": "TESTE HOLDER",
"number": "5201561050025011",
"expiryMonth": "09",
"expiryYear": "2024",
"brand": "mastercard",
"cvv": "123"
}
},
"customer": {
"name": "Comprador Teste",
"document": "99999999999",
"email": "[email protected]",
"phone": "11999999999",
"birthdate": "1969-12-31",
"billingAddress": {
"street": "Rua teste",
"number": "1",
"district": "Bairro teste",
"complement": "Complemento teste",
"zipcode": "99999999",
"city": "São Paulo",
"state": "SP",
"country": "BRA"
}
},
"splits": [
{
"recipientToken": "9b7ba208a0e54094b9c06ef479acf4b29ddc1d3a",
"merchantType": "PRIMARY",
"chargeFee": true,
"type": "PERCENTAGE",
"amountSplit": 6000
},
{
"recipientToken": "4a723333747e4aa3ac10f12fa65af89e5057d651",
"merchantType": "SECONDARY",
"type": "PERCENTAGE",
"chargeFee": false,
"discountGrossAmount": false,
"amountSplit": 4000
},
{
"recipientToken": "4a723333747e4aa3ac10f12fa65af89e5057d633",
"merchantType": "SECONDARY",
"type": "AMOUNT",
"chargeFee": false,
"discountGrossAmount": false,
"amountSplit": 200
}
]
}
Creación de Pago con Split Tardío
La creación de un pago con split tardío, al igual que en el split estándar, consiste en el proceso de modificación y ajuste de liquidación, es decir, no está directamente relacionado con la modificación del flujo de autorización y liquidación del arreglo de pagos creado. De esta manera, puedes realizar tanto una preautorización como una autorización con split tardío.
Sin embargo, su diferencia con el split estándar radica en el momento tardío de modificación de los participantes de la liquidación del pago, es decir, en lugar de definir los participantes del split en el momento de la creación del pago, realizas esta definición en un momento posterior a la captura.
A continuación, aquí tienes una esquematización del flujo de proceso:
Aquí tienes una esquematización del split tardío del pago:
Por lo tanto, observando el esquema, se percibe la necesidad de realizar la solicitud de creación del pago y la solicitud de activación del split tardío (anteriormente denominada "Definición de los Participantes").
En caso de que el establecimiento cree el pago informando el split tardío y, por casualidad, la definición de los participantes a través del punto final de Activación del Split Tardío no se realice, el pago no se liquidará hasta que el establecimiento que creó los pagos realice la definición de los participantes o cancele el pago.
A continuación, aquí tienes un ejemplo de solicitud para la creación de pagos con split de pago tardío:
{
"amount": 1035,
"payment": {
"type": "credit",
"installments": 1,
"capture": true,
"delayed_split": true,
"softdescriptor": "PAG*TESTE",
"card": {
"holder": "TESTE HOLDER",
"number": "5201561050025011",
"expiry_month": "09",
"expiry_year": "2024",
"brand": "mastercard",
"cvv": "123"
}
},
"customer": {
"name": "Comprador Teste",
"document": "99999999999",
"email": "[email protected]",
"phone": "11999999999",
"birthdate": "1969-12-31",
"billing_address": {
"street": "Rua teste",
"number": "1",
"district": "Bairro teste",
"complement": "Complemento teste",
"zipcode": "99999999",
"city": "São Paulo",
"state": "SP",
"country": "BRA"
}
}
}
Después de la creación del pago, es necesario activar el split de pago. A continuación, te muestro un ejemplo de solicitud:
{
"orderId": "6183f4ac7ad8d",
"splits": [
{
"recipientToken": "9b7ba208a0e54094b9c06ef479acf4b29ddc1d3a",
"merchantType": "PRIMARY",
"chargeFee": true,
"type": "PERCENTAGE",
"amountSplit": 6000
},
{
"recipientToken": "4a723333747e4aa3ac10f12fa65af89e5057d651",
"merchantType": "SECONDARY",
"type": "PERCENTAGE",
"chargeFee": false,
"discountGrossAmount": false,
"amountSplit": 4000
},
{
"recipientToken": "4a723333747e4aa3ac10f12fa65af89e5057d633",
"merchantType": "SECONDARY",
"type": "AMOUNT",
"chargeFee": false,
"discountGrossAmount": false,
"amountSplit": 200
}
]
}
Vale la pena señalar que se deben tener en cuenta algunas observaciones:
- En caso de que la suma de los porcentajes de los participantes del split tardío sea mayor que 100%, la activación del split tardío no se llevará a cabo y seguirá pendiente de activación.
- En caso de que la suma de los porcentajes de los participantes del split tardío sea menor que 100%, se realizará la activación del split tardío y el participante primario recibirá el porcentaje restante que quedó del split creado.
- En caso de que la tarifa cobrada por la plataforma por la autorización del pago sea sobre el neto del participante y el descuento de esta sobre el participante resulte en un valor neto a recibir negativo, la activación del split tardío no se llevará a cabo y seguirá pendiente de activación.
- Si la tarifa cobrada por la plataforma no se informa para ser pagada por ninguno de los participantes a través del parámetro
chargeFee, será cobrada por el participante primario de la activación del split.
Además de considerar los casos anteriores, revisa las Consideraciones sobre la División de Pagos para integrarte al punto final de activación del split.