Compras Autorizadas: Captura y Cancelación
Versiones anteriores de la API
La documentación de la API versión V1 está disponible en la sección de Legacy
Capturar una compra
Este método le permite confirmar una compra autorizada. El proceso de captura le da la flexibilidad de confirmar y finalizar una transacción preautorizada, permitiéndole ajustar el valor si es necesario.
Nota
No todos los métodos de pago admiten la función de preautorización. Está disponible para los siguientes países:
URL de la solicitud
Debe realizar una petición POST a las siguientes URLs según sus necesidades:
- Producción:
https://api.bamboopayment.com/v3/api/purchase/{{TransactionId}}/capture - Pruebas:
https://api.stage.bamboopayment.com/v3/api/purchase/{{TransactionId}}/capture
Recuerda incluir la Clave Privada del comercio en los encabezados de la petición.
Para más detalles, consulta nuestra Guía de Autenticación.
Parámetros de la solicitud
El body en la solicitud es opcional para confirmar una compra. Si no envía ninguna solicitud, el método confirmará la compra preautorizada por su valor original.
El valor de la compra puede variar respecto al enviado en el proceso de compra inicial, pero el nuevo valor no puede ser mayor que el valor original.
Ejemplo de solicitud (Captura Parcial)
Debe incluir el nuevo valor en la solicitud para confirmar una compra con un valor menor al original. Por ejemplo:
{
"Amount": 50
}Ejemplo de respuesta (Captura Parcial)
Obtendrá el mismo objeto Response que para el objeto de compra.
Resultado: COMPLETED - Estado: PREAUTHORIZED
{
"TransactionId": "79632697147789184",
"Result": "COMPLETED",
"Status": "PREAUTHORIZED",
"ErrorCode": null,
"ErrorDescription": null,
"Created": "2024-08-07T17:51:54.620",
"AuthorizationDate": "2024-08-07T17:51:56.879",
"AuthorizationCode": "839936",
"Amount": 5000,
"Currency": "BRL",
"Installments": 2,
"TaxableAmount": null,
"Tip": null,
"Url": "https://api.stage.bamboopayment.com/Purchase/79632697147789184",
"MetadataOut": null,
"Action": null,
"PaymentMethod": {
"Brand": "Visa",
"CardOwner": "João Silva",
"Bin": "450799",
"IssuerBank": "Banco do Brasil",
"Type": "CreditCard",
"Expiration": "203008",
"Last4": "4905"
}Cancelar una compra
La anulación es el acto de cancelar una transacción preautorizada antes de que se finalice o liquide. Cuando se anula una transacción, es como si la compra nunca hubiera ocurrido y se libera el cupo del límite autorizado. Las anulaciones generalmente ocurren antes de que el pago se procese completamente, por lo que no se cobra al medio de pago del cliente por la transacción anulada.
Versiones anteriores de la API
La documentación de la API versión V1 está disponible en la sección de Legacy
La operación de cancelación solo está disponible para compras previamente autorizadas con estado PreAuthorized. Si está interesado en reembolsar una compra que ya ha sido capturada, consulte la sección de reembolsos para obtener instrucciones detalladas.
Nota
La función de preautorización puede no estar soportada por todos los métodos de pago y está disponible para los siguientes países:
URL de la solicitud
Debe realizar una petición POST a las siguientes URLs según sus necesidades:
- Producción:
https://api.bamboopayment.com/v3/api/purchase/{{TransactionId}}/cancel - Pruebas:
https://api.stage.bamboopayment.com/v3/api/purchase/{{TransactionId}}/cancel
Recuerda incluir la Clave Privada del comercio en los encabezados de la petición.
Para más detalles, consulta nuestra Guía de Autenticación.
Parámetros de la solicitud
No se requiere el body en la solicitud para cancelar una compra. Si no envía ninguna solicitud, la compra se anulará con su valor original.
El valor a anular puede variar respecto al que se envió en el proceso de Compra inicial, pero el nuevo valor no puede ser mayor que el valor original.
Nota
La disponibilidad de la funcionalidad de cancelación parcial puede variar según el país. Para obtener información detallada sobre esta función en su región específica, consulte con su Account Manager.
Ejemplo de solicitud (Cancelación Parcial)
Para realizar la cancelación de la compra con un valor menor al original, debe incluir el nuevo valor en la solicitud. Por ejemplo:
{
"Amount": 50
}Parámetros de respuesta
Cuando realiza la cancelación, obtendrá el mismo objeto Response que para el objeto de compra.
Resultado: COMPLETED - Estado: CANCELLED
{
"TransactionId": "79632697147789184",
"Result": "COMPLETED",
"Status": "CANCELLED",
"ErrorCode": null,
"ErrorDescription": null,
"Created": "2024-08-07T17:51:54.620",
"AuthorizationDate": "2024-08-07T17:51:56.879",
"AuthorizationCode": "839936",
"Amount": 5000,
"Currency": "BRL",
"Installments": 2,
"TaxableAmount": null,
"Tip": null,
"Url": "https://api.stage.bamboopayment.com/Purchase/79632697147789184",
"MetadataOut": null,
"Action": null,
"PaymentMethod": {
"Brand": "Visa",
"CardOwner": "João Silva",
"Bin": "450799",
"IssuerBank": "Banco do Brasil",
"Type": "CreditCard",
"Expiration": "203008",
"Last4": "4905"
}
}